google-cloud-recaptcha_enterprise-v1 0.5.0 → 0.6.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: 80ac614deb6f19fdc91502ed03f14857e6b153008254cc22a61c9105fb3f4e0f
4
- data.tar.gz: c8177212bb19aba5bf7242281e60fa07abbe5c3895392be2b1d1d479bb75e9ee
3
+ metadata.gz: 9f256800fdd81e93e4045ae4b13e2b9219e17eeb9d4937b942fea2c86712d027
4
+ data.tar.gz: 804b44cf983a6d02548124ddf2f082d7320a66f4a1389bb885c446b09b565926
5
5
  SHA512:
6
- metadata.gz: eef410de801d8f28db19ec486243bdc9a1bef11770039e7198e1a957d3e34834f10ef067f5fc5a996e7c9bb82498d775e825325a88045f17fa6d8a84e5d5d12c
7
- data.tar.gz: 6fcbd07ca6d8aaeb7f3c287353485b4da686d4c30ea91e3d82bc667457f179053b7fc4c3410b617495199ed1fb1a2ff1772c26bbe6b630fca8c7fa98a98ad96f
6
+ metadata.gz: ee31985432275b2f8f4b610ea09c3eba05cd910bcdcd29048234c36a02571ec1400407df0b28427d15f24aeb7b4d5ec1ea032069a7da4535ce0b080594bed5f4
7
+ data.tar.gz: a50764572d48829d53018192b80db86aa0fd0dcb86e3aee1103459665e1d4616adc9ab58aaa32bb07fcbac39f3d7d721893d19031c9fc23c42ff959f2952f169
@@ -190,6 +190,21 @@ module Google
190
190
  #
191
191
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
192
192
  #
193
+ # @example Basic example
194
+ # require "google/cloud/recaptcha_enterprise/v1"
195
+ #
196
+ # # Create a client object. The client can be reused for multiple calls.
197
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
198
+ #
199
+ # # Create a request. To set request fields, pass in keyword arguments.
200
+ # request = Google::Cloud::RecaptchaEnterprise::V1::CreateAssessmentRequest.new
201
+ #
202
+ # # Call the create_assessment method.
203
+ # result = client.create_assessment request
204
+ #
205
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Assessment.
206
+ # p result
207
+ #
193
208
  def create_assessment request, options = nil
194
209
  raise ::ArgumentError, "request must be provided" if request.nil?
195
210
 
@@ -207,9 +222,11 @@ module Google
207
222
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
208
223
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
209
224
 
210
- header_params = {
211
- "parent" => request.parent
212
- }
225
+ header_params = {}
226
+ if request.parent
227
+ header_params["parent"] = request.parent
228
+ end
229
+
213
230
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
214
231
  metadata[:"x-goog-request-params"] ||= request_params_header
215
232
 
@@ -243,7 +260,7 @@ module Google
243
260
  # @param options [::Gapic::CallOptions, ::Hash]
244
261
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
245
262
  #
246
- # @overload annotate_assessment(name: nil, annotation: nil, reasons: nil)
263
+ # @overload annotate_assessment(name: nil, annotation: nil, reasons: nil, hashed_account_id: nil)
247
264
  # Pass arguments to `annotate_assessment` via keyword arguments. Note that at
248
265
  # least one keyword argument is required. To specify no parameters, or to keep all
249
266
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -257,6 +274,12 @@ module Google
257
274
  # the event is legitimate or fraudulent.
258
275
  # @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
259
276
  # Optional. Optional reasons for the annotation that will be assigned to the Event.
277
+ # @param hashed_account_id [::String]
278
+ # Optional. Optional unique stable hashed user identifier to apply to the assessment.
279
+ # This is an alternative to setting the hashed_account_id in
280
+ # CreateAssessment, for example when the account identifier is not yet known
281
+ # in the initial request. It is recommended that the identifier is hashed
282
+ # using hmac-sha256 with stable secret.
260
283
  #
261
284
  # @yield [response, operation] Access the result along with the RPC operation
262
285
  # @yieldparam response [::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse]
@@ -266,6 +289,21 @@ module Google
266
289
  #
267
290
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
268
291
  #
292
+ # @example Basic example
293
+ # require "google/cloud/recaptcha_enterprise/v1"
294
+ #
295
+ # # Create a client object. The client can be reused for multiple calls.
296
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
297
+ #
298
+ # # Create a request. To set request fields, pass in keyword arguments.
299
+ # request = Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest.new
300
+ #
301
+ # # Call the annotate_assessment method.
302
+ # result = client.annotate_assessment request
303
+ #
304
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentResponse.
305
+ # p result
306
+ #
269
307
  def annotate_assessment request, options = nil
270
308
  raise ::ArgumentError, "request must be provided" if request.nil?
271
309
 
@@ -283,9 +321,11 @@ module Google
283
321
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
284
322
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
285
323
 
286
- header_params = {
287
- "name" => request.name
288
- }
324
+ header_params = {}
325
+ if request.name
326
+ header_params["name"] = request.name
327
+ end
328
+
289
329
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
290
330
  metadata[:"x-goog-request-params"] ||= request_params_header
291
331
 
@@ -337,6 +377,21 @@ module Google
337
377
  #
338
378
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
339
379
  #
380
+ # @example Basic example
381
+ # require "google/cloud/recaptcha_enterprise/v1"
382
+ #
383
+ # # Create a client object. The client can be reused for multiple calls.
384
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
385
+ #
386
+ # # Create a request. To set request fields, pass in keyword arguments.
387
+ # request = Google::Cloud::RecaptchaEnterprise::V1::CreateKeyRequest.new
388
+ #
389
+ # # Call the create_key method.
390
+ # result = client.create_key request
391
+ #
392
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key.
393
+ # p result
394
+ #
340
395
  def create_key request, options = nil
341
396
  raise ::ArgumentError, "request must be provided" if request.nil?
342
397
 
@@ -354,9 +409,11 @@ module Google
354
409
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
355
410
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
356
411
 
357
- header_params = {
358
- "parent" => request.parent
359
- }
412
+ header_params = {}
413
+ if request.parent
414
+ header_params["parent"] = request.parent
415
+ end
416
+
360
417
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
361
418
  metadata[:"x-goog-request-params"] ||= request_params_header
362
419
 
@@ -412,6 +469,27 @@ module Google
412
469
  #
413
470
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
414
471
  #
472
+ # @example Basic example
473
+ # require "google/cloud/recaptcha_enterprise/v1"
474
+ #
475
+ # # Create a client object. The client can be reused for multiple calls.
476
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
477
+ #
478
+ # # Create a request. To set request fields, pass in keyword arguments.
479
+ # request = Google::Cloud::RecaptchaEnterprise::V1::ListKeysRequest.new
480
+ #
481
+ # # Call the list_keys method.
482
+ # result = client.list_keys request
483
+ #
484
+ # # The returned object is of type Gapic::PagedEnumerable. You can
485
+ # # iterate over all elements by calling #each, and the enumerable
486
+ # # will lazily make API calls to fetch subsequent pages. Other
487
+ # # methods are also available for managing paging directly.
488
+ # result.each do |response|
489
+ # # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::Key.
490
+ # p response
491
+ # end
492
+ #
415
493
  def list_keys request, options = nil
416
494
  raise ::ArgumentError, "request must be provided" if request.nil?
417
495
 
@@ -429,9 +507,11 @@ module Google
429
507
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
430
508
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
431
509
 
432
- header_params = {
433
- "parent" => request.parent
434
- }
510
+ header_params = {}
511
+ if request.parent
512
+ header_params["parent"] = request.parent
513
+ end
514
+
435
515
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
436
516
  metadata[:"x-goog-request-params"] ||= request_params_header
437
517
 
@@ -482,6 +562,21 @@ module Google
482
562
  #
483
563
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
484
564
  #
565
+ # @example Basic example
566
+ # require "google/cloud/recaptcha_enterprise/v1"
567
+ #
568
+ # # Create a client object. The client can be reused for multiple calls.
569
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
570
+ #
571
+ # # Create a request. To set request fields, pass in keyword arguments.
572
+ # request = Google::Cloud::RecaptchaEnterprise::V1::GetKeyRequest.new
573
+ #
574
+ # # Call the get_key method.
575
+ # result = client.get_key request
576
+ #
577
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key.
578
+ # p result
579
+ #
485
580
  def get_key request, options = nil
486
581
  raise ::ArgumentError, "request must be provided" if request.nil?
487
582
 
@@ -499,9 +594,11 @@ module Google
499
594
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
500
595
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
501
596
 
502
- header_params = {
503
- "name" => request.name
504
- }
597
+ header_params = {}
598
+ if request.name
599
+ header_params["name"] = request.name
600
+ end
601
+
505
602
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
506
603
  metadata[:"x-goog-request-params"] ||= request_params_header
507
604
 
@@ -553,6 +650,21 @@ module Google
553
650
  #
554
651
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
555
652
  #
653
+ # @example Basic example
654
+ # require "google/cloud/recaptcha_enterprise/v1"
655
+ #
656
+ # # Create a client object. The client can be reused for multiple calls.
657
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
658
+ #
659
+ # # Create a request. To set request fields, pass in keyword arguments.
660
+ # request = Google::Cloud::RecaptchaEnterprise::V1::UpdateKeyRequest.new
661
+ #
662
+ # # Call the update_key method.
663
+ # result = client.update_key request
664
+ #
665
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key.
666
+ # p result
667
+ #
556
668
  def update_key request, options = nil
557
669
  raise ::ArgumentError, "request must be provided" if request.nil?
558
670
 
@@ -570,9 +682,11 @@ module Google
570
682
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
571
683
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
572
684
 
573
- header_params = {
574
- "key.name" => request.key.name
575
- }
685
+ header_params = {}
686
+ if request.key&.name
687
+ header_params["key.name"] = request.key.name
688
+ end
689
+
576
690
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
577
691
  metadata[:"x-goog-request-params"] ||= request_params_header
578
692
 
@@ -622,6 +736,21 @@ module Google
622
736
  #
623
737
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
624
738
  #
739
+ # @example Basic example
740
+ # require "google/cloud/recaptcha_enterprise/v1"
741
+ #
742
+ # # Create a client object. The client can be reused for multiple calls.
743
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
744
+ #
745
+ # # Create a request. To set request fields, pass in keyword arguments.
746
+ # request = Google::Cloud::RecaptchaEnterprise::V1::DeleteKeyRequest.new
747
+ #
748
+ # # Call the delete_key method.
749
+ # result = client.delete_key request
750
+ #
751
+ # # The returned object is of type Google::Protobuf::Empty.
752
+ # p result
753
+ #
625
754
  def delete_key request, options = nil
626
755
  raise ::ArgumentError, "request must be provided" if request.nil?
627
756
 
@@ -639,9 +768,11 @@ module Google
639
768
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
640
769
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
641
770
 
642
- header_params = {
643
- "name" => request.name
644
- }
771
+ header_params = {}
772
+ if request.name
773
+ header_params["name"] = request.name
774
+ end
775
+
645
776
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
646
777
  metadata[:"x-goog-request-params"] ||= request_params_header
647
778
 
@@ -696,6 +827,21 @@ module Google
696
827
  #
697
828
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
698
829
  #
830
+ # @example Basic example
831
+ # require "google/cloud/recaptcha_enterprise/v1"
832
+ #
833
+ # # Create a client object. The client can be reused for multiple calls.
834
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
835
+ #
836
+ # # Create a request. To set request fields, pass in keyword arguments.
837
+ # request = Google::Cloud::RecaptchaEnterprise::V1::MigrateKeyRequest.new
838
+ #
839
+ # # Call the migrate_key method.
840
+ # result = client.migrate_key request
841
+ #
842
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Key.
843
+ # p result
844
+ #
699
845
  def migrate_key request, options = nil
700
846
  raise ::ArgumentError, "request must be provided" if request.nil?
701
847
 
@@ -713,9 +859,11 @@ module Google
713
859
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
714
860
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
715
861
 
716
- header_params = {
717
- "name" => request.name
718
- }
862
+ header_params = {}
863
+ if request.name
864
+ header_params["name"] = request.name
865
+ end
866
+
719
867
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
720
868
  metadata[:"x-goog-request-params"] ||= request_params_header
721
869
 
@@ -766,6 +914,21 @@ module Google
766
914
  #
767
915
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
768
916
  #
917
+ # @example Basic example
918
+ # require "google/cloud/recaptcha_enterprise/v1"
919
+ #
920
+ # # Create a client object. The client can be reused for multiple calls.
921
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
922
+ #
923
+ # # Create a request. To set request fields, pass in keyword arguments.
924
+ # request = Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest.new
925
+ #
926
+ # # Call the get_metrics method.
927
+ # result = client.get_metrics request
928
+ #
929
+ # # The returned object is of type Google::Cloud::RecaptchaEnterprise::V1::Metrics.
930
+ # p result
931
+ #
769
932
  def get_metrics request, options = nil
770
933
  raise ::ArgumentError, "request must be provided" if request.nil?
771
934
 
@@ -783,9 +946,11 @@ module Google
783
946
  gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
784
947
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
785
948
 
786
- header_params = {
787
- "name" => request.name
788
- }
949
+ header_params = {}
950
+ if request.name
951
+ header_params["name"] = request.name
952
+ end
953
+
789
954
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
790
955
  metadata[:"x-goog-request-params"] ||= request_params_header
791
956
 
@@ -805,6 +970,326 @@ module Google
805
970
  raise ::Google::Cloud::Error.from_error(e)
806
971
  end
807
972
 
973
+ ##
974
+ # List groups of related accounts.
975
+ #
976
+ # @overload list_related_account_groups(request, options = nil)
977
+ # Pass arguments to `list_related_account_groups` via a request object, either of type
978
+ # {::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest} or an equivalent Hash.
979
+ #
980
+ # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest, ::Hash]
981
+ # A request object representing the call parameters. Required. To specify no
982
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
983
+ # @param options [::Gapic::CallOptions, ::Hash]
984
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
985
+ #
986
+ # @overload list_related_account_groups(parent: nil, page_size: nil, page_token: nil)
987
+ # Pass arguments to `list_related_account_groups` via keyword arguments. Note that at
988
+ # least one keyword argument is required. To specify no parameters, or to keep all
989
+ # the default parameter values, pass an empty Hash as a request object (see above).
990
+ #
991
+ # @param parent [::String]
992
+ # Required. The name of the project to list related account groups from, in the format
993
+ # "projects/\\{project}".
994
+ # @param page_size [::Integer]
995
+ # Optional. The maximum number of groups to return. The service may return fewer than
996
+ # this value.
997
+ # If unspecified, at most 50 groups will be returned.
998
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
999
+ # @param page_token [::String]
1000
+ # Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
1001
+ # Provide this to retrieve the subsequent page.
1002
+ #
1003
+ # When paginating, all other parameters provided to
1004
+ # `ListRelatedAccountGroups` must match the call that provided the page
1005
+ # token.
1006
+ #
1007
+ # @yield [response, operation] Access the result along with the RPC operation
1008
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>]
1009
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1010
+ #
1011
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>]
1012
+ #
1013
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1014
+ #
1015
+ # @example Basic example
1016
+ # require "google/cloud/recaptcha_enterprise/v1"
1017
+ #
1018
+ # # Create a client object. The client can be reused for multiple calls.
1019
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
1020
+ #
1021
+ # # Create a request. To set request fields, pass in keyword arguments.
1022
+ # request = Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest.new
1023
+ #
1024
+ # # Call the list_related_account_groups method.
1025
+ # result = client.list_related_account_groups request
1026
+ #
1027
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1028
+ # # iterate over all elements by calling #each, and the enumerable
1029
+ # # will lazily make API calls to fetch subsequent pages. Other
1030
+ # # methods are also available for managing paging directly.
1031
+ # result.each do |response|
1032
+ # # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup.
1033
+ # p response
1034
+ # end
1035
+ #
1036
+ def list_related_account_groups request, options = nil
1037
+ raise ::ArgumentError, "request must be provided" if request.nil?
1038
+
1039
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest
1040
+
1041
+ # Converts hash and nil to an options object
1042
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1043
+
1044
+ # Customize the options with defaults
1045
+ metadata = @config.rpcs.list_related_account_groups.metadata.to_h
1046
+
1047
+ # Set x-goog-api-client and x-goog-user-project headers
1048
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1049
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1050
+ gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
1051
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1052
+
1053
+ header_params = {}
1054
+ if request.parent
1055
+ header_params["parent"] = request.parent
1056
+ end
1057
+
1058
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1059
+ metadata[:"x-goog-request-params"] ||= request_params_header
1060
+
1061
+ options.apply_defaults timeout: @config.rpcs.list_related_account_groups.timeout,
1062
+ metadata: metadata,
1063
+ retry_policy: @config.rpcs.list_related_account_groups.retry_policy
1064
+
1065
+ options.apply_defaults timeout: @config.timeout,
1066
+ metadata: @config.metadata,
1067
+ retry_policy: @config.retry_policy
1068
+
1069
+ @recaptcha_enterprise_service_stub.call_rpc :list_related_account_groups, request, options: options do |response, operation|
1070
+ response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_related_account_groups, request, response, operation, options
1071
+ yield response, operation if block_given?
1072
+ return response
1073
+ end
1074
+ rescue ::GRPC::BadStatus => e
1075
+ raise ::Google::Cloud::Error.from_error(e)
1076
+ end
1077
+
1078
+ ##
1079
+ # Get the memberships in a group of related accounts.
1080
+ #
1081
+ # @overload list_related_account_group_memberships(request, options = nil)
1082
+ # Pass arguments to `list_related_account_group_memberships` via a request object, either of type
1083
+ # {::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest} or an equivalent Hash.
1084
+ #
1085
+ # @param request [::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest, ::Hash]
1086
+ # A request object representing the call parameters. Required. To specify no
1087
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1088
+ # @param options [::Gapic::CallOptions, ::Hash]
1089
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1090
+ #
1091
+ # @overload list_related_account_group_memberships(parent: nil, page_size: nil, page_token: nil)
1092
+ # Pass arguments to `list_related_account_group_memberships` via keyword arguments. Note that at
1093
+ # least one keyword argument is required. To specify no parameters, or to keep all
1094
+ # the default parameter values, pass an empty Hash as a request object (see above).
1095
+ #
1096
+ # @param parent [::String]
1097
+ # Required. The resource name for the related account group in the format
1098
+ # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
1099
+ # @param page_size [::Integer]
1100
+ # Optional. The maximum number of accounts to return. The service may return fewer than
1101
+ # this value.
1102
+ # If unspecified, at most 50 accounts will be returned.
1103
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
1104
+ # @param page_token [::String]
1105
+ # Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
1106
+ # call.
1107
+ #
1108
+ # When paginating, all other parameters provided to
1109
+ # `ListRelatedAccountGroupMemberships` must match the call that provided the
1110
+ # page token.
1111
+ #
1112
+ # @yield [response, operation] Access the result along with the RPC operation
1113
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
1114
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1115
+ #
1116
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
1117
+ #
1118
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1119
+ #
1120
+ # @example Basic example
1121
+ # require "google/cloud/recaptcha_enterprise/v1"
1122
+ #
1123
+ # # Create a client object. The client can be reused for multiple calls.
1124
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
1125
+ #
1126
+ # # Create a request. To set request fields, pass in keyword arguments.
1127
+ # request = Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest.new
1128
+ #
1129
+ # # Call the list_related_account_group_memberships method.
1130
+ # result = client.list_related_account_group_memberships request
1131
+ #
1132
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1133
+ # # iterate over all elements by calling #each, and the enumerable
1134
+ # # will lazily make API calls to fetch subsequent pages. Other
1135
+ # # methods are also available for managing paging directly.
1136
+ # result.each do |response|
1137
+ # # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership.
1138
+ # p response
1139
+ # end
1140
+ #
1141
+ def list_related_account_group_memberships request, options = nil
1142
+ raise ::ArgumentError, "request must be provided" if request.nil?
1143
+
1144
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest
1145
+
1146
+ # Converts hash and nil to an options object
1147
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1148
+
1149
+ # Customize the options with defaults
1150
+ metadata = @config.rpcs.list_related_account_group_memberships.metadata.to_h
1151
+
1152
+ # Set x-goog-api-client and x-goog-user-project headers
1153
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1154
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1155
+ gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
1156
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1157
+
1158
+ header_params = {}
1159
+ if request.parent
1160
+ header_params["parent"] = request.parent
1161
+ end
1162
+
1163
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1164
+ metadata[:"x-goog-request-params"] ||= request_params_header
1165
+
1166
+ options.apply_defaults timeout: @config.rpcs.list_related_account_group_memberships.timeout,
1167
+ metadata: metadata,
1168
+ retry_policy: @config.rpcs.list_related_account_group_memberships.retry_policy
1169
+
1170
+ options.apply_defaults timeout: @config.timeout,
1171
+ metadata: @config.metadata,
1172
+ retry_policy: @config.retry_policy
1173
+
1174
+ @recaptcha_enterprise_service_stub.call_rpc :list_related_account_group_memberships, request, options: options do |response, operation|
1175
+ response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :list_related_account_group_memberships, request, response, operation, options
1176
+ yield response, operation if block_given?
1177
+ return response
1178
+ end
1179
+ rescue ::GRPC::BadStatus => e
1180
+ raise ::Google::Cloud::Error.from_error(e)
1181
+ end
1182
+
1183
+ ##
1184
+ # Search group memberships related to a given account.
1185
+ #
1186
+ # @overload search_related_account_group_memberships(request, options = nil)
1187
+ # Pass arguments to `search_related_account_group_memberships` via a request object, either of type
1188
+ # {::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest} or an equivalent Hash.
1189
+ #
1190
+ # @param request [::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest, ::Hash]
1191
+ # A request object representing the call parameters. Required. To specify no
1192
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1193
+ # @param options [::Gapic::CallOptions, ::Hash]
1194
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1195
+ #
1196
+ # @overload search_related_account_group_memberships(parent: nil, hashed_account_id: nil, page_size: nil, page_token: nil)
1197
+ # Pass arguments to `search_related_account_group_memberships` via keyword arguments. Note that at
1198
+ # least one keyword argument is required. To specify no parameters, or to keep all
1199
+ # the default parameter values, pass an empty Hash as a request object (see above).
1200
+ #
1201
+ # @param parent [::String]
1202
+ # Required. The name of the project to search related account group memberships from,
1203
+ # in the format "projects/\\{project}".
1204
+ # @param hashed_account_id [::String]
1205
+ # Optional. The unique stable hashed user identifier we should search connections to.
1206
+ # The identifier should correspond to a `hashed_account_id` provided in a
1207
+ # previous CreateAssessment or AnnotateAssessment call.
1208
+ # @param page_size [::Integer]
1209
+ # Optional. The maximum number of groups to return. The service may return fewer than
1210
+ # this value.
1211
+ # If unspecified, at most 50 groups will be returned.
1212
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
1213
+ # @param page_token [::String]
1214
+ # Optional. A page token, received from a previous
1215
+ # `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
1216
+ # subsequent page.
1217
+ #
1218
+ # When paginating, all other parameters provided to
1219
+ # `SearchRelatedAccountGroupMemberships` must match the call that provided
1220
+ # the page token.
1221
+ #
1222
+ # @yield [response, operation] Access the result along with the RPC operation
1223
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
1224
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1225
+ #
1226
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
1227
+ #
1228
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1229
+ #
1230
+ # @example Basic example
1231
+ # require "google/cloud/recaptcha_enterprise/v1"
1232
+ #
1233
+ # # Create a client object. The client can be reused for multiple calls.
1234
+ # client = Google::Cloud::RecaptchaEnterprise::V1::RecaptchaEnterpriseService::Client.new
1235
+ #
1236
+ # # Create a request. To set request fields, pass in keyword arguments.
1237
+ # request = Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest.new
1238
+ #
1239
+ # # Call the search_related_account_group_memberships method.
1240
+ # result = client.search_related_account_group_memberships request
1241
+ #
1242
+ # # The returned object is of type Gapic::PagedEnumerable. You can
1243
+ # # iterate over all elements by calling #each, and the enumerable
1244
+ # # will lazily make API calls to fetch subsequent pages. Other
1245
+ # # methods are also available for managing paging directly.
1246
+ # result.each do |response|
1247
+ # # Each element is of type ::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership.
1248
+ # p response
1249
+ # end
1250
+ #
1251
+ def search_related_account_group_memberships request, options = nil
1252
+ raise ::ArgumentError, "request must be provided" if request.nil?
1253
+
1254
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest
1255
+
1256
+ # Converts hash and nil to an options object
1257
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1258
+
1259
+ # Customize the options with defaults
1260
+ metadata = @config.rpcs.search_related_account_group_memberships.metadata.to_h
1261
+
1262
+ # Set x-goog-api-client and x-goog-user-project headers
1263
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1264
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1265
+ gapic_version: ::Google::Cloud::RecaptchaEnterprise::V1::VERSION
1266
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1267
+
1268
+ header_params = {}
1269
+ if request.parent
1270
+ header_params["parent"] = request.parent
1271
+ end
1272
+
1273
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1274
+ metadata[:"x-goog-request-params"] ||= request_params_header
1275
+
1276
+ options.apply_defaults timeout: @config.rpcs.search_related_account_group_memberships.timeout,
1277
+ metadata: metadata,
1278
+ retry_policy: @config.rpcs.search_related_account_group_memberships.retry_policy
1279
+
1280
+ options.apply_defaults timeout: @config.timeout,
1281
+ metadata: @config.metadata,
1282
+ retry_policy: @config.retry_policy
1283
+
1284
+ @recaptcha_enterprise_service_stub.call_rpc :search_related_account_group_memberships, request, options: options do |response, operation|
1285
+ response = ::Gapic::PagedEnumerable.new @recaptcha_enterprise_service_stub, :search_related_account_group_memberships, request, response, operation, options
1286
+ yield response, operation if block_given?
1287
+ return response
1288
+ end
1289
+ rescue ::GRPC::BadStatus => e
1290
+ raise ::Google::Cloud::Error.from_error(e)
1291
+ end
1292
+
808
1293
  ##
809
1294
  # Configuration class for the RecaptchaEnterpriseService API.
810
1295
  #
@@ -985,6 +1470,21 @@ module Google
985
1470
  # @return [::Gapic::Config::Method]
986
1471
  #
987
1472
  attr_reader :get_metrics
1473
+ ##
1474
+ # RPC-specific configuration for `list_related_account_groups`
1475
+ # @return [::Gapic::Config::Method]
1476
+ #
1477
+ attr_reader :list_related_account_groups
1478
+ ##
1479
+ # RPC-specific configuration for `list_related_account_group_memberships`
1480
+ # @return [::Gapic::Config::Method]
1481
+ #
1482
+ attr_reader :list_related_account_group_memberships
1483
+ ##
1484
+ # RPC-specific configuration for `search_related_account_group_memberships`
1485
+ # @return [::Gapic::Config::Method]
1486
+ #
1487
+ attr_reader :search_related_account_group_memberships
988
1488
 
989
1489
  # @private
990
1490
  def initialize parent_rpcs = nil
@@ -1006,6 +1506,12 @@ module Google
1006
1506
  @migrate_key = ::Gapic::Config::Method.new migrate_key_config
1007
1507
  get_metrics_config = parent_rpcs.get_metrics if parent_rpcs.respond_to? :get_metrics
1008
1508
  @get_metrics = ::Gapic::Config::Method.new get_metrics_config
1509
+ list_related_account_groups_config = parent_rpcs.list_related_account_groups if parent_rpcs.respond_to? :list_related_account_groups
1510
+ @list_related_account_groups = ::Gapic::Config::Method.new list_related_account_groups_config
1511
+ list_related_account_group_memberships_config = parent_rpcs.list_related_account_group_memberships if parent_rpcs.respond_to? :list_related_account_group_memberships
1512
+ @list_related_account_group_memberships = ::Gapic::Config::Method.new list_related_account_group_memberships_config
1513
+ search_related_account_group_memberships_config = parent_rpcs.search_related_account_group_memberships if parent_rpcs.respond_to? :search_related_account_group_memberships
1514
+ @search_related_account_group_memberships = ::Gapic::Config::Method.new search_related_account_group_memberships_config
1009
1515
 
1010
1516
  yield self if block_given?
1011
1517
  end
@@ -89,6 +89,23 @@ module Google
89
89
  "projects/#{project}"
90
90
  end
91
91
 
92
+ ##
93
+ # Create a fully-qualified RelatedAccountGroup resource string.
94
+ #
95
+ # The resource will be in the following format:
96
+ #
97
+ # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`
98
+ #
99
+ # @param project [String]
100
+ # @param relatedaccountgroup [String]
101
+ #
102
+ # @return [::String]
103
+ def related_account_group_path project:, relatedaccountgroup:
104
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
105
+
106
+ "projects/#{project}/relatedaccountgroups/#{relatedaccountgroup}"
107
+ end
108
+
92
109
  extend self
93
110
  end
94
111
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module RecaptchaEnterprise
23
23
  module V1
24
- VERSION = "0.5.0"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
10
8
  require 'google/protobuf/empty_pb'
11
9
  require 'google/protobuf/field_mask_pb'
12
10
  require 'google/protobuf/timestamp_pb'
11
+ require 'google/protobuf'
12
+
13
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
14
  add_file("google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto", :syntax => :proto3) do
15
15
  add_message "google.cloud.recaptchaenterprise.v1.CreateAssessmentRequest" do
@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
20
20
  optional :name, :string, 1
21
21
  optional :annotation, :enum, 2, "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation"
22
22
  repeated :reasons, :enum, 3, "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason"
23
+ optional :hashed_account_id, :bytes, 4
23
24
  end
24
25
  add_enum "google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation" do
25
26
  value :ANNOTATION_UNSPECIFIED, 0
@@ -45,6 +46,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
45
46
  optional :event, :message, 2, "google.cloud.recaptchaenterprise.v1.Event"
46
47
  optional :risk_analysis, :message, 3, "google.cloud.recaptchaenterprise.v1.RiskAnalysis"
47
48
  optional :token_properties, :message, 4, "google.cloud.recaptchaenterprise.v1.TokenProperties"
49
+ optional :account_defender_assessment, :message, 6, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment"
48
50
  end
49
51
  add_message "google.cloud.recaptchaenterprise.v1.Event" do
50
52
  optional :token, :string, 1
@@ -52,6 +54,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
52
54
  optional :user_agent, :string, 3
53
55
  optional :user_ip_address, :string, 4
54
56
  optional :expected_action, :string, 5
57
+ optional :hashed_account_id, :bytes, 6
55
58
  end
56
59
  add_message "google.cloud.recaptchaenterprise.v1.RiskAnalysis" do
57
60
  optional :score, :float, 1
@@ -81,6 +84,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
81
84
  value :MISSING, 5
82
85
  value :BROWSER_ERROR, 6
83
86
  end
87
+ add_message "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment" do
88
+ repeated :labels, :enum, 1, "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel"
89
+ end
90
+ add_enum "google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel" do
91
+ value :ACCOUNT_DEFENDER_LABEL_UNSPECIFIED, 0
92
+ value :PROFILE_MATCH, 1
93
+ value :SUSPICIOUS_LOGIN_ACTIVITY, 2
94
+ value :SUSPICIOUS_ACCOUNT_CREATION, 3
95
+ value :RELATED_ACCOUNTS_NUMBER_HIGH, 4
96
+ end
84
97
  add_message "google.cloud.recaptchaenterprise.v1.CreateKeyRequest" do
85
98
  optional :parent, :string, 1
86
99
  optional :key, :message, 2, "google.cloud.recaptchaenterprise.v1.Key"
@@ -177,6 +190,41 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
177
190
  optional :failed_count, :int64, 3
178
191
  optional :passed_count, :int64, 4
179
192
  end
193
+ add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsRequest" do
194
+ optional :parent, :string, 1
195
+ optional :page_size, :int32, 2
196
+ optional :page_token, :string, 3
197
+ end
198
+ add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse" do
199
+ repeated :related_account_group_memberships, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership"
200
+ optional :next_page_token, :string, 2
201
+ end
202
+ add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsRequest" do
203
+ optional :parent, :string, 1
204
+ optional :page_size, :int32, 2
205
+ optional :page_token, :string, 3
206
+ end
207
+ add_message "google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse" do
208
+ repeated :related_account_groups, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroup"
209
+ optional :next_page_token, :string, 2
210
+ end
211
+ add_message "google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest" do
212
+ optional :parent, :string, 1
213
+ optional :hashed_account_id, :bytes, 2
214
+ optional :page_size, :int32, 3
215
+ optional :page_token, :string, 4
216
+ end
217
+ add_message "google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse" do
218
+ repeated :related_account_group_memberships, :message, 1, "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership"
219
+ optional :next_page_token, :string, 2
220
+ end
221
+ add_message "google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership" do
222
+ optional :name, :string, 1
223
+ optional :hashed_account_id, :bytes, 2
224
+ end
225
+ add_message "google.cloud.recaptchaenterprise.v1.RelatedAccountGroup" do
226
+ optional :name, :string, 1
227
+ end
180
228
  end
181
229
  end
182
230
 
@@ -195,6 +243,8 @@ module Google
195
243
  RiskAnalysis::ClassificationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RiskAnalysis.ClassificationReason").enummodule
196
244
  TokenProperties = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties").msgclass
197
245
  TokenProperties::InvalidReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.TokenProperties.InvalidReason").enummodule
246
+ AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment").msgclass
247
+ AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
198
248
  CreateKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.CreateKeyRequest").msgclass
199
249
  ListKeysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysRequest").msgclass
200
250
  ListKeysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListKeysResponse").msgclass
@@ -215,6 +265,14 @@ module Google
215
265
  ScoreDistribution = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ScoreDistribution").msgclass
216
266
  ScoreMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ScoreMetrics").msgclass
217
267
  ChallengeMetrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ChallengeMetrics").msgclass
268
+ ListRelatedAccountGroupMembershipsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsRequest").msgclass
269
+ ListRelatedAccountGroupMembershipsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse").msgclass
270
+ ListRelatedAccountGroupsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsRequest").msgclass
271
+ ListRelatedAccountGroupsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse").msgclass
272
+ SearchRelatedAccountGroupMembershipsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsRequest").msgclass
273
+ SearchRelatedAccountGroupMembershipsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse").msgclass
274
+ RelatedAccountGroupMembership = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RelatedAccountGroupMembership").msgclass
275
+ RelatedAccountGroup = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1.RelatedAccountGroup").msgclass
218
276
  end
219
277
  end
220
278
  end
@@ -27,7 +27,7 @@ module Google
27
27
  # Service to determine the likelihood an event is legitimate.
28
28
  class Service
29
29
 
30
- include GRPC::GenericService
30
+ include ::GRPC::GenericService
31
31
 
32
32
  self.marshal_class_method = :encode
33
33
  self.unmarshal_class_method = :decode
@@ -58,6 +58,12 @@ module Google
58
58
  # Get some aggregated metrics for a Key. This data can be used to build
59
59
  # dashboards.
60
60
  rpc :GetMetrics, ::Google::Cloud::RecaptchaEnterprise::V1::GetMetricsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::Metrics
61
+ # List groups of related accounts.
62
+ rpc :ListRelatedAccountGroups, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupsResponse
63
+ # Get the memberships in a group of related accounts.
64
+ rpc :ListRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::ListRelatedAccountGroupMembershipsResponse
65
+ # Search group memberships related to a given account.
66
+ rpc :SearchRelatedAccountGroupMemberships, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsRequest, ::Google::Cloud::RecaptchaEnterprise::V1::SearchRelatedAccountGroupMembershipsResponse
61
67
  end
62
68
 
63
69
  Stub = Service.rpc_stub_class
@@ -47,6 +47,13 @@ module Google
47
47
  # @!attribute [rw] reasons
48
48
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>]
49
49
  # Optional. Optional reasons for the annotation that will be assigned to the Event.
50
+ # @!attribute [rw] hashed_account_id
51
+ # @return [::String]
52
+ # Optional. Optional unique stable hashed user identifier to apply to the assessment.
53
+ # This is an alternative to setting the hashed_account_id in
54
+ # CreateAssessment, for example when the account identifier is not yet known
55
+ # in the initial request. It is recommended that the identifier is hashed
56
+ # using hmac-sha256 with stable secret.
50
57
  class AnnotateAssessmentRequest
51
58
  include ::Google::Protobuf::MessageExts
52
59
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -127,6 +134,10 @@ module Google
127
134
  # @!attribute [r] token_properties
128
135
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::TokenProperties]
129
136
  # Output only. Properties of the provided event token.
137
+ # @!attribute [rw] account_defender_assessment
138
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment]
139
+ # Assessment returned by Account Defender when a hashed_account_id is
140
+ # provided.
130
141
  class Assessment
131
142
  include ::Google::Protobuf::MessageExts
132
143
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -152,6 +163,10 @@ module Google
152
163
  # Optional. The expected action for this type of event. This should be the same action
153
164
  # provided at token generation time on client-side platforms already
154
165
  # integrated with recaptcha enterprise.
166
+ # @!attribute [rw] hashed_account_id
167
+ # @return [::String]
168
+ # Optional. Optional unique stable hashed user identifier for the request. The
169
+ # identifier should ideally be hashed using sha256 with stable secret.
155
170
  class Event
156
171
  include ::Google::Protobuf::MessageExts
157
172
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -243,6 +258,37 @@ module Google
243
258
  end
244
259
  end
245
260
 
261
+ # Account Defender risk assessment.
262
+ # @!attribute [rw] labels
263
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::AccountDefenderAssessment::AccountDefenderLabel>]
264
+ # Labels for this request.
265
+ class AccountDefenderAssessment
266
+ include ::Google::Protobuf::MessageExts
267
+ extend ::Google::Protobuf::MessageExts::ClassMethods
268
+
269
+ # Labels returned by Account Defender for this request.
270
+ module AccountDefenderLabel
271
+ # Default unspecified type.
272
+ ACCOUNT_DEFENDER_LABEL_UNSPECIFIED = 0
273
+
274
+ # The request matches a known good profile for the user.
275
+ PROFILE_MATCH = 1
276
+
277
+ # The request is potentially a suspicious login event and should be further
278
+ # verified either via multi-factor authentication or another system.
279
+ SUSPICIOUS_LOGIN_ACTIVITY = 2
280
+
281
+ # The request matched a profile that previously had suspicious account
282
+ # creation behavior. This could mean this is a fake account.
283
+ SUSPICIOUS_ACCOUNT_CREATION = 3
284
+
285
+ # The account in the request has a high number of related accounts. It does
286
+ # not necessarily imply that the account is bad but could require
287
+ # investigating.
288
+ RELATED_ACCOUNTS_NUMBER_HIGH = 4
289
+ end
290
+ end
291
+
246
292
  # The create key request message.
247
293
  # @!attribute [rw] parent
248
294
  # @return [::String]
@@ -425,11 +471,11 @@ module Google
425
471
  # challenge depending on risk and trust factors.
426
472
  TESTING_CHALLENGE_UNSPECIFIED = 0
427
473
 
428
- # Challenge requests for this key will always return a nocaptcha, which
474
+ # Challenge requests for this key always return a nocaptcha, which
429
475
  # does not require a solution.
430
476
  NOCAPTCHA = 1
431
477
 
432
- # Challenge requests for this key will always return an unsolvable
478
+ # Challenge requests for this key always return an unsolvable
433
479
  # challenge.
434
480
  UNSOLVABLE_CHALLENGE = 2
435
481
  end
@@ -447,8 +493,8 @@ module Google
447
493
  # Examples: 'example.com' or 'subdomain.example.com'
448
494
  # @!attribute [rw] allow_amp_traffic
449
495
  # @return [::Boolean]
450
- # Required. Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
451
- # This can only be set for the SCORE integration type.
496
+ # If set to true, the key can be used on AMP (Accelerated Mobile Pages)
497
+ # websites. This is supported only for the SCORE integration type.
452
498
  # @!attribute [rw] integration_type
453
499
  # @return [::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType]
454
500
  # Required. Describes how this key is integrated with the website.
@@ -501,7 +547,7 @@ module Google
501
547
  # Settings specific to keys that can be used by Android apps.
502
548
  # @!attribute [rw] allow_all_package_names
503
549
  # @return [::Boolean]
504
- # If set to true, it means allowed_package_names will not be enforced.
550
+ # If set to true, allowed_package_names are not enforced.
505
551
  # @!attribute [rw] allowed_package_names
506
552
  # @return [::Array<::String>]
507
553
  # Android package names of apps allowed to use the key.
@@ -514,7 +560,7 @@ module Google
514
560
  # Settings specific to keys that can be used by iOS apps.
515
561
  # @!attribute [rw] allow_all_bundle_ids
516
562
  # @return [::Boolean]
517
- # If set to true, it means allowed_bundle_ids will not be enforced.
563
+ # If set to true, allowed_bundle_ids are not enforced.
518
564
  # @!attribute [rw] allowed_bundle_ids
519
565
  # @return [::Array<::String>]
520
566
  # iOS bundle ids of apps allowed to use the key.
@@ -588,6 +634,148 @@ module Google
588
634
  include ::Google::Protobuf::MessageExts
589
635
  extend ::Google::Protobuf::MessageExts::ClassMethods
590
636
  end
637
+
638
+ # The request message to list memberships in a related account group.
639
+ # @!attribute [rw] parent
640
+ # @return [::String]
641
+ # Required. The resource name for the related account group in the format
642
+ # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
643
+ # @!attribute [rw] page_size
644
+ # @return [::Integer]
645
+ # Optional. The maximum number of accounts to return. The service may return fewer than
646
+ # this value.
647
+ # If unspecified, at most 50 accounts will be returned.
648
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
649
+ # @!attribute [rw] page_token
650
+ # @return [::String]
651
+ # Optional. A page token, received from a previous `ListRelatedAccountGroupMemberships`
652
+ # call.
653
+ #
654
+ # When paginating, all other parameters provided to
655
+ # `ListRelatedAccountGroupMemberships` must match the call that provided the
656
+ # page token.
657
+ class ListRelatedAccountGroupMembershipsRequest
658
+ include ::Google::Protobuf::MessageExts
659
+ extend ::Google::Protobuf::MessageExts::ClassMethods
660
+ end
661
+
662
+ # The response to a `ListRelatedAccountGroupMemberships` call.
663
+ # @!attribute [rw] related_account_group_memberships
664
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
665
+ # The memberships listed by the query.
666
+ # @!attribute [rw] next_page_token
667
+ # @return [::String]
668
+ # A token, which can be sent as `page_token` to retrieve the next page.
669
+ # If this field is omitted, there are no subsequent pages.
670
+ class ListRelatedAccountGroupMembershipsResponse
671
+ include ::Google::Protobuf::MessageExts
672
+ extend ::Google::Protobuf::MessageExts::ClassMethods
673
+ end
674
+
675
+ # The request message to list related account groups.
676
+ # @!attribute [rw] parent
677
+ # @return [::String]
678
+ # Required. The name of the project to list related account groups from, in the format
679
+ # "projects/\\{project}".
680
+ # @!attribute [rw] page_size
681
+ # @return [::Integer]
682
+ # Optional. The maximum number of groups to return. The service may return fewer than
683
+ # this value.
684
+ # If unspecified, at most 50 groups will be returned.
685
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
686
+ # @!attribute [rw] page_token
687
+ # @return [::String]
688
+ # Optional. A page token, received from a previous `ListRelatedAccountGroups` call.
689
+ # Provide this to retrieve the subsequent page.
690
+ #
691
+ # When paginating, all other parameters provided to
692
+ # `ListRelatedAccountGroups` must match the call that provided the page
693
+ # token.
694
+ class ListRelatedAccountGroupsRequest
695
+ include ::Google::Protobuf::MessageExts
696
+ extend ::Google::Protobuf::MessageExts::ClassMethods
697
+ end
698
+
699
+ # The response to a `ListRelatedAccountGroups` call.
700
+ # @!attribute [rw] related_account_groups
701
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroup>]
702
+ # The groups of related accounts listed by the query.
703
+ # @!attribute [rw] next_page_token
704
+ # @return [::String]
705
+ # A token, which can be sent as `page_token` to retrieve the next page.
706
+ # If this field is omitted, there are no subsequent pages.
707
+ class ListRelatedAccountGroupsResponse
708
+ include ::Google::Protobuf::MessageExts
709
+ extend ::Google::Protobuf::MessageExts::ClassMethods
710
+ end
711
+
712
+ # The request message to search related account group memberships.
713
+ # @!attribute [rw] parent
714
+ # @return [::String]
715
+ # Required. The name of the project to search related account group memberships from,
716
+ # in the format "projects/\\{project}".
717
+ # @!attribute [rw] hashed_account_id
718
+ # @return [::String]
719
+ # Optional. The unique stable hashed user identifier we should search connections to.
720
+ # The identifier should correspond to a `hashed_account_id` provided in a
721
+ # previous CreateAssessment or AnnotateAssessment call.
722
+ # @!attribute [rw] page_size
723
+ # @return [::Integer]
724
+ # Optional. The maximum number of groups to return. The service may return fewer than
725
+ # this value.
726
+ # If unspecified, at most 50 groups will be returned.
727
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
728
+ # @!attribute [rw] page_token
729
+ # @return [::String]
730
+ # Optional. A page token, received from a previous
731
+ # `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
732
+ # subsequent page.
733
+ #
734
+ # When paginating, all other parameters provided to
735
+ # `SearchRelatedAccountGroupMemberships` must match the call that provided
736
+ # the page token.
737
+ class SearchRelatedAccountGroupMembershipsRequest
738
+ include ::Google::Protobuf::MessageExts
739
+ extend ::Google::Protobuf::MessageExts::ClassMethods
740
+ end
741
+
742
+ # The response to a `SearchRelatedAccountGroupMemberships` call.
743
+ # @!attribute [rw] related_account_group_memberships
744
+ # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1::RelatedAccountGroupMembership>]
745
+ # The queried memberships.
746
+ # @!attribute [rw] next_page_token
747
+ # @return [::String]
748
+ # A token, which can be sent as `page_token` to retrieve the next page.
749
+ # If this field is omitted, there are no subsequent pages.
750
+ class SearchRelatedAccountGroupMembershipsResponse
751
+ include ::Google::Protobuf::MessageExts
752
+ extend ::Google::Protobuf::MessageExts::ClassMethods
753
+ end
754
+
755
+ # A membership in a group of related accounts.
756
+ # @!attribute [rw] name
757
+ # @return [::String]
758
+ # Required. The resource name for this membership in the format
759
+ # `projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}`.
760
+ # @!attribute [rw] hashed_account_id
761
+ # @return [::String]
762
+ # The unique stable hashed user identifier of the member. The identifier
763
+ # corresponds to a `hashed_account_id` provided in a previous
764
+ # CreateAssessment or AnnotateAssessment call.
765
+ class RelatedAccountGroupMembership
766
+ include ::Google::Protobuf::MessageExts
767
+ extend ::Google::Protobuf::MessageExts::ClassMethods
768
+ end
769
+
770
+ # A group of related accounts.
771
+ # @!attribute [rw] name
772
+ # @return [::String]
773
+ # Required. The resource name for the related account group in the format
774
+ # `projects/{project}/relatedaccountgroups/{related_account_group}`.
775
+ class RelatedAccountGroup
776
+ include ::Google::Protobuf::MessageExts
777
+ extend ::Google::Protobuf::MessageExts::ClassMethods
778
+ end
591
779
  end
592
780
  end
593
781
  end
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.5.0
4
+ version: 0.6.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: 2021-09-22 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common