* $paymentsresellersubscriptionService = new Google\Service\PaymentsResellerSubscription(...); * $subscriptions = $paymentsresellersubscriptionService->partners_subscriptions; * */ class PartnersSubscriptions extends \Google\Service\Resource { /** * Used by partners to cancel a subscription service either immediately or by * the end of the current billing cycle for their customers. It should be called * directly by the partner using service accounts. (subscriptions.cancel) * * @param string $name Required. The name of the subscription resource to be * cancelled. It will have the format of * "partners/{partner_id}/subscriptions/{subscription_id}" * @param GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse * @throws \Google\Service\Exception */ public function cancel($name, GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('cancel', [$params], GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse::class); } /** * Used by partners to create a subscription for their customers. The created * subscription is associated with the end user inferred from the end user * credentials. This API must be authorized by the end user using OAuth. * (subscriptions.create) * * @param string $parent Required. The parent resource name, which is the * identifier of the partner. It will have the format of * "partners/{partner_id}". * @param GoogleCloudPaymentsResellerSubscriptionV1Subscription $postBody * @param array $optParams Optional parameters. * * @opt_param string subscriptionId Required. Identifies the subscription * resource on the Partner side. The value is restricted to 63 ASCII characters * at the maximum. If a subscription was previously created with the same * subscription_id, we will directly return that one. * @return GoogleCloudPaymentsResellerSubscriptionV1Subscription * @throws \Google\Service\Exception */ public function create($parent, GoogleCloudPaymentsResellerSubscriptionV1Subscription $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], GoogleCloudPaymentsResellerSubscriptionV1Subscription::class); } /** * Used by partners to entitle a previously provisioned subscription to the * current end user. The end user identity is inferred from the authorized * credential of the request. This API must be authorized by the end user using * OAuth. (subscriptions.entitle) * * @param string $name Required. The name of the subscription resource that is * entitled to the current end user. It will have the format of * "partners/{partner_id}/subscriptions/{subscription_id}" * @param GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse * @throws \Google\Service\Exception */ public function entitle($name, GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('entitle', [$params], GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse::class); } /** * [Opt-in only] Most partners should be on auto-extend by default. Used by * partners to extend a subscription service for their customers on an ongoing * basis for the subscription to remain active and renewable. It should be * called directly by the partner using service accounts. (subscriptions.extend) * * @param string $name Required. The name of the subscription resource to be * extended. It will have the format of * "partners/{partner_id}/subscriptions/{subscription_id}". * @param GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse * @throws \Google\Service\Exception */ public function extend($name, GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('extend', [$params], GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse::class); } /** * Used by partners to get a subscription by id. It should be called directly by * the partner using service accounts. (subscriptions.get) * * @param string $name Required. The name of the subscription resource to * retrieve. It will have the format of * "partners/{partner_id}/subscriptions/{subscription_id}" * @param array $optParams Optional parameters. * @return GoogleCloudPaymentsResellerSubscriptionV1Subscription * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], GoogleCloudPaymentsResellerSubscriptionV1Subscription::class); } /** * Used by partners to provision a subscription for their customers. This * creates a subscription without associating it with the end user account. * EntitleSubscription must be called separately using OAuth in order for the * end user account to be associated with the subscription. It should be called * directly by the partner using service accounts. (subscriptions.provision) * * @param string $parent Required. The parent resource name, which is the * identifier of the partner. It will have the format of * "partners/{partner_id}". * @param GoogleCloudPaymentsResellerSubscriptionV1Subscription $postBody * @param array $optParams Optional parameters. * * @opt_param string subscriptionId Required. Identifies the subscription * resource on the Partner side. The value is restricted to 63 ASCII characters * at the maximum. If a subscription was previously created with the same * subscription_id, we will directly return that one. * @return GoogleCloudPaymentsResellerSubscriptionV1Subscription * @throws \Google\Service\Exception */ public function provision($parent, GoogleCloudPaymentsResellerSubscriptionV1Subscription $postBody, $optParams = []) { $params = ['parent' => $parent, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('provision', [$params], GoogleCloudPaymentsResellerSubscriptionV1Subscription::class); } /** * Revokes the pending cancellation of a subscription, which is currently in * `STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already * cancelled, the request will fail. - **This API doesn't apply to YouTube * subscriptions.** It should be called directly by the partner using service * accounts. (subscriptions.undoCancel) * * @param string $name Required. The name of the subscription resource whose * pending cancellation needs to be undone. It will have the format of * "partners/{partner_id}/subscriptions/{subscription_id}" * @param GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse * @throws \Google\Service\Exception */ public function undoCancel($name, GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('undoCancel', [$params], GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(PartnersSubscriptions::class, 'Google_Service_PaymentsResellerSubscription_Resource_PartnersSubscriptions');