google-cloud-channel-v1 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1920f9872e068419e07b8e12f7e89da67827e4fd599c6d9b3f61488b8e98f374
-  data.tar.gz: e0606dd541251e3ef1eeb4241eff2a2f87dd8b9235e2e87625d27f97dfed065e
+  metadata.gz: b2b4f1afca124a5f74ca7bd6ec081394018ba54f33b21a6fcbff3a0dd33a3549
+  data.tar.gz: c0c7cd5596c378c0384085cb9a4d2a331c8c87ee010c3811324d61eb3d8b76ca
 SHA512:
-  metadata.gz: a30e188b05f7a61707306df4c53a79bfea5d815cadb71778f0d10104fba2a3e80b0bd447fe40b2e6af2999da505800ce0a4a617f0e38362eadfe5f5258e73416
-  data.tar.gz: b82010ddebc0d89beef5b81fa60c25ff5202867833a1caaa13c5566aed7dd3258fa7f42ee5cb6ae5571f1f201ad3dcc82e015d974e83bafada48f4c27c16728f
+  metadata.gz: a8dec77b18187153a47bff5054b86f0e9844a703d24d3ac294076d14dfef26a48ba60dfcca29b0174d7d18ddfc18377700d24a994be8ff1b1e6f216e3f4c0305
+  data.tar.gz: f5f564fecb6a420e8f02800ab9598ee354a074e58ed13996053d7532fc3eb66f45793deb20ff6f0ed0e0aa06b55c85ac9bbdc8c0518e79229cc4b74e18589499

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

@@ -297,7 +297,7 @@ module Google
             end
 
             ##
-            # Returns a requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
+            # Returns the requested {::Google::Cloud::Channel::V1::Customer Customer} resource.
             #
             # Possible error codes:
             #
@@ -620,7 +620,7 @@ module Google
             end
 
             ##
-            # Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently and irreversibly.
+            # Deletes the given {::Google::Cloud::Channel::V1::Customer Customer} permanently.
             #
             # Possible error codes:
             #
@@ -1091,7 +1091,7 @@ module Google
             end
 
             ##
-            # Returns a requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
+            # Returns the requested {::Google::Cloud::Channel::V1::Entitlement Entitlement} resource.
             #
             # Possible error codes:
             #
@@ -2341,7 +2341,7 @@ module Google
             end
 
             ##
-            # Returns a requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
+            # Returns the requested {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink} resource.
             # You must be a distributor to call this method.
             #
             # Possible error codes:
@@ -2610,6 +2610,83 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Returns the requested {::Google::Cloud::Channel::V1::Offer Offer} resource.
+            #
+            # Possible error codes:
+            #
+            # * PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
+            # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
+            # * NOT_FOUND: Entitlement or offer was not found.
+            #
+            # Return value:
+            # The {::Google::Cloud::Channel::V1::Offer Offer} resource.
+            #
+            # @overload lookup_offer(request, options = nil)
+            #   Pass arguments to `lookup_offer` via a request object, either of type
+            #   {::Google::Cloud::Channel::V1::LookupOfferRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Channel::V1::LookupOfferRequest, ::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 lookup_offer(entitlement: nil)
+            #   Pass arguments to `lookup_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).
+            #
+            #   @param entitlement [::String]
+            #     Required. The resource name of the entitlement to retrieve the Offer.
+            #     Entitlement uses the format:
+            #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Channel::V1::Offer]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Channel::V1::Offer]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def lookup_offer request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::LookupOfferRequest
+
+              # 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.lookup_offer.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 = {
+                "entitlement" => request.entitlement
+              }
+              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.lookup_offer.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.lookup_offer.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_channel_service_stub.call_rpc :lookup_offer, 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
+
             ##
             # Lists the Products the reseller is authorized to sell.
             #
@@ -3568,6 +3645,11 @@ module Google
                 #
                 attr_reader :update_channel_partner_link
                 ##
+                # RPC-specific configuration for `lookup_offer`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :lookup_offer
+                ##
                 # RPC-specific configuration for `list_products`
                 # @return [::Gapic::Config::Method]
                 #
@@ -3660,6 +3742,8 @@ module Google
                   @create_channel_partner_link = ::Gapic::Config::Method.new create_channel_partner_link_config
                   update_channel_partner_link_config = parent_rpcs.update_channel_partner_link if parent_rpcs.respond_to? :update_channel_partner_link
                   @update_channel_partner_link = ::Gapic::Config::Method.new update_channel_partner_link_config
+                  lookup_offer_config = parent_rpcs.lookup_offer if parent_rpcs.respond_to? :lookup_offer
+                  @lookup_offer = ::Gapic::Config::Method.new lookup_offer_config
                   list_products_config = parent_rpcs.list_products if parent_rpcs.respond_to? :list_products
                   @list_products = ::Gapic::Config::Method.new list_products_config
                   list_skus_config = parent_rpcs.list_skus if parent_rpcs.respond_to? :list_skus

data/lib/google/cloud/channel/v1/service_pb.rb

@@ -181,6 +181,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 1
       optional :request_id, :string, 3
     end
+    add_message "google.cloud.channel.v1.LookupOfferRequest" do
+      optional :entitlement, :string, 1
+    end
     add_message "google.cloud.channel.v1.ListProductsRequest" do
       optional :account, :string, 1
       optional :page_size, :int32, 2
@@ -331,6 +334,7 @@ module Google
         CancelEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CancelEntitlementRequest").msgclass
         SuspendEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.SuspendEntitlementRequest").msgclass
         ActivateEntitlementRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ActivateEntitlementRequest").msgclass
+        LookupOfferRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.LookupOfferRequest").msgclass
         ListProductsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListProductsRequest").msgclass
         ListProductsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListProductsResponse").msgclass
         ListSkusRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSkusRequest").msgclass

data/lib/google/cloud/channel/v1/service_services_pb.rb

@@ -45,7 +45,7 @@ module Google
           # distributors and their indirect resellers in a channel.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode
@@ -62,7 +62,7 @@ module Google
             # Return value:
             # List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
             rpc :ListCustomers, ::Google::Cloud::Channel::V1::ListCustomersRequest, ::Google::Cloud::Channel::V1::ListCustomersResponse
-            # Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.
+            # Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.
             #
             # Possible error codes:
             #
@@ -119,7 +119,7 @@ module Google
             # Return value:
             # The updated [Customer][google.cloud.channel.v1.Customer] resource.
             rpc :UpdateCustomer, ::Google::Cloud::Channel::V1::UpdateCustomerRequest, ::Google::Cloud::Channel::V1::Customer
-            # Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.
+            # Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.
             #
             # Possible error codes:
             #
@@ -199,7 +199,7 @@ module Google
             # Return value:
             # List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
             rpc :ListTransferableOffers, ::Google::Cloud::Channel::V1::ListTransferableOffersRequest, ::Google::Cloud::Channel::V1::ListTransferableOffersResponse
-            # Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
+            # Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
             #
             # Possible error codes:
             #
@@ -491,7 +491,7 @@ module Google
             # Return value:
             # The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.
             rpc :ListChannelPartnerLinks, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksRequest, ::Google::Cloud::Channel::V1::ListChannelPartnerLinksResponse
-            # Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
+            # Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
             # You must be a distributor to call this method.
             #
             # Possible error codes:
@@ -550,6 +550,17 @@ module Google
             # Return value:
             # The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
             rpc :UpdateChannelPartnerLink, ::Google::Cloud::Channel::V1::UpdateChannelPartnerLinkRequest, ::Google::Cloud::Channel::V1::ChannelPartnerLink
+            # Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.
+            #
+            # Possible error codes:
+            #
+            # * PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
+            # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
+            # * NOT_FOUND: Entitlement or offer was not found.
+            #
+            # Return value:
+            # The [Offer][google.cloud.channel.v1.Offer] resource.
+            rpc :LookupOffer, ::Google::Cloud::Channel::V1::LookupOfferRequest, ::Google::Cloud::Channel::V1::Offer
             # Lists the Products the reseller is authorized to sell.
             #
             # Possible error codes:

data/lib/google/cloud/channel/v1/subscriber_event_pb.rb

@@ -33,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :RENEWAL_SETTING_CHANGED, 10
       value :PAID_SERVICE_STARTED, 11
       value :LICENSE_ASSIGNMENT_CHANGED, 12
+      value :LICENSE_CAP_CHANGED, 13
     end
     add_message "google.cloud.channel.v1.SubscriberEvent" do
       oneof :event do

data/lib/google/cloud/channel/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Channel
       module V1
-        VERSION = "0.6.0"
+        VERSION = "0.7.0"
       end
     end
   end

data/proto_docs/google/cloud/channel/v1/customers.rb

@@ -31,36 +31,33 @@ module Google
         #     Required. Name of the organization that the customer entity represents.
         # @!attribute [rw] org_postal_address
         #   @return [::Google::Type::PostalAddress]
-        #     Required. Address of the organization of the customer entity.
-        #     Region and zip codes are required to enforce US laws and embargoes.
-        #     Valid address lines are required for all customers.
-        #     Language code is discarded. Use the Customer-level language code to set the
-        #     customer's language.
+        #     Required. The organization address for the customer. To enforce US laws and
+        #     embargoes, we require a region and zip code. You must provide valid
+        #     addresses for every customer. To set the customer's language, use the
+        #     Customer-level language code.
         # @!attribute [rw] primary_contact_info
         #   @return [::Google::Cloud::Channel::V1::ContactInfo]
         #     Primary contact info.
         # @!attribute [rw] alternate_email
         #   @return [::String]
-        #     Secondary contact email.
-        #     Alternate email and primary contact email are required to have different
-        #     domains if primary contact email is present.
-        #     When creating admin.google.com accounts, users get notified credentials at
-        #     this email. This email address is also used as a recovery email.
+        #     Secondary contact email. You need to provide an alternate email to create
+        #     different domains if a primary contact email already exists. Users will
+        #     receive a notification with credentials when you create an admin.google.com
+        #     account. Secondary emails are also recovery email addresses.
         # @!attribute [rw] domain
         #   @return [::String]
-        #     Required. Primary domain used by the customer.
-        #     Domain of primary contact email is required to be same as the provided
-        #     domain.
+        #     Required. The customer's primary domain. Must match the primary contact
+        #     email's domain.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time at which the customer is created.
+        #     Output only. Time when the customer was created.
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time at which the customer is updated.
+        #     Output only. Time when the customer was updated.
         # @!attribute [r] cloud_identity_id
         #   @return [::String]
-        #     Output only. Customer's cloud_identity_id.
-        #     Populated only if a Cloud Identity resource exists for this customer.
+        #     Output only. The customer's Cloud Identity ID if the customer has a Cloud
+        #     Identity resource.
         # @!attribute [rw] language_code
         #   @return [::String]
         #     Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
@@ -82,26 +79,25 @@ module Google
         # Contact information for a customer account.
         # @!attribute [rw] first_name
         #   @return [::String]
-        #     First name of the contact in the customer account.
+        #     The customer account contact's first name.
         # @!attribute [rw] last_name
         #   @return [::String]
-        #     Last name of the contact in the customer account.
+        #     The customer account contact's last name.
         # @!attribute [r] display_name
         #   @return [::String]
-        #     Output only. Display name of the contact in the customer account.
-        #     Populated by combining customer first name and last name.
+        #     Output only. The customer account contact's display name, formatted as a
+        #     combination of the customer's first and last name.
         # @!attribute [rw] email
         #   @return [::String]
-        #     Email of the contact in the customer account.
-        #     Email is required for entitlements that need creation of admin.google.com
-        #     accounts. The email will be the username used in credentials to access the
-        #     admin.google.com account.
+        #     The customer account's contact email. Required for entitlements that create
+        #     admin.google.com accounts, and serves as the customer's username for those
+        #     accounts.
         # @!attribute [rw] title
         #   @return [::String]
-        #     Optional. Job title of the contact in the customer account.
+        #     Optional. The customer account contact's job title.
         # @!attribute [rw] phone
         #   @return [::String]
-        #     Phone number of the contact in the customer account.
+        #     The customer account's contact phone number.
         class ContactInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/channel/v1/service.rb

@@ -701,6 +701,17 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for LookupOffer.
+        # @!attribute [rw] entitlement
+        #   @return [::String]
+        #     Required. The resource name of the entitlement to retrieve the Offer.
+        #     Entitlement uses the format:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
+        class LookupOfferRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for ListProducts.
         # @!attribute [rw] account
         #   @return [::String]

data/proto_docs/google/cloud/channel/v1/subscriber_event.rb

@@ -98,6 +98,9 @@ module Google
 
             # License was assigned to or revoked from a user.
             LICENSE_ASSIGNMENT_CHANGED = 12
+
+            # License cap was changed for the entitlement.
+            LICENSE_CAP_CHANGED = 13
           end
         end
 

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-channel-v1
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Channel V1 API