google-cloud-channel-v1 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ec05fd73c6128dd0af7292a7d128d045cf89082e902ca06c81ac415ec589309
-  data.tar.gz: 1aa78d199501d1876c868a26f1a7d98b303c8e4e9411a8f717114aa960290b38
+  metadata.gz: 5566da74a754c65656f754a01c8f1b0bc897b7ecb9c9391a4079111367e1fd27
+  data.tar.gz: ca025b2e1ea002ad41309bf689edef56009942842532a838a046f7922888313e
 SHA512:
-  metadata.gz: 1685d2697475114598e8396704e27edd24e16eb94d065a96deeaeaab851413e51a27dca544ad4c4798343d4e31d52356ca52cfe84cc1dc4e25c8fa0f00de6cae
-  data.tar.gz: 53395b7f4d80932af5d4a912cfb84976022e8de758fd9864a3cba0fd509f575d2a25b6b2a233cb0a522000337385a67b856662208811ed9d0776826aece998aa
+  metadata.gz: ecb279fbcec3ac0e83afe89a83a0f2dfc9af4774c99659af9597192df13fb1f3b661290c018ad8fd80a84ff6a2855ab363af2c50e4f170a354b91727187d924b
+  data.tar.gz: 463cf47b6dd9f1ee46d7f7b4c71afc14c742deb1a38fb7d983580111c13f1ab0ca5227893e051c6c936d2acbab173ff7cff3c84542ab72440bb5a08c0ebc872a

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

@@ -696,6 +696,113 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Imports a {::Google::Cloud::Channel::V1::Customer 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 {::Google::Cloud::Channel::V1::Customer Customer}.
+            #
+            # @overload import_customer(request, options = nil)
+            #   Pass arguments to `import_customer` via a request object, either of type
+            #   {::Google::Cloud::Channel::V1::ImportCustomerRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Channel::V1::ImportCustomerRequest, ::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 import_customer(domain: nil, cloud_identity_id: nil, parent: nil, auth_token: nil, overwrite_if_exists: nil, channel_partner_id: nil, customer: nil)
+            #   Pass arguments to `import_customer` 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 domain [::String]
+            #     Required. Customer domain.
+            #   @param cloud_identity_id [::String]
+            #     Required. Customer's Cloud Identity ID
+            #   @param parent [::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}
+            #   @param auth_token [::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.
+            #   @param overwrite_if_exists [::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.
+            #   @param channel_partner_id [::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.
+            #   @param customer [::String]
+            #     Optional. Specifies the customer that will receive imported Cloud Identity
+            #     information.
+            #     Format: accounts/\\{account_id}/customers/\\{customer_id}
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Channel::V1::Customer]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Channel::V1::Customer]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def import_customer request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ImportCustomerRequest
+
+              # 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.import_customer.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 = {
+                "parent" => request.parent
+              }
+              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.import_customer.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.import_customer.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_channel_service_stub.call_rpc :import_customer, 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
+
             ##
             # Creates a Cloud Identity for the given customer using the customer's
             # information, or the information provided here.
@@ -3608,6 +3715,11 @@ module Google
                 #
                 attr_reader :delete_customer
                 ##
+                # RPC-specific configuration for `import_customer`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :import_customer
+                ##
                 # RPC-specific configuration for `provision_cloud_identity`
                 # @return [::Gapic::Config::Method]
                 #
@@ -3762,6 +3874,8 @@ module Google
                   @update_customer = ::Gapic::Config::Method.new update_customer_config
                   delete_customer_config = parent_rpcs.delete_customer if parent_rpcs.respond_to? :delete_customer
                   @delete_customer = ::Gapic::Config::Method.new delete_customer_config
+                  import_customer_config = parent_rpcs.import_customer if parent_rpcs.respond_to? :import_customer
+                  @import_customer = ::Gapic::Config::Method.new import_customer_config
                   provision_cloud_identity_config = parent_rpcs.provision_cloud_identity if parent_rpcs.respond_to? :provision_cloud_identity
                   @provision_cloud_identity = ::Gapic::Config::Method.new provision_cloud_identity_config
                   list_entitlements_config = parent_rpcs.list_entitlements if parent_rpcs.respond_to? :list_entitlements

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

@@ -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

@@ -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/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Channel
       module V1
-        VERSION = "0.7.2"
+        VERSION = "0.8.0"
       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/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]

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.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common