google-cloud-channel-v1 0.21.0 → 0.22.1

data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb

@@ -190,7 +190,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -530,8 +531,11 @@ module Google
             #
             # Possible error codes:
             #
-            # * PERMISSION_DENIED: The reseller account making the request is different
-            # from the reseller account in the API request.
+            # * PERMISSION_DENIED:
+            #     * The reseller account making the request is different from the
+            #     reseller account in the API request.
+            #     * You are not authorized to create a customer. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * INVALID_ARGUMENT:
             #     * Required request parameters are missing or invalid.
             #     * Domain field value doesn't match the primary email domain.
@@ -826,8 +830,11 @@ module Google
             #
             # Possible error codes:
             #
-            # * PERMISSION_DENIED: The reseller account making the request is different
-            # from the reseller account in the API request.
+            # * PERMISSION_DENIED:
+            #     * The reseller account making the request is different from the
+            #     reseller account in the API request.
+            #     * You are not authorized to import the customer. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * NOT_FOUND: Cloud Identity doesn't exist or was deleted.
             # * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is
             # expired or invalid.
@@ -949,7 +956,10 @@ module Google
             #
             # Possible error codes:
             #
-            # *  PERMISSION_DENIED: The customer doesn't belong to the reseller.
+            # *  PERMISSION_DENIED:
+            #      * The customer doesn't belong to the reseller.
+            #      * You are not authorized to provision cloud identity id. See
+            #      https://support.google.com/channelservices/answer/9759265
             # *  INVALID_ARGUMENT: Required request parameters are missing or invalid.
             # *  NOT_FOUND: The customer was not found.
             # *  ALREADY_EXISTS: The customer's primary email already exists. Retry
@@ -1330,6 +1340,8 @@ module Google
             #     auth token.
             #     * The reseller account making the request is different
             #     from the reseller account in the query.
+            #     * The reseller is not authorized to transact on this Product. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
             #
             # Return value:
@@ -1346,7 +1358,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_transferable_offers(cloud_identity_id: nil, customer_name: nil, parent: nil, page_size: nil, page_token: nil, sku: nil, language_code: nil)
+            # @overload list_transferable_offers(cloud_identity_id: nil, customer_name: nil, parent: nil, page_size: nil, page_token: nil, sku: nil, language_code: nil, billing_account: nil)
             #   Pass arguments to `list_transferable_offers` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1375,6 +1387,12 @@ module Google
             #     Optional. The BCP-47 language code. For example, "en-US". The
             #     response will localize in the corresponding language code, if specified.
             #     The default value is "en-US".
+            #   @param billing_account [::String]
+            #     Optional. The Billing Account to look up Offers for. Format:
+            #     accounts/\\{account_id}/billingAccounts/\\{billing_account_id}.
+            #
+            #     This field is only relevant for multi-currency accounts. It should be left
+            #     empty for single currency accounts.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::TransferableOffer>]
@@ -1547,7 +1565,10 @@ module Google
             #
             # Possible error codes:
             #
-            # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
+            # * PERMISSION_DENIED:
+            #     * The customer doesn't belong to the reseller.
+            #     * The reseller is not authorized to transact on this Product. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * INVALID_ARGUMENT:
             #     * Required request parameters are missing or invalid.
             #     * There is already a customer entitlement for a SKU from the same
@@ -1991,7 +2012,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload change_offer(name: nil, offer: nil, parameters: nil, purchase_order_id: nil, request_id: nil)
+            # @overload change_offer(name: nil, offer: nil, parameters: nil, purchase_order_id: nil, request_id: nil, billing_account: nil)
             #   Pass arguments to `change_offer` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -2023,6 +2044,12 @@ module Google
             #     The request ID must be a valid [UUID](https://tools.ietf.org/html/rfc4122)
             #     with the exception that zero UUID is not supported
             #     (`00000000-0000-0000-0000-000000000000`).
+            #   @param billing_account [::String]
+            #     Optional. The billing account resource name that is used to pay for this
+            #     entitlement when setting up billing on a trial subscription.
+            #
+            #     This field is only relevant for multi-currency accounts. It should be
+            #     left empty for single currency accounts.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -2627,7 +2654,10 @@ module Google
             #
             # Possible error codes:
             #
-            # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
+            # * PERMISSION_DENIED:
+            #     * The customer doesn't belong to the reseller.
+            #     * The reseller is not authorized to transact on this Product. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
             # * NOT_FOUND: The customer or offer resource was not found.
             # * ALREADY_EXISTS: The SKU was already transferred for the customer.
@@ -3606,12 +3636,12 @@ module Google
             # * The new config will not modify exports used with other configs.
             # Changes to the config may be immediate, but may take up to 24 hours.
             # * There is a limit of ten configs for any
-            # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}
-            # or
+            # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement},
+            # for any
             # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
             # * The contained
             # {::Google::Cloud::Channel::V1::CustomerRepricingConfig#repricing_config CustomerRepricingConfig.repricing_config}
-            # vaule must be different from the value used in the current config for a
+            # value must be different from the value used in the current config for a
             # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}.
             #
             # Possible Error Codes:
@@ -4198,10 +4228,12 @@ module Google
             # * The new config will not modify exports used with other configs.
             # Changes to the config may be immediate, but may take up to 24 hours.
             # * There is a limit of ten configs for any ChannelPartner or
+            # {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement},
+            # for any
             # {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}.
             # * The contained
             # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#repricing_config ChannelPartnerRepricingConfig.repricing_config}
-            # vaule must be different from the value used in the current config for a
+            # value must be different from the value used in the current config for a
             # ChannelPartner.
             #
             # Possible Error Codes:
@@ -5305,7 +5337,10 @@ module Google
             #
             # Possible error codes:
             #
-            # * PERMISSION_DENIED: The customer doesn't belong to the reseller
+            # * PERMISSION_DENIED:
+            #     * The customer doesn't belong to the reseller
+            #     * The reseller is not authorized to transact on this Product. See
+            #     https://support.google.com/channelservices/answer/9759265
             # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
             #
             # @overload list_purchasable_offers(request, options = nil)
@@ -5410,6 +5445,106 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Lists the billing accounts that are eligible to purchase particular SKUs
+            # for a given customer.
+            #
+            # Possible error codes:
+            #
+            # * PERMISSION_DENIED: The customer doesn't belong to the reseller.
+            # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
+            #
+            # Return value:
+            # Based on the provided list of SKUs, returns a list of SKU groups that must
+            # be purchased using the same billing account and the billing accounts
+            # eligible to purchase each SKU group.
+            #
+            # @overload query_eligible_billing_accounts(request, options = nil)
+            #   Pass arguments to `query_eligible_billing_accounts` via a request object, either of type
+            #   {::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload query_eligible_billing_accounts(customer: nil, skus: nil)
+            #   Pass arguments to `query_eligible_billing_accounts` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param customer [::String]
+            #     Required. The resource name of the customer to list eligible billing
+            #     accounts for. Format: accounts/\\{account_id}/customers/\\{customer_id}.
+            #   @param skus [::Array<::String>]
+            #     Required. List of SKUs to list eligible billing accounts for. At least one
+            #     SKU is required. Format: products/\\{product_id}/skus/\\{sku_id}.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/channel/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Channel::V1::QueryEligibleBillingAccountsRequest.new
+            #
+            #   # Call the query_eligible_billing_accounts method.
+            #   result = client.query_eligible_billing_accounts request
+            #
+            #   # The returned object is of type Google::Cloud::Channel::V1::QueryEligibleBillingAccountsResponse.
+            #   p result
+            #
+            def query_eligible_billing_accounts request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::QueryEligibleBillingAccountsRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.query_eligible_billing_accounts.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Channel::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.customer
+                header_params["customer"] = request.customer
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.query_eligible_billing_accounts.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.query_eligible_billing_accounts.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_channel_service_stub.call_rpc :query_eligible_billing_accounts, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Registers a service account with subscriber privileges on the Cloud Pub/Sub
             # topic for this Channel Services account. After you create a
@@ -5979,6 +6114,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the CloudChannelService API.
               #
@@ -6218,6 +6361,11 @@ module Google
                 #
                 attr_reader :list_purchasable_offers
                 ##
+                # RPC-specific configuration for `query_eligible_billing_accounts`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :query_eligible_billing_accounts
+                ##
                 # RPC-specific configuration for `register_subscriber`
                 # @return [::Gapic::Config::Method]
                 #
@@ -6328,6 +6476,8 @@ module Google
                   @list_purchasable_skus = ::Gapic::Config::Method.new list_purchasable_skus_config
                   list_purchasable_offers_config = parent_rpcs.list_purchasable_offers if parent_rpcs.respond_to? :list_purchasable_offers
                   @list_purchasable_offers = ::Gapic::Config::Method.new list_purchasable_offers_config
+                  query_eligible_billing_accounts_config = parent_rpcs.query_eligible_billing_accounts if parent_rpcs.respond_to? :query_eligible_billing_accounts
+                  @query_eligible_billing_accounts = ::Gapic::Config::Method.new query_eligible_billing_accounts_config
                   register_subscriber_config = parent_rpcs.register_subscriber if parent_rpcs.respond_to? :register_subscriber
                   @register_subscriber = ::Gapic::Config::Method.new register_subscriber_config
                   unregister_subscriber_config = parent_rpcs.unregister_subscriber if parent_rpcs.respond_to? :unregister_subscriber

data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb

@@ -93,7 +93,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
 
               # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the Operations API.
               #