google-cloud-recaptcha_enterprise-v1 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb553d077ccc71cb034e2fb0ff624aabf5fb6298c0ebcccd700b3df74a537f3
-  data.tar.gz: c8fda32169b5a4a491bcfff8f3fa23f0a349d2fe13962466148491eb724ad220
+  metadata.gz: 5088ca44e052b45ccfcb29d3fbc4510235c0c3aaedaf4c1255ff237cef928470
+  data.tar.gz: fcba51e7ee2249c21c663cff12f900b9cc5ea0563e03596dfacf1494cdd36f41
 SHA512:
-  metadata.gz: 68c5f54671922f909bdf340b4446abee0c48270cc06d85ae0245a6998e5317221364f3254bca80365080160ea51f19e4504fcc6f39539ab109d89c2a388db3e2
-  data.tar.gz: 5245bcdff7ab73ca97db012172bcd0b77f8abcc4d4d29dabec8f752fb2e1c692ad6d89edbd90e22d16c95ae720b15dee28b425cbc8bd273569a4a3b59f04bf12
+  metadata.gz: 2155f69b74449d32a98e898872a3bcbcd831189eb23da2a754050a3b3f541f04a41e834d2c16b7bd9814f2176262ab3a323047ef76a1f73a0074173d1ec9f893
+  data.tar.gz: 01f2bbef7f1fd929e7c4b3efbd2be83954cf08f854c83c7aa89d52f124dc016076e757015767d2b803371e8672f5abb943aac754012c2babdc5f60f41b2a3caa

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the reCAPTCHA Enterprise V1 API
 
-API Client library for the reCAPTCHA Enterprise V1 API
+Help protect your website from fraudulent activity, spam, and abuse without creating friction.
 
 reCAPTCHA Enterprise is a service that protects your site from spam and abuse.
 
@@ -47,7 +47,7 @@ for general usage information.
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
 The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

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

@@ -260,7 +260,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, reasons: nil, hashed_account_id: nil)
+            # @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil, transaction_event: 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).
@@ -281,6 +281,9 @@ module Google
             #     CreateAssessment, for example when the account identifier is not yet known
             #     in the initial request. It is recommended that the identifier is hashed
             #     using hmac-sha256 with stable secret.
+            #   @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent, ::Hash]
+            #     Optional. If the assessment is part of a payment transaction, provide
+            #     details on payment lifecycle events that occur in the transaction.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse]
@@ -482,13 +485,11 @@ module Google
             #   # Call the list_keys method.
             #   result = client.list_keys 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|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::Key.
-            #     p response
+            #     p item
             #   end
             #
             def list_keys request, options = nil
@@ -1121,13 +1122,11 @@ module Google
             #   # Call the list_related_account_groups method.
             #   result = client.list_related_account_groups 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|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup.
-            #     p response
+            #     p item
             #   end
             #
             def list_related_account_groups request, options = nil
@@ -1225,13 +1224,11 @@ module Google
             #   # Call the list_related_account_group_memberships method.
             #   result = client.list_related_account_group_memberships 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|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership.
-            #     p response
+            #     p item
             #   end
             #
             def list_related_account_group_memberships request, options = nil
@@ -1335,13 +1332,11 @@ module Google
             #   # Call the search_related_account_group_memberships method.
             #   result = client.search_related_account_group_memberships 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|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership.
-            #     p response
+            #     p item
             #   end
             #
             def search_related_account_group_memberships request, options = nil
@@ -1424,9 +1419,9 @@ module Google
             #    *  (`String`) The path to a service account key file in JSON format
             #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials

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

@@ -33,7 +33,7 @@ module Google
         ##
         # Service to determine the likelihood an event is legitimate.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/recaptcha_enterprise/v1/recaptcha_enterprise_service"
         #     client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module RecaptchaEnterprise
       module V1
-        VERSION = "0.12.0"
+        VERSION = "0.13.0"
       end
     end
   end

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

@@ -23,9 +23,9 @@ module Google
   module Cloud
     module RecaptchaEnterprise
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/recaptcha_enterprise/v1"
       #     client = ::Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new

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

@@ -17,11 +17,39 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :parent, :string, 1
       optional :assessment, :message, 2, "google.cloud.recaptchaenterprise.v1.Assessment"
     end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionEvent" do
+      optional :event_type, :enum, 1, "google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType"
+      optional :reason, :string, 2
+      optional :value, :double, 3
+      optional :event_time, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_enum "google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType" do
+      value :TRANSACTION_EVENT_TYPE_UNSPECIFIED, 0
+      value :MERCHANT_APPROVE, 1
+      value :MERCHANT_DENY, 2
+      value :MANUAL_REVIEW, 3
+      value :AUTHORIZATION, 4
+      value :AUTHORIZATION_DECLINE, 5
+      value :PAYMENT_CAPTURE, 6
+      value :PAYMENT_CAPTURE_DECLINE, 7
+      value :CANCEL, 8
+      value :CHARGEBACK_INQUIRY, 9
+      value :CHARGEBACK_ALERT, 10
+      value :FRAUD_NOTIFICATION, 11
+      value :CHARGEBACK, 12
+      value :CHARGEBACK_REPRESENTMENT, 13
+      value :CHARGEBACK_REVERSE, 14
+      value :REFUND_REQUEST, 15
+      value :REFUND_DECLINE, 16
+      value :REFUND, 17
+      value :REFUND_REVERSE, 18
+    end
     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
+      optional :transaction_event, :message, 5, "google.cloud.recaptchaenterprise.v1.TransactionEvent"
     end
     add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation" do
       value :ANNOTATION_UNSPECIFIED, 0
@@ -89,6 +117,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :account_verification, :message, 5, "google.cloud.recaptchaenterprise.v1.AccountVerificationInfo"
       optional :account_defender_assessment, :message, 6, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment"
       optional :private_password_leak_verification, :message, 8, "google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification"
+      optional :fraud_prevention_assessment, :message, 11, "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment"
     end
     add_message "google.cloud.recaptchaenterprise.v1.Event" do
       optional :token, :string, 1
@@ -97,6 +126,50 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :user_ip_address, :string, 4
       optional :expected_action, :string, 5
       optional :hashed_account_id, :bytes, 6
+      optional :transaction_data, :message, 13, "google.cloud.recaptchaenterprise.v1.TransactionData"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionData" do
+      proto3_optional :transaction_id, :string, 11
+      optional :payment_method, :string, 1
+      optional :card_bin, :string, 2
+      optional :card_last_four, :string, 3
+      optional :currency_code, :string, 4
+      optional :value, :double, 5
+      optional :shipping_value, :double, 12
+      optional :shipping_address, :message, 6, "google.cloud.recaptchaenterprise.v1.TransactionData.Address"
+      optional :billing_address, :message, 7, "google.cloud.recaptchaenterprise.v1.TransactionData.Address"
+      optional :user, :message, 8, "google.cloud.recaptchaenterprise.v1.TransactionData.User"
+      repeated :merchants, :message, 13, "google.cloud.recaptchaenterprise.v1.TransactionData.User"
+      repeated :items, :message, 14, "google.cloud.recaptchaenterprise.v1.TransactionData.Item"
+      optional :gateway_info, :message, 10, "google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionData.Address" do
+      optional :recipient, :string, 1
+      repeated :address, :string, 2
+      optional :locality, :string, 3
+      optional :administrative_area, :string, 4
+      optional :region_code, :string, 5
+      optional :postal_code, :string, 6
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionData.User" do
+      optional :account_id, :string, 6
+      optional :creation_ms, :int64, 1
+      optional :email, :string, 2
+      optional :email_verified, :bool, 3
+      optional :phone_number, :string, 4
+      optional :phone_verified, :bool, 5
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionData.Item" do
+      optional :name, :string, 1
+      optional :value, :double, 2
+      optional :quantity, :int64, 3
+      optional :merchant_account_id, :string, 4
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo" do
+      optional :name, :string, 1
+      optional :gateway_response_code, :string, 2
+      optional :avs_response_code, :string, 3
+      optional :cvv_response_code, :string, 4
     end
     add_message "google.cloud.recaptchaenterprise.v1.RiskAnalysis" do
       optional :score, :float, 1
@@ -109,6 +182,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :TOO_MUCH_TRAFFIC, 3
       value :UNEXPECTED_USAGE_PATTERNS, 4
       value :LOW_CONFIDENCE_SCORE, 5
+      value :SUSPECTED_CARDING, 6
+      value :SUSPECTED_CHARGEBACK, 7
     end
     add_message "google.cloud.recaptchaenterprise.v1.TokenProperties" do
       optional :valid, :bool, 1
@@ -128,6 +203,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :MISSING, 5
       value :BROWSER_ERROR, 6
     end
+    add_message "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment" do
+      optional :transaction_risk, :float, 1
+      optional :stolen_instrument_verdict, :message, 2, "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict"
+      optional :card_testing_verdict, :message, 3, "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict"
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict" do
+      optional :risk, :float, 1
+    end
+    add_message "google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict" do
+      optional :risk, :float, 1
+    end
     add_message "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment" do
       repeated :labels, :enum, 1, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel"
     end
@@ -299,6 +385,8 @@ module Google
     module RecaptchaEnterprise
       module V1
         CreateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest").msgclass
+        TransactionEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionEvent").msgclass
+        TransactionEvent::TransactionEventType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionEvent.TransactionEventType").enummodule
         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
@@ -309,10 +397,18 @@ module Google
         PrivatePasswordLeakVerification = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification").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
+        TransactionData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionData").msgclass
+        TransactionData::Address = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionData.Address").msgclass
+        TransactionData::User = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionData.User").msgclass
+        TransactionData::Item = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionData.Item").msgclass
+        TransactionData::GatewayInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TransactionData.GatewayInfo").msgclass
         RiskAnalysis = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis").msgclass
         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
+        FraudPreventionAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment").msgclass
+        FraudPreventionAssessment::StolenInstrumentVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.StolenInstrumentVerdict").msgclass
+        FraudPreventionAssessment::CardTestingVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.FraudPreventionAssessment.CardTestingVerdict").msgclass
         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

data/proto_docs/google/api/client.rb

@@ -35,7 +35,9 @@ module Google
     # Details about how and where to publish client libraries.
     # @!attribute [rw] version
     #   @return [::String]
-    #     Version of the API to apply these settings to.
+    #     Version of the API to apply these settings to. This is the full protobuf
+    #     package for the API, ending in the version element.
+    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
     # @!attribute [rw] launch_stage
     #   @return [::Google::Api::LaunchStage]
     #     Launch stage of this version of the API.
@@ -111,6 +113,10 @@ module Google
     #     Client library settings.  If the same version string appears multiple
     #     times in this list, then the last one wins.  Settings from earlier
     #     settings with the same version string are discarded.
+    # @!attribute [rw] proto_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to proto reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -240,8 +246,8 @@ module Google
     #     Example of a YAML configuration::
     #
     #      publishing:
-    #        method_behavior:
-    #          - selector: CreateAdDomain
+    #        method_settings:
+    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
     #              initial_poll_delay:
     #                seconds: 60 # 1 minute

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

@@ -34,6 +34,127 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Describes an event in the lifecycle of a payment transaction.
+        # @!attribute [rw] event_type
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent::TransactionEventType]
+        #     Optional. The type of this transaction event.
+        # @!attribute [rw] reason
+        #   @return [::String]
+        #     Optional. The reason or standardized code that corresponds with this
+        #     transaction event, if one exists. For example, a CHARGEBACK event with code
+        #     6005.
+        # @!attribute [rw] value
+        #   @return [::Float]
+        #     Optional. The value that corresponds with this transaction event, if one
+        #     exists. For example, a refund event where $5.00 was refunded. Currency is
+        #     obtained from the original transaction data.
+        # @!attribute [rw] event_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Timestamp when this transaction event occurred; otherwise assumed
+        #     to be the time of the API call.
+        class TransactionEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum that represents an event in the payment transaction lifecycle.
+          module TransactionEventType
+            # Default, unspecified event type.
+            TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0
+
+            # Indicates that the transaction is approved by the merchant. The
+            # accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
+            # 'CYBERSOURCE', or 'MANUAL_REVIEW'.
+            MERCHANT_APPROVE = 1
+
+            # Indicates that the transaction is denied and concluded due to risks
+            # detected by the merchant. The accompanying reasons can include terms such
+            # as 'INHOUSE',  'ACCERTIFY',  'CYBERSOURCE', or 'MANUAL_REVIEW'.
+            MERCHANT_DENY = 2
+
+            # Indicates that the transaction is being evaluated by a human, due to
+            # suspicion or risk.
+            MANUAL_REVIEW = 3
+
+            # Indicates that the authorization attempt with the card issuer succeeded.
+            AUTHORIZATION = 4
+
+            # Indicates that the authorization attempt with the card issuer failed.
+            # The accompanying reasons can include Visa's '54' indicating that the card
+            # is expired, or '82' indicating that the CVV is incorrect.
+            AUTHORIZATION_DECLINE = 5
+
+            # Indicates that the transaction is completed because the funds were
+            # settled.
+            PAYMENT_CAPTURE = 6
+
+            # Indicates that the transaction could not be completed because the funds
+            # were not settled.
+            PAYMENT_CAPTURE_DECLINE = 7
+
+            # Indicates that the transaction has been canceled. Specify the reason
+            # for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
+            CANCEL = 8
+
+            # Indicates that the merchant has received a chargeback inquiry due to
+            # fraud for the transaction, requesting additional information before a
+            # fraud chargeback is officially issued and a formal chargeback
+            # notification is sent.
+            CHARGEBACK_INQUIRY = 9
+
+            # Indicates that the merchant has received a chargeback alert due to fraud
+            # for the transaction. The process of resolving the dispute without
+            # involving the payment network is started.
+            CHARGEBACK_ALERT = 10
+
+            # Indicates that a fraud notification is issued for the transaction, sent
+            # by the payment instrument's issuing bank because the transaction appears
+            # to be fraudulent. We recommend including TC40 or SAFE data in the
+            # `reason` field for this event type. For partial chargebacks, we recommend
+            # that you include an amount in the `value` field.
+            FRAUD_NOTIFICATION = 11
+
+            # Indicates that the merchant is informed by the payment network that the
+            # transaction has entered the chargeback process due to fraud. Reason code
+            # examples include Discover's '6005' and '6041'. For partial chargebacks,
+            # we recommend that you include an amount in the `value` field.
+            CHARGEBACK = 12
+
+            # Indicates that the transaction has entered the chargeback process due to
+            # fraud, and that the merchant has chosen to enter representment. Reason
+            # examples include Discover's '6005' and '6041'. For partial chargebacks,
+            # we recommend that you include an amount in the `value` field.
+            CHARGEBACK_REPRESENTMENT = 13
+
+            # Indicates that the transaction has had a fraud chargeback which was
+            # illegitimate and was reversed as a result. For partial chargebacks, we
+            # recommend that you include an amount in the `value` field.
+            CHARGEBACK_REVERSE = 14
+
+            # Indicates that the merchant has received a refund for a completed
+            # transaction. For partial refunds, we recommend that you include an amount
+            # in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
+            # exempt tax)
+            REFUND_REQUEST = 15
+
+            # Indicates that the merchant has received a refund request for this
+            # transaction, but that they have declined it. For partial refunds, we
+            # recommend that you include an amount in the `value` field. Reason
+            # example: 'TAX_EXEMPT' (partial refund of exempt tax)
+            REFUND_DECLINE = 16
+
+            # Indicates that the completed transaction was refunded by the merchant.
+            # For partial refunds, we recommend that you include an amount in the
+            # `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
+            # tax)
+            REFUND = 17
+
+            # Indicates that the completed transaction was refunded by the merchant,
+            # and that this refund was reversed. For partial refunds, we recommend that
+            # you include an amount in the `value` field.
+            REFUND_REVERSE = 18
+          end
+        end
+
         # The request message to annotate an Assessment.
         # @!attribute [rw] name
         #   @return [::String]
@@ -55,6 +176,10 @@ module Google
         #     CreateAssessment, for example when the account identifier is not yet known
         #     in the initial request. It is recommended that the identifier is hashed
         #     using hmac-sha256 with stable secret.
+        # @!attribute [rw] transaction_event
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent]
+        #     Optional. If the assessment is part of a payment transaction, provide
+        #     details on payment lifecycle events that occur in the transaction.
         class AnnotateAssessmentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -263,7 +388,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A recaptcha assessment resource.
+        # A reCAPTCHA Enterprise assessment resource.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The resource name for the Assessment in the format
@@ -289,19 +414,23 @@ module Google
         #   @return [::Google::Cloud::RecaptchaEnterprise::V1::PrivatePasswordLeakVerification]
         #     The private password leak verification field contains the parameters that
         #     are used to to check for leaks privately without sharing user credentials.
+        # @!attribute [rw] fraud_prevention_assessment
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment]
+        #     Assessment returned by Fraud Prevention when TransactionData is provided.
         class Assessment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The event being assessed.
         # @!attribute [rw] token
         #   @return [::String]
-        #     Optional. The user response token provided by the reCAPTCHA client-side
-        #     integration on your site.
+        #     Optional. The user response token provided by the reCAPTCHA Enterprise
+        #     client-side integration on your site.
         # @!attribute [rw] site_key
         #   @return [::String]
-        #     Optional. The site key that was used to invoke reCAPTCHA on your site and
-        #     generate the token.
+        #     Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
+        #     site and generate the token.
         # @!attribute [rw] user_agent
         #   @return [::String]
         #     Optional. The user agent present in the request from the user's device
@@ -319,11 +448,168 @@ module Google
         #   @return [::String]
         #     Optional. Unique stable hashed user identifier for the request. The
         #     identifier must be hashed using hmac-sha256 with stable secret.
+        # @!attribute [rw] transaction_data
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData]
+        #     Optional. Data describing a payment transaction to be assessed. Sending
+        #     this data enables reCAPTCHA Enterprise Fraud Prevention and the
+        #     FraudPreventionAssessment component in the response.
         class Event
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
+        # All fields are optional.
+        # @!attribute [rw] transaction_id
+        #   @return [::String]
+        #     Unique identifier for the transaction. This custom identifier can be used
+        #     to reference this transaction in the future, for example, labeling a refund
+        #     or chargeback event. Two attempts at the same transaction should use the
+        #     same transaction id.
+        # @!attribute [rw] payment_method
+        #   @return [::String]
+        #     The payment method for the transaction. The allowed values are:
+        #
+        #     * credit-card
+        #     * debit-card
+        #     * gift-card
+        #     * processor-\\{name} (If a third-party is used, for example,
+        #     processor-paypal)
+        #     * custom-\\{name} (If an alternative method is used, for example,
+        #     custom-crypto)
+        # @!attribute [rw] card_bin
+        #   @return [::String]
+        #     The Bank Identification Number - generally the first 6 or 8 digits of the
+        #     card.
+        # @!attribute [rw] card_last_four
+        #   @return [::String]
+        #     The last four digits of the card.
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     The currency code in ISO-4217 format.
+        # @!attribute [rw] value
+        #   @return [::Float]
+        #     The decimal value of the transaction in the specified currency.
+        # @!attribute [rw] shipping_value
+        #   @return [::Float]
+        #     The value of shipping in the specified currency. 0 for free or no shipping.
+        # @!attribute [rw] shipping_address
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
+        #     Destination address if this transaction involves shipping a physical item.
+        # @!attribute [rw] billing_address
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
+        #     Address associated with the payment method when applicable.
+        # @!attribute [rw] user
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User]
+        #     Information about the user paying/initiating the transaction.
+        # @!attribute [rw] merchants
+        #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User>]
+        #     Information about the user or users fulfilling the transaction.
+        # @!attribute [rw] items
+        #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Item>]
+        #     Items purchased in this transaction.
+        # @!attribute [rw] gateway_info
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::GatewayInfo]
+        #     Information about the payment gateway's response to the transaction.
+        class TransactionData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Structured address format for billing and shipping addresses.
+          # @!attribute [rw] recipient
+          #   @return [::String]
+          #     The recipient name, potentially including information such as "care of".
+          # @!attribute [rw] address
+          #   @return [::Array<::String>]
+          #     The first lines of the address. The first line generally contains the
+          #     street name and number, and further lines may include information such as
+          #     an apartment number.
+          # @!attribute [rw] locality
+          #   @return [::String]
+          #     The town/city of the address.
+          # @!attribute [rw] administrative_area
+          #   @return [::String]
+          #     The state, province, or otherwise administrative area of the address.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     The CLDR country/region of the address.
+          # @!attribute [rw] postal_code
+          #   @return [::String]
+          #     The postal or ZIP code of the address.
+          class Address
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Details about a user's account involved in the transaction.
+          # @!attribute [rw] account_id
+          #   @return [::String]
+          #     Unique account identifier for this user. If using account defender,
+          #     this should match the hashed_account_id field. Otherwise, a unique and
+          #     persistent identifier for this account.
+          # @!attribute [rw] creation_ms
+          #   @return [::Integer]
+          #     The epoch milliseconds of the user's account creation.
+          # @!attribute [rw] email
+          #   @return [::String]
+          #     The email address of the user.
+          # @!attribute [rw] email_verified
+          #   @return [::Boolean]
+          #     Whether the email has been verified to be accessible by the user (OTP or
+          #     similar).
+          # @!attribute [rw] phone_number
+          #   @return [::String]
+          #     The phone number of the user, with country code.
+          # @!attribute [rw] phone_verified
+          #   @return [::Boolean]
+          #     Whether the phone number has been verified to be accessible by the user
+          #     (OTP or similar).
+          class User
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Line items being purchased in this transaction.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The full name of the item.
+          # @!attribute [rw] value
+          #   @return [::Float]
+          #     The value per item that the user is paying, in the transaction currency,
+          #     after discounts.
+          # @!attribute [rw] quantity
+          #   @return [::Integer]
+          #     The quantity of this item that is being purchased.
+          # @!attribute [rw] merchant_account_id
+          #   @return [::String]
+          #     When a merchant is specified, its corresponding account_id. Necessary to
+          #     populate marketplace-style transactions.
+          class Item
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Details about the transaction from the gateway.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the gateway service (for example, stripe, square, paypal).
+          # @!attribute [rw] gateway_response_code
+          #   @return [::String]
+          #     Gateway response code describing the state of the transaction.
+          # @!attribute [rw] avs_response_code
+          #   @return [::String]
+          #     AVS response code from the gateway
+          #     (available only when reCAPTCHA Enterprise is called after authorization).
+          # @!attribute [rw] cvv_response_code
+          #   @return [::String]
+          #     CVV response code from the gateway
+          #     (available only when reCAPTCHA Enterprise is called after authorization).
+          class GatewayInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Risk analysis result for an event.
         # @!attribute [rw] score
         #   @return [::Float]
@@ -358,9 +644,16 @@ module Google
             # Too little traffic has been received from this site thus far to generate
             # quality risk analysis.
             LOW_CONFIDENCE_SCORE = 5
+
+            # The request matches behavioral characteristics of a carding attack.
+            SUSPECTED_CARDING = 6
+
+            # The request matches behavioral characteristics of chargebacks for fraud.
+            SUSPECTED_CHARGEBACK = 7
           end
         end
 
+        # Properties of the provided event token.
         # @!attribute [rw] valid
         #   @return [::Boolean]
         #     Whether the provided user response token is valid. When valid = false, the
@@ -418,6 +711,45 @@ module Google
           end
         end
 
+        # Assessment for Fraud Prevention.
+        # @!attribute [rw] transaction_risk
+        #   @return [::Float]
+        #     Probability (0-1) of this transaction being fraudulent. Summarizes the
+        #     combined risk of attack vectors below.
+        # @!attribute [rw] stolen_instrument_verdict
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::StolenInstrumentVerdict]
+        #     Assessment of this transaction for risk of a stolen instrument.
+        # @!attribute [rw] card_testing_verdict
+        #   @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::CardTestingVerdict]
+        #     Assessment of this transaction for risk of being part of a card testing
+        #     attack.
+        class FraudPreventionAssessment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about stolen instrument fraud, where the user is not the
+          # legitimate owner of the instrument being used for the purchase.
+          # @!attribute [rw] risk
+          #   @return [::Float]
+          #     Probability (0-1) of this transaction being executed with a stolen
+          #     instrument.
+          class StolenInstrumentVerdict
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Information about card testing fraud, where an adversary is testing
+          # fraudulently obtained cards or brute forcing their details.
+          # @!attribute [rw] risk
+          #   @return [::Float]
+          #     Probability (0-1) of this transaction attempt being part of a card
+          #     testing attack.
+          class CardTestingVerdict
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Account defender risk assessment.
         # @!attribute [rw] labels
         #   @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
@@ -623,9 +955,9 @@ module Google
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
         #     Creating and managing labels</a>.
-        # @!attribute [rw] create_time
+        # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     The timestamp corresponding to the creation of this Key.
+        #     Output only. The timestamp corresponding to the creation of this Key.
         # @!attribute [rw] testing_options
         #   @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions]
         #     Options for user acceptance testing.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recaptcha_enterprise-v1
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -207,8 +207,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
-summary: API Client library for the reCAPTCHA Enterprise V1 API
+summary: Help protect your website from fraudulent activity, spam, and abuse without
+  creating friction.
 test_files: []