google-cloud-recaptcha_enterprise-v1 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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::V1::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,12 +162,13 @@ module Google
41
162
  # "projects/\\{project}/assessments/\\{assessment}".
42
163
  # @!attribute [rw] annotation
43
164
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
44
- # Optional. The annotation that will be assigned to the Event. This field can be left
45
- # empty to provide reasons that apply to an event without concluding whether
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::V1::AnnotateAssessmentRequest::Reason>]
49
- # Optional. Optional reasons for the annotation that will be assigned to the Event.
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
174
  # Optional. Unique stable hashed user identifier to apply to the assessment.
@@ -54,6 +176,10 @@ module Google
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::V1::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
@@ -152,32 +278,117 @@ module Google
152
278
  extend ::Google::Protobuf::MessageExts::ClassMethods
153
279
  end
154
280
 
281
+ # Information about a verification endpoint that can be used for 2FA.
282
+ # @!attribute [rw] email_address
283
+ # @return [::String]
284
+ # Email address for which to trigger a verification request.
285
+ # @!attribute [rw] phone_number
286
+ # @return [::String]
287
+ # Phone number for which to trigger a verification request. Should be given
288
+ # in E.164 format.
289
+ # @!attribute [r] request_token
290
+ # @return [::String]
291
+ # Output only. Token to provide to the client to trigger endpoint
292
+ # verification. It must be used within 15 minutes.
293
+ # @!attribute [r] last_verification_time
294
+ # @return [::Google::Protobuf::Timestamp]
295
+ # Output only. Timestamp of the last successful verification for the
296
+ # endpoint, if any.
297
+ class EndpointVerificationInfo
298
+ include ::Google::Protobuf::MessageExts
299
+ extend ::Google::Protobuf::MessageExts::ClassMethods
300
+ end
301
+
302
+ # Information about account verification, used for identity verification.
303
+ # @!attribute [rw] endpoints
304
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::EndpointVerificationInfo>]
305
+ # Endpoints that can be used for identity verification.
306
+ # @!attribute [rw] language_code
307
+ # @return [::String]
308
+ # Language code preference for the verification message, set as a IETF BCP 47
309
+ # language code.
310
+ # @!attribute [r] latest_verification_result
311
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo::Result]
312
+ # Output only. Result of the latest account verification challenge.
313
+ # @!attribute [rw] username
314
+ # @return [::String]
315
+ # Username of the account that is being verified. Deprecated. Customers
316
+ # should now provide the hashed account ID field in Event.
317
+ class AccountVerificationInfo
318
+ include ::Google::Protobuf::MessageExts
319
+ extend ::Google::Protobuf::MessageExts::ClassMethods
320
+
321
+ # Result of the account verification as contained in the verdict token issued
322
+ # at the end of the verification flow.
323
+ module Result
324
+ # No information about the latest account verification.
325
+ RESULT_UNSPECIFIED = 0
326
+
327
+ # The user was successfully verified. This means the account verification
328
+ # challenge was successfully completed.
329
+ SUCCESS_USER_VERIFIED = 1
330
+
331
+ # The user failed the verification challenge.
332
+ ERROR_USER_NOT_VERIFIED = 2
333
+
334
+ # The site is not properly onboarded to use the account verification
335
+ # feature.
336
+ ERROR_SITE_ONBOARDING_INCOMPLETE = 3
337
+
338
+ # The recipient is not allowed for account verification. This can occur
339
+ # during integration but should not occur in production.
340
+ ERROR_RECIPIENT_NOT_ALLOWED = 4
341
+
342
+ # The recipient has already been sent too many verification codes in a
343
+ # short amount of time.
344
+ ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED = 5
345
+
346
+ # The verification flow could not be completed due to a critical internal
347
+ # error.
348
+ ERROR_CRITICAL_INTERNAL = 6
349
+
350
+ # The client has exceeded their two factor request quota for this period of
351
+ # time.
352
+ ERROR_CUSTOMER_QUOTA_EXHAUSTED = 7
353
+
354
+ # The request cannot be processed at the time because of an incident. This
355
+ # bypass can be restricted to a problematic destination email domain, a
356
+ # customer, or could affect the entire service.
357
+ ERROR_VERIFICATION_BYPASSED = 8
358
+
359
+ # The request parameters do not match with the token provided and cannot be
360
+ # processed.
361
+ ERROR_VERDICT_MISMATCH = 9
362
+ end
363
+ end
364
+
155
365
  # Private password leak verification info.
156
366
  # @!attribute [rw] lookup_hash_prefix
157
367
  # @return [::String]
158
- # Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It
159
- # is used to look up password leaks associated with that hash prefix.
368
+ # Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
369
+ # username. It is used to look up password leaks associated with that hash
370
+ # prefix.
160
371
  # @!attribute [rw] encrypted_user_credentials_hash
161
372
  # @return [::String]
162
- # Optional. Encrypted Scrypt hash of the canonicalized username+password. It is
163
- # re-encrypted by the server and returned through
373
+ # Optional. Encrypted Scrypt hash of the canonicalized username+password. It
374
+ # is re-encrypted by the server and returned through
164
375
  # `reencrypted_user_credentials_hash`.
165
376
  # @!attribute [r] encrypted_leak_match_prefixes
166
377
  # @return [::Array<::String>]
167
- # Output only. List of prefixes of the encrypted potential password leaks that matched the
168
- # given parameters. They must be compared with the client-side decryption
169
- # prefix of `reencrypted_user_credentials_hash`
378
+ # Output only. List of prefixes of the encrypted potential password leaks
379
+ # that matched the given parameters. They must be compared with the
380
+ # client-side decryption prefix of `reencrypted_user_credentials_hash`
170
381
  # @!attribute [r] reencrypted_user_credentials_hash
171
382
  # @return [::String]
172
- # Output only. Corresponds to the re-encryption of the `encrypted_user_credentials_hash`
173
- # field. It is used to match potential password leaks within
174
- # `encrypted_leak_match_prefixes`.
383
+ # Output only. Corresponds to the re-encryption of the
384
+ # `encrypted_user_credentials_hash` field. It is used to match potential
385
+ # password leaks within `encrypted_leak_match_prefixes`.
175
386
  class PrivatePasswordLeakVerification
176
387
  include ::Google::Protobuf::MessageExts
177
388
  extend ::Google::Protobuf::MessageExts::ClassMethods
178
389
  end
179
390
 
180
- # A recaptcha assessment resource.
391
+ # A reCAPTCHA Enterprise assessment resource.
181
392
  # @!attribute [r] name
182
393
  # @return [::String]
183
394
  # Output only. The resource name for the Assessment in the format
@@ -191,6 +402,10 @@ module Google
191
402
  # @!attribute [r] token_properties
192
403
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties]
193
404
  # Output only. Properties of the provided event token.
405
+ # @!attribute [rw] account_verification
406
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountVerificationInfo]
407
+ # Account verification information for identity verification. The assessment
408
+ # event must include a token and site key to use this feature.
194
409
  # @!attribute [rw] account_defender_assessment
195
410
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
196
411
  # Assessment returned by account defender when a hashed_account_id is
@@ -199,40 +414,202 @@ module Google
199
414
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::PrivatePasswordLeakVerification]
200
415
  # The private password leak verification field contains the parameters that
201
416
  # are used to to check for leaks privately without sharing user credentials.
417
+ # @!attribute [rw] fraud_prevention_assessment
418
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment]
419
+ # Assessment returned by Fraud Prevention when TransactionData is provided.
202
420
  class Assessment
203
421
  include ::Google::Protobuf::MessageExts
204
422
  extend ::Google::Protobuf::MessageExts::ClassMethods
205
423
  end
206
424
 
425
+ # The event being assessed.
207
426
  # @!attribute [rw] token
208
427
  # @return [::String]
209
- # Optional. The user response token provided by the reCAPTCHA client-side integration
210
- # on your site.
428
+ # Optional. The user response token provided by the reCAPTCHA Enterprise
429
+ # client-side integration on your site.
211
430
  # @!attribute [rw] site_key
212
431
  # @return [::String]
213
- # Optional. The site key that was used to invoke reCAPTCHA on your site and generate
214
- # the token.
432
+ # Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
433
+ # site and generate the token.
215
434
  # @!attribute [rw] user_agent
216
435
  # @return [::String]
217
- # Optional. The user agent present in the request from the user's device related to
218
- # this event.
436
+ # Optional. The user agent present in the request from the user's device
437
+ # related to this event.
219
438
  # @!attribute [rw] user_ip_address
220
439
  # @return [::String]
221
- # Optional. The IP address in the request from the user's device related to this event.
440
+ # Optional. The IP address in the request from the user's device related to
441
+ # this event.
222
442
  # @!attribute [rw] expected_action
223
443
  # @return [::String]
224
- # Optional. The expected action for this type of event. This should be the same action
225
- # provided at token generation time on client-side platforms already
226
- # integrated with recaptcha enterprise.
444
+ # Optional. The expected action for this type of event. This should be the
445
+ # same action provided at token generation time on client-side platforms
446
+ # already integrated with recaptcha enterprise.
227
447
  # @!attribute [rw] hashed_account_id
228
448
  # @return [::String]
229
- # Optional. Unique stable hashed user identifier for the request. The identifier must
230
- # be hashed using hmac-sha256 with stable secret.
449
+ # Optional. Unique stable hashed user identifier for the request. The
450
+ # identifier must be hashed using hmac-sha256 with stable secret.
451
+ # @!attribute [rw] transaction_data
452
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData]
453
+ # Optional. Data describing a payment transaction to be assessed. Sending
454
+ # this data enables reCAPTCHA Enterprise Fraud Prevention and the
455
+ # FraudPreventionAssessment component in the response.
231
456
  class Event
232
457
  include ::Google::Protobuf::MessageExts
233
458
  extend ::Google::Protobuf::MessageExts::ClassMethods
234
459
  end
235
460
 
461
+ # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
462
+ # All fields are optional.
463
+ # @!attribute [rw] transaction_id
464
+ # @return [::String]
465
+ # Unique identifier for the transaction. This custom identifier can be used
466
+ # to reference this transaction in the future, for example, labeling a refund
467
+ # or chargeback event. Two attempts at the same transaction should use the
468
+ # same transaction id.
469
+ # @!attribute [rw] payment_method
470
+ # @return [::String]
471
+ # The payment method for the transaction. The allowed values are:
472
+ #
473
+ # * credit-card
474
+ # * debit-card
475
+ # * gift-card
476
+ # * processor-\\{name} (If a third-party is used, for example,
477
+ # processor-paypal)
478
+ # * custom-\\{name} (If an alternative method is used, for example,
479
+ # custom-crypto)
480
+ # @!attribute [rw] card_bin
481
+ # @return [::String]
482
+ # The Bank Identification Number - generally the first 6 or 8 digits of the
483
+ # card.
484
+ # @!attribute [rw] card_last_four
485
+ # @return [::String]
486
+ # The last four digits of the card.
487
+ # @!attribute [rw] currency_code
488
+ # @return [::String]
489
+ # The currency code in ISO-4217 format.
490
+ # @!attribute [rw] value
491
+ # @return [::Float]
492
+ # The decimal value of the transaction in the specified currency.
493
+ # @!attribute [rw] shipping_value
494
+ # @return [::Float]
495
+ # The value of shipping in the specified currency. 0 for free or no shipping.
496
+ # @!attribute [rw] shipping_address
497
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
498
+ # Destination address if this transaction involves shipping a physical item.
499
+ # @!attribute [rw] billing_address
500
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Address]
501
+ # Address associated with the payment method when applicable.
502
+ # @!attribute [rw] user
503
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User]
504
+ # Information about the user paying/initiating the transaction.
505
+ # @!attribute [rw] merchants
506
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::User>]
507
+ # Information about the user or users fulfilling the transaction.
508
+ # @!attribute [rw] items
509
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::Item>]
510
+ # Items purchased in this transaction.
511
+ # @!attribute [rw] gateway_info
512
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::TransactionData::GatewayInfo]
513
+ # Information about the payment gateway's response to the transaction.
514
+ class TransactionData
515
+ include ::Google::Protobuf::MessageExts
516
+ extend ::Google::Protobuf::MessageExts::ClassMethods
517
+
518
+ # Structured address format for billing and shipping addresses.
519
+ # @!attribute [rw] recipient
520
+ # @return [::String]
521
+ # The recipient name, potentially including information such as "care of".
522
+ # @!attribute [rw] address
523
+ # @return [::Array<::String>]
524
+ # The first lines of the address. The first line generally contains the
525
+ # street name and number, and further lines may include information such as
526
+ # an apartment number.
527
+ # @!attribute [rw] locality
528
+ # @return [::String]
529
+ # The town/city of the address.
530
+ # @!attribute [rw] administrative_area
531
+ # @return [::String]
532
+ # The state, province, or otherwise administrative area of the address.
533
+ # @!attribute [rw] region_code
534
+ # @return [::String]
535
+ # The CLDR country/region of the address.
536
+ # @!attribute [rw] postal_code
537
+ # @return [::String]
538
+ # The postal or ZIP code of the address.
539
+ class Address
540
+ include ::Google::Protobuf::MessageExts
541
+ extend ::Google::Protobuf::MessageExts::ClassMethods
542
+ end
543
+
544
+ # Details about a user's account involved in the transaction.
545
+ # @!attribute [rw] account_id
546
+ # @return [::String]
547
+ # Unique account identifier for this user. If using account defender,
548
+ # this should match the hashed_account_id field. Otherwise, a unique and
549
+ # persistent identifier for this account.
550
+ # @!attribute [rw] creation_ms
551
+ # @return [::Integer]
552
+ # The epoch milliseconds of the user's account creation.
553
+ # @!attribute [rw] email
554
+ # @return [::String]
555
+ # The email address of the user.
556
+ # @!attribute [rw] email_verified
557
+ # @return [::Boolean]
558
+ # Whether the email has been verified to be accessible by the user (OTP or
559
+ # similar).
560
+ # @!attribute [rw] phone_number
561
+ # @return [::String]
562
+ # The phone number of the user, with country code.
563
+ # @!attribute [rw] phone_verified
564
+ # @return [::Boolean]
565
+ # Whether the phone number has been verified to be accessible by the user
566
+ # (OTP or similar).
567
+ class User
568
+ include ::Google::Protobuf::MessageExts
569
+ extend ::Google::Protobuf::MessageExts::ClassMethods
570
+ end
571
+
572
+ # Line items being purchased in this transaction.
573
+ # @!attribute [rw] name
574
+ # @return [::String]
575
+ # The full name of the item.
576
+ # @!attribute [rw] value
577
+ # @return [::Float]
578
+ # The value per item that the user is paying, in the transaction currency,
579
+ # after discounts.
580
+ # @!attribute [rw] quantity
581
+ # @return [::Integer]
582
+ # The quantity of this item that is being purchased.
583
+ # @!attribute [rw] merchant_account_id
584
+ # @return [::String]
585
+ # When a merchant is specified, its corresponding account_id. Necessary to
586
+ # populate marketplace-style transactions.
587
+ class Item
588
+ include ::Google::Protobuf::MessageExts
589
+ extend ::Google::Protobuf::MessageExts::ClassMethods
590
+ end
591
+
592
+ # Details about the transaction from the gateway.
593
+ # @!attribute [rw] name
594
+ # @return [::String]
595
+ # Name of the gateway service (for example, stripe, square, paypal).
596
+ # @!attribute [rw] gateway_response_code
597
+ # @return [::String]
598
+ # Gateway response code describing the state of the transaction.
599
+ # @!attribute [rw] avs_response_code
600
+ # @return [::String]
601
+ # AVS response code from the gateway
602
+ # (available only when reCAPTCHA Enterprise is called after authorization).
603
+ # @!attribute [rw] cvv_response_code
604
+ # @return [::String]
605
+ # CVV response code from the gateway
606
+ # (available only when reCAPTCHA Enterprise is called after authorization).
607
+ class GatewayInfo
608
+ include ::Google::Protobuf::MessageExts
609
+ extend ::Google::Protobuf::MessageExts::ClassMethods
610
+ end
611
+ end
612
+
236
613
  # Risk analysis result for an event.
237
614
  # @!attribute [rw] score
238
615
  # @return [::Float]
@@ -267,9 +644,16 @@ module Google
267
644
  # Too little traffic has been received from this site thus far to generate
268
645
  # quality risk analysis.
269
646
  LOW_CONFIDENCE_SCORE = 5
647
+
648
+ # The request matches behavioral characteristics of a carding attack.
649
+ SUSPECTED_CARDING = 6
650
+
651
+ # The request matches behavioral characteristics of chargebacks for fraud.
652
+ SUSPECTED_CHARGEBACK = 7
270
653
  end
271
654
  end
272
655
 
656
+ # Properties of the provided event token.
273
657
  # @!attribute [rw] valid
274
658
  # @return [::Boolean]
275
659
  # Whether the provided user response token is valid. When valid = false, the
@@ -286,6 +670,14 @@ module Google
286
670
  # @!attribute [rw] hostname
287
671
  # @return [::String]
288
672
  # The hostname of the page on which the token was generated (Web keys only).
673
+ # @!attribute [rw] android_package_name
674
+ # @return [::String]
675
+ # The name of the Android package with which the token was generated (Android
676
+ # keys only).
677
+ # @!attribute [rw] ios_bundle_id
678
+ # @return [::String]
679
+ # The ID of the iOS bundle with which the token was generated (iOS keys
680
+ # only).
289
681
  # @!attribute [rw] action
290
682
  # @return [::String]
291
683
  # Action name provided at token generation.
@@ -319,6 +711,45 @@ module Google
319
711
  end
320
712
  end
321
713
 
714
+ # Assessment for Fraud Prevention.
715
+ # @!attribute [rw] transaction_risk
716
+ # @return [::Float]
717
+ # Probability (0-1) of this transaction being fraudulent. Summarizes the
718
+ # combined risk of attack vectors below.
719
+ # @!attribute [rw] stolen_instrument_verdict
720
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::StolenInstrumentVerdict]
721
+ # Assessment of this transaction for risk of a stolen instrument.
722
+ # @!attribute [rw] card_testing_verdict
723
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::FraudPreventionAssessment::CardTestingVerdict]
724
+ # Assessment of this transaction for risk of being part of a card testing
725
+ # attack.
726
+ class FraudPreventionAssessment
727
+ include ::Google::Protobuf::MessageExts
728
+ extend ::Google::Protobuf::MessageExts::ClassMethods
729
+
730
+ # Information about stolen instrument fraud, where the user is not the
731
+ # legitimate owner of the instrument being used for the purchase.
732
+ # @!attribute [rw] risk
733
+ # @return [::Float]
734
+ # Probability (0-1) of this transaction being executed with a stolen
735
+ # instrument.
736
+ class StolenInstrumentVerdict
737
+ include ::Google::Protobuf::MessageExts
738
+ extend ::Google::Protobuf::MessageExts::ClassMethods
739
+ end
740
+
741
+ # Information about card testing fraud, where an adversary is testing
742
+ # fraudulently obtained cards or brute forcing their details.
743
+ # @!attribute [rw] risk
744
+ # @return [::Float]
745
+ # Probability (0-1) of this transaction attempt being part of a card
746
+ # testing attack.
747
+ class CardTestingVerdict
748
+ include ::Google::Protobuf::MessageExts
749
+ extend ::Google::Protobuf::MessageExts::ClassMethods
750
+ end
751
+ end
752
+
322
753
  # Account defender risk assessment.
323
754
  # @!attribute [rw] labels
324
755
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
@@ -397,8 +828,8 @@ module Google
397
828
  # The retrieve legacy secret key request message.
398
829
  # @!attribute [rw] key
399
830
  # @return [::String]
400
- # Required. The public key name linked to the requested secret key in the format
401
- # "projects/\\{project}/keys/\\{key}".
831
+ # Required. The public key name linked to the requested secret key in the
832
+ # format "projects/\\{project}/keys/\\{key}".
402
833
  class RetrieveLegacySecretKeyRequest
403
834
  include ::Google::Protobuf::MessageExts
404
835
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -420,8 +851,8 @@ module Google
420
851
  # Required. The key to update.
421
852
  # @!attribute [rw] update_mask
422
853
  # @return [::Google::Protobuf::FieldMask]
423
- # Optional. The mask to control which fields of the key get updated. If the mask is not
424
- # present, all fields will be updated.
854
+ # Optional. The mask to control which fields of the key get updated. If the
855
+ # mask is not present, all fields will be updated.
425
856
  class UpdateKeyRequest
426
857
  include ::Google::Protobuf::MessageExts
427
858
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -442,6 +873,16 @@ module Google
442
873
  # @return [::String]
443
874
  # Required. The name of the key to be migrated, in the format
444
875
  # "projects/\\{project}/keys/\\{key}".
876
+ # @!attribute [rw] skip_billing_check
877
+ # @return [::Boolean]
878
+ # Optional. If true, skips the billing check.
879
+ # A reCAPTCHA Enterprise key or migrated key behaves differently than a
880
+ # reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see
881
+ # https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid
882
+ # any disruption of your usage, we check that a billing account is present.
883
+ # If your usage of reCAPTCHA is under the free quota, you can safely skip the
884
+ # billing check and proceed with the migration. See
885
+ # https://cloud.google.com/recaptcha-enterprise/docs/billing-information.
445
886
  class MigrateKeyRequest
446
887
  include ::Google::Protobuf::MessageExts
447
888
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -514,9 +955,9 @@ module Google
514
955
  # @return [::Google::Protobuf::Map{::String => ::String}]
515
956
  # See <a href="https://cloud.google.com/recaptcha-enterprise/docs/labels">
516
957
  # Creating and managing labels</a>.
517
- # @!attribute [rw] create_time
958
+ # @!attribute [r] create_time
518
959
  # @return [::Google::Protobuf::Timestamp]
519
- # The timestamp corresponding to the creation of this Key.
960
+ # Output only. The timestamp corresponding to the creation of this Key.
520
961
  # @!attribute [rw] testing_options
521
962
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions]
522
963
  # Options for user acceptance testing.
@@ -685,7 +1126,6 @@ module Google
685
1126
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::RecaptchaEnterprise::V1::ScoreDistribution}]
686
1127
  # Action-based metrics. The map key is the action name which specified by the
687
1128
  # site owners at time of the "execute" client-side call.
688
- # Populated only for SCORE keys.
689
1129
  class ScoreMetrics
690
1130
  include ::Google::Protobuf::MessageExts
691
1131
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -729,14 +1169,13 @@ module Google
729
1169
  # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
730
1170
  # @!attribute [rw] page_size
731
1171
  # @return [::Integer]
732
- # Optional. The maximum number of accounts to return. The service might return fewer
733
- # than this value.
734
- # If unspecified, at most 50 accounts are returned.
735
- # The maximum value is 1000; values above 1000 are coerced to 1000.
1172
+ # Optional. The maximum number of accounts to return. The service might
1173
+ # return fewer than this value. If unspecified, at most 50 accounts are
1174
+ # returned. The maximum value is 1000; values above 1000 are coerced to 1000.
736
1175
  # @!attribute [rw] page_token
737
1176
  # @return [::String]
738
- # Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
739
- # call.
1177
+ # Optional. A page token, received from a previous
1178
+ # `ListRelatedAccountGroupMemberships` call.
740
1179
  #
741
1180
  # When paginating, all other parameters provided to
742
1181
  # `ListRelatedAccountGroupMemberships` must match the call that provided the
@@ -762,18 +1201,17 @@ module Google
762
1201
  # The request message to list related account groups.
763
1202
  # @!attribute [rw] parent
764
1203
  # @return [::String]
765
- # Required. The name of the project to list related account groups from, in the format
766
- # "projects/\\{project}".
1204
+ # Required. The name of the project to list related account groups from, in
1205
+ # the format "projects/\\{project}".
767
1206
  # @!attribute [rw] page_size
768
1207
  # @return [::Integer]
769
- # Optional. The maximum number of groups to return. The service might return fewer than
770
- # this value.
771
- # If unspecified, at most 50 groups are returned.
772
- # The maximum value is 1000; values above 1000 are coerced to 1000.
1208
+ # Optional. The maximum number of groups to return. The service might return
1209
+ # fewer than this value. If unspecified, at most 50 groups are returned. The
1210
+ # maximum value is 1000; values above 1000 are coerced to 1000.
773
1211
  # @!attribute [rw] page_token
774
1212
  # @return [::String]
775
- # Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
776
- # Provide this to retrieve the subsequent page.
1213
+ # Optional. A page token, received from a previous `ListRelatedAccountGroups`
1214
+ # call. Provide this to retrieve the subsequent page.
777
1215
  #
778
1216
  # When paginating, all other parameters provided to
779
1217
  # `ListRelatedAccountGroups` must match the call that provided the page
@@ -799,19 +1237,19 @@ module Google
799
1237
  # The request message to search related account group memberships.
800
1238
  # @!attribute [rw] project
801
1239
  # @return [::String]
802
- # Required. The name of the project to search related account group memberships from.
803
- # Specify the project name in the following format: "projects/\\{project}".
1240
+ # Required. The name of the project to search related account group
1241
+ # memberships from. Specify the project name in the following format:
1242
+ # "projects/\\{project}".
804
1243
  # @!attribute [rw] hashed_account_id
805
1244
  # @return [::String]
806
- # Optional. The unique stable hashed user identifier we should search connections to.
807
- # The identifier should correspond to a `hashed_account_id` provided in a
808
- # previous `CreateAssessment` or `AnnotateAssessment` call.
1245
+ # Optional. The unique stable hashed user identifier we should search
1246
+ # connections to. The identifier should correspond to a `hashed_account_id`
1247
+ # provided in a previous `CreateAssessment` or `AnnotateAssessment` call.
809
1248
  # @!attribute [rw] page_size
810
1249
  # @return [::Integer]
811
- # Optional. The maximum number of groups to return. The service might return fewer than
812
- # this value.
813
- # If unspecified, at most 50 groups are returned.
814
- # The maximum value is 1000; values above 1000 are coerced to 1000.
1250
+ # Optional. The maximum number of groups to return. The service might return
1251
+ # fewer than this value. If unspecified, at most 50 groups are returned. The
1252
+ # maximum value is 1000; values above 1000 are coerced to 1000.
815
1253
  # @!attribute [rw] page_token
816
1254
  # @return [::String]
817
1255
  # Optional. A page token, received from a previous