google-cloud-recaptcha_enterprise-v1 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9ea5260c755afca31b18d99b08fabab0c114e71e18f1de5fad5871457ac29b
-  data.tar.gz: 0ffe08204473a050d0aa30c4592c83b694ac75ba054969c20ce2cd5cb20eb488
+  metadata.gz: 80ac614deb6f19fdc91502ed03f14857e6b153008254cc22a61c9105fb3f4e0f
+  data.tar.gz: c8177212bb19aba5bf7242281e60fa07abbe5c3895392be2b1d1d479bb75e9ee
 SHA512:
-  metadata.gz: 2ae6854aff84657d175233d264e98fb47514d305e4222680b037b58c80132f87628611c560c4556177a73de4799237f4203786074ca8c2c3be2a9c3c841d0476
-  data.tar.gz: b8fbb86cefebc19eee4ac16adcf0ac65e8bbf641a9608355c6cedbf123a16dd22ab3e9031bfe9e16fc8f0d9d4e68f3e2db61621c3f607a81e4a3264309e928ee
+  metadata.gz: eef410de801d8f28db19ec486243bdc9a1bef11770039e7198e1a957d3e34834f10ef067f5fc5a996e7c9bb82498d775e825325a88045f17fa6d8a84e5d5d12c
+  data.tar.gz: 6fcbd07ca6d8aaeb7f3c287353485b4da686d4c30ea91e3d82bc667457f179053b7fc4c3410b617495199ed1fb1a2ff1772c26bbe6b630fca8c7fa98a98ad96f

data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/client.rb

@@ -231,7 +231,7 @@ module Google
 
             ##
             # Annotates a previously created Assessment to provide additional information
-            # on whether the event turned out to be authentic or fradulent.
+            # on whether the event turned out to be authentic or fraudulent.
             #
             # @overload annotate_assessment(request, options = nil)
             #   Pass arguments to `annotate_assessment` via a request object, either of type
@@ -243,7 +243,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload annotate_assessment(name: nil, annotation: nil)
+            # @overload annotate_assessment(name: nil, annotation: nil, reasons: nil)
             #   Pass arguments to `annotate_assessment` 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).
@@ -252,7 +252,11 @@ module Google
             #     Required. The resource name of the Assessment, in the format
             #     "projects/\\{project}/assessments/\\{assessment}".
             #   @param annotation [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
-            #     Required. The annotation that will be assigned to the Event.
+            #     Optional. The annotation that will be assigned to the Event. This field can be left
+            #     empty to provide reasons that apply to an event without concluding whether
+            #     the event is legitimate or fraudulent.
+            #   @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
+            #     Optional. Optional reasons for the annotation that will be assigned to the Event.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse]
@@ -538,7 +542,7 @@ module Google
             #   @param key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash]
             #     Required. The key to update.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     Optional. The mask to control which field of the key get updated. If the mask is not
+            #     Optional. The mask to control which fields of the key get updated. If the mask is not
             #     present, all fields will be updated.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -657,6 +661,150 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
+            # Once a key is migrated, it can be used from either product. SiteVerify
+            # requests are billed as CreateAssessment calls. You must be
+            # authenticated as one of the current owners of the reCAPTCHA Site Key, and
+            # your user must have the reCAPTCHA Enterprise Admin IAM role in the
+            # destination project.
+            #
+            # @overload migrate_key(request, options = nil)
+            #   Pass arguments to `migrate_key` via a request object, either of type
+            #   {::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest, ::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 migrate_key(name: nil)
+            #   Pass arguments to `migrate_key` 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 name [::String]
+            #     Required. The name of the key to be migrated, in the format
+            #     "projects/\\{project}/keys/\\{key}".
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::RecaptchaEnterprise::V1::Key]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def migrate_key request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest
+
+              # 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.migrate_key.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::RecaptchaEnterprise::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "name" => request.name
+              }
+              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.migrate_key.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.migrate_key.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @recaptcha_enterprise_service_stub.call_rpc :migrate_key, 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
+
+            ##
+            # Get some aggregated metrics for a Key. This data can be used to build
+            # dashboards.
+            #
+            # @overload get_metrics(request, options = nil)
+            #   Pass arguments to `get_metrics` via a request object, either of type
+            #   {::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest, ::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 get_metrics(name: nil)
+            #   Pass arguments to `get_metrics` 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 name [::String]
+            #     Required. The name of the requested metrics, in the format
+            #     "projects/\\{project}/keys/\\{key}/metrics".
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Metrics]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::RecaptchaEnterprise::V1::Metrics]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def get_metrics request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest
+
+              # 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.get_metrics.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::RecaptchaEnterprise::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "name" => request.name
+              }
+              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.get_metrics.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_metrics.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @recaptcha_enterprise_service_stub.call_rpc :get_metrics, 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
+
             ##
             # Configuration class for the RecaptchaEnterpriseService API.
             #
@@ -827,6 +975,16 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :delete_key
+                ##
+                # RPC-specific configuration for `migrate_key`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :migrate_key
+                ##
+                # RPC-specific configuration for `get_metrics`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_metrics
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -844,6 +1002,10 @@ module Google
                   @update_key = ::Gapic::Config::Method.new update_key_config
                   delete_key_config = parent_rpcs.delete_key if parent_rpcs.respond_to? :delete_key
                   @delete_key = ::Gapic::Config::Method.new delete_key_config
+                  migrate_key_config = parent_rpcs.migrate_key if parent_rpcs.respond_to? :migrate_key
+                  @migrate_key = ::Gapic::Config::Method.new migrate_key_config
+                  get_metrics_config = parent_rpcs.get_metrics if parent_rpcs.respond_to? :get_metrics
+                  @get_metrics = ::Gapic::Config::Method.new get_metrics_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service/paths.rb

@@ -58,6 +58,23 @@ module Google
               "projects/#{project}/keys/#{key}"
             end
 
+            ##
+            # Create a fully-qualified Metrics resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/keys/{key}/metrics`
+            #
+            # @param project [String]
+            # @param key [String]
+            #
+            # @return [::String]
+            def metrics_path project:, key:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/keys/#{key}/metrics"
+            end
+
             ##
             # Create a fully-qualified Project resource string.
             #

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module RecaptchaEnterprise
       module V1
-        VERSION = "0.4.3"
+        VERSION = "0.5.0"
       end
     end
   end

data/lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_pb.rb

@@ -19,6 +19,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest" do
       optional :name, :string, 1
       optional :annotation, :enum, 2, "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation"
+      repeated :reasons, :enum, 3, "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason"
     end
     add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation" do
       value :ANNOTATION_UNSPECIFIED, 0
@@ -27,6 +28,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :PASSWORD_CORRECT, 3
       value :PASSWORD_INCORRECT, 4
     end
+    add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason" do
+      value :REASON_UNSPECIFIED, 0
+      value :CHARGEBACK, 1
+      value :PAYMENT_HEURISTICS, 2
+      value :INITIATED_TWO_FACTOR, 7
+      value :PASSED_TWO_FACTOR, 3
+      value :FAILED_TWO_FACTOR, 4
+      value :CORRECT_PASSWORD, 5
+      value :INCORRECT_PASSWORD, 6
+    end
     add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse" do
     end
     add_message "google.cloud.recaptchaenterprise.v1.Assessment" do
@@ -68,6 +79,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :EXPIRED, 3
       value :DUPE, 4
       value :MISSING, 5
+      value :BROWSER_ERROR, 6
     end
     add_message "google.cloud.recaptchaenterprise.v1.CreateKeyRequest" do
       optional :parent, :string, 1
@@ -92,17 +104,39 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.recaptchaenterprise.v1.DeleteKeyRequest" do
       optional :name, :string, 1
     end
+    add_message "google.cloud.recaptchaenterprise.v1.MigrateKeyRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.GetMetricsRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.Metrics" do
+      optional :name, :string, 4
+      optional :start_time, :message, 1, "google.protobuf.Timestamp"
+      repeated :score_metrics, :message, 2, "google.cloud.recaptchaenterprise.v1.ScoreMetrics"
+      repeated :challenge_metrics, :message, 3, "google.cloud.recaptchaenterprise.v1.ChallengeMetrics"
+    end
     add_message "google.cloud.recaptchaenterprise.v1.Key" do
       optional :name, :string, 1
       optional :display_name, :string, 2
       map :labels, :string, :string, 6
       optional :create_time, :message, 7, "google.protobuf.Timestamp"
+      optional :testing_options, :message, 9, "google.cloud.recaptchaenterprise.v1.TestingOptions"
       oneof :platform_settings do
         optional :web_settings, :message, 3, "google.cloud.recaptchaenterprise.v1.WebKeySettings"
         optional :android_settings, :message, 4, "google.cloud.recaptchaenterprise.v1.AndroidKeySettings"
         optional :ios_settings, :message, 5, "google.cloud.recaptchaenterprise.v1.IOSKeySettings"
       end
     end
+    add_message "google.cloud.recaptchaenterprise.v1.TestingOptions" do
+      optional :testing_score, :float, 1
+      optional :testing_challenge, :enum, 2, "google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge" do
+      value :TESTING_CHALLENGE_UNSPECIFIED, 0
+      value :NOCAPTCHA, 1
+      value :UNSOLVABLE_CHALLENGE, 2
+    end
     add_message "google.cloud.recaptchaenterprise.v1.WebKeySettings" do
       optional :allow_all_domains, :bool, 3
       repeated :allowed_domains, :string, 1
@@ -123,11 +157,26 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :SECURITY, 3
     end
     add_message "google.cloud.recaptchaenterprise.v1.AndroidKeySettings" do
+      optional :allow_all_package_names, :bool, 2
       repeated :allowed_package_names, :string, 1
     end
     add_message "google.cloud.recaptchaenterprise.v1.IOSKeySettings" do
+      optional :allow_all_bundle_ids, :bool, 2
       repeated :allowed_bundle_ids, :string, 1
     end
+    add_message "google.cloud.recaptchaenterprise.v1.ScoreDistribution" do
+      map :score_buckets, :int32, :int64, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ScoreMetrics" do
+      optional :overall_metrics, :message, 1, "google.cloud.recaptchaenterprise.v1.ScoreDistribution"
+      map :action_metrics, :string, :message, 2, "google.cloud.recaptchaenterprise.v1.ScoreDistribution"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ChallengeMetrics" do
+      optional :pageload_count, :int64, 1
+      optional :nocaptcha_count, :int64, 2
+      optional :failed_count, :int64, 3
+      optional :passed_count, :int64, 4
+    end
   end
 end
 
@@ -138,6 +187,7 @@ module Google
         CreateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest").msgclass
         AnnotateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest").msgclass
         AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation").enummodule
+        AnnotateAssessmentRequest::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason").enummodule
         AnnotateAssessmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse").msgclass
         Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Assessment").msgclass
         Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Event").msgclass
@@ -151,12 +201,20 @@ module Google
         GetKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.GetKeyRequest").msgclass
         UpdateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.UpdateKeyRequest").msgclass
         DeleteKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.DeleteKeyRequest").msgclass
+        MigrateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.MigrateKeyRequest").msgclass
+        GetMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.GetMetricsRequest").msgclass
+        Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Metrics").msgclass
         Key = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Key").msgclass
+        TestingOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TestingOptions").msgclass
+        TestingOptions::TestingChallenge = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge").enummodule
         WebKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings").msgclass
         WebKeySettings::IntegrationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType").enummodule
         WebKeySettings::ChallengeSecurityPreference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference").enummodule
         AndroidKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AndroidKeySettings").msgclass
         IOSKeySettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.IOSKeySettings").msgclass
+        ScoreDistribution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ScoreDistribution").msgclass
+        ScoreMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ScoreMetrics").msgclass
+        ChallengeMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ChallengeMetrics").msgclass
       end
     end
   end

data/lib/google/cloud/recaptchaenterprise/v1/recaptchaenterprise_services_pb.rb

@@ -36,7 +36,7 @@ module Google
             # Creates an Assessment of the likelihood an event is legitimate.
             rpc :CreateAssessment, ::Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Assessment
             # Annotates a previously created Assessment to provide additional information
-            # on whether the event turned out to be authentic or fradulent.
+            # on whether the event turned out to be authentic or fraudulent.
             rpc :AnnotateAssessment, ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest, ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse
             # Creates a new reCAPTCHA Enterprise key.
             rpc :CreateKey, ::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Key
@@ -48,6 +48,16 @@ module Google
             rpc :UpdateKey, ::Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Key
             # Deletes the specified key.
             rpc :DeleteKey, ::Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest, ::Google::Protobuf::Empty
+            # Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
+            # Once a key is migrated, it can be used from either product. SiteVerify
+            # requests are billed as CreateAssessment calls. You must be
+            # authenticated as one of the current owners of the reCAPTCHA Site Key, and
+            # your user must have the reCAPTCHA Enterprise Admin IAM role in the
+            # destination project.
+            rpc :MigrateKey, ::Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Key
+            # Get some aggregated metrics for a Key. This data can be used to build
+            # dashboards.
+            rpc :GetMetrics, ::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Metrics
           end
 
           Stub = Service.rpc_stub_class

data/proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

@@ -41,12 +41,17 @@ module Google
         #     "projects/\\{project}/assessments/\\{assessment}".
         # @!attribute [rw] annotation
         #   @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
-        #     Required. The annotation that will be assigned to the Event.
+        #     Optional. The annotation that will be assigned to the Event. This field can be left
+        #     empty to provide reasons that apply to an event without concluding whether
+        #     the event is legitimate or fraudulent.
+        # @!attribute [rw] reasons
+        #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
+        #     Optional. Optional reasons for the annotation that will be assigned to the Event.
         class AnnotateAssessmentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # Enum that reprensents the types of annotations.
+          # Enum that represents the types of annotations.
           module Annotation
             # Default unspecified type.
             ANNOTATION_UNSPECIFIED = 0
@@ -58,13 +63,48 @@ module Google
             FRAUDULENT = 2
 
             # Provides information that the event was related to a login event in which
-            # the user typed the correct password.
+            # the user typed the correct password. Deprecated, prefer indicating
+            # CORRECT_PASSWORD through the reasons field instead.
             PASSWORD_CORRECT = 3
 
             # Provides information that the event was related to a login event in which
-            # the user typed the incorrect password.
+            # the user typed the incorrect password. Deprecated, prefer indicating
+            # INCORRECT_PASSWORD through the reasons field instead.
             PASSWORD_INCORRECT = 4
           end
+
+          # Enum that represents potential reasons for annotating an assessment.
+          module Reason
+            # Default unspecified reason.
+            REASON_UNSPECIFIED = 0
+
+            # Indicates a chargeback for fraud was issued for the transaction
+            # associated with the assessment.
+            CHARGEBACK = 1
+
+            # Indicates the transaction associated with the assessment is suspected of
+            # being fraudulent based on the payment method, billing details, shipping
+            # address or other transaction information.
+            PAYMENT_HEURISTICS = 2
+
+            # Indicates that the user was served a 2FA challenge. An old assessment
+            # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
+            # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
+            # This is equivalent to `FAILED_TWO_FACTOR`.
+            INITIATED_TWO_FACTOR = 7
+
+            # Indicates that the user passed a 2FA challenge.
+            PASSED_TWO_FACTOR = 3
+
+            # Indicates that the user failed a 2FA challenge.
+            FAILED_TWO_FACTOR = 4
+
+            # Indicates the user provided the correct password.
+            CORRECT_PASSWORD = 5
+
+            # Indicates the user provided an incorrect password.
+            INCORRECT_PASSWORD = 6
+          end
         end
 
         # Empty response for AnnotateAssessment.
@@ -130,7 +170,6 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # LINT.IfChange(classification_reason)
           # Reasons contributing to the risk analysis verdict.
           module ClassificationReason
             # Default unspecified type.
@@ -178,7 +217,6 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
-          # LINT.IfChange
           # Enum that represents the types of invalid token reasons.
           module InvalidReason
             # Default unspecified type.
@@ -198,6 +236,10 @@ module Google
 
             # The user verification token was not present.
             MISSING = 5
+
+            # A retriable error (such as network failure) occurred on the browser.
+            # Could easily be simulated by an attacker.
+            BROWSER_ERROR = 6
           end
         end
 
@@ -261,7 +303,7 @@ module Google
         #     Required. The key to update.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Optional. The mask to control which field of the key get updated. If the mask is not
+        #     Optional. The mask to control which fields of the key get updated. If the mask is not
         #     present, all fields will be updated.
         class UpdateKeyRequest
           include ::Google::Protobuf::MessageExts
@@ -278,6 +320,48 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The migrate key request message.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the key to be migrated, in the format
+        #     "projects/\\{project}/keys/\\{key}".
+        class MigrateKeyRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The get metrics request message.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the requested metrics, in the format
+        #     "projects/\\{project}/keys/\\{key}/metrics".
+        class GetMetricsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metrics for a single Key.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The name of the metrics, in the format
+        #     "projects/\\{project}/keys/\\{key}/metrics".
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Inclusive start time aligned to a day (UTC).
+        # @!attribute [rw] score_metrics
+        #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::ScoreMetrics>]
+        #     Metrics will be continuous and in order by dates, and in the granularity
+        #     of day. All Key types should have score-based data.
+        # @!attribute [rw] challenge_metrics
+        #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::ChallengeMetrics>]
+        #     Metrics will be continuous and in order by dates, and in the granularity
+        #     of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have
+        #     challenge-based data.
+        class Metrics
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A key used to identify and configure applications (web and/or mobile) that
         # use reCAPTCHA Enterprise.
         # @!attribute [rw] name
@@ -298,11 +382,14 @@ module Google
         #     Settings for keys that can be used by iOS apps.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Optional. See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
+        #     See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
         #     Creating and managing labels</a>.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The timestamp corresponding to the creation of this Key.
+        # @!attribute [rw] testing_options
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions]
+        #     Options for user acceptance testing.
         class Key
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -317,6 +404,37 @@ module Google
           end
         end
 
+        # Options for user acceptance testing.
+        # @!attribute [rw] testing_score
+        #   @return [::Float]
+        #     All assessments for this Key will return this score. Must be between 0
+        #     (likely not legitimate) and 1 (likely legitimate) inclusive.
+        # @!attribute [rw] testing_challenge
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions::TestingChallenge]
+        #     For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
+        #     for this site will return nocaptcha if NOCAPTCHA, or an unsolvable
+        #     challenge if CHALLENGE.
+        class TestingOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum that represents the challenge option for challenge-based (CHECKBOX,
+          # INVISIBLE) testing keys.
+          module TestingChallenge
+            # Perform the normal risk analysis and return either nocaptcha or a
+            # challenge depending on risk and trust factors.
+            TESTING_CHALLENGE_UNSPECIFIED = 0
+
+            # Challenge requests for this key will always return a nocaptcha, which
+            # does not require a solution.
+            NOCAPTCHA = 1
+
+            # Challenge requests for this key will always return an unsolvable
+            # challenge.
+            UNSOLVABLE_CHALLENGE = 2
+          end
+        end
+
         # Settings specific to keys that can be used by websites.
         # @!attribute [rw] allow_all_domains
         #   @return [::Boolean]
@@ -330,6 +448,7 @@ module Google
         # @!attribute [rw] allow_amp_traffic
         #   @return [::Boolean]
         #     Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
+        #     This can only be set for the SCORE integration type.
         # @!attribute [rw] integration_type
         #   @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType]
         #     Required. Describes how this key is integrated with the website.
@@ -380,6 +499,9 @@ module Google
         end
 
         # Settings specific to keys that can be used by Android apps.
+        # @!attribute [rw] allow_all_package_names
+        #   @return [::Boolean]
+        #     If set to true, it means allowed_package_names will not be enforced.
         # @!attribute [rw] allowed_package_names
         #   @return [::Array<::String>]
         #     Android package names of apps allowed to use the key.
@@ -390,6 +512,9 @@ module Google
         end
 
         # Settings specific to keys that can be used by iOS apps.
+        # @!attribute [rw] allow_all_bundle_ids
+        #   @return [::Boolean]
+        #     If set to true, it means allowed_bundle_ids will not be enforced.
         # @!attribute [rw] allowed_bundle_ids
         #   @return [::Array<::String>]
         #     iOS bundle ids of apps allowed to use the key.
@@ -398,6 +523,71 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Score distribution.
+        # @!attribute [rw] score_buckets
+        #   @return [::Google::Protobuf::Map{::Integer => ::Integer}]
+        #     Map key is score value multiplied by 100. The scores are discrete values
+        #     between [0, 1]. The maximum number of buckets is on order of a few dozen,
+        #     but typically much lower (ie. 10).
+        class ScoreDistribution
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::Integer]
+          # @!attribute [rw] value
+          #   @return [::Integer]
+          class ScoreBucketsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Metrics related to scoring.
+        # @!attribute [rw] overall_metrics
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution]
+        #     Aggregated score metrics for all traffic.
+        # @!attribute [rw] action_metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution}]
+        #     Action-based metrics. The map key is the action name which specified by the
+        #     site owners at time of the "execute" client-side call.
+        #     Populated only for SCORE keys.
+        class ScoreMetrics
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution]
+          class ActionMetricsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Metrics related to challenges.
+        # @!attribute [rw] pageload_count
+        #   @return [::Integer]
+        #     Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent
+        #     to a count of pageloads for pages that include reCAPTCHA.
+        # @!attribute [rw] nocaptcha_count
+        #   @return [::Integer]
+        #     Count of nocaptchas (successful verification without a challenge) issued.
+        # @!attribute [rw] failed_count
+        #   @return [::Integer]
+        #     Count of submitted challenge solutions that were incorrect or otherwise
+        #     deemed suspicious such that a subsequent challenge was triggered.
+        # @!attribute [rw] passed_count
+        #   @return [::Integer]
+        #     Count of nocaptchas (successful verification without a challenge) plus
+        #     submitted challenge solutions that were correct and resulted in
+        #     verification.
+        class ChallengeMetrics
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

metadata

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