google-cloud-recaptcha_enterprise-v1 0.10.0 → 0.11.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 221e03d16a4262691e7ef6c40c92a8ebed53ce3329ad866f7e22fe3cd974ba86
4
- data.tar.gz: 8096928aab4e5b1b79f1583075b614555bd40a9b6aa26f295ec442caf5925275
3
+ metadata.gz: '07468eeb23f79728f1abb3b7d4c7d9798ce6f6c56e8b19ddb1966c7c1825da17'
4
+ data.tar.gz: 6057be1b8629514da509c2a58940c75f61d570a8c01df3ced8ecdef23bae85e0
5
5
  SHA512:
6
- metadata.gz: 021c0a662790f95d3a9eb2d1e3dfed6ff980523a731a05bd8af77fceb5ac3f2b1143ea2fb2b3b08bc12bfb0fe2e5ba85f034e0fd6dec91cd095eb39840e1ae5e
7
- data.tar.gz: 83d6aa911387c483070c013a24ef817fde09a755674a8096776c50d5286b969af590cc908d3d7094d0d072592305c23b3e59390e35611ae84a6b45245b65362e
6
+ metadata.gz: 2ee21165e81d5998764623a8cdfdebe452aa5239bf53e91add630fb433cfd2d39b28918dafe36d1e7d2063fcea74ff91a093faa0de3b120aed21fe87dc57666a
7
+ data.tar.gz: 9069800d3ef653e9204c65acd5ac4308c6220289aab138be351f3fc4c1a0435e74e26325e6b27d0b937c3522ae49d7e26265f975aa42c9befa87fc7a39ba8540
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
@@ -269,15 +269,14 @@ module Google
269
269
  # Required. The resource name of the Assessment, in the format
270
270
  # "projects/\\{project}/assessments/\\{assessment}".
271
271
  # @param annotation [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
272
- # Optional. The annotation that will be assigned to the Event. This field can
273
- # be left empty to provide reasons that apply to an event without concluding
274
- # whether the event is legitimate or fraudulent.
272
+ # Optional. The annotation that will be assigned to the Event. This field can be left
273
+ # empty to provide reasons that apply to an event without concluding whether
274
+ # the event is legitimate or fraudulent.
275
275
  # @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
276
- # Optional. Optional reasons for the annotation that will be assigned to the
277
- # Event.
276
+ # Optional. Optional reasons for the annotation that will be assigned to the Event.
278
277
  # @param hashed_account_id [::String]
279
- # Optional. Optional unique stable hashed user identifier to apply to the
280
- # assessment. This is an alternative to setting the hashed_account_id in
278
+ # Optional. Unique stable hashed user identifier to apply to the assessment.
279
+ # This is an alternative to setting the hashed_account_id in
281
280
  # CreateAssessment, for example when the account identifier is not yet known
282
281
  # in the initial request. It is recommended that the identifier is hashed
283
282
  # using hmac-sha256 with stable secret.
@@ -533,6 +532,94 @@ module Google
533
532
  raise ::Google::Cloud::Error.from_error(e)
534
533
  end
535
534
 
535
+ ##
536
+ # Returns the secret key related to the specified public key.
537
+ # You must use the legacy secret key only in a 3rd party integration with
538
+ # legacy reCAPTCHA.
539
+ #
540
+ # @overload retrieve_legacy_secret_key(request, options = nil)
541
+ # Pass arguments to `retrieve_legacy_secret_key` via a request object, either of type
542
+ # {::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest} or an equivalent Hash.
543
+ #
544
+ # @param request [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest, ::Hash]
545
+ # A request object representing the call parameters. Required. To specify no
546
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
547
+ # @param options [::Gapic::CallOptions, ::Hash]
548
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
549
+ #
550
+ # @overload retrieve_legacy_secret_key(key: nil)
551
+ # Pass arguments to `retrieve_legacy_secret_key` via keyword arguments. Note that at
552
+ # least one keyword argument is required. To specify no parameters, or to keep all
553
+ # the default parameter values, pass an empty Hash as a request object (see above).
554
+ #
555
+ # @param key [::String]
556
+ # Required. The public key name linked to the requested secret key in the format
557
+ # "projects/\\{project}/keys/\\{key}".
558
+ #
559
+ # @yield [response, operation] Access the result along with the RPC operation
560
+ # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse]
561
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
562
+ #
563
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse]
564
+ #
565
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
566
+ #
567
+ # @example Basic example
568
+ # require "google/cloud/recaptcha_enterprise/v1"
569
+ #
570
+ # # Create a client object. The client can be reused for multiple calls.
571
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
572
+ #
573
+ # # Create a request. To set request fields, pass in keyword arguments.
574
+ # request = Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest.new
575
+ #
576
+ # # Call the retrieve_legacy_secret_key method.
577
+ # result = client.retrieve_legacy_secret_key request
578
+ #
579
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse.
580
+ # p result
581
+ #
582
+ def retrieve_legacy_secret_key request, options = nil
583
+ raise ::ArgumentError, "request must be provided" if request.nil?
584
+
585
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest
586
+
587
+ # Converts hash and nil to an options object
588
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
589
+
590
+ # Customize the options with defaults
591
+ metadata = @config.rpcs.retrieve_legacy_secret_key.metadata.to_h
592
+
593
+ # Set x-goog-api-client and x-goog-user-project headers
594
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
595
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
596
+ gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
597
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
598
+
599
+ header_params = {}
600
+ if request.key
601
+ header_params["key"] = request.key
602
+ end
603
+
604
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
605
+ metadata[:"x-goog-request-params"] ||= request_params_header
606
+
607
+ options.apply_defaults timeout: @config.rpcs.retrieve_legacy_secret_key.timeout,
608
+ metadata: metadata,
609
+ retry_policy: @config.rpcs.retrieve_legacy_secret_key.retry_policy
610
+
611
+ options.apply_defaults timeout: @config.timeout,
612
+ metadata: @config.metadata,
613
+ retry_policy: @config.retry_policy
614
+
615
+ @recaptcha_enterprise_service_stub.call_rpc :retrieve_legacy_secret_key, request, options: options do |response, operation|
616
+ yield response, operation if block_given?
617
+ return response
618
+ end
619
+ rescue ::GRPC::BadStatus => e
620
+ raise ::Google::Cloud::Error.from_error(e)
621
+ end
622
+
536
623
  ##
537
624
  # Returns the specified key.
538
625
  #
@@ -640,8 +727,8 @@ module Google
640
727
  # @param key [::Google::Cloud::RecaptchaEnterprise::V1::Key, ::Hash]
641
728
  # Required. The key to update.
642
729
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
643
- # Optional. The mask to control which fields of the key get updated. If the
644
- # mask is not present, all fields will be updated.
730
+ # Optional. The mask to control which fields of the key get updated. If the mask is not
731
+ # present, all fields will be updated.
645
732
  #
646
733
  # @yield [response, operation] Access the result along with the RPC operation
647
734
  # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::Key]
@@ -990,15 +1077,16 @@ module Google
990
1077
  # the default parameter values, pass an empty Hash as a request object (see above).
991
1078
  #
992
1079
  # @param parent [::String]
993
- # Required. The name of the project to list related account groups from, in
994
- # the format "projects/\\{project}".
1080
+ # Required. The name of the project to list related account groups from, in the format
1081
+ # "projects/\\{project}".
995
1082
  # @param page_size [::Integer]
996
- # Optional. The maximum number of groups to return. The service may return
997
- # fewer than this value. If unspecified, at most 50 groups will be returned.
998
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
1083
+ # Optional. The maximum number of groups to return. The service might return fewer than
1084
+ # this value.
1085
+ # If unspecified, at most 50 groups are returned.
1086
+ # The maximum value is 1000; values above 1000 are coerced to 1000.
999
1087
  # @param page_token [::String]
1000
- # Optional. A page token, received from a previous `ListRelatedAccountGroups`
1001
- # call. Provide this to retrieve the subsequent page.
1088
+ # Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
1089
+ # Provide this to retrieve the subsequent page.
1002
1090
  #
1003
1091
  # When paginating, all other parameters provided to
1004
1092
  # `ListRelatedAccountGroups` must match the call that provided the page
@@ -1076,7 +1164,7 @@ module Google
1076
1164
  end
1077
1165
 
1078
1166
  ##
1079
- # Get the memberships in a group of related accounts.
1167
+ # Get memberships in a group of related accounts.
1080
1168
  #
1081
1169
  # @overload list_related_account_group_memberships(request, options = nil)
1082
1170
  # Pass arguments to `list_related_account_group_memberships` via a request object, either of type
@@ -1097,13 +1185,13 @@ module Google
1097
1185
  # Required. The resource name for the related account group in the format
1098
1186
  # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
1099
1187
  # @param page_size [::Integer]
1100
- # Optional. The maximum number of accounts to return. The service may return
1101
- # fewer than this value. If unspecified, at most 50 accounts will be
1102
- # returned. The maximum value is 1000; values above 1000 will be coerced to
1103
- # 1000.
1188
+ # Optional. The maximum number of accounts to return. The service might return fewer
1189
+ # than this value.
1190
+ # If unspecified, at most 50 accounts are returned.
1191
+ # The maximum value is 1000; values above 1000 are coerced to 1000.
1104
1192
  # @param page_token [::String]
1105
- # Optional. A page token, received from a previous
1106
- # `ListRelatedAccountGroupMemberships` call.
1193
+ # Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
1194
+ # call.
1107
1195
  #
1108
1196
  # When paginating, all other parameters provided to
1109
1197
  # `ListRelatedAccountGroupMemberships` must match the call that provided the
@@ -1199,16 +1287,17 @@ module Google
1199
1287
  # the default parameter values, pass an empty Hash as a request object (see above).
1200
1288
  #
1201
1289
  # @param project [::String]
1202
- # Required. The name of the project to search related account group
1203
- # memberships from, in the format "projects/\\{project}".
1290
+ # Required. The name of the project to search related account group memberships from.
1291
+ # Specify the project name in the following format: "projects/\\{project}".
1204
1292
  # @param hashed_account_id [::String]
1205
- # Optional. The unique stable hashed user identifier we should search
1206
- # connections to. The identifier should correspond to a `hashed_account_id`
1207
- # provided in a previous CreateAssessment or AnnotateAssessment call.
1293
+ # Optional. The unique stable hashed user identifier we should search connections to.
1294
+ # The identifier should correspond to a `hashed_account_id` provided in a
1295
+ # previous `CreateAssessment` or `AnnotateAssessment` call.
1208
1296
  # @param page_size [::Integer]
1209
- # Optional. The maximum number of groups to return. The service may return
1210
- # fewer than this value. If unspecified, at most 50 groups will be returned.
1211
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
1297
+ # Optional. The maximum number of groups to return. The service might return fewer than
1298
+ # this value.
1299
+ # If unspecified, at most 50 groups are returned.
1300
+ # The maximum value is 1000; values above 1000 are coerced to 1000.
1212
1301
  # @param page_token [::String]
1213
1302
  # Optional. A page token, received from a previous
1214
1303
  # `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
@@ -1445,6 +1534,11 @@ module Google
1445
1534
  #
1446
1535
  attr_reader :list_keys
1447
1536
  ##
1537
+ # RPC-specific configuration for `retrieve_legacy_secret_key`
1538
+ # @return [::Gapic::Config::Method]
1539
+ #
1540
+ attr_reader :retrieve_legacy_secret_key
1541
+ ##
1448
1542
  # RPC-specific configuration for `get_key`
1449
1543
  # @return [::Gapic::Config::Method]
1450
1544
  #
@@ -1495,6 +1589,8 @@ module Google
1495
1589
  @create_key = ::Gapic::Config::Method.new create_key_config
1496
1590
  list_keys_config = parent_rpcs.list_keys if parent_rpcs.respond_to? :list_keys
1497
1591
  @list_keys = ::Gapic::Config::Method.new list_keys_config
1592
+ retrieve_legacy_secret_key_config = parent_rpcs.retrieve_legacy_secret_key if parent_rpcs.respond_to? :retrieve_legacy_secret_key
1593
+ @retrieve_legacy_secret_key = ::Gapic::Config::Method.new retrieve_legacy_secret_key_config
1498
1594
  get_key_config = parent_rpcs.get_key if parent_rpcs.respond_to? :get_key
1499
1595
  @get_key = ::Gapic::Config::Method.new get_key_config
1500
1596
  update_key_config = parent_rpcs.update_key if parent_rpcs.respond_to? :update_key
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module RecaptchaEnterprise
23
23
  module V1
24
- VERSION = "0.10.0"
24
+ VERSION = "0.11.0"
25
25
  end
26
26
  end
27
27
  end
@@ -35,15 +35,26 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
35
35
  value :CHARGEBACK, 1
36
36
  value :CHARGEBACK_FRAUD, 8
37
37
  value :CHARGEBACK_DISPUTE, 9
38
+ value :REFUND, 10
39
+ value :REFUND_FRAUD, 11
40
+ value :TRANSACTION_ACCEPTED, 12
41
+ value :TRANSACTION_DECLINED, 13
38
42
  value :PAYMENT_HEURISTICS, 2
39
43
  value :INITIATED_TWO_FACTOR, 7
40
44
  value :PASSED_TWO_FACTOR, 3
41
45
  value :FAILED_TWO_FACTOR, 4
42
46
  value :CORRECT_PASSWORD, 5
43
47
  value :INCORRECT_PASSWORD, 6
48
+ value :SOCIAL_SPAM, 14
44
49
  end
45
50
  add_message "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse" do
46
51
  end
52
+ add_message "google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification" do
53
+ optional :lookup_hash_prefix, :bytes, 1
54
+ optional :encrypted_user_credentials_hash, :bytes, 2
55
+ repeated :encrypted_leak_match_prefixes, :bytes, 3
56
+ optional :reencrypted_user_credentials_hash, :bytes, 4
57
+ end
47
58
  add_message "google.cloud.recaptchaenterprise.v1.Assessment" do
48
59
  optional :name, :string, 1
49
60
  optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1.Event"
@@ -98,12 +109,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
98
109
  value :SUSPICIOUS_ACCOUNT_CREATION, 3
99
110
  value :RELATED_ACCOUNTS_NUMBER_HIGH, 4
100
111
  end
101
- add_message "google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification" do
102
- optional :lookup_hash_prefix, :bytes, 1
103
- optional :encrypted_user_credentials_hash, :bytes, 2
104
- repeated :encrypted_leak_match_prefixes, :bytes, 3
105
- optional :reencrypted_user_credentials_hash, :bytes, 4
106
- end
107
112
  add_message "google.cloud.recaptchaenterprise.v1.CreateKeyRequest" do
108
113
  optional :parent, :string, 1
109
114
  optional :key, :message, 2, "google.cloud.recaptchaenterprise.v1.Key"
@@ -117,6 +122,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
117
122
  repeated :keys, :message, 1, "google.cloud.recaptchaenterprise.v1.Key"
118
123
  optional :next_page_token, :string, 2
119
124
  end
125
+ add_message "google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyRequest" do
126
+ optional :key, :string, 1
127
+ end
120
128
  add_message "google.cloud.recaptchaenterprise.v1.GetKeyRequest" do
121
129
  optional :name, :string, 1
122
130
  end
@@ -139,6 +147,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
139
147
  repeated :score_metrics, :message, 2, "google.cloud.recaptchaenterprise.v1.ScoreMetrics"
140
148
  repeated :challenge_metrics, :message, 3, "google.cloud.recaptchaenterprise.v1.ChallengeMetrics"
141
149
  end
150
+ add_message "google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse" do
151
+ optional :legacy_secret_key, :string, 1
152
+ end
142
153
  add_message "google.cloud.recaptchaenterprise.v1.Key" do
143
154
  optional :name, :string, 1
144
155
  optional :display_name, :string, 2
@@ -262,6 +273,7 @@ module Google
262
273
  AnnotateAssessmentRequest::Annotation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation").enummodule
263
274
  AnnotateAssessmentRequest::Reason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason").enummodule
264
275
  AnnotateAssessmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse").msgclass
276
+ PrivatePasswordLeakVerification = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification").msgclass
265
277
  Assessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Assessment").msgclass
266
278
  Event = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Event").msgclass
267
279
  RiskAnalysis = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis").msgclass
@@ -270,16 +282,17 @@ module Google
270
282
  TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason").enummodule
271
283
  AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment").msgclass
272
284
  AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
273
- PrivatePasswordLeakVerification = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.PrivatePasswordLeakVerification").msgclass
274
285
  CreateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateKeyRequest").msgclass
275
286
  ListKeysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysRequest").msgclass
276
287
  ListKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysResponse").msgclass
288
+ RetrieveLegacySecretKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyRequest").msgclass
277
289
  GetKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.GetKeyRequest").msgclass
278
290
  UpdateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.UpdateKeyRequest").msgclass
279
291
  DeleteKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.DeleteKeyRequest").msgclass
280
292
  MigrateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.MigrateKeyRequest").msgclass
281
293
  GetMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.GetMetricsRequest").msgclass
282
294
  Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Metrics").msgclass
295
+ RetrieveLegacySecretKeyResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse").msgclass
283
296
  Key = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.Key").msgclass
284
297
  TestingOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TestingOptions").msgclass
285
298
  TestingOptions::TestingChallenge = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TestingOptions.TestingChallenge").enummodule
@@ -42,6 +42,10 @@ module Google
42
42
  rpc :CreateKey, ::Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Key
43
43
  # Returns the list of all keys that belong to a project.
44
44
  rpc :ListKeys, ::Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListKeysResponse
45
+ # Returns the secret key related to the specified public key.
46
+ # You must use the legacy secret key only in a 3rd party integration with
47
+ # legacy reCAPTCHA.
48
+ rpc :RetrieveLegacySecretKey, ::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::RetrieveLegacySecretKeyResponse
45
49
  # Returns the specified key.
46
50
  rpc :GetKey, ::Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Key
47
51
  # Updates the specified key.
@@ -60,7 +64,7 @@ module Google
60
64
  rpc :GetMetrics, ::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Metrics
61
65
  # List groups of related accounts.
62
66
  rpc :ListRelatedAccountGroups, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsResponse
63
- # Get the memberships in a group of related accounts.
67
+ # Get memberships in a group of related accounts.
64
68
  rpc :ListRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsResponse
65
69
  # Search group memberships related to a given account.
66
70
  rpc :SearchRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsResponse
@@ -41,17 +41,16 @@ module Google
41
41
  # "projects/\\{project}/assessments/\\{assessment}".
42
42
  # @!attribute [rw] annotation
43
43
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation]
44
- # Optional. The annotation that will be assigned to the Event. This field can
45
- # be left empty to provide reasons that apply to an event without concluding
46
- # whether the event is legitimate or fraudulent.
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.
47
47
  # @!attribute [rw] reasons
48
48
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
49
- # Optional. Optional reasons for the annotation that will be assigned to the
50
- # Event.
49
+ # Optional. Optional reasons for the annotation that will be assigned to the Event.
51
50
  # @!attribute [rw] hashed_account_id
52
51
  # @return [::String]
53
- # Optional. Optional unique stable hashed user identifier to apply to the
54
- # assessment. This is an alternative to setting the hashed_account_id in
52
+ # Optional. Unique stable hashed user identifier to apply to the assessment.
53
+ # This is an alternative to setting the hashed_account_id in
55
54
  # CreateAssessment, for example when the account identifier is not yet known
56
55
  # in the initial request. It is recommended that the identifier is hashed
57
56
  # using hmac-sha256 with stable secret.
@@ -86,21 +85,38 @@ module Google
86
85
  # Default unspecified reason.
87
86
  REASON_UNSPECIFIED = 0
88
87
 
89
- # Indicates a chargeback issued for the transaction with no other details.
90
- # When possible, specify the type by using CHARGEBACK_FRAUD or
88
+ # Indicates that the transaction had a chargeback issued with no other
89
+ # details. When possible, specify the type by using CHARGEBACK_FRAUD or
91
90
  # CHARGEBACK_DISPUTE instead.
92
91
  CHARGEBACK = 1
93
92
 
94
- # Indicates a chargeback related to an alleged unauthorized transaction
95
- # from the cardholder's perspective (for example, the card number was
96
- # stolen).
93
+ # Indicates that the transaction had a chargeback issued related to an
94
+ # alleged unauthorized transaction from the cardholder's perspective (for
95
+ # example, the card number was stolen).
97
96
  CHARGEBACK_FRAUD = 8
98
97
 
99
- # Indicates a chargeback related to the cardholder having provided their
100
- # card details but allegedly not being satisfied with the purchase
101
- # (for example, misrepresentation, attempted cancellation).
98
+ # Indicates that the transaction had a chargeback issued related to the
99
+ # cardholder having provided their card details but allegedly not being
100
+ # satisfied with the purchase (for example, misrepresentation, attempted
101
+ # cancellation).
102
102
  CHARGEBACK_DISPUTE = 9
103
103
 
104
+ # Indicates that the completed payment transaction was refunded by the
105
+ # seller.
106
+ REFUND = 10
107
+
108
+ # Indicates that the completed payment transaction was determined to be
109
+ # fraudulent by the seller, and was cancelled and refunded as a result.
110
+ REFUND_FRAUD = 11
111
+
112
+ # Indicates that the payment transaction was accepted, and the user was
113
+ # charged.
114
+ TRANSACTION_ACCEPTED = 12
115
+
116
+ # Indicates that the payment transaction was declined, for example due to
117
+ # invalid card details.
118
+ TRANSACTION_DECLINED = 13
119
+
104
120
  # Indicates the transaction associated with the assessment is suspected of
105
121
  # being fraudulent based on the payment method, billing details, shipping
106
122
  # address or other transaction information.
@@ -123,6 +139,10 @@ module Google
123
139
 
124
140
  # Indicates the user provided an incorrect password.
125
141
  INCORRECT_PASSWORD = 6
142
+
143
+ # Indicates that the user sent unwanted and abusive messages to other users
144
+ # of the platform, such as spam, scams, phishing, or social engineering.
145
+ SOCIAL_SPAM = 14
126
146
  end
127
147
  end
128
148
 
@@ -132,6 +152,31 @@ module Google
132
152
  extend ::Google::Protobuf::MessageExts::ClassMethods
133
153
  end
134
154
 
155
+ # Private password leak verification info.
156
+ # @!attribute [rw] lookup_hash_prefix
157
+ # @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.
160
+ # @!attribute [rw] encrypted_user_credentials_hash
161
+ # @return [::String]
162
+ # Optional. Encrypted Scrypt hash of the canonicalized username+password. It is
163
+ # re-encrypted by the server and returned through
164
+ # `reencrypted_user_credentials_hash`.
165
+ # @!attribute [r] encrypted_leak_match_prefixes
166
+ # @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`
170
+ # @!attribute [r] reencrypted_user_credentials_hash
171
+ # @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`.
175
+ class PrivatePasswordLeakVerification
176
+ include ::Google::Protobuf::MessageExts
177
+ extend ::Google::Protobuf::MessageExts::ClassMethods
178
+ end
179
+
135
180
  # A recaptcha assessment resource.
136
181
  # @!attribute [r] name
137
182
  # @return [::String]
@@ -148,11 +193,12 @@ module Google
148
193
  # Output only. Properties of the provided event token.
149
194
  # @!attribute [rw] account_defender_assessment
150
195
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
151
- # Assessment returned by Account Defender when a hashed_account_id is
196
+ # Assessment returned by account defender when a hashed_account_id is
152
197
  # provided.
153
198
  # @!attribute [rw] private_password_leak_verification
154
199
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::PrivatePasswordLeakVerification]
155
- # Password leak verification info.
200
+ # The private password leak verification field contains the parameters that
201
+ # are used to to check for leaks privately without sharing user credentials.
156
202
  class Assessment
157
203
  include ::Google::Protobuf::MessageExts
158
204
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -160,29 +206,28 @@ module Google
160
206
 
161
207
  # @!attribute [rw] token
162
208
  # @return [::String]
163
- # Optional. The user response token provided by the reCAPTCHA client-side
164
- # integration on your site.
209
+ # Optional. The user response token provided by the reCAPTCHA client-side integration
210
+ # on your site.
165
211
  # @!attribute [rw] site_key
166
212
  # @return [::String]
167
- # Optional. The site key that was used to invoke reCAPTCHA on your site and
168
- # generate the token.
213
+ # Optional. The site key that was used to invoke reCAPTCHA on your site and generate
214
+ # the token.
169
215
  # @!attribute [rw] user_agent
170
216
  # @return [::String]
171
- # Optional. The user agent present in the request from the user's device
172
- # related to this event.
217
+ # Optional. The user agent present in the request from the user's device related to
218
+ # this event.
173
219
  # @!attribute [rw] user_ip_address
174
220
  # @return [::String]
175
- # Optional. The IP address in the request from the user's device related to
176
- # this event.
221
+ # Optional. The IP address in the request from the user's device related to this event.
177
222
  # @!attribute [rw] expected_action
178
223
  # @return [::String]
179
- # Optional. The expected action for this type of event. This should be the
180
- # same action provided at token generation time on client-side platforms
181
- # already integrated with recaptcha enterprise.
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.
182
227
  # @!attribute [rw] hashed_account_id
183
228
  # @return [::String]
184
- # Optional. Optional unique stable hashed user identifier for the request.
185
- # The identifier should ideally be hashed using sha256 with stable secret.
229
+ # Optional. Unique stable hashed user identifier for the request. The identifier must
230
+ # be hashed using hmac-sha256 with stable secret.
186
231
  class Event
187
232
  include ::Google::Protobuf::MessageExts
188
233
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -240,7 +285,7 @@ module Google
240
285
  # The timestamp corresponding to the generation of the token.
241
286
  # @!attribute [rw] hostname
242
287
  # @return [::String]
243
- # The hostname of the page on which the token was generated.
288
+ # The hostname of the page on which the token was generated (Web keys only).
244
289
  # @!attribute [rw] action
245
290
  # @return [::String]
246
291
  # Action name provided at token generation.
@@ -274,7 +319,7 @@ module Google
274
319
  end
275
320
  end
276
321
 
277
- # Account Defender risk assessment.
322
+ # Account defender risk assessment.
278
323
  # @!attribute [rw] labels
279
324
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
280
325
  # Labels for this request.
@@ -282,7 +327,7 @@ module Google
282
327
  include ::Google::Protobuf::MessageExts
283
328
  extend ::Google::Protobuf::MessageExts::ClassMethods
284
329
 
285
- # Labels returned by Account Defender for this request.
330
+ # Labels returned by account defender for this request.
286
331
  module AccountDefenderLabel
287
332
  # Default unspecified type.
288
333
  ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0
@@ -290,46 +335,21 @@ module Google
290
335
  # The request matches a known good profile for the user.
291
336
  PROFILE_MATCH = 1
292
337
 
293
- # The request is potentially a suspicious login event and should be further
294
- # verified either via multi-factor authentication or another system.
338
+ # The request is potentially a suspicious login event and must be further
339
+ # verified either through multi-factor authentication or another system.
295
340
  SUSPICIOUS_LOGIN_ACTIVITY = 2
296
341
 
297
342
  # The request matched a profile that previously had suspicious account
298
- # creation behavior. This could mean this is a fake account.
343
+ # creation behavior. This can mean that this is a fake account.
299
344
  SUSPICIOUS_ACCOUNT_CREATION = 3
300
345
 
301
346
  # The account in the request has a high number of related accounts. It does
302
- # not necessarily imply that the account is bad but could require
303
- # investigating.
347
+ # not necessarily imply that the account is bad but can require further
348
+ # investigation.
304
349
  RELATED_ACCOUNTS_NUMBER_HIGH = 4
305
350
  end
306
351
  end
307
352
 
308
- # Private password leak verification info.
309
- # @!attribute [rw] lookup_hash_prefix
310
- # @return [::String]
311
- # Exactly 26-bit prefix of the SHA-256 hash of the canonicalized username. It
312
- # is used to look up password leaks associated with that hash prefix.
313
- # @!attribute [rw] encrypted_user_credentials_hash
314
- # @return [::String]
315
- # Encrypted Scrypt hash of the canonicalized username+password. It is
316
- # re-encrypted by the server and returned through
317
- # `reencrypted_user_credentials_hash`.
318
- # @!attribute [r] encrypted_leak_match_prefixes
319
- # @return [::Array<::String>]
320
- # List of prefixes of the encrypted potential password leaks that matched the
321
- # given parameters. They should be compared with the client-side decryption
322
- # prefix of `reencrypted_user_credentials_hash`
323
- # @!attribute [r] reencrypted_user_credentials_hash
324
- # @return [::String]
325
- # Corresponds to the re-encryption of the `encrypted_user_credentials_hash`
326
- # field. Used to match potential password leaks within
327
- # `encrypted_leak_match_prefixes`.
328
- class PrivatePasswordLeakVerification
329
- include ::Google::Protobuf::MessageExts
330
- extend ::Google::Protobuf::MessageExts::ClassMethods
331
- end
332
-
333
353
  # The create key request message.
334
354
  # @!attribute [rw] parent
335
355
  # @return [::String]
@@ -374,6 +394,16 @@ module Google
374
394
  extend ::Google::Protobuf::MessageExts::ClassMethods
375
395
  end
376
396
 
397
+ # The retrieve legacy secret key request message.
398
+ # @!attribute [rw] key
399
+ # @return [::String]
400
+ # Required. The public key name linked to the requested secret key in the format
401
+ # "projects/\\{project}/keys/\\{key}".
402
+ class RetrieveLegacySecretKeyRequest
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
+ end
406
+
377
407
  # The get key request message.
378
408
  # @!attribute [rw] name
379
409
  # @return [::String]
@@ -390,8 +420,8 @@ module Google
390
420
  # Required. The key to update.
391
421
  # @!attribute [rw] update_mask
392
422
  # @return [::Google::Protobuf::FieldMask]
393
- # Optional. The mask to control which fields of the key get updated. If the
394
- # mask is not present, all fields will be updated.
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.
395
425
  class UpdateKeyRequest
396
426
  include ::Google::Protobuf::MessageExts
397
427
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -449,6 +479,19 @@ module Google
449
479
  extend ::Google::Protobuf::MessageExts::ClassMethods
450
480
  end
451
481
 
482
+ # Secret key is used only in legacy reCAPTCHA. It must be used in a 3rd party
483
+ # integration with legacy reCAPTCHA.
484
+ # @!attribute [rw] legacy_secret_key
485
+ # @return [::String]
486
+ # The secret key (also known as shared secret) authorizes communication
487
+ # between your application backend and the reCAPTCHA Enterprise server to
488
+ # create an assessment.
489
+ # The secret key needs to be kept safe for security purposes.
490
+ class RetrieveLegacySecretKeyResponse
491
+ include ::Google::Protobuf::MessageExts
492
+ extend ::Google::Protobuf::MessageExts::ClassMethods
493
+ end
494
+
452
495
  # A key used to identify and configure applications (web and/or mobile) that
453
496
  # use reCAPTCHA Enterprise.
454
497
  # @!attribute [rw] name
@@ -686,14 +729,14 @@ module Google
686
729
  # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
687
730
  # @!attribute [rw] page_size
688
731
  # @return [::Integer]
689
- # Optional. The maximum number of accounts to return. The service may return
690
- # fewer than this value. If unspecified, at most 50 accounts will be
691
- # returned. The maximum value is 1000; values above 1000 will be coerced to
692
- # 1000.
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.
693
736
  # @!attribute [rw] page_token
694
737
  # @return [::String]
695
- # Optional. A page token, received from a previous
696
- # `ListRelatedAccountGroupMemberships` call.
738
+ # Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
739
+ # call.
697
740
  #
698
741
  # When paginating, all other parameters provided to
699
742
  # `ListRelatedAccountGroupMemberships` must match the call that provided the
@@ -719,17 +762,18 @@ module Google
719
762
  # The request message to list related account groups.
720
763
  # @!attribute [rw] parent
721
764
  # @return [::String]
722
- # Required. The name of the project to list related account groups from, in
723
- # the format "projects/\\{project}".
765
+ # Required. The name of the project to list related account groups from, in the format
766
+ # "projects/\\{project}".
724
767
  # @!attribute [rw] page_size
725
768
  # @return [::Integer]
726
- # Optional. The maximum number of groups to return. The service may return
727
- # fewer than this value. If unspecified, at most 50 groups will be returned.
728
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
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.
729
773
  # @!attribute [rw] page_token
730
774
  # @return [::String]
731
- # Optional. A page token, received from a previous `ListRelatedAccountGroups`
732
- # call. Provide this to retrieve the subsequent page.
775
+ # Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
776
+ # Provide this to retrieve the subsequent page.
733
777
  #
734
778
  # When paginating, all other parameters provided to
735
779
  # `ListRelatedAccountGroups` must match the call that provided the page
@@ -755,18 +799,19 @@ module Google
755
799
  # The request message to search related account group memberships.
756
800
  # @!attribute [rw] project
757
801
  # @return [::String]
758
- # Required. The name of the project to search related account group
759
- # memberships from, in the format "projects/\\{project}".
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}".
760
804
  # @!attribute [rw] hashed_account_id
761
805
  # @return [::String]
762
- # Optional. The unique stable hashed user identifier we should search
763
- # connections to. The identifier should correspond to a `hashed_account_id`
764
- # provided in a previous CreateAssessment or AnnotateAssessment call.
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.
765
809
  # @!attribute [rw] page_size
766
810
  # @return [::Integer]
767
- # Optional. The maximum number of groups to return. The service may return
768
- # fewer than this value. If unspecified, at most 50 groups will be returned.
769
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
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.
770
815
  # @!attribute [rw] page_token
771
816
  # @return [::String]
772
817
  # Optional. A page token, received from a previous
@@ -803,7 +848,7 @@ module Google
803
848
  # @return [::String]
804
849
  # The unique stable hashed user identifier of the member. The identifier
805
850
  # corresponds to a `hashed_account_id` provided in a previous
806
- # CreateAssessment or AnnotateAssessment call.
851
+ # `CreateAssessment` or `AnnotateAssessment` call.
807
852
  class RelatedAccountGroupMembership
808
853
  include ::Google::Protobuf::MessageExts
809
854
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-recaptcha_enterprise-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.11.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: 2022-07-07 00:00:00.000000000 Z
11
+ date: 2022-10-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.10'
19
+ version: '0.12'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.10'
29
+ version: '0.12'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a