google-apis-recaptchaenterprise_v1 0.37.0 → 0.38.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 699feef1e6da5839899a2d69503de6afbb39fd083eaca27232ee29c69bceafae
4
- data.tar.gz: 551eff0101c5013633f8c89b2cd12eb2b92f27282efaf51cb32419b9d30ce655
3
+ metadata.gz: 83f3381bbfe181b8c81adced280ac0009e5166e1452d74f3e5938440798498b6
4
+ data.tar.gz: 4d8fb061cce48d7e0cea01cae037715453ffac4dcc88709643a5f0c3ac3c29b9
5
5
  SHA512:
6
- metadata.gz: 5f927be7d85351d22a8b02fb3e488b31576d4d3cc63c39df5bd31378ab9ffbed59e0044df7754996d7128bec110c5c5895f0b4c440e3efc2253aae164fa996ab
7
- data.tar.gz: 5e9176f271ef5db727266846feb7aa8622f125e551eeda230c87005fdd3a9ea24e6be7da4466aa3f5b7e406db5a408689da8a0a444ce58f36334a15664f118e6
6
+ metadata.gz: f52931ea7b614133b514bbd3fe7c77c525b5f7fea2eb09f87e00d3091b77d03262b52c2c6616db88ef8bd6cb70aab651c452d25cf7530723ca270130066cae39
7
+ data.tar.gz: ead9b8f43fe491e9820529f192fde70f23b20e35e3226c34ac51c0e728196d5a076c4760e2cb18987b2804c6d48b8bd2fef21c070721fb8a619734e97b987dfb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-recaptchaenterprise_v1
2
2
 
3
+ ### v0.38.0 (2023-10-15)
4
+
5
+ * Regenerated from discovery document revision 20231008
6
+
3
7
  ### v0.37.0 (2023-09-24)
4
8
 
5
9
  * Regenerated from discovery document revision 20230917
@@ -26,7 +26,7 @@ module Google
26
26
  class GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
- # Labels for this request.
29
+ # Output only. Labels for this request.
30
30
  # Corresponds to the JSON property `labels`
31
31
  # @return [Array<String>]
32
32
  attr_accessor :labels
@@ -45,13 +45,13 @@ module Google
45
45
  class GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo
46
46
  include Google::Apis::Core::Hashable
47
47
 
48
- # Endpoints that can be used for identity verification.
48
+ # Optional. Endpoints that can be used for identity verification.
49
49
  # Corresponds to the JSON property `endpoints`
50
50
  # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo>]
51
51
  attr_accessor :endpoints
52
52
 
53
- # Language code preference for the verification message, set as a IETF BCP 47
54
- # language code.
53
+ # Optional. Language code preference for the verification message, set as a IETF
54
+ # BCP 47 language code.
55
55
  # Corresponds to the JSON property `languageCode`
56
56
  # @return [String]
57
57
  attr_accessor :language_code
@@ -84,20 +84,20 @@ module Google
84
84
  class GoogleCloudRecaptchaenterpriseV1AndroidKeySettings
85
85
  include Google::Apis::Core::Hashable
86
86
 
87
- # If set to true, allowed_package_names are not enforced.
87
+ # Optional. If set to true, allowed_package_names are not enforced.
88
88
  # Corresponds to the JSON property `allowAllPackageNames`
89
89
  # @return [Boolean]
90
90
  attr_accessor :allow_all_package_names
91
91
  alias_method :allow_all_package_names?, :allow_all_package_names
92
92
 
93
- # Android package names of apps allowed to use the key. Example: 'com.
93
+ # Optional. Android package names of apps allowed to use the key. Example: 'com.
94
94
  # companyname.appname'
95
95
  # Corresponds to the JSON property `allowedPackageNames`
96
96
  # @return [Array<String>]
97
97
  attr_accessor :allowed_package_names
98
98
 
99
- # Set to true for keys that are used in an Android application that is available
100
- # for download in app stores in addition to the Google Play Store.
99
+ # Optional. Set to true for keys that are used in an Android application that is
100
+ # available for download in app stores in addition to the Google Play Store.
101
101
  # Corresponds to the JSON property `supportNonGoogleAppStoreDistribution`
102
102
  # @return [Boolean]
103
103
  attr_accessor :support_non_google_app_store_distribution
@@ -241,8 +241,8 @@ module Google
241
241
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FraudSignals]
242
242
  attr_accessor :fraud_signals
243
243
 
244
- # Output only. The resource name for the Assessment in the format "projects/`
245
- # project`/assessments/`assessment`".
244
+ # Output only. The resource name for the Assessment in the format `projects/`
245
+ # project`/assessments/`assessment``.
246
246
  # Corresponds to the JSON property `name`
247
247
  # @return [String]
248
248
  attr_accessor :name
@@ -400,7 +400,7 @@ module Google
400
400
  # @return [Array<String>]
401
401
  attr_accessor :headers
402
402
 
403
- # Optional. Optional JA3 fingerprint for SSL clients.
403
+ # Optional. JA3 fingerprint for SSL clients.
404
404
  # Corresponds to the JSON property `ja3`
405
405
  # @return [String]
406
406
  attr_accessor :ja3
@@ -423,7 +423,6 @@ module Google
423
423
  attr_accessor :token
424
424
 
425
425
  # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
426
- # All fields are optional.
427
426
  # Corresponds to the JSON property `transactionData`
428
427
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionData]
429
428
  attr_accessor :transaction_data
@@ -562,12 +561,12 @@ module Google
562
561
  class GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction
563
562
  include Google::Apis::Core::Hashable
564
563
 
565
- # The header key to set in the request to the backend server.
564
+ # Optional. The header key to set in the request to the backend server.
566
565
  # Corresponds to the JSON property `key`
567
566
  # @return [String]
568
567
  attr_accessor :key
569
568
 
570
- # The header value to set in the request to the backend server.
569
+ # Optional. The header value to set in the request to the backend server.
571
570
  # Corresponds to the JSON property `value`
572
571
  # @return [String]
573
572
  attr_accessor :value
@@ -588,8 +587,8 @@ module Google
588
587
  class GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction
589
588
  include Google::Apis::Core::Hashable
590
589
 
591
- # The address to redirect to. The target is a relative path in the current host.
592
- # Example: "/blog/404.html".
590
+ # Optional. The address to redirect to. The target is a relative path in the
591
+ # current host. Example: "/blog/404.html".
593
592
  # Corresponds to the JSON property `path`
594
593
  # @return [String]
595
594
  attr_accessor :path
@@ -609,42 +608,42 @@ module Google
609
608
  class GoogleCloudRecaptchaenterpriseV1FirewallPolicy
610
609
  include Google::Apis::Core::Hashable
611
610
 
612
- # The actions that the caller should take regarding user access. There should be
613
- # at most one terminal action. A terminal action is any action that forces a
614
- # response, such as AllowAction, BlockAction or SubstituteAction. Zero or more
615
- # non-terminal actions such as SetHeader might be specified. A single policy can
616
- # contain up to 16 actions.
611
+ # Optional. The actions that the caller should take regarding user access. There
612
+ # should be at most one terminal action. A terminal action is any action that
613
+ # forces a response, such as `AllowAction`, `BlockAction` or `SubstituteAction`.
614
+ # Zero or more non-terminal actions such as `SetHeader` might be specified. A
615
+ # single policy can contain up to 16 actions.
617
616
  # Corresponds to the JSON property `actions`
618
617
  # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FirewallAction>]
619
618
  attr_accessor :actions
620
619
 
621
- # A CEL (Common Expression Language) conditional expression that specifies if
622
- # this policy applies to an incoming user request. If this condition evaluates
623
- # to true and the requested path matched the path pattern, the associated
624
- # actions should be executed by the caller. The condition string is checked for
625
- # CEL syntax correctness on creation. For more information, see the [CEL spec](
626
- # https://github.com/google/cel-spec) and its [language definition](https://
627
- # github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max
628
- # length of 500 characters.
620
+ # Optional. A CEL (Common Expression Language) conditional expression that
621
+ # specifies if this policy applies to an incoming user request. If this
622
+ # condition evaluates to true and the requested path matched the path pattern,
623
+ # the associated actions should be executed by the caller. The condition string
624
+ # is checked for CEL syntax correctness on creation. For more information, see
625
+ # the [CEL spec](https://github.com/google/cel-spec) and its [language
626
+ # definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A
627
+ # condition has a max length of 500 characters.
629
628
  # Corresponds to the JSON property `condition`
630
629
  # @return [String]
631
630
  attr_accessor :condition
632
631
 
633
- # A description of what this policy aims to achieve, for convenience purposes.
634
- # The description can at most include 256 UTF-8 characters.
632
+ # Optional. A description of what this policy aims to achieve, for convenience
633
+ # purposes. The description can at most include 256 UTF-8 characters.
635
634
  # Corresponds to the JSON property `description`
636
635
  # @return [String]
637
636
  attr_accessor :description
638
637
 
639
- # The resource name for the FirewallPolicy in the format "projects/`project`/
640
- # firewallpolicies/`firewallpolicy`".
638
+ # The resource name for the FirewallPolicy in the format `projects/`project`/
639
+ # firewallpolicies/`firewallpolicy``.
641
640
  # Corresponds to the JSON property `name`
642
641
  # @return [String]
643
642
  attr_accessor :name
644
643
 
645
- # The path for which this policy applies, specified as a glob pattern. For more
646
- # information on glob, see the [manual page](https://man7.org/linux/man-pages/
647
- # man7/glob.7.html). A path has a max length of 200 characters.
644
+ # Optional. The path for which this policy applies, specified as a glob pattern.
645
+ # For more information on glob, see the [manual page](https://man7.org/linux/man-
646
+ # pages/man7/glob.7.html). A path has a max length of 200 characters.
648
647
  # Corresponds to the JSON property `path`
649
648
  # @return [String]
650
649
  attr_accessor :path
@@ -715,8 +714,9 @@ module Google
715
714
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict]
716
715
  attr_accessor :stolen_instrument_verdict
717
716
 
718
- # Probability of this transaction being fraudulent. Summarizes the combined risk
719
- # of attack vectors below. Values are from 0.0 (lowest) to 1.0 (highest).
717
+ # Output only. Probability of this transaction being fraudulent. Summarizes the
718
+ # combined risk of attack vectors below. Values are from 0.0 (lowest) to 1.0 (
719
+ # highest).
720
720
  # Corresponds to the JSON property `transactionRisk`
721
721
  # @return [Float]
722
722
  attr_accessor :transaction_risk
@@ -738,8 +738,8 @@ module Google
738
738
  class GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentBehavioralTrustVerdict
739
739
  include Google::Apis::Core::Hashable
740
740
 
741
- # Probability of this transaction attempt being executed in a behaviorally
742
- # trustworthy way. Values are from 0.0 (lowest) to 1.0 (highest).
741
+ # Output only. Probability of this transaction attempt being executed in a
742
+ # behaviorally trustworthy way. Values are from 0.0 (lowest) to 1.0 (highest).
743
743
  # Corresponds to the JSON property `trust`
744
744
  # @return [Float]
745
745
  attr_accessor :trust_prop
@@ -759,8 +759,8 @@ module Google
759
759
  class GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict
760
760
  include Google::Apis::Core::Hashable
761
761
 
762
- # Probability of this transaction attempt being part of a card testing attack.
763
- # Values are from 0.0 (lowest) to 1.0 (highest).
762
+ # Output only. Probability of this transaction attempt being part of a card
763
+ # testing attack. Values are from 0.0 (lowest) to 1.0 (highest).
764
764
  # Corresponds to the JSON property `risk`
765
765
  # @return [Float]
766
766
  attr_accessor :risk
@@ -780,8 +780,8 @@ module Google
780
780
  class GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict
781
781
  include Google::Apis::Core::Hashable
782
782
 
783
- # Probability of this transaction being executed with a stolen instrument.
784
- # Values are from 0.0 (lowest) to 1.0 (highest).
783
+ # Output only. Probability of this transaction being executed with a stolen
784
+ # instrument. Values are from 0.0 (lowest) to 1.0 (highest).
785
785
  # Corresponds to the JSON property `risk`
786
786
  # @return [Float]
787
787
  attr_accessor :risk
@@ -872,14 +872,14 @@ module Google
872
872
  class GoogleCloudRecaptchaenterpriseV1IosKeySettings
873
873
  include Google::Apis::Core::Hashable
874
874
 
875
- # If set to true, allowed_bundle_ids are not enforced.
875
+ # Optional. If set to true, allowed_bundle_ids are not enforced.
876
876
  # Corresponds to the JSON property `allowAllBundleIds`
877
877
  # @return [Boolean]
878
878
  attr_accessor :allow_all_bundle_ids
879
879
  alias_method :allow_all_bundle_ids?, :allow_all_bundle_ids
880
880
 
881
- # iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.
882
- # productname.appname'
881
+ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.
882
+ # companyname.productname.appname'
883
883
  # Corresponds to the JSON property `allowedBundleIds`
884
884
  # @return [Array<String>]
885
885
  attr_accessor :allowed_bundle_ids
@@ -916,7 +916,7 @@ module Google
916
916
  # @return [String]
917
917
  attr_accessor :create_time
918
918
 
919
- # Human-readable display name of this key. Modifiable by user.
919
+ # Required. Human-readable display name of this key. Modifiable by user.
920
920
  # Corresponds to the JSON property `displayName`
921
921
  # @return [String]
922
922
  attr_accessor :display_name
@@ -926,12 +926,13 @@ module Google
926
926
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1IosKeySettings]
927
927
  attr_accessor :ios_settings
928
928
 
929
- # See Creating and managing labels.
929
+ # Optional. See [Creating and managing labels] (https://cloud.google.com/
930
+ # recaptcha-enterprise/docs/labels).
930
931
  # Corresponds to the JSON property `labels`
931
932
  # @return [Hash<String,String>]
932
933
  attr_accessor :labels
933
934
 
934
- # The resource name for the Key in the format "projects/`project`/keys/`key`".
935
+ # The resource name for the Key in the format `projects/`project`/keys/`key``.
935
936
  # Corresponds to the JSON property `name`
936
937
  # @return [String]
937
938
  attr_accessor :name
@@ -1084,8 +1085,8 @@ module Google
1084
1085
  # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1ChallengeMetrics>]
1085
1086
  attr_accessor :challenge_metrics
1086
1087
 
1087
- # Output only. The name of the metrics, in the format "projects/`project`/keys/`
1088
- # key`/metrics".
1088
+ # Output only. The name of the metrics, in the format `projects/`project`/keys/`
1089
+ # key`/metrics`.
1089
1090
  # Corresponds to the JSON property `name`
1090
1091
  # @return [String]
1091
1092
  attr_accessor :name
@@ -1160,7 +1161,7 @@ module Google
1160
1161
  # @return [String]
1161
1162
  attr_accessor :encrypted_user_credentials_hash
1162
1163
 
1163
- # Optional. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
1164
+ # Required. Exactly 26-bit prefix of the SHA-256 hash of the canonicalized
1164
1165
  # username. It is used to look up password leaks associated with that hash
1165
1166
  # prefix.
1166
1167
  # Corresponds to the JSON property `lookupHashPrefix`
@@ -1264,19 +1265,19 @@ module Google
1264
1265
  class GoogleCloudRecaptchaenterpriseV1RiskAnalysis
1265
1266
  include Google::Apis::Core::Hashable
1266
1267
 
1267
- # Extended verdict reasons to be used for experimentation only. The set of
1268
- # possible reasons is subject to change.
1268
+ # Output only. Extended verdict reasons to be used for experimentation only. The
1269
+ # set of possible reasons is subject to change.
1269
1270
  # Corresponds to the JSON property `extendedVerdictReasons`
1270
1271
  # @return [Array<String>]
1271
1272
  attr_accessor :extended_verdict_reasons
1272
1273
 
1273
- # Reasons contributing to the risk analysis verdict.
1274
+ # Output only. Reasons contributing to the risk analysis verdict.
1274
1275
  # Corresponds to the JSON property `reasons`
1275
1276
  # @return [Array<String>]
1276
1277
  attr_accessor :reasons
1277
1278
 
1278
- # Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate
1279
- # traffic while 0.0 means very likely non-legitimate traffic).
1279
+ # Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely
1280
+ # legitimate traffic while 0.0 means very likely non-legitimate traffic).
1280
1281
  # Corresponds to the JSON property `score`
1281
1282
  # @return [Float]
1282
1283
  attr_accessor :score
@@ -1410,15 +1411,15 @@ module Google
1410
1411
  class GoogleCloudRecaptchaenterpriseV1TestingOptions
1411
1412
  include Google::Apis::Core::Hashable
1412
1413
 
1413
- # For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests
1414
- # for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge
1415
- # if CHALLENGE.
1414
+ # Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge
1415
+ # requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable
1416
+ # challenge if CHALLENGE.
1416
1417
  # Corresponds to the JSON property `testingChallenge`
1417
1418
  # @return [String]
1418
1419
  attr_accessor :testing_challenge
1419
1420
 
1420
- # All assessments for this Key will return this score. Must be between 0 (likely
1421
- # not legitimate) and 1 (likely legitimate) inclusive.
1421
+ # Optional. All assessments for this Key will return this score. Must be between
1422
+ # 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
1422
1423
  # Corresponds to the JSON property `testingScore`
1423
1424
  # @return [Float]
1424
1425
  attr_accessor :testing_score
@@ -1438,41 +1439,44 @@ module Google
1438
1439
  class GoogleCloudRecaptchaenterpriseV1TokenProperties
1439
1440
  include Google::Apis::Core::Hashable
1440
1441
 
1441
- # Action name provided at token generation.
1442
+ # Output only. Action name provided at token generation.
1442
1443
  # Corresponds to the JSON property `action`
1443
1444
  # @return [String]
1444
1445
  attr_accessor :action
1445
1446
 
1446
- # The name of the Android package with which the token was generated (Android
1447
- # keys only).
1447
+ # Output only. The name of the Android package with which the token was
1448
+ # generated (Android keys only).
1448
1449
  # Corresponds to the JSON property `androidPackageName`
1449
1450
  # @return [String]
1450
1451
  attr_accessor :android_package_name
1451
1452
 
1452
- # The timestamp corresponding to the generation of the token.
1453
+ # Output only. The timestamp corresponding to the generation of the token.
1453
1454
  # Corresponds to the JSON property `createTime`
1454
1455
  # @return [String]
1455
1456
  attr_accessor :create_time
1456
1457
 
1457
- # The hostname of the page on which the token was generated (Web keys only).
1458
+ # Output only. The hostname of the page on which the token was generated (Web
1459
+ # keys only).
1458
1460
  # Corresponds to the JSON property `hostname`
1459
1461
  # @return [String]
1460
1462
  attr_accessor :hostname
1461
1463
 
1462
- # Reason associated with the response when valid = false.
1464
+ # Output only. Reason associated with the response when valid = false.
1463
1465
  # Corresponds to the JSON property `invalidReason`
1464
1466
  # @return [String]
1465
1467
  attr_accessor :invalid_reason
1466
1468
 
1467
- # The ID of the iOS bundle with which the token was generated (iOS keys only).
1469
+ # Output only. The ID of the iOS bundle with which the token was generated (iOS
1470
+ # keys only).
1468
1471
  # Corresponds to the JSON property `iosBundleId`
1469
1472
  # @return [String]
1470
1473
  attr_accessor :ios_bundle_id
1471
1474
 
1472
- # Whether the provided user response token is valid. When valid = false, the
1473
- # reason could be specified in invalid_reason or it could also be due to a user
1474
- # failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to
1475
- # generate the token was different than the one specified in the assessment).
1475
+ # Output only. Whether the provided user response token is valid. When valid =
1476
+ # false, the reason could be specified in invalid_reason or it could also be due
1477
+ # to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
1478
+ # used to generate the token was different than the one specified in the
1479
+ # assessment).
1476
1480
  # Corresponds to the JSON property `valid`
1477
1481
  # @return [Boolean]
1478
1482
  attr_accessor :valid
@@ -1495,7 +1499,6 @@ module Google
1495
1499
  end
1496
1500
 
1497
1501
  # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
1498
- # All fields are optional.
1499
1502
  class GoogleCloudRecaptchaenterpriseV1TransactionData
1500
1503
  include Google::Apis::Core::Hashable
1501
1504
 
@@ -1504,17 +1507,18 @@ module Google
1504
1507
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataAddress]
1505
1508
  attr_accessor :billing_address
1506
1509
 
1507
- # The Bank Identification Number - generally the first 6 or 8 digits of the card.
1510
+ # Optional. The Bank Identification Number - generally the first 6 or 8 digits
1511
+ # of the card.
1508
1512
  # Corresponds to the JSON property `cardBin`
1509
1513
  # @return [String]
1510
1514
  attr_accessor :card_bin
1511
1515
 
1512
- # The last four digits of the card.
1516
+ # Optional. The last four digits of the card.
1513
1517
  # Corresponds to the JSON property `cardLastFour`
1514
1518
  # @return [String]
1515
1519
  attr_accessor :card_last_four
1516
1520
 
1517
- # The currency code in ISO-4217 format.
1521
+ # Optional. The currency code in ISO-4217 format.
1518
1522
  # Corresponds to the JSON property `currencyCode`
1519
1523
  # @return [String]
1520
1524
  attr_accessor :currency_code
@@ -1524,20 +1528,20 @@ module Google
1524
1528
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo]
1525
1529
  attr_accessor :gateway_info
1526
1530
 
1527
- # Items purchased in this transaction.
1531
+ # Optional. Items purchased in this transaction.
1528
1532
  # Corresponds to the JSON property `items`
1529
1533
  # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataItem>]
1530
1534
  attr_accessor :items
1531
1535
 
1532
- # Information about the user or users fulfilling the transaction.
1536
+ # Optional. Information about the user or users fulfilling the transaction.
1533
1537
  # Corresponds to the JSON property `merchants`
1534
1538
  # @return [Array<Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataUser>]
1535
1539
  attr_accessor :merchants
1536
1540
 
1537
- # The payment method for the transaction. The allowed values are: * credit-card *
1538
- # debit-card * gift-card * processor-`name` (If a third-party is used, for
1539
- # example, processor-paypal) * custom-`name` (If an alternative method is used,
1540
- # for example, custom-crypto)
1541
+ # Optional. The payment method for the transaction. The allowed values are: *
1542
+ # credit-card * debit-card * gift-card * processor-`name` (If a third-party is
1543
+ # used, for example, processor-paypal) * custom-`name` (If an alternative method
1544
+ # is used, for example, custom-crypto)
1541
1545
  # Corresponds to the JSON property `paymentMethod`
1542
1546
  # @return [String]
1543
1547
  attr_accessor :payment_method
@@ -1547,7 +1551,8 @@ module Google
1547
1551
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataAddress]
1548
1552
  attr_accessor :shipping_address
1549
1553
 
1550
- # The value of shipping in the specified currency. 0 for free or no shipping.
1554
+ # Optional. The value of shipping in the specified currency. 0 for free or no
1555
+ # shipping.
1551
1556
  # Corresponds to the JSON property `shippingValue`
1552
1557
  # @return [Float]
1553
1558
  attr_accessor :shipping_value
@@ -1565,7 +1570,7 @@ module Google
1565
1570
  # @return [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1TransactionDataUser]
1566
1571
  attr_accessor :user
1567
1572
 
1568
- # The decimal value of the transaction in the specified currency.
1573
+ # Optional. The decimal value of the transaction in the specified currency.
1569
1574
  # Corresponds to the JSON property `value`
1570
1575
  # @return [Float]
1571
1576
  attr_accessor :value
@@ -1596,34 +1601,35 @@ module Google
1596
1601
  class GoogleCloudRecaptchaenterpriseV1TransactionDataAddress
1597
1602
  include Google::Apis::Core::Hashable
1598
1603
 
1599
- # The first lines of the address. The first line generally contains the street
1600
- # name and number, and further lines may include information such as an
1601
- # apartment number.
1604
+ # Optional. The first lines of the address. The first line generally contains
1605
+ # the street name and number, and further lines may include information such as
1606
+ # an apartment number.
1602
1607
  # Corresponds to the JSON property `address`
1603
1608
  # @return [Array<String>]
1604
1609
  attr_accessor :address
1605
1610
 
1606
- # The state, province, or otherwise administrative area of the address.
1611
+ # Optional. The state, province, or otherwise administrative area of the address.
1607
1612
  # Corresponds to the JSON property `administrativeArea`
1608
1613
  # @return [String]
1609
1614
  attr_accessor :administrative_area
1610
1615
 
1611
- # The town/city of the address.
1616
+ # Optional. The town/city of the address.
1612
1617
  # Corresponds to the JSON property `locality`
1613
1618
  # @return [String]
1614
1619
  attr_accessor :locality
1615
1620
 
1616
- # The postal or ZIP code of the address.
1621
+ # Optional. The postal or ZIP code of the address.
1617
1622
  # Corresponds to the JSON property `postalCode`
1618
1623
  # @return [String]
1619
1624
  attr_accessor :postal_code
1620
1625
 
1621
- # The recipient name, potentially including information such as "care of".
1626
+ # Optional. The recipient name, potentially including information such as "care
1627
+ # of".
1622
1628
  # Corresponds to the JSON property `recipient`
1623
1629
  # @return [String]
1624
1630
  attr_accessor :recipient
1625
1631
 
1626
- # The CLDR country/region of the address.
1632
+ # Optional. The CLDR country/region of the address.
1627
1633
  # Corresponds to the JSON property `regionCode`
1628
1634
  # @return [String]
1629
1635
  attr_accessor :region_code
@@ -1647,24 +1653,24 @@ module Google
1647
1653
  class GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo
1648
1654
  include Google::Apis::Core::Hashable
1649
1655
 
1650
- # AVS response code from the gateway (available only when reCAPTCHA Enterprise
1651
- # is called after authorization).
1656
+ # Optional. AVS response code from the gateway (available only when reCAPTCHA
1657
+ # Enterprise is called after authorization).
1652
1658
  # Corresponds to the JSON property `avsResponseCode`
1653
1659
  # @return [String]
1654
1660
  attr_accessor :avs_response_code
1655
1661
 
1656
- # CVV response code from the gateway (available only when reCAPTCHA Enterprise
1657
- # is called after authorization).
1662
+ # Optional. CVV response code from the gateway (available only when reCAPTCHA
1663
+ # Enterprise is called after authorization).
1658
1664
  # Corresponds to the JSON property `cvvResponseCode`
1659
1665
  # @return [String]
1660
1666
  attr_accessor :cvv_response_code
1661
1667
 
1662
- # Gateway response code describing the state of the transaction.
1668
+ # Optional. Gateway response code describing the state of the transaction.
1663
1669
  # Corresponds to the JSON property `gatewayResponseCode`
1664
1670
  # @return [String]
1665
1671
  attr_accessor :gateway_response_code
1666
1672
 
1667
- # Name of the gateway service (for example, stripe, square, paypal).
1673
+ # Optional. Name of the gateway service (for example, stripe, square, paypal).
1668
1674
  # Corresponds to the JSON property `name`
1669
1675
  # @return [String]
1670
1676
  attr_accessor :name
@@ -1686,24 +1692,24 @@ module Google
1686
1692
  class GoogleCloudRecaptchaenterpriseV1TransactionDataItem
1687
1693
  include Google::Apis::Core::Hashable
1688
1694
 
1689
- # When a merchant is specified, its corresponding account_id. Necessary to
1690
- # populate marketplace-style transactions.
1695
+ # Optional. When a merchant is specified, its corresponding account_id.
1696
+ # Necessary to populate marketplace-style transactions.
1691
1697
  # Corresponds to the JSON property `merchantAccountId`
1692
1698
  # @return [String]
1693
1699
  attr_accessor :merchant_account_id
1694
1700
 
1695
- # The full name of the item.
1701
+ # Optional. The full name of the item.
1696
1702
  # Corresponds to the JSON property `name`
1697
1703
  # @return [String]
1698
1704
  attr_accessor :name
1699
1705
 
1700
- # The quantity of this item that is being purchased.
1706
+ # Optional. The quantity of this item that is being purchased.
1701
1707
  # Corresponds to the JSON property `quantity`
1702
1708
  # @return [Fixnum]
1703
1709
  attr_accessor :quantity
1704
1710
 
1705
- # The value per item that the user is paying, in the transaction currency, after
1706
- # discounts.
1711
+ # Optional. The value per item that the user is paying, in the transaction
1712
+ # currency, after discounts.
1707
1713
  # Corresponds to the JSON property `value`
1708
1714
  # @return [Float]
1709
1715
  attr_accessor :value
@@ -1725,37 +1731,37 @@ module Google
1725
1731
  class GoogleCloudRecaptchaenterpriseV1TransactionDataUser
1726
1732
  include Google::Apis::Core::Hashable
1727
1733
 
1728
- # Unique account identifier for this user. If using account defender, this
1729
- # should match the hashed_account_id field. Otherwise, a unique and persistent
1730
- # identifier for this account.
1734
+ # Optional. Unique account identifier for this user. If using account defender,
1735
+ # this should match the hashed_account_id field. Otherwise, a unique and
1736
+ # persistent identifier for this account.
1731
1737
  # Corresponds to the JSON property `accountId`
1732
1738
  # @return [String]
1733
1739
  attr_accessor :account_id
1734
1740
 
1735
- # The epoch milliseconds of the user's account creation.
1741
+ # Optional. The epoch milliseconds of the user's account creation.
1736
1742
  # Corresponds to the JSON property `creationMs`
1737
1743
  # @return [Fixnum]
1738
1744
  attr_accessor :creation_ms
1739
1745
 
1740
- # The email address of the user.
1746
+ # Optional. The email address of the user.
1741
1747
  # Corresponds to the JSON property `email`
1742
1748
  # @return [String]
1743
1749
  attr_accessor :email
1744
1750
 
1745
- # Whether the email has been verified to be accessible by the user (OTP or
1746
- # similar).
1751
+ # Optional. Whether the email has been verified to be accessible by the user (
1752
+ # OTP or similar).
1747
1753
  # Corresponds to the JSON property `emailVerified`
1748
1754
  # @return [Boolean]
1749
1755
  attr_accessor :email_verified
1750
1756
  alias_method :email_verified?, :email_verified
1751
1757
 
1752
- # The phone number of the user, with country code.
1758
+ # Optional. The phone number of the user, with country code.
1753
1759
  # Corresponds to the JSON property `phoneNumber`
1754
1760
  # @return [String]
1755
1761
  attr_accessor :phone_number
1756
1762
 
1757
- # Whether the phone number has been verified to be accessible by the user (OTP
1758
- # or similar).
1763
+ # Optional. Whether the phone number has been verified to be accessible by the
1764
+ # user (OTP or similar).
1759
1765
  # Corresponds to the JSON property `phoneVerified`
1760
1766
  # @return [Boolean]
1761
1767
  attr_accessor :phone_verified
@@ -1847,30 +1853,30 @@ module Google
1847
1853
  class GoogleCloudRecaptchaenterpriseV1WebKeySettings
1848
1854
  include Google::Apis::Core::Hashable
1849
1855
 
1850
- # If set to true, it means allowed_domains will not be enforced.
1856
+ # Optional. If set to true, it means allowed_domains will not be enforced.
1851
1857
  # Corresponds to the JSON property `allowAllDomains`
1852
1858
  # @return [Boolean]
1853
1859
  attr_accessor :allow_all_domains
1854
1860
  alias_method :allow_all_domains?, :allow_all_domains
1855
1861
 
1856
- # If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites.
1857
- # This is supported only for the SCORE integration type.
1862
+ # Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages)
1863
+ # websites. This is supported only for the SCORE integration type.
1858
1864
  # Corresponds to the JSON property `allowAmpTraffic`
1859
1865
  # @return [Boolean]
1860
1866
  attr_accessor :allow_amp_traffic
1861
1867
  alias_method :allow_amp_traffic?, :allow_amp_traffic
1862
1868
 
1863
- # Domains or subdomains of websites allowed to use the key. All subdomains of an
1864
- # allowed domain are automatically allowed. A valid domain requires a host and
1865
- # must not include any path, port, query or fragment. Examples: 'example.com' or
1866
- # 'subdomain.example.com'
1869
+ # Optional. Domains or subdomains of websites allowed to use the key. All
1870
+ # subdomains of an allowed domain are automatically allowed. A valid domain
1871
+ # requires a host and must not include any path, port, query or fragment.
1872
+ # Examples: 'example.com' or 'subdomain.example.com'
1867
1873
  # Corresponds to the JSON property `allowedDomains`
1868
1874
  # @return [Array<String>]
1869
1875
  attr_accessor :allowed_domains
1870
1876
 
1871
- # Settings for the frequency and difficulty at which this key triggers captcha
1872
- # challenges. This should only be specified for IntegrationTypes CHECKBOX and
1873
- # INVISIBLE.
1877
+ # Optional. Settings for the frequency and difficulty at which this key triggers
1878
+ # captcha challenges. This should only be specified for IntegrationTypes
1879
+ # CHECKBOX and INVISIBLE.
1874
1880
  # Corresponds to the JSON property `challengeSecurityPreference`
1875
1881
  # @return [String]
1876
1882
  attr_accessor :challenge_security_preference
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RecaptchaenterpriseV1
18
18
  # Version of the google-apis-recaptchaenterprise_v1 gem
19
- GEM_VERSION = "0.37.0"
19
+ GEM_VERSION = "0.38.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230917"
25
+ REVISION = "20231008"
26
26
  end
27
27
  end
28
28
  end
@@ -53,8 +53,8 @@ module Google
53
53
  # Annotates a previously created Assessment to provide additional information on
54
54
  # whether the event turned out to be authentic or fraudulent.
55
55
  # @param [String] name
56
- # Required. The resource name of the Assessment, in the format "projects/`
57
- # project`/assessments/`assessment`".
56
+ # Required. The resource name of the Assessment, in the format `projects/`
57
+ # project`/assessments/`assessment``.
58
58
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest] google_cloud_recaptchaenterprise_v1_annotate_assessment_request_object
59
59
  # @param [String] fields
60
60
  # Selector specifying which fields to include in a partial response.
@@ -88,7 +88,7 @@ module Google
88
88
  # Creates an Assessment of the likelihood an event is legitimate.
89
89
  # @param [String] parent
90
90
  # Required. The name of the project in which the assessment will be created, in
91
- # the format "projects/`project`".
91
+ # the format `projects/`project``.
92
92
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Assessment] google_cloud_recaptchaenterprise_v1_assessment_object
93
93
  # @param [String] fields
94
94
  # Selector specifying which fields to include in a partial response.
@@ -123,8 +123,8 @@ module Google
123
123
  # Enterprise actions can be executed. A project may have a maximum of 1000
124
124
  # policies.
125
125
  # @param [String] parent
126
- # Required. The name of the project this policy will apply to, in the format "
127
- # projects/`project`".
126
+ # Required. The name of the project this policy will apply to, in the format `
127
+ # projects/`project``.
128
128
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FirewallPolicy] google_cloud_recaptchaenterprise_v1_firewall_policy_object
129
129
  # @param [String] fields
130
130
  # Selector specifying which fields to include in a partial response.
@@ -157,8 +157,8 @@ module Google
157
157
 
158
158
  # Deletes the specified firewall policy.
159
159
  # @param [String] name
160
- # Required. The name of the policy to be deleted, in the format "projects/`
161
- # project`/firewallpolicies/`firewallpolicy`".
160
+ # Required. The name of the policy to be deleted, in the format `projects/`
161
+ # project`/firewallpolicies/`firewallpolicy``.
162
162
  # @param [String] fields
163
163
  # Selector specifying which fields to include in a partial response.
164
164
  # @param [String] quota_user
@@ -188,8 +188,8 @@ module Google
188
188
 
189
189
  # Returns the specified firewall policy.
190
190
  # @param [String] name
191
- # Required. The name of the requested policy, in the format "projects/`project`/
192
- # firewallpolicies/`firewallpolicy`".
191
+ # Required. The name of the requested policy, in the format `projects/`project`/
192
+ # firewallpolicies/`firewallpolicy``.
193
193
  # @param [String] fields
194
194
  # Selector specifying which fields to include in a partial response.
195
195
  # @param [String] quota_user
@@ -219,8 +219,8 @@ module Google
219
219
 
220
220
  # Returns the list of all firewall policies that belong to a project.
221
221
  # @param [String] parent
222
- # Required. The name of the project to list the policies for, in the format "
223
- # projects/`project`".
222
+ # Required. The name of the project to list the policies for, in the format `
223
+ # projects/`project``.
224
224
  # @param [Fixnum] page_size
225
225
  # Optional. The maximum number of policies to return. Default is 10. Max limit
226
226
  # is 1000.
@@ -258,8 +258,8 @@ module Google
258
258
 
259
259
  # Updates the specified firewall policy.
260
260
  # @param [String] name
261
- # The resource name for the FirewallPolicy in the format "projects/`project`/
262
- # firewallpolicies/`firewallpolicy`".
261
+ # The resource name for the FirewallPolicy in the format `projects/`project`/
262
+ # firewallpolicies/`firewallpolicy``.
263
263
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1FirewallPolicy] google_cloud_recaptchaenterprise_v1_firewall_policy_object
264
264
  # @param [String] update_mask
265
265
  # Optional. The mask to control which fields of the policy get updated. If the
@@ -297,7 +297,7 @@ module Google
297
297
  # Creates a new reCAPTCHA Enterprise key.
298
298
  # @param [String] parent
299
299
  # Required. The name of the project in which the key will be created, in the
300
- # format "projects/`project`".
300
+ # format `projects/`project``.
301
301
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Key] google_cloud_recaptchaenterprise_v1_key_object
302
302
  # @param [String] fields
303
303
  # Selector specifying which fields to include in a partial response.
@@ -330,8 +330,8 @@ module Google
330
330
 
331
331
  # Deletes the specified key.
332
332
  # @param [String] name
333
- # Required. The name of the key to be deleted, in the format "projects/`project`/
334
- # keys/`key`".
333
+ # Required. The name of the key to be deleted, in the format `projects/`project`/
334
+ # keys/`key``.
335
335
  # @param [String] fields
336
336
  # Selector specifying which fields to include in a partial response.
337
337
  # @param [String] quota_user
@@ -361,8 +361,8 @@ module Google
361
361
 
362
362
  # Returns the specified key.
363
363
  # @param [String] name
364
- # Required. The name of the requested key, in the format "projects/`project`/
365
- # keys/`key`".
364
+ # Required. The name of the requested key, in the format `projects/`project`/
365
+ # keys/`key``.
366
366
  # @param [String] fields
367
367
  # Selector specifying which fields to include in a partial response.
368
368
  # @param [String] quota_user
@@ -393,8 +393,8 @@ module Google
393
393
  # Get some aggregated metrics for a Key. This data can be used to build
394
394
  # dashboards.
395
395
  # @param [String] name
396
- # Required. The name of the requested metrics, in the format "projects/`project`/
397
- # keys/`key`/metrics".
396
+ # Required. The name of the requested metrics, in the format `projects/`project`/
397
+ # keys/`key`/metrics`.
398
398
  # @param [String] fields
399
399
  # Selector specifying which fields to include in a partial response.
400
400
  # @param [String] quota_user
@@ -425,7 +425,7 @@ module Google
425
425
  # Returns the list of all keys that belong to a project.
426
426
  # @param [String] parent
427
427
  # Required. The name of the project that contains the keys that will be listed,
428
- # in the format "projects/`project`".
428
+ # in the format `projects/`project``.
429
429
  # @param [Fixnum] page_size
430
430
  # Optional. The maximum number of keys to return. Default is 10. Max limit is
431
431
  # 1000.
@@ -467,8 +467,8 @@ module Google
467
467
  # owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise
468
468
  # Admin IAM role in the destination project.
469
469
  # @param [String] name
470
- # Required. The name of the key to be migrated, in the format "projects/`project`
471
- # /keys/`key`".
470
+ # Required. The name of the key to be migrated, in the format `projects/`project`
471
+ # /keys/`key``.
472
472
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest] google_cloud_recaptchaenterprise_v1_migrate_key_request_object
473
473
  # @param [String] fields
474
474
  # Selector specifying which fields to include in a partial response.
@@ -501,7 +501,7 @@ module Google
501
501
 
502
502
  # Updates the specified key.
503
503
  # @param [String] name
504
- # The resource name for the Key in the format "projects/`project`/keys/`key`".
504
+ # The resource name for the Key in the format `projects/`project`/keys/`key``.
505
505
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1Key] google_cloud_recaptchaenterprise_v1_key_object
506
506
  # @param [String] update_mask
507
507
  # Optional. The mask to control which fields of the key get updated. If the mask
@@ -540,7 +540,7 @@ module Google
540
540
  # legacy secret key only in a 3rd party integration with legacy reCAPTCHA.
541
541
  # @param [String] key
542
542
  # Required. The public key name linked to the requested secret key in the format
543
- # "projects/`project`/keys/`key`".
543
+ # `projects/`project`/keys/`key``.
544
544
  # @param [String] fields
545
545
  # Selector specifying which fields to include in a partial response.
546
546
  # @param [String] quota_user
@@ -571,7 +571,7 @@ module Google
571
571
  # Search group memberships related to a given account.
572
572
  # @param [String] project
573
573
  # Required. The name of the project to search related account group memberships
574
- # from. Specify the project name in the following format: "projects/`project`".
574
+ # from. Specify the project name in the following format: `projects/`project``.
575
575
  # @param [Google::Apis::RecaptchaenterpriseV1::GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest] google_cloud_recaptchaenterprise_v1_search_related_account_group_memberships_request_object
576
576
  # @param [String] fields
577
577
  # Selector specifying which fields to include in a partial response.
@@ -605,7 +605,7 @@ module Google
605
605
  # List groups of related accounts.
606
606
  # @param [String] parent
607
607
  # Required. The name of the project to list related account groups from, in the
608
- # format "projects/`project`".
608
+ # format `projects/`project``.
609
609
  # @param [Fixnum] page_size
610
610
  # Optional. The maximum number of groups to return. The service might return
611
611
  # fewer than this value. If unspecified, at most 50 groups are returned. The
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-recaptchaenterprise_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.37.0
4
+ version: 0.38.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-09-24 00:00:00.000000000 Z
11
+ date: 2023-10-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-recaptchaenterprise_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-recaptchaenterprise_v1/v0.37.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-recaptchaenterprise_v1/v0.38.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-recaptchaenterprise_v1
63
63
  post_install_message:
64
64
  rdoc_options: []