google-cloud-recaptcha_enterprise-v1 0.4.1 → 0.6.0

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.
             #
@@ -72,6 +89,23 @@ module Google
               "projects/#{project}"
             end
 
+            ##
+            # Create a fully-qualified RelatedAccountGroup resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`
+            #
+            # @param project [String]
+            # @param relatedaccountgroup [String]
+            #
+            # @return [::String]
+            def related_account_group_path project:, relatedaccountgroup:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/relatedaccountgroups/#{relatedaccountgroup}"
+            end
+
             extend self
           end
         end

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module RecaptchaEnterprise
       module V1
-        VERSION = "0.4.1"
+        VERSION = "0.6.0"
       end
     end
   end

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto", :syntax => :proto3) do
     add_message "google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest" do
@@ -19,6 +19,8 @@ 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"
+      optional :hashed_account_id, :bytes, 4
     end
     add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation" do
       value :ANNOTATION_UNSPECIFIED, 0
@@ -27,6 +29,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
@@ -34,6 +46,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1.Event"
       optional :risk_analysis, :message, 3, "google.cloud.recaptchaenterprise.v1.RiskAnalysis"
       optional :token_properties, :message, 4, "google.cloud.recaptchaenterprise.v1.TokenProperties"
+      optional :account_defender_assessment, :message, 6, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment"
     end
     add_message "google.cloud.recaptchaenterprise.v1.Event" do
       optional :token, :string, 1
@@ -41,6 +54,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :user_agent, :string, 3
       optional :user_ip_address, :string, 4
       optional :expected_action, :string, 5
+      optional :hashed_account_id, :bytes, 6
     end
     add_message "google.cloud.recaptchaenterprise.v1.RiskAnalysis" do
       optional :score, :float, 1
@@ -68,6 +82,17 @@ 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.AccountDefenderAssessment" do
+      repeated :labels, :enum, 1, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel" do
+      value :ACCOUNT_DEFENDER_LABEL_UNSPECIFIED, 0
+      value :PROFILE_MATCH, 1
+      value :SUSPICIOUS_LOGIN_ACTIVITY, 2
+      value :SUSPICIOUS_ACCOUNT_CREATION, 3
+      value :RELATED_ACCOUNTS_NUMBER_HIGH, 4
     end
     add_message "google.cloud.recaptchaenterprise.v1.CreateKeyRequest" do
       optional :parent, :string, 1
@@ -92,17 +117,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 +170,61 @@ 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
+    add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse" do
+      repeated :related_account_group_memberships, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse" do
+      repeated :related_account_groups, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroup"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest" do
+      optional :parent, :string, 1
+      optional :hashed_account_id, :bytes, 2
+      optional :page_size, :int32, 3
+      optional :page_token, :string, 4
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse" do
+      repeated :related_account_group_memberships, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership" do
+      optional :name, :string, 1
+      optional :hashed_account_id, :bytes, 2
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.RelatedAccountGroup" do
+      optional :name, :string, 1
+    end
   end
 end
 
@@ -138,6 +235,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
@@ -145,18 +243,36 @@ module Google
         RiskAnalysis::ClassificationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason").enummodule
         TokenProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties").msgclass
         TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason").enummodule
+        AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment").msgclass
+        AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
         CreateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateKeyRequest").msgclass
         ListKeysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysRequest").msgclass
         ListKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysResponse").msgclass
         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
+        ListRelatedAccountGroupMembershipsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsRequest").msgclass
+        ListRelatedAccountGroupMembershipsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse").msgclass
+        ListRelatedAccountGroupsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsRequest").msgclass
+        ListRelatedAccountGroupsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse").msgclass
+        SearchRelatedAccountGroupMembershipsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest").msgclass
+        SearchRelatedAccountGroupMembershipsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse").msgclass
+        RelatedAccountGroupMembership = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership").msgclass
+        RelatedAccountGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RelatedAccountGroup").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,22 @@ 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
+            # List groups of related accounts.
+            rpc :ListRelatedAccountGroups, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsResponse
+            # Get the memberships in a group of related accounts.
+            rpc :ListRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsResponse
+            # Search group memberships related to a given account.
+            rpc :SearchRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsResponse
           end
 
           Stub = Service.rpc_stub_class

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end