<?php
/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * GENERATED CODE WARNING
 * Generated by gapic-generator-php from the file
 * https://github.com/googleapis/googleapis/blob/master/google/apps/meet/v2beta/service.proto
 * Updates to the above are reflected here through a refresh process.
 *
 * @experimental
 */

namespace Google\Apps\Meet\V2beta\Client;

use Google\ApiCore\ApiException;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\Options\ClientOptions;
use Google\ApiCore\PagedListResponse;
use Google\ApiCore\ResourceHelperTrait;
use Google\ApiCore\RetrySettings;
use Google\ApiCore\Transport\TransportInterface;
use Google\ApiCore\ValidationException;
use Google\Apps\Meet\V2beta\ConnectActiveConferenceRequest;
use Google\Apps\Meet\V2beta\ConnectActiveConferenceResponse;
use Google\Apps\Meet\V2beta\CreateMemberRequest;
use Google\Apps\Meet\V2beta\CreateSpaceRequest;
use Google\Apps\Meet\V2beta\DeleteMemberRequest;
use Google\Apps\Meet\V2beta\EndActiveConferenceRequest;
use Google\Apps\Meet\V2beta\GetMemberRequest;
use Google\Apps\Meet\V2beta\GetSpaceRequest;
use Google\Apps\Meet\V2beta\ListMembersRequest;
use Google\Apps\Meet\V2beta\Member;
use Google\Apps\Meet\V2beta\Space;
use Google\Apps\Meet\V2beta\UpdateSpaceRequest;
use Google\Auth\FetchAuthTokenInterface;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Log\LoggerInterface;

/**
 * Service Description: REST API for services dealing with spaces.
 *
 * This class provides the ability to make remote calls to the backing service through method
 * calls that map to API methods.
 *
 * Many parameters require resource names to be formatted in a particular way. To
 * assist with these names, this class includes a format method for each type of
 * name, and additionally a parseName method to extract the individual identifiers
 * contained within formatted names that are returned by the API.
 *
 * @experimental
 *
 * @method PromiseInterface<ConnectActiveConferenceResponse> connectActiveConferenceAsync(ConnectActiveConferenceRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Member> createMemberAsync(CreateMemberRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Space> createSpaceAsync(CreateSpaceRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<void> deleteMemberAsync(DeleteMemberRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<void> endActiveConferenceAsync(EndActiveConferenceRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Member> getMemberAsync(GetMemberRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Space> getSpaceAsync(GetSpaceRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<PagedListResponse> listMembersAsync(ListMembersRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Space> updateSpaceAsync(UpdateSpaceRequest $request, array $optionalArgs = [])
 */
final class SpacesServiceClient
{
    use GapicClientTrait;
    use ResourceHelperTrait;

    /** The name of the service. */
    private const SERVICE_NAME = 'google.apps.meet.v2beta.SpacesService';

    /**
     * The default address of the service.
     *
     * @deprecated SERVICE_ADDRESS_TEMPLATE should be used instead.
     */
    private const SERVICE_ADDRESS = 'meet.googleapis.com';

    /** The address template of the service. */
    private const SERVICE_ADDRESS_TEMPLATE = 'meet.UNIVERSE_DOMAIN';

    /** The default port of the service. */
    private const DEFAULT_SERVICE_PORT = 443;

    /** The name of the code generator, to be included in the agent header. */
    private const CODEGEN_NAME = 'gapic';

    /** The default scopes required by the service. */
    public static $serviceScopes = [
        'https://www.googleapis.com/auth/meetings.conference.media.audio.readonly',
        'https://www.googleapis.com/auth/meetings.conference.media.readonly',
        'https://www.googleapis.com/auth/meetings.conference.media.video.readonly',
        'https://www.googleapis.com/auth/meetings.space.created',
        'https://www.googleapis.com/auth/meetings.space.readonly',
        'https://www.googleapis.com/auth/meetings.space.settings',
    ];

    private static function getClientDefaults()
    {
        return [
            'serviceName' => self::SERVICE_NAME,
            'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT,
            'clientConfig' => __DIR__ . '/../resources/spaces_service_client_config.json',
            'descriptorsConfigPath' => __DIR__ . '/../resources/spaces_service_descriptor_config.php',
            'gcpApiConfigPath' => __DIR__ . '/../resources/spaces_service_grpc_config.json',
            'credentialsConfig' => [
                'defaultScopes' => self::$serviceScopes,
            ],
            'transportConfig' => [
                'rest' => [
                    'restClientConfigPath' => __DIR__ . '/../resources/spaces_service_rest_client_config.php',
                ],
            ],
        ];
    }

    /**
     * Formats a string containing the fully-qualified path to represent a
     * conference_record resource.
     *
     * @param string $conferenceRecord
     *
     * @return string The formatted conference_record resource.
     *
     * @experimental
     */
    public static function conferenceRecordName(string $conferenceRecord): string
    {
        return self::getPathTemplate('conferenceRecord')->render([
            'conference_record' => $conferenceRecord,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a member
     * resource.
     *
     * @param string $space
     * @param string $member
     *
     * @return string The formatted member resource.
     *
     * @experimental
     */
    public static function memberName(string $space, string $member): string
    {
        return self::getPathTemplate('member')->render([
            'space' => $space,
            'member' => $member,
        ]);
    }

    /**
     * Formats a string containing the fully-qualified path to represent a space
     * resource.
     *
     * @param string $space
     *
     * @return string The formatted space resource.
     *
     * @experimental
     */
    public static function spaceName(string $space): string
    {
        return self::getPathTemplate('space')->render([
            'space' => $space,
        ]);
    }

    /**
     * Parses a formatted name string and returns an associative array of the components in the name.
     * The following name formats are supported:
     * Template: Pattern
     * - conferenceRecord: conferenceRecords/{conference_record}
     * - member: spaces/{space}/members/{member}
     * - space: spaces/{space}
     *
     * The optional $template argument can be supplied to specify a particular pattern,
     * and must match one of the templates listed above. If no $template argument is
     * provided, or if the $template argument does not match one of the templates
     * listed, then parseName will check each of the supported templates, and return
     * the first match.
     *
     * @param string  $formattedName The formatted name string
     * @param ?string $template      Optional name of template to match
     *
     * @return array An associative array from name component IDs to component values.
     *
     * @throws ValidationException If $formattedName could not be matched.
     *
     * @experimental
     */
    public static function parseName(string $formattedName, ?string $template = null): array
    {
        return self::parseFormattedName($formattedName, $template);
    }

    /**
     * Constructor.
     *
     * @param array|ClientOptions $options {
     *     Optional. Options for configuring the service API wrapper.
     *
     *     @type string $apiEndpoint
     *           The address of the API remote host. May optionally include the port, formatted
     *           as "<uri>:<port>". Default 'meet.googleapis.com:443'.
     *     @type FetchAuthTokenInterface|CredentialsWrapper $credentials
     *           This option should only be used with a pre-constructed
     *           {@see FetchAuthTokenInterface} or {@see CredentialsWrapper} object. Note that
     *           when one of these objects are provided, any settings in $credentialsConfig will
     *           be ignored.
     *           **Important**: If you are providing a path to a credentials file, or a decoded
     *           credentials file as a PHP array, this usage is now DEPRECATED. Providing an
     *           unvalidated credential configuration to Google APIs can compromise the security
     *           of your systems and data. It is recommended to create the credentials explicitly
     *           ```
     *           use Google\Auth\Credentials\ServiceAccountCredentials;
     *           use Google\Apps\Meet\V2beta\SpacesServiceClient;
     *           $creds = new ServiceAccountCredentials($scopes, $json);
     *           $options = new SpacesServiceClient(['credentials' => $creds]);
     *           ```
     *           {@see
     *           https://cloud.google.com/docs/authentication/external/externally-sourced-credentials}
     *     @type array $credentialsConfig
     *           Options used to configure credentials, including auth token caching, for the
     *           client. For a full list of supporting configuration options, see
     *           {@see \Google\ApiCore\CredentialsWrapper::build()} .
     *     @type bool $disableRetries
     *           Determines whether or not retries defined by the client configuration should be
     *           disabled. Defaults to `false`.
     *     @type string|array $clientConfig
     *           Client method configuration, including retry settings. This option can be either
     *           a path to a JSON file, or a PHP array containing the decoded JSON data. By
     *           default this settings points to the default client config file, which is
     *           provided in the resources folder.
     *     @type string|TransportInterface $transport
     *           The transport used for executing network requests. May be either the string
     *           `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system.
     *           *Advanced usage*: Additionally, it is possible to pass in an already
     *           instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note
     *           that when this object is provided, any settings in $transportConfig, and any
     *           $apiEndpoint setting, will be ignored.
     *     @type array $transportConfig
     *           Configuration options that will be used to construct the transport. Options for
     *           each supported transport type should be passed in a key for that transport. For
     *           example:
     *           $transportConfig = [
     *               'grpc' => [...],
     *               'rest' => [...],
     *           ];
     *           See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and
     *           {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the
     *           supported options.
     *     @type callable $clientCertSource
     *           A callable which returns the client cert as a string. This can be used to
     *           provide a certificate and private key to the transport layer for mTLS.
     *     @type false|LoggerInterface $logger
     *           A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the
     *           'GOOGLE_SDK_PHP_LOGGING' environment flag
     *     @type string $universeDomain
     *           The service domain for the client. Defaults to 'googleapis.com'.
     * }
     *
     * @throws ValidationException
     *
     * @experimental
     */
    public function __construct(array|ClientOptions $options = [])
    {
        $clientOptions = $this->buildClientOptions($options);
        $this->setClientOptions($clientOptions);
    }

    /** Handles execution of the async variants for each documented method. */
    public function __call($method, $args)
    {
        if (substr($method, -5) !== 'Async') {
            trigger_error('Call to undefined method ' . __CLASS__ . "::$method()", E_USER_ERROR);
        }

        array_unshift($args, substr($method, 0, -5));
        return call_user_func_array([$this, 'startAsyncCall'], $args);
    }

    /**
     * [Developer Preview](https://developers.google.com/workspace/preview):
     * Broker a WebRTC connection to the active conference of a space.
     *
     * On success, clients must use the resulting SDP (Session Description
     * Protocol) answer to establish a WebRTC connection. Once connected,
     * additional functionality is available across WebRTC data channels.
     *
     * See [Meet Media API
     * overview](https://developers.google.com/meet/media-api/guides/overview) for
     * more details about this connection.
     *
     * The async variant is {@see SpacesServiceClient::connectActiveConferenceAsync()}
     * .
     *
     * @example samples/V2beta/SpacesServiceClient/connect_active_conference.php
     *
     * @param ConnectActiveConferenceRequest $request     A request to house fields associated with the call.
     * @param array                          $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return ConnectActiveConferenceResponse
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function connectActiveConference(
        ConnectActiveConferenceRequest $request,
        array $callOptions = []
    ): ConnectActiveConferenceResponse {
        return $this->startApiCall('ConnectActiveConference', $request, $callOptions)->wait();
    }

    /**
     * [Developer Preview](https://developers.google.com/workspace/preview):
     * Create a member.
     *
     * This API supports the `fields` parameter in
     * [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters).
     * When the `fields` parameter is omitted, this API response will default to
     * "name,email,role,user".
     *
     * The async variant is {@see SpacesServiceClient::createMemberAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/create_member.php
     *
     * @param CreateMemberRequest $request     A request to house fields associated with the call.
     * @param array               $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Member
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function createMember(CreateMemberRequest $request, array $callOptions = []): Member
    {
        return $this->startApiCall('CreateMember', $request, $callOptions)->wait();
    }

    /**
     * Creates a space.
     *
     * The async variant is {@see SpacesServiceClient::createSpaceAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/create_space.php
     *
     * @param CreateSpaceRequest $request     A request to house fields associated with the call.
     * @param array              $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Space
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function createSpace(CreateSpaceRequest $request, array $callOptions = []): Space
    {
        return $this->startApiCall('CreateSpace', $request, $callOptions)->wait();
    }

    /**
     * [Developer Preview](https://developers.google.com/workspace/preview):
     * Delete the member who was previously assigned roles in the space.
     *
     * The async variant is {@see SpacesServiceClient::deleteMemberAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/delete_member.php
     *
     * @param DeleteMemberRequest $request     A request to house fields associated with the call.
     * @param array               $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function deleteMember(DeleteMemberRequest $request, array $callOptions = []): void
    {
        $this->startApiCall('DeleteMember', $request, $callOptions)->wait();
    }

    /**
     * Ends an active conference (if there's one).
     *
     * For an example, see [End active
     * conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
     *
     * The async variant is {@see SpacesServiceClient::endActiveConferenceAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/end_active_conference.php
     *
     * @param EndActiveConferenceRequest $request     A request to house fields associated with the call.
     * @param array                      $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function endActiveConference(EndActiveConferenceRequest $request, array $callOptions = []): void
    {
        $this->startApiCall('EndActiveConference', $request, $callOptions)->wait();
    }

    /**
     * [Developer Preview](https://developers.google.com/workspace/preview):
     * Get a member.
     *
     * This API supports the `fields` parameter in
     * [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters).
     * When the `fields` parameter is omitted, this API response will default to
     * "name,email,role,user".
     *
     * The async variant is {@see SpacesServiceClient::getMemberAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/get_member.php
     *
     * @param GetMemberRequest $request     A request to house fields associated with the call.
     * @param array            $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Member
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function getMember(GetMemberRequest $request, array $callOptions = []): Member
    {
        return $this->startApiCall('GetMember', $request, $callOptions)->wait();
    }

    /**
     * Gets details about a meeting space.
     *
     * For an example, see [Get a meeting
     * space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
     *
     * The async variant is {@see SpacesServiceClient::getSpaceAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/get_space.php
     *
     * @param GetSpaceRequest $request     A request to house fields associated with the call.
     * @param array           $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Space
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function getSpace(GetSpaceRequest $request, array $callOptions = []): Space
    {
        return $this->startApiCall('GetSpace', $request, $callOptions)->wait();
    }

    /**
     * [Developer Preview](https://developers.google.com/workspace/preview):
     * List members.
     *
     * This API supports the `fields` parameter in
     * [SystemParameterContext](https://cloud.google.com/apis/docs/system-parameters).
     * When the `fields` parameter is omitted this API response will default to
     * "name,email,role,user".
     *
     * The async variant is {@see SpacesServiceClient::listMembersAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/list_members.php
     *
     * @param ListMembersRequest $request     A request to house fields associated with the call.
     * @param array              $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return PagedListResponse
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function listMembers(ListMembersRequest $request, array $callOptions = []): PagedListResponse
    {
        return $this->startApiCall('ListMembers', $request, $callOptions);
    }

    /**
     * Updates details about a meeting space.
     *
     * For an example, see [Update a meeting
     * space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
     *
     * The async variant is {@see SpacesServiceClient::updateSpaceAsync()} .
     *
     * @example samples/V2beta/SpacesServiceClient/update_space.php
     *
     * @param UpdateSpaceRequest $request     A request to house fields associated with the call.
     * @param array              $callOptions {
     *     Optional.
     *
     *     @type RetrySettings|array $retrySettings
     *           Retry settings to use for this call. Can be a {@see RetrySettings} object, or an
     *           associative array of retry settings parameters. See the documentation on
     *           {@see RetrySettings} for example usage.
     * }
     *
     * @return Space
     *
     * @throws ApiException Thrown if the API call fails.
     *
     * @experimental
     */
    public function updateSpace(UpdateSpaceRequest $request, array $callOptions = []): Space
    {
        return $this->startApiCall('UpdateSpace', $request, $callOptions)->wait();
    }
}
