class Subscriptions extends Resource (View source)

The "subscriptions" collection of methods.

Typical usage is:

 $workspaceeventsService = new Google\Service\WorkspaceEvents(...);
 $subscriptions = $workspaceeventsService->subscriptions;

Methods

create(Subscription $postBody, array $optParams = [])

Developer Preview: Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription. (subscriptions.create)

delete(string $name, array $optParams = [])

Developer Preview: Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription. (subscriptions.delete)

get(string $name, array $optParams = [])

Developer Preview: Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription. (subscriptions.get)

listSubscriptions(array $optParams = [])

Developer Preview: Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions. (subscriptions.listSubscriptions)

patch(string $name, Subscription $postBody, array $optParams = [])

Developer Preview: Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription. (subscriptions.patch)

reactivate(string $name, ReactivateSubscriptionRequest $postBody, array $optParams = [])

Developer Preview: Reactivates a suspended Google Workspace subscription. This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Details

Operation create(Subscription $postBody, array $optParams = [])

Developer Preview: Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription. (subscriptions.create)

Parameters

Subscription $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation delete(string $name, array $optParams = [])

Developer Preview: Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription. (subscriptions.delete)

Parameters

string $name

Required. Resource name of the subscription to delete. Format: subscriptions/{subscription}

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Subscription get(string $name, array $optParams = [])

Developer Preview: Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription. (subscriptions.get)

Parameters

string $name

Required. Resource name of the subscription. Format: subscriptions/{subscription}

array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

ListSubscriptionsResponse listSubscriptions(array $optParams = [])

Developer Preview: Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions. (subscriptions.listSubscriptions)

Parameters

array $optParams

Optional parameters.

Return Value

ListSubscriptionsResponse

Exceptions

Exception

Operation patch(string $name, Subscription $postBody, array $optParams = [])

Developer Preview: Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription. (subscriptions.patch)

Parameters

string $name

Optional. Immutable. Identifier. Resource name of the subscription. Format: subscriptions/{subscription}

Subscription $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation reactivate(string $name, ReactivateSubscriptionRequest $postBody, array $optParams = [])

Developer Preview: Reactivates a suspended Google Workspace subscription. This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

(subscriptions.reactivate)

Parameters

string $name

Required. Resource name of the subscription. Format: subscriptions/{subscription}

ReactivateSubscriptionRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception