google-cloud-recaptcha_enterprise-v1beta1 0.7.0 → 0.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/client.rb +13 -9
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/client.rb +13 -9
- data/lib/google/cloud/recaptcha_enterprise/v1beta1/version.rb +1 -1
- data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb +101 -0
- data/proto_docs/google/api/client.rb +9 -3
- data/proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb +391 -37
- metadata +4 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e48ddd8b5611b430fefd47dafda8bd583d57a47df77e293143781a51a0ebda85
|
|
4
|
+
data.tar.gz: d750e9eb5c847fcb2fda8b0d6b4e970b2ff66c477376cee1ec92f7db4aabdc04
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6c7fdcd8f9246385dae4ab0b51c252f6a5ca98e29dee6e14ea57577cd2d5c6f7c4dbc41f631344308621798d04b4cfeec71ea41956e9c2cb21ac091bebdfc16f
|
|
7
|
+
data.tar.gz: 681f3b3c0c1f21bd3f3a5bf1791a8aeddf1c46148bf96c2a8a99f7bd1f00b166e20252e9822690bb82a3588a4a641c5a17e9c462df186915d9d50fc2e7c8b478
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Ruby Client for the reCAPTCHA Enterprise V1beta1 API
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Help protect your website from fraudulent activity, spam, and abuse without creating friction.
|
|
4
4
|
|
|
5
5
|
reCAPTCHA Enterprise is a service that protects your site from spam and abuse.
|
|
6
6
|
|
|
@@ -47,7 +47,7 @@ for general usage information.
|
|
|
47
47
|
|
|
48
48
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
|
49
49
|
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
|
|
50
|
-
or a [`Google::Cloud::Logging::Logger`](https://
|
|
50
|
+
or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
|
|
51
51
|
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)
|
|
52
52
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
|
53
53
|
|
|
@@ -250,7 +250,7 @@ module Google
|
|
|
250
250
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
251
251
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
252
252
|
#
|
|
253
|
-
# @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil)
|
|
253
|
+
# @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil, transaction_event: nil)
|
|
254
254
|
# Pass arguments to `annotate_assessment` via keyword arguments. Note that at
|
|
255
255
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
256
256
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -259,17 +259,21 @@ module Google
|
|
|
259
259
|
# Required. The resource name of the Assessment, in the format
|
|
260
260
|
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
|
261
261
|
# @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
|
|
262
|
-
# Optional. The annotation that will be assigned to the Event. This field can
|
|
263
|
-
# empty to provide reasons that apply to an event without concluding
|
|
264
|
-
# the event is legitimate or fraudulent.
|
|
262
|
+
# Optional. The annotation that will be assigned to the Event. This field can
|
|
263
|
+
# be left empty to provide reasons that apply to an event without concluding
|
|
264
|
+
# whether the event is legitimate or fraudulent.
|
|
265
265
|
# @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
|
|
266
|
-
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
266
|
+
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
267
|
+
# Event.
|
|
267
268
|
# @param hashed_account_id [::String]
|
|
268
|
-
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
269
|
-
# This is an alternative to setting the hashed_account_id in
|
|
269
|
+
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
270
|
+
# assessment. This is an alternative to setting the hashed_account_id in
|
|
270
271
|
# CreateAssessment, for example when the account identifier is not yet known
|
|
271
272
|
# in the initial request. It is recommended that the identifier is hashed
|
|
272
273
|
# using hmac-sha256 with stable secret.
|
|
274
|
+
# @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent, ::Hash]
|
|
275
|
+
# Optional. If the assessment is part of a payment transaction, provide
|
|
276
|
+
# details on payment lifecycle events that occur in the transaction.
|
|
273
277
|
#
|
|
274
278
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
275
279
|
# @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentResponse]
|
|
@@ -373,9 +377,9 @@ module Google
|
|
|
373
377
|
# * (`String`) The path to a service account key file in JSON format
|
|
374
378
|
# * (`Hash`) A service account key as a Hash
|
|
375
379
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
376
|
-
# (see the [googleauth docs](https://
|
|
380
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
377
381
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
378
|
-
# (see the [signet docs](https://
|
|
382
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
|
379
383
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
|
380
384
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
381
385
|
# * (`nil`) indicating no credentials
|
data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/client.rb
CHANGED
|
@@ -218,7 +218,7 @@ module Google
|
|
|
218
218
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
219
219
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
220
220
|
#
|
|
221
|
-
# @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil)
|
|
221
|
+
# @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil, transaction_event: nil)
|
|
222
222
|
# Pass arguments to `annotate_assessment` via keyword arguments. Note that at
|
|
223
223
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
224
224
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -227,17 +227,21 @@ module Google
|
|
|
227
227
|
# Required. The resource name of the Assessment, in the format
|
|
228
228
|
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
|
229
229
|
# @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
|
|
230
|
-
# Optional. The annotation that will be assigned to the Event. This field can
|
|
231
|
-
# empty to provide reasons that apply to an event without concluding
|
|
232
|
-
# the event is legitimate or fraudulent.
|
|
230
|
+
# Optional. The annotation that will be assigned to the Event. This field can
|
|
231
|
+
# be left empty to provide reasons that apply to an event without concluding
|
|
232
|
+
# whether the event is legitimate or fraudulent.
|
|
233
233
|
# @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
|
|
234
|
-
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
234
|
+
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
235
|
+
# Event.
|
|
235
236
|
# @param hashed_account_id [::String]
|
|
236
|
-
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
237
|
-
# This is an alternative to setting the hashed_account_id in
|
|
237
|
+
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
238
|
+
# assessment. This is an alternative to setting the hashed_account_id in
|
|
238
239
|
# CreateAssessment, for example when the account identifier is not yet known
|
|
239
240
|
# in the initial request. It is recommended that the identifier is hashed
|
|
240
241
|
# using hmac-sha256 with stable secret.
|
|
242
|
+
# @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent, ::Hash]
|
|
243
|
+
# Optional. If the assessment is part of a payment transaction, provide
|
|
244
|
+
# details on payment lifecycle events that occur in the transaction.
|
|
241
245
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
242
246
|
# @yieldparam result [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentResponse]
|
|
243
247
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -318,9 +322,9 @@ module Google
|
|
|
318
322
|
# * (`String`) The path to a service account key file in JSON format
|
|
319
323
|
# * (`Hash`) A service account key as a Hash
|
|
320
324
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
321
|
-
# (see the [googleauth docs](https://
|
|
325
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
322
326
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
323
|
-
# (see the [signet docs](https://
|
|
327
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
|
324
328
|
# * (`nil`) indicating no credentials
|
|
325
329
|
# @return [::Object]
|
|
326
330
|
# @!attribute [rw] scope
|
|
@@ -15,11 +15,39 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
15
15
|
optional :parent, :string, 1
|
|
16
16
|
optional :assessment, :message, 2, "google.cloud.recaptchaenterprise.v1beta1.Assessment"
|
|
17
17
|
end
|
|
18
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionEvent" do
|
|
19
|
+
optional :event_type, :enum, 1, "google.cloud.recaptchaenterprise.v1beta1.TransactionEvent.TransactionEventType"
|
|
20
|
+
optional :reason, :string, 2
|
|
21
|
+
optional :value, :double, 3
|
|
22
|
+
optional :event_time, :message, 4, "google.protobuf.Timestamp"
|
|
23
|
+
end
|
|
24
|
+
add_enum "google.cloud.recaptchaenterprise.v1beta1.TransactionEvent.TransactionEventType" do
|
|
25
|
+
value :TRANSACTION_EVENT_TYPE_UNSPECIFIED, 0
|
|
26
|
+
value :MERCHANT_APPROVE, 1
|
|
27
|
+
value :MERCHANT_DENY, 2
|
|
28
|
+
value :MANUAL_REVIEW, 3
|
|
29
|
+
value :AUTHORIZATION, 4
|
|
30
|
+
value :AUTHORIZATION_DECLINE, 5
|
|
31
|
+
value :PAYMENT_CAPTURE, 6
|
|
32
|
+
value :PAYMENT_CAPTURE_DECLINE, 7
|
|
33
|
+
value :CANCEL, 8
|
|
34
|
+
value :CHARGEBACK_INQUIRY, 9
|
|
35
|
+
value :CHARGEBACK_ALERT, 10
|
|
36
|
+
value :FRAUD_NOTIFICATION, 11
|
|
37
|
+
value :CHARGEBACK, 12
|
|
38
|
+
value :CHARGEBACK_REPRESENTMENT, 13
|
|
39
|
+
value :CHARGEBACK_REVERSE, 14
|
|
40
|
+
value :REFUND_REQUEST, 15
|
|
41
|
+
value :REFUND_DECLINE, 16
|
|
42
|
+
value :REFUND, 17
|
|
43
|
+
value :REFUND_REVERSE, 18
|
|
44
|
+
end
|
|
18
45
|
add_message "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest" do
|
|
19
46
|
optional :name, :string, 1
|
|
20
47
|
optional :annotation, :enum, 2, "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation"
|
|
21
48
|
repeated :reasons, :enum, 3, "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Reason"
|
|
22
49
|
optional :hashed_account_id, :bytes, 4
|
|
50
|
+
optional :transaction_event, :message, 5, "google.cloud.recaptchaenterprise.v1beta1.TransactionEvent"
|
|
23
51
|
end
|
|
24
52
|
add_enum "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation" do
|
|
25
53
|
value :ANNOTATION_UNSPECIFIED, 0
|
|
@@ -33,12 +61,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
33
61
|
value :CHARGEBACK, 1
|
|
34
62
|
value :CHARGEBACK_FRAUD, 8
|
|
35
63
|
value :CHARGEBACK_DISPUTE, 9
|
|
64
|
+
value :REFUND, 10
|
|
65
|
+
value :REFUND_FRAUD, 11
|
|
66
|
+
value :TRANSACTION_ACCEPTED, 12
|
|
67
|
+
value :TRANSACTION_DECLINED, 13
|
|
36
68
|
value :PAYMENT_HEURISTICS, 2
|
|
37
69
|
value :INITIATED_TWO_FACTOR, 7
|
|
38
70
|
value :PASSED_TWO_FACTOR, 3
|
|
39
71
|
value :FAILED_TWO_FACTOR, 4
|
|
40
72
|
value :CORRECT_PASSWORD, 5
|
|
41
73
|
value :INCORRECT_PASSWORD, 6
|
|
74
|
+
value :SOCIAL_SPAM, 14
|
|
42
75
|
end
|
|
43
76
|
add_message "google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse" do
|
|
44
77
|
end
|
|
@@ -55,6 +88,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
55
88
|
repeated :reasons, :enum, 5, "google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason"
|
|
56
89
|
optional :password_leak_verification, :message, 7, "google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification"
|
|
57
90
|
optional :account_defender_assessment, :message, 8, "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment"
|
|
91
|
+
optional :fraud_prevention_assessment, :message, 11, "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment"
|
|
58
92
|
end
|
|
59
93
|
add_enum "google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason" do
|
|
60
94
|
value :CLASSIFICATION_REASON_UNSPECIFIED, 0
|
|
@@ -63,6 +97,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
63
97
|
value :TOO_MUCH_TRAFFIC, 3
|
|
64
98
|
value :UNEXPECTED_USAGE_PATTERNS, 4
|
|
65
99
|
value :LOW_CONFIDENCE_SCORE, 5
|
|
100
|
+
value :SUSPECTED_CARDING, 6
|
|
101
|
+
value :SUSPECTED_CHARGEBACK, 7
|
|
66
102
|
end
|
|
67
103
|
add_message "google.cloud.recaptchaenterprise.v1beta1.Event" do
|
|
68
104
|
optional :token, :string, 1
|
|
@@ -71,6 +107,50 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
71
107
|
optional :user_ip_address, :string, 4
|
|
72
108
|
optional :expected_action, :string, 5
|
|
73
109
|
optional :hashed_account_id, :bytes, 6
|
|
110
|
+
optional :transaction_data, :message, 13, "google.cloud.recaptchaenterprise.v1beta1.TransactionData"
|
|
111
|
+
end
|
|
112
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionData" do
|
|
113
|
+
proto3_optional :transaction_id, :string, 11
|
|
114
|
+
optional :payment_method, :string, 1
|
|
115
|
+
optional :card_bin, :string, 2
|
|
116
|
+
optional :card_last_four, :string, 3
|
|
117
|
+
optional :currency_code, :string, 4
|
|
118
|
+
optional :value, :double, 5
|
|
119
|
+
optional :shipping_value, :double, 12
|
|
120
|
+
optional :shipping_address, :message, 6, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address"
|
|
121
|
+
optional :billing_address, :message, 7, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address"
|
|
122
|
+
optional :user, :message, 8, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.User"
|
|
123
|
+
repeated :merchants, :message, 13, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.User"
|
|
124
|
+
repeated :items, :message, 14, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.Item"
|
|
125
|
+
optional :gateway_info, :message, 10, "google.cloud.recaptchaenterprise.v1beta1.TransactionData.GatewayInfo"
|
|
126
|
+
end
|
|
127
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address" do
|
|
128
|
+
optional :recipient, :string, 1
|
|
129
|
+
repeated :address, :string, 2
|
|
130
|
+
optional :locality, :string, 3
|
|
131
|
+
optional :administrative_area, :string, 4
|
|
132
|
+
optional :region_code, :string, 5
|
|
133
|
+
optional :postal_code, :string, 6
|
|
134
|
+
end
|
|
135
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionData.User" do
|
|
136
|
+
optional :account_id, :string, 6
|
|
137
|
+
optional :creation_ms, :int64, 1
|
|
138
|
+
optional :email, :string, 2
|
|
139
|
+
optional :email_verified, :bool, 3
|
|
140
|
+
optional :phone_number, :string, 4
|
|
141
|
+
optional :phone_verified, :bool, 5
|
|
142
|
+
end
|
|
143
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionData.Item" do
|
|
144
|
+
optional :name, :string, 1
|
|
145
|
+
optional :value, :double, 2
|
|
146
|
+
optional :quantity, :int64, 3
|
|
147
|
+
optional :merchant_account_id, :string, 4
|
|
148
|
+
end
|
|
149
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.TransactionData.GatewayInfo" do
|
|
150
|
+
optional :name, :string, 1
|
|
151
|
+
optional :gateway_response_code, :string, 2
|
|
152
|
+
optional :avs_response_code, :string, 3
|
|
153
|
+
optional :cvv_response_code, :string, 4
|
|
74
154
|
end
|
|
75
155
|
add_message "google.cloud.recaptchaenterprise.v1beta1.TokenProperties" do
|
|
76
156
|
optional :valid, :bool, 1
|
|
@@ -89,6 +169,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
89
169
|
value :MISSING, 6
|
|
90
170
|
value :BROWSER_ERROR, 7
|
|
91
171
|
end
|
|
172
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment" do
|
|
173
|
+
optional :transaction_risk, :float, 1
|
|
174
|
+
optional :stolen_instrument_verdict, :message, 2, "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict"
|
|
175
|
+
optional :card_testing_verdict, :message, 3, "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict"
|
|
176
|
+
end
|
|
177
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict" do
|
|
178
|
+
optional :risk, :float, 1
|
|
179
|
+
end
|
|
180
|
+
add_message "google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict" do
|
|
181
|
+
optional :risk, :float, 1
|
|
182
|
+
end
|
|
92
183
|
add_message "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment" do
|
|
93
184
|
repeated :labels, :enum, 1, "google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel"
|
|
94
185
|
end
|
|
@@ -107,6 +198,8 @@ module Google
|
|
|
107
198
|
module RecaptchaEnterprise
|
|
108
199
|
module V1beta1
|
|
109
200
|
CreateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.CreateAssessmentRequest").msgclass
|
|
201
|
+
TransactionEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionEvent").msgclass
|
|
202
|
+
TransactionEvent::TransactionEventType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionEvent.TransactionEventType").enummodule
|
|
110
203
|
AnnotateAssessmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest").msgclass
|
|
111
204
|
AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation").enummodule
|
|
112
205
|
AnnotateAssessmentRequest::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Reason").enummodule
|
|
@@ -115,8 +208,16 @@ module Google
|
|
|
115
208
|
Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Assessment").msgclass
|
|
116
209
|
Assessment::ClassificationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReason").enummodule
|
|
117
210
|
Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.Event").msgclass
|
|
211
|
+
TransactionData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionData").msgclass
|
|
212
|
+
TransactionData::Address = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address").msgclass
|
|
213
|
+
TransactionData::User = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionData.User").msgclass
|
|
214
|
+
TransactionData::Item = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionData.Item").msgclass
|
|
215
|
+
TransactionData::GatewayInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TransactionData.GatewayInfo").msgclass
|
|
118
216
|
TokenProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties").msgclass
|
|
119
217
|
TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.TokenProperties.InvalidReason").enummodule
|
|
218
|
+
FraudPreventionAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment").msgclass
|
|
219
|
+
FraudPreventionAssessment::StolenInstrumentVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict").msgclass
|
|
220
|
+
FraudPreventionAssessment::CardTestingVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict").msgclass
|
|
120
221
|
AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment").msgclass
|
|
121
222
|
AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
|
|
122
223
|
end
|
|
@@ -35,7 +35,9 @@ module Google
|
|
|
35
35
|
# Details about how and where to publish client libraries.
|
|
36
36
|
# @!attribute [rw] version
|
|
37
37
|
# @return [::String]
|
|
38
|
-
# Version of the API to apply these settings to.
|
|
38
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
|
39
|
+
# package for the API, ending in the version element.
|
|
40
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
|
39
41
|
# @!attribute [rw] launch_stage
|
|
40
42
|
# @return [::Google::Api::LaunchStage]
|
|
41
43
|
# Launch stage of this version of the API.
|
|
@@ -111,6 +113,10 @@ module Google
|
|
|
111
113
|
# Client library settings. If the same version string appears multiple
|
|
112
114
|
# times in this list, then the last one wins. Settings from earlier
|
|
113
115
|
# settings with the same version string are discarded.
|
|
116
|
+
# @!attribute [rw] proto_reference_documentation_uri
|
|
117
|
+
# @return [::String]
|
|
118
|
+
# Optional link to proto reference documentation. Example:
|
|
119
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
|
114
120
|
class Publishing
|
|
115
121
|
include ::Google::Protobuf::MessageExts
|
|
116
122
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -240,8 +246,8 @@ module Google
|
|
|
240
246
|
# Example of a YAML configuration::
|
|
241
247
|
#
|
|
242
248
|
# publishing:
|
|
243
|
-
#
|
|
244
|
-
# - selector:
|
|
249
|
+
# method_settings:
|
|
250
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
|
245
251
|
# long_running:
|
|
246
252
|
# initial_poll_delay:
|
|
247
253
|
# seconds: 60 # 1 minute
|
|
@@ -34,6 +34,127 @@ module Google
|
|
|
34
34
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
+
# Describes an event in the lifecycle of a payment transaction.
|
|
38
|
+
# @!attribute [rw] event_type
|
|
39
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent::TransactionEventType]
|
|
40
|
+
# Optional. The type of this transaction event.
|
|
41
|
+
# @!attribute [rw] reason
|
|
42
|
+
# @return [::String]
|
|
43
|
+
# Optional. The reason or standardized code that corresponds with this
|
|
44
|
+
# transaction event, if one exists. For example, a CHARGEBACK event with code
|
|
45
|
+
# 6005.
|
|
46
|
+
# @!attribute [rw] value
|
|
47
|
+
# @return [::Float]
|
|
48
|
+
# Optional. The value that corresponds with this transaction event, if one
|
|
49
|
+
# exists. For example, a refund event where $5.00 was refunded. Currency is
|
|
50
|
+
# obtained from the original transaction data.
|
|
51
|
+
# @!attribute [rw] event_time
|
|
52
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
53
|
+
# Optional. Timestamp when this transaction event occurred; otherwise assumed
|
|
54
|
+
# to be the time of the API call.
|
|
55
|
+
class TransactionEvent
|
|
56
|
+
include ::Google::Protobuf::MessageExts
|
|
57
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
58
|
+
|
|
59
|
+
# Enum that represents an event in the payment transaction lifecycle.
|
|
60
|
+
module TransactionEventType
|
|
61
|
+
# Default, unspecified event type.
|
|
62
|
+
TRANSACTION_EVENT_TYPE_UNSPECIFIED = 0
|
|
63
|
+
|
|
64
|
+
# Indicates that the transaction is approved by the merchant. The
|
|
65
|
+
# accompanying reasons can include terms such as 'INHOUSE', 'ACCERTIFY',
|
|
66
|
+
# 'CYBERSOURCE', or 'MANUAL_REVIEW'.
|
|
67
|
+
MERCHANT_APPROVE = 1
|
|
68
|
+
|
|
69
|
+
# Indicates that the transaction is denied and concluded due to risks
|
|
70
|
+
# detected by the merchant. The accompanying reasons can include terms such
|
|
71
|
+
# as 'INHOUSE', 'ACCERTIFY', 'CYBERSOURCE', or 'MANUAL_REVIEW'.
|
|
72
|
+
MERCHANT_DENY = 2
|
|
73
|
+
|
|
74
|
+
# Indicates that the transaction is being evaluated by a human, due to
|
|
75
|
+
# suspicion or risk.
|
|
76
|
+
MANUAL_REVIEW = 3
|
|
77
|
+
|
|
78
|
+
# Indicates that the authorization attempt with the card issuer succeeded.
|
|
79
|
+
AUTHORIZATION = 4
|
|
80
|
+
|
|
81
|
+
# Indicates that the authorization attempt with the card issuer failed.
|
|
82
|
+
# The accompanying reasons can include Visa's '54' indicating that the card
|
|
83
|
+
# is expired, or '82' indicating that the CVV is incorrect.
|
|
84
|
+
AUTHORIZATION_DECLINE = 5
|
|
85
|
+
|
|
86
|
+
# Indicates that the transaction is completed because the funds were
|
|
87
|
+
# settled.
|
|
88
|
+
PAYMENT_CAPTURE = 6
|
|
89
|
+
|
|
90
|
+
# Indicates that the transaction could not be completed because the funds
|
|
91
|
+
# were not settled.
|
|
92
|
+
PAYMENT_CAPTURE_DECLINE = 7
|
|
93
|
+
|
|
94
|
+
# Indicates that the transaction has been canceled. Specify the reason
|
|
95
|
+
# for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.
|
|
96
|
+
CANCEL = 8
|
|
97
|
+
|
|
98
|
+
# Indicates that the merchant has received a chargeback inquiry due to
|
|
99
|
+
# fraud for the transaction, requesting additional information before a
|
|
100
|
+
# fraud chargeback is officially issued and a formal chargeback
|
|
101
|
+
# notification is sent.
|
|
102
|
+
CHARGEBACK_INQUIRY = 9
|
|
103
|
+
|
|
104
|
+
# Indicates that the merchant has received a chargeback alert due to fraud
|
|
105
|
+
# for the transaction. The process of resolving the dispute without
|
|
106
|
+
# involving the payment network is started.
|
|
107
|
+
CHARGEBACK_ALERT = 10
|
|
108
|
+
|
|
109
|
+
# Indicates that a fraud notification is issued for the transaction, sent
|
|
110
|
+
# by the payment instrument's issuing bank because the transaction appears
|
|
111
|
+
# to be fraudulent. We recommend including TC40 or SAFE data in the
|
|
112
|
+
# `reason` field for this event type. For partial chargebacks, we recommend
|
|
113
|
+
# that you include an amount in the `value` field.
|
|
114
|
+
FRAUD_NOTIFICATION = 11
|
|
115
|
+
|
|
116
|
+
# Indicates that the merchant is informed by the payment network that the
|
|
117
|
+
# transaction has entered the chargeback process due to fraud. Reason code
|
|
118
|
+
# examples include Discover's '6005' and '6041'. For partial chargebacks,
|
|
119
|
+
# we recommend that you include an amount in the `value` field.
|
|
120
|
+
CHARGEBACK = 12
|
|
121
|
+
|
|
122
|
+
# Indicates that the transaction has entered the chargeback process due to
|
|
123
|
+
# fraud, and that the merchant has chosen to enter representment. Reason
|
|
124
|
+
# examples include Discover's '6005' and '6041'. For partial chargebacks,
|
|
125
|
+
# we recommend that you include an amount in the `value` field.
|
|
126
|
+
CHARGEBACK_REPRESENTMENT = 13
|
|
127
|
+
|
|
128
|
+
# Indicates that the transaction has had a fraud chargeback which was
|
|
129
|
+
# illegitimate and was reversed as a result. For partial chargebacks, we
|
|
130
|
+
# recommend that you include an amount in the `value` field.
|
|
131
|
+
CHARGEBACK_REVERSE = 14
|
|
132
|
+
|
|
133
|
+
# Indicates that the merchant has received a refund for a completed
|
|
134
|
+
# transaction. For partial refunds, we recommend that you include an amount
|
|
135
|
+
# in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of
|
|
136
|
+
# exempt tax)
|
|
137
|
+
REFUND_REQUEST = 15
|
|
138
|
+
|
|
139
|
+
# Indicates that the merchant has received a refund request for this
|
|
140
|
+
# transaction, but that they have declined it. For partial refunds, we
|
|
141
|
+
# recommend that you include an amount in the `value` field. Reason
|
|
142
|
+
# example: 'TAX_EXEMPT' (partial refund of exempt tax)
|
|
143
|
+
REFUND_DECLINE = 16
|
|
144
|
+
|
|
145
|
+
# Indicates that the completed transaction was refunded by the merchant.
|
|
146
|
+
# For partial refunds, we recommend that you include an amount in the
|
|
147
|
+
# `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt
|
|
148
|
+
# tax)
|
|
149
|
+
REFUND = 17
|
|
150
|
+
|
|
151
|
+
# Indicates that the completed transaction was refunded by the merchant,
|
|
152
|
+
# and that this refund was reversed. For partial refunds, we recommend that
|
|
153
|
+
# you include an amount in the `value` field.
|
|
154
|
+
REFUND_REVERSE = 18
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
|
|
37
158
|
# The request message to annotate an Assessment.
|
|
38
159
|
# @!attribute [rw] name
|
|
39
160
|
# @return [::String]
|
|
@@ -41,19 +162,24 @@ module Google
|
|
|
41
162
|
# "projects/\\{project_number}/assessments/\\{assessment_id}".
|
|
42
163
|
# @!attribute [rw] annotation
|
|
43
164
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
|
|
44
|
-
# Optional. The annotation that will be assigned to the Event. This field can
|
|
45
|
-
# empty to provide reasons that apply to an event without concluding
|
|
46
|
-
# the event is legitimate or fraudulent.
|
|
165
|
+
# Optional. The annotation that will be assigned to the Event. This field can
|
|
166
|
+
# be left empty to provide reasons that apply to an event without concluding
|
|
167
|
+
# whether the event is legitimate or fraudulent.
|
|
47
168
|
# @!attribute [rw] reasons
|
|
48
169
|
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
|
|
49
|
-
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
170
|
+
# Optional. Optional reasons for the annotation that will be assigned to the
|
|
171
|
+
# Event.
|
|
50
172
|
# @!attribute [rw] hashed_account_id
|
|
51
173
|
# @return [::String]
|
|
52
|
-
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
53
|
-
# This is an alternative to setting the hashed_account_id in
|
|
174
|
+
# Optional. Optional unique stable hashed user identifier to apply to the
|
|
175
|
+
# assessment. This is an alternative to setting the hashed_account_id in
|
|
54
176
|
# CreateAssessment, for example when the account identifier is not yet known
|
|
55
177
|
# in the initial request. It is recommended that the identifier is hashed
|
|
56
178
|
# using hmac-sha256 with stable secret.
|
|
179
|
+
# @!attribute [rw] transaction_event
|
|
180
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent]
|
|
181
|
+
# Optional. If the assessment is part of a payment transaction, provide
|
|
182
|
+
# details on payment lifecycle events that occur in the transaction.
|
|
57
183
|
class AnnotateAssessmentRequest
|
|
58
184
|
include ::Google::Protobuf::MessageExts
|
|
59
185
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -85,21 +211,38 @@ module Google
|
|
|
85
211
|
# Default unspecified reason.
|
|
86
212
|
REASON_UNSPECIFIED = 0
|
|
87
213
|
|
|
88
|
-
# Indicates a chargeback issued
|
|
89
|
-
# When possible, specify the type by using CHARGEBACK_FRAUD or
|
|
214
|
+
# Indicates that the transaction had a chargeback issued with no other
|
|
215
|
+
# details. When possible, specify the type by using CHARGEBACK_FRAUD or
|
|
90
216
|
# CHARGEBACK_DISPUTE instead.
|
|
91
217
|
CHARGEBACK = 1
|
|
92
218
|
|
|
93
|
-
# Indicates a chargeback related to an
|
|
94
|
-
# from the cardholder's perspective (for
|
|
95
|
-
# stolen).
|
|
219
|
+
# Indicates that the transaction had a chargeback issued related to an
|
|
220
|
+
# alleged unauthorized transaction from the cardholder's perspective (for
|
|
221
|
+
# example, the card number was stolen).
|
|
96
222
|
CHARGEBACK_FRAUD = 8
|
|
97
223
|
|
|
98
|
-
# Indicates a chargeback related to the
|
|
99
|
-
# card details but allegedly not being
|
|
100
|
-
# (for example, misrepresentation, attempted
|
|
224
|
+
# Indicates that the transaction had a chargeback issued related to the
|
|
225
|
+
# cardholder having provided their card details but allegedly not being
|
|
226
|
+
# satisfied with the purchase (for example, misrepresentation, attempted
|
|
227
|
+
# cancellation).
|
|
101
228
|
CHARGEBACK_DISPUTE = 9
|
|
102
229
|
|
|
230
|
+
# Indicates that the completed payment transaction was refunded by the
|
|
231
|
+
# seller.
|
|
232
|
+
REFUND = 10
|
|
233
|
+
|
|
234
|
+
# Indicates that the completed payment transaction was determined to be
|
|
235
|
+
# fraudulent by the seller, and was cancelled and refunded as a result.
|
|
236
|
+
REFUND_FRAUD = 11
|
|
237
|
+
|
|
238
|
+
# Indicates that the payment transaction was accepted, and the user was
|
|
239
|
+
# charged.
|
|
240
|
+
TRANSACTION_ACCEPTED = 12
|
|
241
|
+
|
|
242
|
+
# Indicates that the payment transaction was declined, for example due to
|
|
243
|
+
# invalid card details.
|
|
244
|
+
TRANSACTION_DECLINED = 13
|
|
245
|
+
|
|
103
246
|
# Indicates the transaction associated with the assessment is suspected of
|
|
104
247
|
# being fraudulent based on the payment method, billing details, shipping
|
|
105
248
|
# address or other transaction information.
|
|
@@ -122,6 +265,10 @@ module Google
|
|
|
122
265
|
|
|
123
266
|
# Indicates the user provided an incorrect password.
|
|
124
267
|
INCORRECT_PASSWORD = 6
|
|
268
|
+
|
|
269
|
+
# Indicates that the user sent unwanted and abusive messages to other users
|
|
270
|
+
# of the platform, such as spam, scams, phishing, or social engineering.
|
|
271
|
+
SOCIAL_SPAM = 14
|
|
125
272
|
end
|
|
126
273
|
end
|
|
127
274
|
|
|
@@ -134,22 +281,23 @@ module Google
|
|
|
134
281
|
# Password leak verification info.
|
|
135
282
|
# @!attribute [rw] hashed_user_credentials
|
|
136
283
|
# @return [::String]
|
|
137
|
-
# Optional. Scrypt hash of the username+password that the customer wants to
|
|
138
|
-
# against a known password leak.
|
|
284
|
+
# Optional. Scrypt hash of the username+password that the customer wants to
|
|
285
|
+
# verify against a known password leak.
|
|
139
286
|
# @!attribute [r] credentials_leaked
|
|
140
287
|
# @return [::Boolean]
|
|
141
|
-
# Output only. Whether or not the user's credentials are present in a known
|
|
288
|
+
# Output only. Whether or not the user's credentials are present in a known
|
|
289
|
+
# leak.
|
|
142
290
|
# @!attribute [rw] canonicalized_username
|
|
143
291
|
# @return [::String]
|
|
144
|
-
# Optional. The username part of the user credentials for which we want to
|
|
145
|
-
# leak check in canonicalized form. This is the same data used to
|
|
146
|
-
# hashed_user_credentials on the customer side.
|
|
292
|
+
# Optional. The username part of the user credentials for which we want to
|
|
293
|
+
# trigger a leak check in canonicalized form. This is the same data used to
|
|
294
|
+
# create the hashed_user_credentials on the customer side.
|
|
147
295
|
class PasswordLeakVerification
|
|
148
296
|
include ::Google::Protobuf::MessageExts
|
|
149
297
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
150
298
|
end
|
|
151
299
|
|
|
152
|
-
# A
|
|
300
|
+
# A reCAPTCHA Enterprise assessment resource.
|
|
153
301
|
# @!attribute [r] name
|
|
154
302
|
# @return [::String]
|
|
155
303
|
# Output only. The resource name for the Assessment in the format
|
|
@@ -176,8 +324,11 @@ module Google
|
|
|
176
324
|
# environment.
|
|
177
325
|
# @!attribute [rw] account_defender_assessment
|
|
178
326
|
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AccountDefenderAssessment]
|
|
179
|
-
# Assessment returned by
|
|
327
|
+
# Assessment returned by account defender when a hashed_account_id is
|
|
180
328
|
# provided.
|
|
329
|
+
# @!attribute [rw] fraud_prevention_assessment
|
|
330
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment]
|
|
331
|
+
# Assessment returned by Fraud Prevention when TransactionData is provided.
|
|
181
332
|
class Assessment
|
|
182
333
|
include ::Google::Protobuf::MessageExts
|
|
183
334
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -203,38 +354,202 @@ module Google
|
|
|
203
354
|
# Too little traffic has been received from this site thus far to generate
|
|
204
355
|
# quality risk analysis.
|
|
205
356
|
LOW_CONFIDENCE_SCORE = 5
|
|
357
|
+
|
|
358
|
+
# The request matches behavioral characteristics of a carding attack.
|
|
359
|
+
SUSPECTED_CARDING = 6
|
|
360
|
+
|
|
361
|
+
# The request matches behavioral characteristics of chargebacks for fraud.
|
|
362
|
+
SUSPECTED_CHARGEBACK = 7
|
|
206
363
|
end
|
|
207
364
|
end
|
|
208
365
|
|
|
209
366
|
# @!attribute [rw] token
|
|
210
367
|
# @return [::String]
|
|
211
|
-
# Optional. The user response token provided by the reCAPTCHA
|
|
212
|
-
# on your site.
|
|
368
|
+
# Optional. The user response token provided by the reCAPTCHA Enterprise
|
|
369
|
+
# client-side integration on your site.
|
|
213
370
|
# @!attribute [rw] site_key
|
|
214
371
|
# @return [::String]
|
|
215
|
-
# Optional. The site key that was used to invoke reCAPTCHA on your
|
|
216
|
-
# the token.
|
|
372
|
+
# Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
|
|
373
|
+
# site and generate the token.
|
|
217
374
|
# @!attribute [rw] user_agent
|
|
218
375
|
# @return [::String]
|
|
219
|
-
# Optional. The user agent present in the request from the user's device
|
|
220
|
-
# this event.
|
|
376
|
+
# Optional. The user agent present in the request from the user's device
|
|
377
|
+
# related to this event.
|
|
221
378
|
# @!attribute [rw] user_ip_address
|
|
222
379
|
# @return [::String]
|
|
223
|
-
# Optional. The IP address in the request from the user's device related to
|
|
380
|
+
# Optional. The IP address in the request from the user's device related to
|
|
381
|
+
# this event.
|
|
224
382
|
# @!attribute [rw] expected_action
|
|
225
383
|
# @return [::String]
|
|
226
|
-
# Optional. The expected action for this type of event. This should be the
|
|
227
|
-
# provided at token generation time on client-side platforms
|
|
228
|
-
# integrated with recaptcha enterprise.
|
|
384
|
+
# Optional. The expected action for this type of event. This should be the
|
|
385
|
+
# same action provided at token generation time on client-side platforms
|
|
386
|
+
# already integrated with recaptcha enterprise.
|
|
229
387
|
# @!attribute [rw] hashed_account_id
|
|
230
388
|
# @return [::String]
|
|
231
|
-
# Optional.
|
|
232
|
-
# identifier
|
|
389
|
+
# Optional. Unique stable hashed user identifier for the request. The
|
|
390
|
+
# identifier must be hashed using hmac-sha256 with stable secret.
|
|
391
|
+
# @!attribute [rw] transaction_data
|
|
392
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData]
|
|
393
|
+
# Optional. Data describing a payment transaction to be assessed. Sending
|
|
394
|
+
# this data enables reCAPTCHA Enterprise Fraud Prevention and the
|
|
395
|
+
# FraudPreventionAssessment component in the response.
|
|
233
396
|
class Event
|
|
234
397
|
include ::Google::Protobuf::MessageExts
|
|
235
398
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
236
399
|
end
|
|
237
400
|
|
|
401
|
+
# Transaction data associated with a payment protected by reCAPTCHA Enterprise.
|
|
402
|
+
# All fields are optional.
|
|
403
|
+
# @!attribute [rw] transaction_id
|
|
404
|
+
# @return [::String]
|
|
405
|
+
# Unique identifier for the transaction. This custom identifier can be used
|
|
406
|
+
# to reference this transaction in the future, for example, labeling a refund
|
|
407
|
+
# or chargeback event. Two attempts at the same transaction should use the
|
|
408
|
+
# same transaction id.
|
|
409
|
+
# @!attribute [rw] payment_method
|
|
410
|
+
# @return [::String]
|
|
411
|
+
# The payment method for the transaction. The allowed values are:
|
|
412
|
+
#
|
|
413
|
+
# * credit-card
|
|
414
|
+
# * debit-card
|
|
415
|
+
# * gift-card
|
|
416
|
+
# * processor-\\{name} (If a third-party is used, for example,
|
|
417
|
+
# processor-paypal)
|
|
418
|
+
# * custom-\\{name} (If an alternative method is used, for example,
|
|
419
|
+
# custom-crypto)
|
|
420
|
+
# @!attribute [rw] card_bin
|
|
421
|
+
# @return [::String]
|
|
422
|
+
# The Bank Identification Number - generally the first 6 or 8 digits of the
|
|
423
|
+
# card.
|
|
424
|
+
# @!attribute [rw] card_last_four
|
|
425
|
+
# @return [::String]
|
|
426
|
+
# The last four digits of the card.
|
|
427
|
+
# @!attribute [rw] currency_code
|
|
428
|
+
# @return [::String]
|
|
429
|
+
# The currency code in ISO-4217 format.
|
|
430
|
+
# @!attribute [rw] value
|
|
431
|
+
# @return [::Float]
|
|
432
|
+
# The decimal value of the transaction in the specified currency.
|
|
433
|
+
# @!attribute [rw] shipping_value
|
|
434
|
+
# @return [::Float]
|
|
435
|
+
# The value of shipping in the specified currency. 0 for free or no shipping.
|
|
436
|
+
# @!attribute [rw] shipping_address
|
|
437
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address]
|
|
438
|
+
# Destination address if this transaction involves shipping a physical item.
|
|
439
|
+
# @!attribute [rw] billing_address
|
|
440
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Address]
|
|
441
|
+
# Address associated with the payment method when applicable.
|
|
442
|
+
# @!attribute [rw] user
|
|
443
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User]
|
|
444
|
+
# Information about the user paying/initiating the transaction.
|
|
445
|
+
# @!attribute [rw] merchants
|
|
446
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::User>]
|
|
447
|
+
# Information about the user or users fulfilling the transaction.
|
|
448
|
+
# @!attribute [rw] items
|
|
449
|
+
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::Item>]
|
|
450
|
+
# Items purchased in this transaction.
|
|
451
|
+
# @!attribute [rw] gateway_info
|
|
452
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData::GatewayInfo]
|
|
453
|
+
# Information about the payment gateway's response to the transaction.
|
|
454
|
+
class TransactionData
|
|
455
|
+
include ::Google::Protobuf::MessageExts
|
|
456
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
457
|
+
|
|
458
|
+
# Structured address format for billing and shipping addresses.
|
|
459
|
+
# @!attribute [rw] recipient
|
|
460
|
+
# @return [::String]
|
|
461
|
+
# The recipient name, potentially including information such as "care of".
|
|
462
|
+
# @!attribute [rw] address
|
|
463
|
+
# @return [::Array<::String>]
|
|
464
|
+
# The first lines of the address. The first line generally contains the
|
|
465
|
+
# street name and number, and further lines may include information such as
|
|
466
|
+
# an apartment number.
|
|
467
|
+
# @!attribute [rw] locality
|
|
468
|
+
# @return [::String]
|
|
469
|
+
# The town/city of the address.
|
|
470
|
+
# @!attribute [rw] administrative_area
|
|
471
|
+
# @return [::String]
|
|
472
|
+
# The state, province, or otherwise administrative area of the address.
|
|
473
|
+
# @!attribute [rw] region_code
|
|
474
|
+
# @return [::String]
|
|
475
|
+
# The CLDR country/region of the address.
|
|
476
|
+
# @!attribute [rw] postal_code
|
|
477
|
+
# @return [::String]
|
|
478
|
+
# The postal or ZIP code of the address.
|
|
479
|
+
class Address
|
|
480
|
+
include ::Google::Protobuf::MessageExts
|
|
481
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
# Details about a user's account involved in the transaction.
|
|
485
|
+
# @!attribute [rw] account_id
|
|
486
|
+
# @return [::String]
|
|
487
|
+
# Unique account identifier for this user. If using account defender,
|
|
488
|
+
# this should match the hashed_account_id field. Otherwise, a unique and
|
|
489
|
+
# persistent identifier for this account.
|
|
490
|
+
# @!attribute [rw] creation_ms
|
|
491
|
+
# @return [::Integer]
|
|
492
|
+
# The epoch milliseconds of the user's account creation.
|
|
493
|
+
# @!attribute [rw] email
|
|
494
|
+
# @return [::String]
|
|
495
|
+
# The email address of the user.
|
|
496
|
+
# @!attribute [rw] email_verified
|
|
497
|
+
# @return [::Boolean]
|
|
498
|
+
# Whether the email has been verified to be accessible by the user (OTP or
|
|
499
|
+
# similar).
|
|
500
|
+
# @!attribute [rw] phone_number
|
|
501
|
+
# @return [::String]
|
|
502
|
+
# The phone number of the user, with country code.
|
|
503
|
+
# @!attribute [rw] phone_verified
|
|
504
|
+
# @return [::Boolean]
|
|
505
|
+
# Whether the phone number has been verified to be accessible by the user
|
|
506
|
+
# (OTP or similar).
|
|
507
|
+
class User
|
|
508
|
+
include ::Google::Protobuf::MessageExts
|
|
509
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
510
|
+
end
|
|
511
|
+
|
|
512
|
+
# Line items being purchased in this transaction.
|
|
513
|
+
# @!attribute [rw] name
|
|
514
|
+
# @return [::String]
|
|
515
|
+
# The full name of the item.
|
|
516
|
+
# @!attribute [rw] value
|
|
517
|
+
# @return [::Float]
|
|
518
|
+
# The value per item that the user is paying, in the transaction currency,
|
|
519
|
+
# after discounts.
|
|
520
|
+
# @!attribute [rw] quantity
|
|
521
|
+
# @return [::Integer]
|
|
522
|
+
# The quantity of this item that is being purchased.
|
|
523
|
+
# @!attribute [rw] merchant_account_id
|
|
524
|
+
# @return [::String]
|
|
525
|
+
# When a merchant is specified, its corresponding account_id. Necessary to
|
|
526
|
+
# populate marketplace-style transactions.
|
|
527
|
+
class Item
|
|
528
|
+
include ::Google::Protobuf::MessageExts
|
|
529
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
530
|
+
end
|
|
531
|
+
|
|
532
|
+
# Details about the transaction from the gateway.
|
|
533
|
+
# @!attribute [rw] name
|
|
534
|
+
# @return [::String]
|
|
535
|
+
# Name of the gateway service (for example, stripe, square, paypal).
|
|
536
|
+
# @!attribute [rw] gateway_response_code
|
|
537
|
+
# @return [::String]
|
|
538
|
+
# Gateway response code describing the state of the transaction.
|
|
539
|
+
# @!attribute [rw] avs_response_code
|
|
540
|
+
# @return [::String]
|
|
541
|
+
# AVS response code from the gateway
|
|
542
|
+
# (available only when reCAPTCHA Enterprise is called after authorization).
|
|
543
|
+
# @!attribute [rw] cvv_response_code
|
|
544
|
+
# @return [::String]
|
|
545
|
+
# CVV response code from the gateway
|
|
546
|
+
# (available only when reCAPTCHA Enterprise is called after authorization).
|
|
547
|
+
class GatewayInfo
|
|
548
|
+
include ::Google::Protobuf::MessageExts
|
|
549
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
550
|
+
end
|
|
551
|
+
end
|
|
552
|
+
|
|
238
553
|
# @!attribute [rw] valid
|
|
239
554
|
# @return [::Boolean]
|
|
240
555
|
# Whether the provided user response token is valid. When valid = false, the
|
|
@@ -276,7 +591,7 @@ module Google
|
|
|
276
591
|
DUPE = 4
|
|
277
592
|
|
|
278
593
|
# The user verification token did not match the provided site key.
|
|
279
|
-
# This may be a configuration error (
|
|
594
|
+
# This may be a configuration error (for example, development keys used in
|
|
280
595
|
# production) or end users trying to use verification tokens from other
|
|
281
596
|
# sites.
|
|
282
597
|
SITE_MISMATCH = 5
|
|
@@ -290,7 +605,46 @@ module Google
|
|
|
290
605
|
end
|
|
291
606
|
end
|
|
292
607
|
|
|
293
|
-
#
|
|
608
|
+
# Assessment for Fraud Prevention.
|
|
609
|
+
# @!attribute [rw] transaction_risk
|
|
610
|
+
# @return [::Float]
|
|
611
|
+
# Probability (0-1) of this transaction being fraudulent. Summarizes the
|
|
612
|
+
# combined risk of attack vectors below.
|
|
613
|
+
# @!attribute [rw] stolen_instrument_verdict
|
|
614
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment::StolenInstrumentVerdict]
|
|
615
|
+
# Assessment of this transaction for risk of a stolen instrument.
|
|
616
|
+
# @!attribute [rw] card_testing_verdict
|
|
617
|
+
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment::CardTestingVerdict]
|
|
618
|
+
# Assessment of this transaction for risk of being part of a card testing
|
|
619
|
+
# attack.
|
|
620
|
+
class FraudPreventionAssessment
|
|
621
|
+
include ::Google::Protobuf::MessageExts
|
|
622
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
623
|
+
|
|
624
|
+
# Information about stolen instrument fraud, where the user is not the
|
|
625
|
+
# legitimate owner of the instrument being used for the purchase.
|
|
626
|
+
# @!attribute [rw] risk
|
|
627
|
+
# @return [::Float]
|
|
628
|
+
# Probability (0-1) of this transaction being executed with a stolen
|
|
629
|
+
# instrument.
|
|
630
|
+
class StolenInstrumentVerdict
|
|
631
|
+
include ::Google::Protobuf::MessageExts
|
|
632
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
633
|
+
end
|
|
634
|
+
|
|
635
|
+
# Information about card testing fraud, where an adversary is testing
|
|
636
|
+
# fraudulently obtained cards or brute forcing their details.
|
|
637
|
+
# @!attribute [rw] risk
|
|
638
|
+
# @return [::Float]
|
|
639
|
+
# Probability (0-1) of this transaction attempt being part of a card
|
|
640
|
+
# testing attack.
|
|
641
|
+
class CardTestingVerdict
|
|
642
|
+
include ::Google::Protobuf::MessageExts
|
|
643
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
644
|
+
end
|
|
645
|
+
end
|
|
646
|
+
|
|
647
|
+
# Account defender risk assessment.
|
|
294
648
|
# @!attribute [rw] labels
|
|
295
649
|
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AccountDefenderAssessment::AccountDefenderLabel>]
|
|
296
650
|
# Labels for this request.
|
|
@@ -298,7 +652,7 @@ module Google
|
|
|
298
652
|
include ::Google::Protobuf::MessageExts
|
|
299
653
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
300
654
|
|
|
301
|
-
# Labels returned by
|
|
655
|
+
# Labels returned by account defender for this request.
|
|
302
656
|
module AccountDefenderLabel
|
|
303
657
|
# Default unspecified type.
|
|
304
658
|
ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-recaptcha_enterprise-v1beta1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.8.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-03-
|
|
11
|
+
date: 2023-03-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
@@ -212,5 +212,6 @@ requirements: []
|
|
|
212
212
|
rubygems_version: 3.4.2
|
|
213
213
|
signing_key:
|
|
214
214
|
specification_version: 4
|
|
215
|
-
summary:
|
|
215
|
+
summary: Help protect your website from fraudulent activity, spam, and abuse without
|
|
216
|
+
creating friction.
|
|
216
217
|
test_files: []
|