Google Apps Events Subscriptions V1 Client - Class SubscriptionsServiceClient (0.1.4)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\CreateSubscriptionRequest;
use Google\Apps\Events\Subscriptions\V1\NotificationEndpoint;
use Google\Apps\Events\Subscriptions\V1\Subscription;
use Google\Rpc\Status;

/**
 * @param string $subscriptionTargetResource    Immutable. The Google Workspace resource that's monitored for
 *                                              events, formatted as the [full resource
 *                                              name](https://google.aip.dev/122#full-resource-names). To learn about
 *                                              target resources and the events that they support, see [Supported Google
 *                                              Workspace
 *                                              events](https://developers.google.com/workspace/events#supported-events).
 *
 *                                              A user can only authorize your app to create one subscription for a given
 *                                              target resource. If your app tries to create another subscription with the
 *                                              same user credentials, the request returns an `ALREADY_EXISTS` error.
 * @param string $subscriptionEventTypesElement Immutable. Unordered list. Input for creating a subscription.
 *                                              Otherwise, output only. One or more types of events to receive about the
 *                                              target resource. Formatted according to the CloudEvents specification.
 *
 *                                              The supported event types depend on the target resource of your
 *                                              subscription. For details, see [Supported Google Workspace
 *                                              events](https://developers.google.com/workspace/events/guides#supported-events).
 *
 *                                              By default, you also receive events about the [lifecycle of your
 *                                              subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 *                                              You don't need to specify lifecycle events for this field.
 *
 *                                              If you specify an event type that doesn't exist for the target resource,
 *                                              the request returns an HTTP `400 Bad Request` status code.
 */
function create_subscription_sample(
    string $subscriptionTargetResource,
    string $subscriptionEventTypesElement
): void {
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $subscriptionEventTypes = [$subscriptionEventTypesElement,];
    $subscriptionNotificationEndpoint = new NotificationEndpoint();
    $subscription = (new Subscription())
        ->setTargetResource($subscriptionTargetResource)
        ->setEventTypes($subscriptionEventTypes)
        ->setNotificationEndpoint($subscriptionNotificationEndpoint);
    $request = (new CreateSubscriptionRequest())
        ->setSubscription($subscription);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subscriptionsServiceClient->createSubscription($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Subscription $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $subscriptionTargetResource = '[TARGET_RESOURCE]';
    $subscriptionEventTypesElement = '[EVENT_TYPES]';

    create_subscription_sample($subscriptionTargetResource, $subscriptionEventTypesElement);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\DeleteSubscriptionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the subscription to delete.
 *
 *                              Format: `subscriptions/{subscription}`
 *                              Please see {@see SubscriptionsServiceClient::subscriptionName()} for help formatting this field.
 */
function delete_subscription_sample(string $formattedName): void
{
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $request = (new DeleteSubscriptionRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subscriptionsServiceClient->deleteSubscription($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SubscriptionsServiceClient::subscriptionName('[SUBSCRIPTION]');

    delete_subscription_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\GetSubscriptionRequest;
use Google\Apps\Events\Subscriptions\V1\Subscription;

/**
 * @param string $formattedName Resource name of the subscription.
 *
 *                              Format: `subscriptions/{subscription}`
 *                              Please see {@see SubscriptionsServiceClient::subscriptionName()} for help formatting this field.
 */
function get_subscription_sample(string $formattedName): void
{
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $request = (new GetSubscriptionRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Subscription $response */
        $response = $subscriptionsServiceClient->getSubscription($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SubscriptionsServiceClient::subscriptionName('[SUBSCRIPTION]');

    get_subscription_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\ListSubscriptionsRequest;
use Google\Apps\Events\Subscriptions\V1\Subscription;

/**
 * @param string $filter A query filter.
 *
 *                       You can filter subscriptions by event type (`event_types`)
 *                       and target resource (`target_resource`).
 *
 *                       You must specify at least one event type in your query. To filter for
 *                       multiple event types, use the `OR` operator.
 *
 *                       To filter by both event type and target resource, use the `AND` operator
 *                       and specify the full resource name, such as
 *                       `//chat.googleapis.com/spaces/{space}`.
 *
 *                       For example, the following queries are valid:
 *
 *                       ```
 *                       event_types:"google.workspace.chat.membership.v1.updated" OR
 *                       event_types:"google.workspace.chat.message.v1.created"
 *
 *                       event_types:"google.workspace.chat.message.v1.created" AND
 *                       target_resource="//chat.googleapis.com/spaces/{space}"
 *
 *                       ( event_types:"google.workspace.chat.membership.v1.updated" OR
 *                       event_types:"google.workspace.chat.message.v1.created" ) AND
 *                       target_resource="//chat.googleapis.com/spaces/{space}"
 *                       ```
 *
 *                       The server rejects invalid queries with an `INVALID_ARGUMENT`
 *                       error.
 */
function list_subscriptions_sample(string $filter): void
{
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $request = (new ListSubscriptionsRequest())
        ->setFilter($filter);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $subscriptionsServiceClient->listSubscriptions($request);

        /** @var Subscription $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $filter = '[FILTER]';

    list_subscriptions_sample($filter);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\ReactivateSubscriptionRequest;
use Google\Apps\Events\Subscriptions\V1\Subscription;
use Google\Rpc\Status;

/**
 * @param string $formattedName Resource name of the subscription.
 *
 *                              Format: `subscriptions/{subscription}`
 *                              Please see {@see SubscriptionsServiceClient::subscriptionName()} for help formatting this field.
 */
function reactivate_subscription_sample(string $formattedName): void
{
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $request = (new ReactivateSubscriptionRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subscriptionsServiceClient->reactivateSubscription($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Subscription $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SubscriptionsServiceClient::subscriptionName('[SUBSCRIPTION]');

    reactivate_subscription_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Apps\Events\Subscriptions\V1\Client\SubscriptionsServiceClient;
use Google\Apps\Events\Subscriptions\V1\NotificationEndpoint;
use Google\Apps\Events\Subscriptions\V1\Subscription;
use Google\Apps\Events\Subscriptions\V1\UpdateSubscriptionRequest;
use Google\Rpc\Status;

/**
 * @param string $subscriptionTargetResource    Immutable. The Google Workspace resource that's monitored for
 *                                              events, formatted as the [full resource
 *                                              name](https://google.aip.dev/122#full-resource-names). To learn about
 *                                              target resources and the events that they support, see [Supported Google
 *                                              Workspace
 *                                              events](https://developers.google.com/workspace/events#supported-events).
 *
 *                                              A user can only authorize your app to create one subscription for a given
 *                                              target resource. If your app tries to create another subscription with the
 *                                              same user credentials, the request returns an `ALREADY_EXISTS` error.
 * @param string $subscriptionEventTypesElement Immutable. Unordered list. Input for creating a subscription.
 *                                              Otherwise, output only. One or more types of events to receive about the
 *                                              target resource. Formatted according to the CloudEvents specification.
 *
 *                                              The supported event types depend on the target resource of your
 *                                              subscription. For details, see [Supported Google Workspace
 *                                              events](https://developers.google.com/workspace/events/guides#supported-events).
 *
 *                                              By default, you also receive events about the [lifecycle of your
 *                                              subscription](https://developers.google.com/workspace/events/guides/events-lifecycle).
 *                                              You don't need to specify lifecycle events for this field.
 *
 *                                              If you specify an event type that doesn't exist for the target resource,
 *                                              the request returns an HTTP `400 Bad Request` status code.
 */
function update_subscription_sample(
    string $subscriptionTargetResource,
    string $subscriptionEventTypesElement
): void {
    // Create a client.
    $subscriptionsServiceClient = new SubscriptionsServiceClient();

    // Prepare the request message.
    $subscriptionEventTypes = [$subscriptionEventTypesElement,];
    $subscriptionNotificationEndpoint = new NotificationEndpoint();
    $subscription = (new Subscription())
        ->setTargetResource($subscriptionTargetResource)
        ->setEventTypes($subscriptionEventTypes)
        ->setNotificationEndpoint($subscriptionNotificationEndpoint);
    $request = (new UpdateSubscriptionRequest())
        ->setSubscription($subscription);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subscriptionsServiceClient->updateSubscription($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Subscription $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $subscriptionTargetResource = '[TARGET_RESOURCE]';
    $subscriptionEventTypesElement = '[EVENT_TYPES]';

    update_subscription_sample($subscriptionTargetResource, $subscriptionEventTypesElement);
}