google-cloud-channel-v1 0.7.2 → 0.9.2

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

@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::ListOperationsRequest.new
+            #
+            #   # Call the list_operations method.
+            #   result = client.list_operations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -160,9 +181,11 @@ module Google
                 gapic_version: ::Google::Cloud::Channel::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -215,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::GetOperationRequest.new
+            #
+            #   # Call the get_operation method.
+            #   result = client.get_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -232,9 +277,11 @@ module Google
                 gapic_version: ::Google::Cloud::Channel::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -287,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::DeleteOperationRequest.new
+            #
+            #   # Call the delete_operation method.
+            #   result = client.delete_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -304,9 +366,11 @@ module Google
                 gapic_version: ::Google::Cloud::Channel::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -364,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::CancelOperationRequest.new
+            #
+            #   # Call the cancel_operation method.
+            #   result = client.cancel_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def cancel_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -381,9 +460,11 @@ module Google
                 gapic_version: ::Google::Cloud::Channel::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -444,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -24,6 +24,23 @@ module Google
         module CloudChannelService
           # Path helper methods for the CloudChannelService API.
           module Paths
+            ##
+            # Create a fully-qualified ChannelPartnerLink resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `accounts/{account}/channelPartnerLinks/{channel_partner_link}`
+            #
+            # @param account [String]
+            # @param channel_partner_link [String]
+            #
+            # @return [::String]
+            def channel_partner_link_path account:, channel_partner_link:
+              raise ::ArgumentError, "account cannot contain /" if account.to_s.include? "/"
+
+              "accounts/#{account}/channelPartnerLinks/#{channel_partner_link}"
+            end
+
             ##
             # Create a fully-qualified Customer resource string.
             #

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

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/common.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/any_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/common.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.EduData" do

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

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/customers.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/postal_address_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/customers.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.Customer" do

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/entitlements.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
@@ -11,6 +9,8 @@ require 'google/cloud/channel/v1/products_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/entitlements.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.Entitlement" do

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/offers.proto
 
-require 'google/protobuf'
-
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/channel/v1/common_pb'
@@ -10,6 +8,8 @@ require 'google/cloud/channel/v1/products_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/money_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/offers.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.Offer" do

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

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/operations.proto
 
+require 'google/api/annotations_pb'
 require 'google/protobuf'
 
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/operations.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.OperationMetadata" do

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/products.proto
 
-require 'google/protobuf'
-
 require 'google/api/resource_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/products.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.Product" do

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -16,6 +14,8 @@ require 'google/cloud/channel/v1/products_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/service.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.CheckCloudIdentityAccountsExistRequest" do
@@ -54,6 +54,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.channel.v1.DeleteCustomerRequest" do
       optional :name, :string, 1
     end
+    add_message "google.cloud.channel.v1.ImportCustomerRequest" do
+      optional :parent, :string, 1
+      optional :auth_token, :string, 4
+      optional :overwrite_if_exists, :bool, 5
+      optional :channel_partner_id, :string, 6
+      optional :customer, :string, 7
+      oneof :customer_identity do
+        optional :domain, :string, 2
+        optional :cloud_identity_id, :string, 3
+      end
+    end
     add_message "google.cloud.channel.v1.ProvisionCloudIdentityRequest" do
       optional :customer, :string, 1
       optional :cloud_identity_info, :message, 2, "google.cloud.channel.v1.CloudIdentityInfo"
@@ -309,6 +320,7 @@ module Google
         CreateCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.CreateCustomerRequest").msgclass
         UpdateCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UpdateCustomerRequest").msgclass
         DeleteCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.DeleteCustomerRequest").msgclass
+        ImportCustomerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ImportCustomerRequest").msgclass
         ProvisionCloudIdentityRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ProvisionCloudIdentityRequest").msgclass
         ListEntitlementsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementsRequest").msgclass
         ListEntitlementsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementsResponse").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
@@ -129,6 +129,24 @@ module Google
             # * FAILED_PRECONDITION: The customer has existing entitlements.
             # * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
             rpc :DeleteCustomer, ::Google::Cloud::Channel::V1::DeleteCustomerRequest, ::Google::Protobuf::Empty
+            # Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided
+            # Cloud Identity ID or domain before a TransferEntitlements call. If a
+            # linked Customer already exists and overwrite_if_exists is true, it will
+            # update that Customer's data.
+            #
+            # Possible error codes:
+            #
+            # * PERMISSION_DENIED: The reseller account making the request is different
+            # from the reseller account in the API request.
+            # * NOT_FOUND: Cloud Identity doesn't exist or was deleted.
+            # * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is
+            # expired or invalid.
+            # * ALREADY_EXISTS: A customer already exists and has conflicting critical
+            # fields. Requires an overwrite.
+            #
+            # Return value:
+            # The [Customer][google.cloud.channel.v1.Customer].
+            rpc :ImportCustomer, ::Google::Cloud::Channel::V1::ImportCustomerRequest, ::Google::Cloud::Channel::V1::Customer
             # Creates a Cloud Identity for the given customer using the customer's
             # information, or the information provided here.
             #

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/channel/v1/subscriber_event.proto
 
-require 'google/protobuf'
-
 require 'google/api/resource_pb'
 require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/channel/v1/subscriber_event.proto", :syntax => :proto3) do
     add_message "google.cloud.channel.v1.CustomerEvent" do

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Channel
       module V1
-        VERSION = "0.7.2"
+        VERSION = "0.9.2"
       end
     end
   end

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

@@ -43,7 +43,8 @@ module Google
         #     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.
+        #     account. Secondary emails are also recovery email addresses. Alternate
+        #     emails are optional when you create Team customers.
         # @!attribute [rw] domain
         #   @return [::String]
         #     Required. The customer's primary domain. Must match the primary contact
@@ -79,10 +80,10 @@ module Google
         # Contact information for a customer account.
         # @!attribute [rw] first_name
         #   @return [::String]
-        #     The customer account contact's first name.
+        #     The customer account contact's first name. Optional for Team customers.
         # @!attribute [rw] last_name
         #   @return [::String]
-        #     The customer account contact's last name.
+        #     The customer account contact's last name. Optional for Team customers.
         # @!attribute [r] display_name
         #   @return [::String]
         #     Output only. The customer account contact's display name, formatted as a
@@ -91,7 +92,7 @@ module Google
         #   @return [::String]
         #     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.
+        #     accounts. Use this email to invite Team customers.
         # @!attribute [rw] title
         #   @return [::String]
         #     Optional. The customer account contact's job title.

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

@@ -64,8 +64,16 @@ module Google
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
         #     Extended entitlement parameters. When creating an entitlement, valid
-        #     parameters' names and values are defined in the offer's parameter
-        #     definitions.
+        #     parameter names and values are defined in the
+        #     {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}.
+        #
+        #     The response may include the following output-only Parameters:
+        #
+        #     - assigned_units: The number of licenses assigned to users.
+        #
+        #     - max_units: The maximum assignable units for a flexible offer.
+        #
+        #     - num_units: The total commitment for commitment-based offers.
         class Entitlement
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -146,6 +146,44 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#import_customer CloudChannelService.ImportCustomer}
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Required. Customer domain.
+        # @!attribute [rw] cloud_identity_id
+        #   @return [::String]
+        #     Required. Customer's Cloud Identity ID
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the reseller's account.
+        #     Parent takes the format: accounts/\\{account_id} or
+        #     accounts/\\{account_id}/channelPartnerLinks/\\{channel_partner_id}
+        # @!attribute [rw] auth_token
+        #   @return [::String]
+        #     Optional. The super admin of the resold customer generates this token to
+        #     authorize a reseller to access their Cloud Identity and purchase
+        #     entitlements on their behalf. You can omit this token after authorization.
+        #     See https://support.google.com/a/answer/7643790 for more details.
+        # @!attribute [rw] overwrite_if_exists
+        #   @return [::Boolean]
+        #     Required. Choose to overwrite an existing customer if found.
+        #     This must be set to true if there is an existing customer with a
+        #     conflicting region code or domain.
+        # @!attribute [rw] channel_partner_id
+        #   @return [::String]
+        #     Optional. Cloud Identity ID of a channel partner who will be the direct reseller for
+        #     the customer's order. This field is required for 2-tier transfer scenarios
+        #     and can be provided via the request Parent binding as well.
+        # @!attribute [rw] customer
+        #   @return [::String]
+        #     Optional. Specifies the customer that will receive imported Cloud Identity
+        #     information.
+        #     Format: accounts/\\{account_id}/customers/\\{customer_id}
+        class ImportCustomerRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for {::Google::Cloud::Channel::V1::CloudChannelService::Client#provision_cloud_identity CloudChannelService.ProvisionCloudIdentity}
         # @!attribute [rw] customer
         #   @return [::String]
@@ -523,6 +561,9 @@ module Google
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
         #     Required. Entitlement parameters to update. You can only change editable parameters.
+        #
+        #     To view the available Parameters for a request, refer to the
+        #     {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
         # @!attribute [rw] request_id
         #   @return [::String]
         #     Optional. You can specify an optional unique request ID, and if you need to retry
@@ -583,7 +624,8 @@ module Google
         #     Format: accounts/\\{account_id}/offers/\\{offer_id}.
         # @!attribute [rw] parameters
         #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
-        #     Optional. Parameters needed to purchase the Offer.
+        #     Optional. Parameters needed to purchase the Offer. To view the available Parameters
+        #     refer to the {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions} from the desired offer.
         # @!attribute [rw] purchase_order_id
         #   @return [::String]
         #     Optional. Purchase order id provided by the reseller.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-channel-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common