<?php
/*
 * Copyright 2024 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/cloud/commerce/consumer/procurement/v1/procurement_service.proto
 * Updates to the above are reflected here through a refresh process.
 */

namespace Google\Cloud\Commerce\Consumer\Procurement\V1\Client;

use Google\ApiCore\ApiException;
use Google\ApiCore\CredentialsWrapper;
use Google\ApiCore\GapicClientTrait;
use Google\ApiCore\OperationResponse;
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\Auth\FetchAuthTokenInterface;
use Google\Cloud\Commerce\Consumer\Procurement\V1\CancelOrderRequest;
use Google\Cloud\Commerce\Consumer\Procurement\V1\GetOrderRequest;
use Google\Cloud\Commerce\Consumer\Procurement\V1\ListOrdersRequest;
use Google\Cloud\Commerce\Consumer\Procurement\V1\ModifyOrderRequest;
use Google\Cloud\Commerce\Consumer\Procurement\V1\Order;
use Google\Cloud\Commerce\Consumer\Procurement\V1\PlaceOrderRequest;
use Google\LongRunning\Client\OperationsClient;
use Google\LongRunning\Operation;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Log\LoggerInterface;

/**
 * Service Description: ConsumerProcurementService allows customers to make purchases of products
 * served by the Cloud Commerce platform.
 *
 *
 * When purchases are made, the
 * [ConsumerProcurementService][google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService]
 * programs the appropriate backends, including both Google's own
 * infrastructure, as well as third-party systems, and to enable billing setup
 * for charging for the procured item.
 *
 *
 * 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.
 *
 * @method PromiseInterface<OperationResponse> cancelOrderAsync(CancelOrderRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<Order> getOrderAsync(GetOrderRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<PagedListResponse> listOrdersAsync(ListOrdersRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<OperationResponse> modifyOrderAsync(ModifyOrderRequest $request, array $optionalArgs = [])
 * @method PromiseInterface<OperationResponse> placeOrderAsync(PlaceOrderRequest $request, array $optionalArgs = [])
 */
final class ConsumerProcurementServiceClient
{
    use GapicClientTrait;
    use ResourceHelperTrait;

    /** The name of the service. */
    private const SERVICE_NAME = 'google.cloud.commerce.consumer.procurement.v1.ConsumerProcurementService';

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

    /** The address template of the service. */
    private const SERVICE_ADDRESS_TEMPLATE = 'cloudcommerceconsumerprocurement.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/cloud-platform'];

    private $operationsClient;

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

    /**
     * Return an OperationsClient object with the same endpoint as $this.
     *
     * @return OperationsClient
     */
    public function getOperationsClient()
    {
        return $this->operationsClient;
    }

    /**
     * Resume an existing long running operation that was previously started by a long
     * running API method. If $methodName is not provided, or does not match a long
     * running API method, then the operation can still be resumed, but the
     * OperationResponse object will not deserialize the final response.
     *
     * @param string $operationName The name of the long running operation
     * @param string $methodName    The name of the method used to start the operation
     *
     * @return OperationResponse
     */
    public function resumeOperation($operationName, $methodName = null)
    {
        $options = $this->descriptors[$methodName]['longRunning'] ?? [];
        $operation = new OperationResponse($operationName, $this->getOperationsClient(), $options);
        $operation->reload();
        return $operation;
    }

    /**
     * Create the default operation client for the service.
     *
     * @param array $options ClientOptions for the client.
     *
     * @return OperationsClient
     */
    private function createOperationsClient(array $options)
    {
        // Unset client-specific configuration options
        unset($options['serviceName'], $options['clientConfig'], $options['descriptorsConfigPath']);

        if (isset($options['operationsClient'])) {
            return $options['operationsClient'];
        }

        return new OperationsClient($options);
    }

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

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

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

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

    /**
     * Parses a formatted name string and returns an associative array of the components in the name.
     * The following name formats are supported:
     * Template: Pattern
     * - billingAccount: billingAccounts/{billing_account}
     * - consumerBillingAccountOffer: billingAccounts/{consumer_billing_account}/offers/{offer}
     * - offer: services/{service}/standardOffers/{offer}
     * - serviceOffer: services/{service}/standardOffers/{offer}
     *
     * 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.
     */
    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
     *           'cloudcommerceconsumerprocurement.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\Cloud\Commerce\Consumer\Procurement\V1\ConsumerProcurementServiceClient;
     *           $creds = new ServiceAccountCredentials($scopes, $json);
     *           $options = new ConsumerProcurementServiceClient(['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
     */
    public function __construct(array|ClientOptions $options = [])
    {
        $clientOptions = $this->buildClientOptions($options);
        $this->setClientOptions($clientOptions);
        $this->operationsClient = $this->createOperationsClient($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);
    }

    /**
     * Cancels an existing
     * [Order][google.cloud.commerce.consumer.procurement.v1.Order]. Every product
     * procured in the Order will be cancelled.
     *
     * The async variant is {@see ConsumerProcurementServiceClient::cancelOrderAsync()}
     * .
     *
     * @example samples/V1/ConsumerProcurementServiceClient/cancel_order.php
     *
     * @param CancelOrderRequest $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 OperationResponse<Order>
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function cancelOrder(CancelOrderRequest $request, array $callOptions = []): OperationResponse
    {
        return $this->startApiCall('CancelOrder', $request, $callOptions)->wait();
    }

    /**
     * Returns the requested
     * [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
     *
     * The async variant is {@see ConsumerProcurementServiceClient::getOrderAsync()} .
     *
     * @example samples/V1/ConsumerProcurementServiceClient/get_order.php
     *
     * @param GetOrderRequest $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 Order
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function getOrder(GetOrderRequest $request, array $callOptions = []): Order
    {
        return $this->startApiCall('GetOrder', $request, $callOptions)->wait();
    }

    /**
     * Lists [Order][google.cloud.commerce.consumer.procurement.v1.Order]
     * resources that the user has access to, within the scope of the parent
     * resource.
     *
     * The async variant is {@see ConsumerProcurementServiceClient::listOrdersAsync()}
     * .
     *
     * @example samples/V1/ConsumerProcurementServiceClient/list_orders.php
     *
     * @param ListOrdersRequest $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.
     */
    public function listOrders(ListOrdersRequest $request, array $callOptions = []): PagedListResponse
    {
        return $this->startApiCall('ListOrders', $request, $callOptions);
    }

    /**
     * Modifies an existing
     * [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.
     *
     * The async variant is {@see ConsumerProcurementServiceClient::modifyOrderAsync()}
     * .
     *
     * @example samples/V1/ConsumerProcurementServiceClient/modify_order.php
     *
     * @param ModifyOrderRequest $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 OperationResponse<Order>
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function modifyOrder(ModifyOrderRequest $request, array $callOptions = []): OperationResponse
    {
        return $this->startApiCall('ModifyOrder', $request, $callOptions)->wait();
    }

    /**
     * Creates a new [Order][google.cloud.commerce.consumer.procurement.v1.Order].
     *
     * This API only supports GCP spend-based committed use
     * discounts specified by GCP documentation.
     *
     * The returned long-running operation is in-progress until the backend
     * completes the creation of the resource. Once completed, the order is
     * in
     * [OrderState.ORDER_STATE_ACTIVE][google.cloud.commerce.consumer.procurement.v1.OrderState.ORDER_STATE_ACTIVE].
     * In case of failure, the order resource will be removed.
     *
     * The async variant is {@see ConsumerProcurementServiceClient::placeOrderAsync()}
     * .
     *
     * @example samples/V1/ConsumerProcurementServiceClient/place_order.php
     *
     * @param PlaceOrderRequest $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 OperationResponse<Order>
     *
     * @throws ApiException Thrown if the API call fails.
     */
    public function placeOrder(PlaceOrderRequest $request, array $callOptions = []): OperationResponse
    {
        return $this->startApiCall('PlaceOrder', $request, $callOptions)->wait();
    }
}
