google-cloud-recaptcha_enterprise-v1beta1 0.10.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/client.rb +39 -17
  4. data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/client.rb +41 -16
  5. data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/recaptcha_enterprise/v1beta1/version.rb +1 -1
  7. data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb +2 -1
  8. data/proto_docs/google/api/client.rb +14 -0
  9. data/proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb +22 -11
  10. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6bd011612ef4d1de27bd77b27830d491a7763f39d3fa66fe3b9a9062d61d3d92
4
- data.tar.gz: e0aa32aaf89a0579a9b73216715ff63323a02314c0855f780e1deac3761d35db
3
+ metadata.gz: ae53ce19d154d8db034644aaa549952c2b254ac7250e50747fd90dc5c7cf17d4
4
+ data.tar.gz: ab246cfa96865045d52069d8b4591369daf96a1ec3f7aa1c0fd044132eba1928
5
5
  SHA512:
6
- metadata.gz: 4b7474396027bb799805d871578d2900e05d142569063172f7738f9704e644e7f2b6eece288518f134cbb2212e7eb2f00983a003f890324a26324b505dbb755c
7
- data.tar.gz: a805fe46d90eca65c23fc5c3725d316679e6939371218d567b025f340dd6b59155b333e8faa871f195da7522bd56bded56fc2bc82ed2637956700fc36d76e3dc
6
+ metadata.gz: db39460b9fc1c77b23b241482485b9548f5f8a9f1ca3354f40448ac7cd4e4d300da7dae33fc5927c533717276d6166d4ca8b8439f5800eb5a124a0f73d2a6aa9
7
+ data.tar.gz: e226ac8f65f9c0dff6f8217ddb494da06936979625c4be7c28323f774eab41ceee1008fea4608b7687b747be60d88a45ef788ecefabbb653b02a4d0dcd1e6d6e
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-recaptcha_enterprise-v1beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-recaptcha_enterprise-v1beta1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export RECAPTCHA_ENTERPRISE_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/recaptcha_enterprise/v1beta1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-recaptcha_enterprise-v1beta1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-recaptcha_enterprise-v1beta1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-recaptcha_enterprise-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `RECAPTCHA_ENTERPRISE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `RECAPTCHA_ENTERPRISE_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/recaptcha_enterprise/v1beta1"
77
-
78
- ENV["RECAPTCHA_ENTERPRISE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/recaptcha_enterprise/v1beta1"
90
58
 
91
59
  client = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/recaptcha_enterprise/v1beta1"
100
68
 
101
69
  ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-recaptcha_enterprise-v1beta1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/recaptcha_enterprise/v1beta1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-recaptcha_enterprise-v1beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # Service to determine the likelihood an event is legitimate.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "recaptchaenterprise.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @recaptcha_enterprise_service_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new RecaptchaEnterpriseService client object.
99
111
  #
@@ -127,8 +139,9 @@ module Google
127
139
  credentials = @config.credentials
128
140
  # Use self-signed JWT if the endpoint is unchanged from default,
129
141
  # but only if the default endpoint does not have a region prefix.
130
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
131
- !@config.endpoint.split(".").first.include?("-")
142
+ enable_self_signed_jwt = @config.endpoint.nil? ||
143
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
+ !@config.endpoint.split(".").first.include?("-"))
132
145
  credentials ||= Credentials.default scope: @config.scope,
133
146
  enable_self_signed_jwt: enable_self_signed_jwt
134
147
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -139,8 +152,10 @@ module Google
139
152
 
140
153
  @recaptcha_enterprise_service_stub = ::Gapic::ServiceStub.new(
141
154
  ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseServiceV1Beta1::Stub,
142
- credentials: credentials,
143
- endpoint: @config.endpoint,
155
+ credentials: credentials,
156
+ endpoint: @config.endpoint,
157
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
158
+ universe_domain: @config.universe_domain,
144
159
  channel_args: @config.channel_args,
145
160
  interceptors: @config.interceptors,
146
161
  channel_pool_config: @config.channel_pool
@@ -169,7 +184,7 @@ module Google
169
184
  #
170
185
  # @param parent [::String]
171
186
  # Required. The name of the project in which the assessment will be created,
172
- # in the format "projects/\\{project_number}".
187
+ # in the format `projects/{project_number}`.
173
188
  # @param assessment [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment, ::Hash]
174
189
  # Required. The assessment details.
175
190
  #
@@ -258,20 +273,19 @@ module Google
258
273
  #
259
274
  # @param name [::String]
260
275
  # Required. The resource name of the Assessment, in the format
261
- # "projects/\\{project_number}/assessments/\\{assessment_id}".
276
+ # `projects/{project_number}/assessments/{assessment_id}`.
262
277
  # @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
263
278
  # Optional. The annotation that will be assigned to the Event. This field can
264
279
  # be left empty to provide reasons that apply to an event without concluding
265
280
  # whether the event is legitimate or fraudulent.
266
281
  # @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
267
- # Optional. Optional reasons for the annotation that will be assigned to the
268
- # Event.
282
+ # Optional. Reasons for the annotation that are assigned to the event.
269
283
  # @param hashed_account_id [::String]
270
- # Optional. Optional unique stable hashed user identifier to apply to the
271
- # assessment. This is an alternative to setting the hashed_account_id in
272
- # CreateAssessment, for example when the account identifier is not yet known
273
- # in the initial request. It is recommended that the identifier is hashed
274
- # using hmac-sha256 with stable secret.
284
+ # Optional. Unique stable hashed user identifier to apply to the assessment.
285
+ # This is an alternative to setting the `hashed_account_id` in
286
+ # `CreateAssessment`, for example, when the account identifier is not yet
287
+ # known in the initial request. It is recommended that the identifier is
288
+ # hashed using hmac-sha256 with stable secret.
275
289
  # @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent, ::Hash]
276
290
  # Optional. If the assessment is part of a payment transaction, provide
277
291
  # details on payment lifecycle events that occur in the transaction.
@@ -370,9 +384,9 @@ module Google
370
384
  # end
371
385
  #
372
386
  # @!attribute [rw] endpoint
373
- # The hostname or hostname:port of the service endpoint.
374
- # Defaults to `"recaptchaenterprise.googleapis.com"`.
375
- # @return [::String]
387
+ # A custom service endpoint, as a hostname or hostname:port. The default is
388
+ # nil, indicating to use the default endpoint in the current universe domain.
389
+ # @return [::String,nil]
376
390
  # @!attribute [rw] credentials
377
391
  # Credentials to send with calls. You may provide any of the following types:
378
392
  # * (`String`) The path to a service account key file in JSON format
@@ -418,13 +432,20 @@ module Google
418
432
  # @!attribute [rw] quota_project
419
433
  # A separate project against which to charge quota.
420
434
  # @return [::String]
435
+ # @!attribute [rw] universe_domain
436
+ # The universe domain within which to make requests. This determines the
437
+ # default endpoint URL. The default value of nil uses the environment
438
+ # universe (usually the default "googleapis.com" universe).
439
+ # @return [::String,nil]
421
440
  #
422
441
  class Configuration
423
442
  extend ::Gapic::Config
424
443
 
444
+ # @private
445
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
425
446
  DEFAULT_ENDPOINT = "recaptchaenterprise.googleapis.com"
426
447
 
427
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
448
+ config_attr :endpoint, nil, ::String, nil
428
449
  config_attr :credentials, nil do |value|
429
450
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
430
451
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -439,6 +460,7 @@ module Google
439
460
  config_attr :metadata, nil, ::Hash, nil
440
461
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
441
462
  config_attr :quota_project, nil, ::String, nil
463
+ config_attr :universe_domain, nil, ::String, nil
442
464
 
443
465
  # @private
444
466
  def initialize parent_config = nil
data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # Service to determine the likelihood an event is legitimate.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "recaptchaenterprise.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @recaptcha_enterprise_service_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new RecaptchaEnterpriseService REST client object.
101
113
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -134,7 +147,12 @@ module Google
134
147
  @quota_project_id = @config.quota_project
135
148
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
136
149
 
137
- @recaptcha_enterprise_service_stub = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
150
+ @recaptcha_enterprise_service_stub = ::Google::Cloud::RecaptchaEnterprise::V1beta1::RecaptchaEnterpriseService::Rest::ServiceStub.new(
151
+ endpoint: @config.endpoint,
152
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
153
+ universe_domain: @config.universe_domain,
154
+ credentials: credentials
155
+ )
138
156
  end
139
157
 
140
158
  # Service calls
@@ -159,7 +177,7 @@ module Google
159
177
  #
160
178
  # @param parent [::String]
161
179
  # Required. The name of the project in which the assessment will be created,
162
- # in the format "projects/\\{project_number}".
180
+ # in the format `projects/{project_number}`.
163
181
  # @param assessment [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment, ::Hash]
164
182
  # Required. The assessment details.
165
183
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -241,20 +259,19 @@ module Google
241
259
  #
242
260
  # @param name [::String]
243
261
  # Required. The resource name of the Assessment, in the format
244
- # "projects/\\{project_number}/assessments/\\{assessment_id}".
262
+ # `projects/{project_number}/assessments/{assessment_id}`.
245
263
  # @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
246
264
  # Optional. The annotation that will be assigned to the Event. This field can
247
265
  # be left empty to provide reasons that apply to an event without concluding
248
266
  # whether the event is legitimate or fraudulent.
249
267
  # @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
250
- # Optional. Optional reasons for the annotation that will be assigned to the
251
- # Event.
268
+ # Optional. Reasons for the annotation that are assigned to the event.
252
269
  # @param hashed_account_id [::String]
253
- # Optional. Optional unique stable hashed user identifier to apply to the
254
- # assessment. This is an alternative to setting the hashed_account_id in
255
- # CreateAssessment, for example when the account identifier is not yet known
256
- # in the initial request. It is recommended that the identifier is hashed
257
- # using hmac-sha256 with stable secret.
270
+ # Optional. Unique stable hashed user identifier to apply to the assessment.
271
+ # This is an alternative to setting the `hashed_account_id` in
272
+ # `CreateAssessment`, for example, when the account identifier is not yet
273
+ # known in the initial request. It is recommended that the identifier is
274
+ # hashed using hmac-sha256 with stable secret.
258
275
  # @param transaction_event [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent, ::Hash]
259
276
  # Optional. If the assessment is part of a payment transaction, provide
260
277
  # details on payment lifecycle events that occur in the transaction.
@@ -346,9 +363,9 @@ module Google
346
363
  # end
347
364
  #
348
365
  # @!attribute [rw] endpoint
349
- # The hostname or hostname:port of the service endpoint.
350
- # Defaults to `"recaptchaenterprise.googleapis.com"`.
351
- # @return [::String]
366
+ # A custom service endpoint, as a hostname or hostname:port. The default is
367
+ # nil, indicating to use the default endpoint in the current universe domain.
368
+ # @return [::String,nil]
352
369
  # @!attribute [rw] credentials
353
370
  # Credentials to send with calls. You may provide any of the following types:
354
371
  # * (`String`) The path to a service account key file in JSON format
@@ -385,13 +402,20 @@ module Google
385
402
  # @!attribute [rw] quota_project
386
403
  # A separate project against which to charge quota.
387
404
  # @return [::String]
405
+ # @!attribute [rw] universe_domain
406
+ # The universe domain within which to make requests. This determines the
407
+ # default endpoint URL. The default value of nil uses the environment
408
+ # universe (usually the default "googleapis.com" universe).
409
+ # @return [::String,nil]
388
410
  #
389
411
  class Configuration
390
412
  extend ::Gapic::Config
391
413
 
414
+ # @private
415
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
392
416
  DEFAULT_ENDPOINT = "recaptchaenterprise.googleapis.com"
393
417
 
394
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
418
+ config_attr :endpoint, nil, ::String, nil
395
419
  config_attr :credentials, nil do |value|
396
420
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
397
421
  allowed.any? { |klass| klass === value }
@@ -403,6 +427,7 @@ module Google
403
427
  config_attr :metadata, nil, ::Hash, nil
404
428
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
405
429
  config_attr :quota_project, nil, ::String, nil
430
+ config_attr :universe_domain, nil, ::String, nil
406
431
 
407
432
  # @private
408
433
  def initialize parent_config = nil
data/lib/google/cloud/recaptcha_enterprise/v1beta1/recaptcha_enterprise_service/rest/service_stub.rb CHANGED
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the create_assessment REST call
45
57
  #
data/lib/google/cloud/recaptcha_enterprise/v1beta1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module RecaptchaEnterprise
23
23
  module V1beta1
24
- VERSION = "0.10.0"
24
+ VERSION = "0.12.0"
25
25
  end
26
26
  end
27
27
  end
data/lib/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise_pb.rb CHANGED
@@ -11,7 +11,7 @@ require 'google/api/resource_pb'
11
11
  require 'google/protobuf/timestamp_pb'
12
12
 
13
13
 
14
- descriptor_data = "\nBgoogle/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto\x12(google.cloud.recaptchaenterprise.v1beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xad\x01\n\x17\x43reateAssessmentRequest\x12\x43\n\x06parent\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+cloudresourcemanager.googleapis.com/Project\x12M\n\nassessment\x18\x02 \x01(\x0b\x32\x34.google.cloud.recaptchaenterprise.v1beta1.AssessmentB\x03\xe0\x41\x02\"\x97\x05\n\x10TransactionEvent\x12h\n\nevent_type\x18\x01 \x01(\x0e\x32O.google.cloud.recaptchaenterprise.v1beta1.TransactionEvent.TransactionEventTypeB\x03\xe0\x41\x01\x12\x13\n\x06reason\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x12\n\x05value\x18\x03 \x01(\x01\x42\x03\xe0\x41\x01\x12\x33\n\nevent_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x01\"\xba\x03\n\x14TransactionEventType\x12&\n\"TRANSACTION_EVENT_TYPE_UNSPECIFIED\x10\x00\x12\x14\n\x10MERCHANT_APPROVE\x10\x01\x12\x11\n\rMERCHANT_DENY\x10\x02\x12\x11\n\rMANUAL_REVIEW\x10\x03\x12\x11\n\rAUTHORIZATION\x10\x04\x12\x19\n\x15\x41UTHORIZATION_DECLINE\x10\x05\x12\x13\n\x0fPAYMENT_CAPTURE\x10\x06\x12\x1b\n\x17PAYMENT_CAPTURE_DECLINE\x10\x07\x12\n\n\x06\x43\x41NCEL\x10\x08\x12\x16\n\x12\x43HARGEBACK_INQUIRY\x10\t\x12\x14\n\x10\x43HARGEBACK_ALERT\x10\n\x12\x16\n\x12\x46RAUD_NOTIFICATION\x10\x0b\x12\x0e\n\nCHARGEBACK\x10\x0c\x12\x1c\n\x18\x43HARGEBACK_REPRESENTMENT\x10\r\x12\x16\n\x12\x43HARGEBACK_REVERSE\x10\x0e\x12\x12\n\x0eREFUND_REQUEST\x10\x0f\x12\x12\n\x0eREFUND_DECLINE\x10\x10\x12\n\n\x06REFUND\x10\x11\x12\x12\n\x0eREFUND_REVERSE\x10\x12\"\xf9\x06\n\x19\x41nnotateAssessmentRequest\x12\x43\n\x04name\x18\x01 \x01(\tB5\xe0\x41\x02\xfa\x41/\n-recaptchaenterprise.googleapis.com/Assessment\x12g\n\nannotation\x18\x02 \x01(\x0e\x32N.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.AnnotationB\x03\xe0\x41\x01\x12`\n\x07reasons\x18\x03 \x03(\x0e\x32J.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.ReasonB\x03\xe0\x41\x01\x12\x1e\n\x11hashed_account_id\x18\x04 \x01(\x0c\x42\x03\xe0\x41\x01\x12Z\n\x11transaction_event\x18\x05 \x01(\x0b\x32:.google.cloud.recaptchaenterprise.v1beta1.TransactionEventB\x03\xe0\x41\x01\"~\n\nAnnotation\x12\x1a\n\x16\x41NNOTATION_UNSPECIFIED\x10\x00\x12\x0e\n\nLEGITIMATE\x10\x01\x12\x0e\n\nFRAUDULENT\x10\x02\x12\x18\n\x10PASSWORD_CORRECT\x10\x03\x1a\x02\x08\x01\x12\x1a\n\x12PASSWORD_INCORRECT\x10\x04\x1a\x02\x08\x01\"\xcf\x02\n\x06Reason\x12\x16\n\x12REASON_UNSPECIFIED\x10\x00\x12\x0e\n\nCHARGEBACK\x10\x01\x12\x14\n\x10\x43HARGEBACK_FRAUD\x10\x08\x12\x16\n\x12\x43HARGEBACK_DISPUTE\x10\t\x12\n\n\x06REFUND\x10\n\x12\x10\n\x0cREFUND_FRAUD\x10\x0b\x12\x18\n\x14TRANSACTION_ACCEPTED\x10\x0c\x12\x18\n\x14TRANSACTION_DECLINED\x10\r\x12\x16\n\x12PAYMENT_HEURISTICS\x10\x02\x12\x18\n\x14INITIATED_TWO_FACTOR\x10\x07\x12\x15\n\x11PASSED_TWO_FACTOR\x10\x03\x12\x15\n\x11\x46\x41ILED_TWO_FACTOR\x10\x04\x12\x14\n\x10\x43ORRECT_PASSWORD\x10\x05\x12\x16\n\x12INCORRECT_PASSWORD\x10\x06\x12\x0f\n\x0bSOCIAL_SPAM\x10\x0e\"\x1c\n\x1a\x41nnotateAssessmentResponse\"\x86\x01\n\x18PasswordLeakVerification\x12$\n\x17hashed_user_credentials\x18\x01 \x01(\x0c\x42\x03\xe0\x41\x01\x12\x1f\n\x12\x63redentials_leaked\x18\x02 \x01(\x08\x42\x03\xe0\x41\x03\x12#\n\x16\x63\x61nonicalized_username\x18\x03 \x01(\tB\x03\xe0\x41\x01\"\xb7\x07\n\nAssessment\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12>\n\x05\x65vent\x18\x02 \x01(\x0b\x32/.google.cloud.recaptchaenterprise.v1beta1.Event\x12\x12\n\x05score\x18\x03 \x01(\x02\x42\x03\xe0\x41\x03\x12X\n\x10token_properties\x18\x04 \x01(\x0b\x32\x39.google.cloud.recaptchaenterprise.v1beta1.TokenPropertiesB\x03\xe0\x41\x03\x12_\n\x07reasons\x18\x05 \x03(\x0e\x32I.google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReasonB\x03\xe0\x41\x03\x12\x66\n\x1apassword_leak_verification\x18\x07 \x01(\x0b\x32\x42.google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification\x12h\n\x1b\x61\x63\x63ount_defender_assessment\x18\x08 \x01(\x0b\x32\x43.google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment\x12h\n\x1b\x66raud_prevention_assessment\x18\x0b \x01(\x0b\x32\x43.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment\"\xe9\x01\n\x14\x43lassificationReason\x12%\n!CLASSIFICATION_REASON_UNSPECIFIED\x10\x00\x12\x0e\n\nAUTOMATION\x10\x01\x12\x1a\n\x16UNEXPECTED_ENVIRONMENT\x10\x02\x12\x14\n\x10TOO_MUCH_TRAFFIC\x10\x03\x12\x1d\n\x19UNEXPECTED_USAGE_PATTERNS\x10\x04\x12\x18\n\x14LOW_CONFIDENCE_SCORE\x10\x05\x12\x15\n\x11SUSPECTED_CARDING\x10\x06\x12\x18\n\x14SUSPECTED_CHARGEBACK\x10\x07:_\xea\x41\\\n-recaptchaenterprise.googleapis.com/Assessment\x12+projects/{project}/assessments/{assessment}\"\x81\x02\n\x05\x45vent\x12\x12\n\x05token\x18\x01 \x01(\tB\x03\xe0\x41\x01\x12\x15\n\x08site_key\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x17\n\nuser_agent\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x1c\n\x0fuser_ip_address\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12\x1c\n\x0f\x65xpected_action\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12\x1e\n\x11hashed_account_id\x18\x06 \x01(\x0c\x42\x03\xe0\x41\x01\x12X\n\x10transaction_data\x18\r \x01(\x0b\x32\x39.google.cloud.recaptchaenterprise.v1beta1.TransactionDataB\x03\xe0\x41\x01\"\x9d\t\n\x0fTransactionData\x12\x1b\n\x0etransaction_id\x18\x0b \x01(\tH\x00\x88\x01\x01\x12\x16\n\x0epayment_method\x18\x01 \x01(\t\x12\x10\n\x08\x63\x61rd_bin\x18\x02 \x01(\t\x12\x16\n\x0e\x63\x61rd_last_four\x18\x03 \x01(\t\x12\x15\n\rcurrency_code\x18\x04 \x01(\t\x12\r\n\x05value\x18\x05 \x01(\x01\x12\x16\n\x0eshipping_value\x18\x0c \x01(\x01\x12[\n\x10shipping_address\x18\x06 \x01(\x0b\x32\x41.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address\x12Z\n\x0f\x62illing_address\x18\x07 \x01(\x0b\x32\x41.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address\x12L\n\x04user\x18\x08 \x01(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.User\x12Q\n\tmerchants\x18\r \x03(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.User\x12M\n\x05items\x18\x0e \x03(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Item\x12[\n\x0cgateway_info\x18\n \x01(\x0b\x32\x45.google.cloud.recaptchaenterprise.v1beta1.TransactionData.GatewayInfo\x1a\x86\x01\n\x07\x41\x64\x64ress\x12\x11\n\trecipient\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x03(\t\x12\x10\n\x08locality\x18\x03 \x01(\t\x12\x1b\n\x13\x61\x64ministrative_area\x18\x04 \x01(\t\x12\x13\n\x0bregion_code\x18\x05 \x01(\t\x12\x13\n\x0bpostal_code\x18\x06 \x01(\t\x1a\x84\x01\n\x04User\x12\x12\n\naccount_id\x18\x06 \x01(\t\x12\x13\n\x0b\x63reation_ms\x18\x01 \x01(\x03\x12\r\n\x05\x65mail\x18\x02 \x01(\t\x12\x16\n\x0e\x65mail_verified\x18\x03 \x01(\x08\x12\x14\n\x0cphone_number\x18\x04 \x01(\t\x12\x16\n\x0ephone_verified\x18\x05 \x01(\x08\x1aR\n\x04Item\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x01\x12\x10\n\x08quantity\x18\x03 \x01(\x03\x12\x1b\n\x13merchant_account_id\x18\x04 \x01(\t\x1ap\n\x0bGatewayInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x1d\n\x15gateway_response_code\x18\x02 \x01(\t\x12\x19\n\x11\x61vs_response_code\x18\x03 \x01(\t\x12\x19\n\x11\x63vv_response_code\x18\x04 \x01(\tB\x11\n\x0f_transaction_id\"\xff\x02\n\x0fTokenProperties\x12\r\n\x05valid\x18\x01 \x01(\x08\x12_\n\x0einvalid_reason\x18\x02 \x01(\x0e\x32G.google.cloud.recaptchaenterprise.v1beta1.TokenProperties.InvalidReason\x12/\n\x0b\x63reate_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x10\n\x08hostname\x18\x04 \x01(\t\x12\x0e\n\x06\x61\x63tion\x18\x05 \x01(\t\"\xa8\x01\n\rInvalidReason\x12\x1e\n\x1aINVALID_REASON_UNSPECIFIED\x10\x00\x12\x1a\n\x16UNKNOWN_INVALID_REASON\x10\x01\x12\r\n\tMALFORMED\x10\x02\x12\x0b\n\x07\x45XPIRED\x10\x03\x12\x08\n\x04\x44UPE\x10\x04\x12\x15\n\rSITE_MISMATCH\x10\x05\x1a\x02\x08\x01\x12\x0b\n\x07MISSING\x10\x06\x12\x11\n\rBROWSER_ERROR\x10\x07\"\xf8\x02\n\x19\x46raudPreventionAssessment\x12\x18\n\x10transaction_risk\x18\x01 \x01(\x02\x12~\n\x19stolen_instrument_verdict\x18\x02 \x01(\x0b\x32[.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict\x12t\n\x14\x63\x61rd_testing_verdict\x18\x03 \x01(\x0b\x32V.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict\x1a\'\n\x17StolenInstrumentVerdict\x12\x0c\n\x04risk\x18\x01 \x01(\x02\x1a\"\n\x12\x43\x61rdTestingVerdict\x12\x0c\n\x04risk\x18\x01 \x01(\x02\"\xbb\x02\n\x19\x41\x63\x63ountDefenderAssessment\x12h\n\x06labels\x18\x01 \x03(\x0e\x32X.google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel\"\xb3\x01\n\x14\x41\x63\x63ountDefenderLabel\x12&\n\"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED\x10\x00\x12\x11\n\rPROFILE_MATCH\x10\x01\x12\x1d\n\x19SUSPICIOUS_LOGIN_ACTIVITY\x10\x02\x12\x1f\n\x1bSUSPICIOUS_ACCOUNT_CREATION\x10\x03\x12 \n\x1cRELATED_ACCOUNTS_NUMBER_HIGH\x10\x04\x32\xcd\x04\n!RecaptchaEnterpriseServiceV1Beta1\x12\xdd\x01\n\x10\x43reateAssessment\x12\x41.google.cloud.recaptchaenterprise.v1beta1.CreateAssessmentRequest\x1a\x34.google.cloud.recaptchaenterprise.v1beta1.Assessment\"P\x82\xd3\xe4\x93\x02\x36\"(/v1beta1/{parent=projects/*}/assessments:\nassessment\xda\x41\x11parent,assessment\x12\xef\x01\n\x12\x41nnotateAssessment\x12\x43.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest\x1a\x44.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse\"N\x82\xd3\xe4\x93\x02\x36\"1/v1beta1/{name=projects/*/assessments/*}:annotate:\x01*\xda\x41\x0fname,annotation\x1aV\xca\x41\"recaptchaenterprise.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xb2\x02\n&com.google.recaptchaenterprise.v1beta1B\x18RecaptchaEnterpriseProtoP\x01Zacloud.google.com/go/recaptchaenterprise/v2/apiv1beta1/recaptchaenterprisepb;recaptchaenterprisepb\xa2\x02\x04GCRE\xaa\x02(Google.Cloud.RecaptchaEnterprise.V1Beta1\xca\x02(Google\\Cloud\\RecaptchaEnterprise\\V1beta1\xea\x02+Google::Cloud::RecaptchaEnterprise::V1beta1b\x06proto3"
14
+ descriptor_data = "\nBgoogle/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.proto\x12(google.cloud.recaptchaenterprise.v1beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xad\x01\n\x17\x43reateAssessmentRequest\x12\x43\n\x06parent\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\n+cloudresourcemanager.googleapis.com/Project\x12M\n\nassessment\x18\x02 \x01(\x0b\x32\x34.google.cloud.recaptchaenterprise.v1beta1.AssessmentB\x03\xe0\x41\x02\"\x97\x05\n\x10TransactionEvent\x12h\n\nevent_type\x18\x01 \x01(\x0e\x32O.google.cloud.recaptchaenterprise.v1beta1.TransactionEvent.TransactionEventTypeB\x03\xe0\x41\x01\x12\x13\n\x06reason\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x12\n\x05value\x18\x03 \x01(\x01\x42\x03\xe0\x41\x01\x12\x33\n\nevent_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x01\"\xba\x03\n\x14TransactionEventType\x12&\n\"TRANSACTION_EVENT_TYPE_UNSPECIFIED\x10\x00\x12\x14\n\x10MERCHANT_APPROVE\x10\x01\x12\x11\n\rMERCHANT_DENY\x10\x02\x12\x11\n\rMANUAL_REVIEW\x10\x03\x12\x11\n\rAUTHORIZATION\x10\x04\x12\x19\n\x15\x41UTHORIZATION_DECLINE\x10\x05\x12\x13\n\x0fPAYMENT_CAPTURE\x10\x06\x12\x1b\n\x17PAYMENT_CAPTURE_DECLINE\x10\x07\x12\n\n\x06\x43\x41NCEL\x10\x08\x12\x16\n\x12\x43HARGEBACK_INQUIRY\x10\t\x12\x14\n\x10\x43HARGEBACK_ALERT\x10\n\x12\x16\n\x12\x46RAUD_NOTIFICATION\x10\x0b\x12\x0e\n\nCHARGEBACK\x10\x0c\x12\x1c\n\x18\x43HARGEBACK_REPRESENTMENT\x10\r\x12\x16\n\x12\x43HARGEBACK_REVERSE\x10\x0e\x12\x12\n\x0eREFUND_REQUEST\x10\x0f\x12\x12\n\x0eREFUND_DECLINE\x10\x10\x12\n\n\x06REFUND\x10\x11\x12\x12\n\x0eREFUND_REVERSE\x10\x12\"\xf9\x06\n\x19\x41nnotateAssessmentRequest\x12\x43\n\x04name\x18\x01 \x01(\tB5\xe0\x41\x02\xfa\x41/\n-recaptchaenterprise.googleapis.com/Assessment\x12g\n\nannotation\x18\x02 \x01(\x0e\x32N.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.AnnotationB\x03\xe0\x41\x01\x12`\n\x07reasons\x18\x03 \x03(\x0e\x32J.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.ReasonB\x03\xe0\x41\x01\x12\x1e\n\x11hashed_account_id\x18\x04 \x01(\x0c\x42\x03\xe0\x41\x01\x12Z\n\x11transaction_event\x18\x05 \x01(\x0b\x32:.google.cloud.recaptchaenterprise.v1beta1.TransactionEventB\x03\xe0\x41\x01\"~\n\nAnnotation\x12\x1a\n\x16\x41NNOTATION_UNSPECIFIED\x10\x00\x12\x0e\n\nLEGITIMATE\x10\x01\x12\x0e\n\nFRAUDULENT\x10\x02\x12\x18\n\x10PASSWORD_CORRECT\x10\x03\x1a\x02\x08\x01\x12\x1a\n\x12PASSWORD_INCORRECT\x10\x04\x1a\x02\x08\x01\"\xcf\x02\n\x06Reason\x12\x16\n\x12REASON_UNSPECIFIED\x10\x00\x12\x0e\n\nCHARGEBACK\x10\x01\x12\x14\n\x10\x43HARGEBACK_FRAUD\x10\x08\x12\x16\n\x12\x43HARGEBACK_DISPUTE\x10\t\x12\n\n\x06REFUND\x10\n\x12\x10\n\x0cREFUND_FRAUD\x10\x0b\x12\x18\n\x14TRANSACTION_ACCEPTED\x10\x0c\x12\x18\n\x14TRANSACTION_DECLINED\x10\r\x12\x16\n\x12PAYMENT_HEURISTICS\x10\x02\x12\x18\n\x14INITIATED_TWO_FACTOR\x10\x07\x12\x15\n\x11PASSED_TWO_FACTOR\x10\x03\x12\x15\n\x11\x46\x41ILED_TWO_FACTOR\x10\x04\x12\x14\n\x10\x43ORRECT_PASSWORD\x10\x05\x12\x16\n\x12INCORRECT_PASSWORD\x10\x06\x12\x0f\n\x0bSOCIAL_SPAM\x10\x0e\"\x1c\n\x1a\x41nnotateAssessmentResponse\"\x86\x01\n\x18PasswordLeakVerification\x12$\n\x17hashed_user_credentials\x18\x01 \x01(\x0c\x42\x03\xe0\x41\x01\x12\x1f\n\x12\x63redentials_leaked\x18\x02 \x01(\x08\x42\x03\xe0\x41\x03\x12#\n\x16\x63\x61nonicalized_username\x18\x03 \x01(\tB\x03\xe0\x41\x01\"\xb7\x07\n\nAssessment\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12>\n\x05\x65vent\x18\x02 \x01(\x0b\x32/.google.cloud.recaptchaenterprise.v1beta1.Event\x12\x12\n\x05score\x18\x03 \x01(\x02\x42\x03\xe0\x41\x03\x12X\n\x10token_properties\x18\x04 \x01(\x0b\x32\x39.google.cloud.recaptchaenterprise.v1beta1.TokenPropertiesB\x03\xe0\x41\x03\x12_\n\x07reasons\x18\x05 \x03(\x0e\x32I.google.cloud.recaptchaenterprise.v1beta1.Assessment.ClassificationReasonB\x03\xe0\x41\x03\x12\x66\n\x1apassword_leak_verification\x18\x07 \x01(\x0b\x32\x42.google.cloud.recaptchaenterprise.v1beta1.PasswordLeakVerification\x12h\n\x1b\x61\x63\x63ount_defender_assessment\x18\x08 \x01(\x0b\x32\x43.google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment\x12h\n\x1b\x66raud_prevention_assessment\x18\x0b \x01(\x0b\x32\x43.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment\"\xe9\x01\n\x14\x43lassificationReason\x12%\n!CLASSIFICATION_REASON_UNSPECIFIED\x10\x00\x12\x0e\n\nAUTOMATION\x10\x01\x12\x1a\n\x16UNEXPECTED_ENVIRONMENT\x10\x02\x12\x14\n\x10TOO_MUCH_TRAFFIC\x10\x03\x12\x1d\n\x19UNEXPECTED_USAGE_PATTERNS\x10\x04\x12\x18\n\x14LOW_CONFIDENCE_SCORE\x10\x05\x12\x15\n\x11SUSPECTED_CARDING\x10\x06\x12\x18\n\x14SUSPECTED_CHARGEBACK\x10\x07:_\xea\x41\\\n-recaptchaenterprise.googleapis.com/Assessment\x12+projects/{project}/assessments/{assessment}\"\x81\x02\n\x05\x45vent\x12\x12\n\x05token\x18\x01 \x01(\tB\x03\xe0\x41\x01\x12\x15\n\x08site_key\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x17\n\nuser_agent\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x1c\n\x0fuser_ip_address\x18\x04 \x01(\tB\x03\xe0\x41\x01\x12\x1c\n\x0f\x65xpected_action\x18\x05 \x01(\tB\x03\xe0\x41\x01\x12\x1e\n\x11hashed_account_id\x18\x06 \x01(\x0c\x42\x03\xe0\x41\x01\x12X\n\x10transaction_data\x18\r \x01(\x0b\x32\x39.google.cloud.recaptchaenterprise.v1beta1.TransactionDataB\x03\xe0\x41\x01\"\x9d\t\n\x0fTransactionData\x12\x1b\n\x0etransaction_id\x18\x0b \x01(\tH\x00\x88\x01\x01\x12\x16\n\x0epayment_method\x18\x01 \x01(\t\x12\x10\n\x08\x63\x61rd_bin\x18\x02 \x01(\t\x12\x16\n\x0e\x63\x61rd_last_four\x18\x03 \x01(\t\x12\x15\n\rcurrency_code\x18\x04 \x01(\t\x12\r\n\x05value\x18\x05 \x01(\x01\x12\x16\n\x0eshipping_value\x18\x0c \x01(\x01\x12[\n\x10shipping_address\x18\x06 \x01(\x0b\x32\x41.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address\x12Z\n\x0f\x62illing_address\x18\x07 \x01(\x0b\x32\x41.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Address\x12L\n\x04user\x18\x08 \x01(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.User\x12Q\n\tmerchants\x18\r \x03(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.User\x12M\n\x05items\x18\x0e \x03(\x0b\x32>.google.cloud.recaptchaenterprise.v1beta1.TransactionData.Item\x12[\n\x0cgateway_info\x18\n \x01(\x0b\x32\x45.google.cloud.recaptchaenterprise.v1beta1.TransactionData.GatewayInfo\x1a\x86\x01\n\x07\x41\x64\x64ress\x12\x11\n\trecipient\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x03(\t\x12\x10\n\x08locality\x18\x03 \x01(\t\x12\x1b\n\x13\x61\x64ministrative_area\x18\x04 \x01(\t\x12\x13\n\x0bregion_code\x18\x05 \x01(\t\x12\x13\n\x0bpostal_code\x18\x06 \x01(\t\x1a\x84\x01\n\x04User\x12\x12\n\naccount_id\x18\x06 \x01(\t\x12\x13\n\x0b\x63reation_ms\x18\x01 \x01(\x03\x12\r\n\x05\x65mail\x18\x02 \x01(\t\x12\x16\n\x0e\x65mail_verified\x18\x03 \x01(\x08\x12\x14\n\x0cphone_number\x18\x04 \x01(\t\x12\x16\n\x0ephone_verified\x18\x05 \x01(\x08\x1aR\n\x04Item\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x01\x12\x10\n\x08quantity\x18\x03 \x01(\x03\x12\x1b\n\x13merchant_account_id\x18\x04 \x01(\t\x1ap\n\x0bGatewayInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x1d\n\x15gateway_response_code\x18\x02 \x01(\t\x12\x19\n\x11\x61vs_response_code\x18\x03 \x01(\t\x12\x19\n\x11\x63vv_response_code\x18\x04 \x01(\tB\x11\n\x0f_transaction_id\"\xff\x02\n\x0fTokenProperties\x12\r\n\x05valid\x18\x01 \x01(\x08\x12_\n\x0einvalid_reason\x18\x02 \x01(\x0e\x32G.google.cloud.recaptchaenterprise.v1beta1.TokenProperties.InvalidReason\x12/\n\x0b\x63reate_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x10\n\x08hostname\x18\x04 \x01(\t\x12\x0e\n\x06\x61\x63tion\x18\x05 \x01(\t\"\xa8\x01\n\rInvalidReason\x12\x1e\n\x1aINVALID_REASON_UNSPECIFIED\x10\x00\x12\x1a\n\x16UNKNOWN_INVALID_REASON\x10\x01\x12\r\n\tMALFORMED\x10\x02\x12\x0b\n\x07\x45XPIRED\x10\x03\x12\x08\n\x04\x44UPE\x10\x04\x12\x15\n\rSITE_MISMATCH\x10\x05\x1a\x02\x08\x01\x12\x0b\n\x07MISSING\x10\x06\x12\x11\n\rBROWSER_ERROR\x10\x07\"\x9f\x04\n\x19\x46raudPreventionAssessment\x12\x18\n\x10transaction_risk\x18\x01 \x01(\x02\x12~\n\x19stolen_instrument_verdict\x18\x02 \x01(\x0b\x32[.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict\x12t\n\x14\x63\x61rd_testing_verdict\x18\x03 \x01(\x0b\x32V.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict\x12|\n\x18\x62\x65havioral_trust_verdict\x18\x04 \x01(\x0b\x32Z.google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.BehavioralTrustVerdict\x1a\'\n\x17StolenInstrumentVerdict\x12\x0c\n\x04risk\x18\x01 \x01(\x02\x1a\"\n\x12\x43\x61rdTestingVerdict\x12\x0c\n\x04risk\x18\x01 \x01(\x02\x1a\'\n\x16\x42\x65havioralTrustVerdict\x12\r\n\x05trust\x18\x01 \x01(\x02\"\xbb\x02\n\x19\x41\x63\x63ountDefenderAssessment\x12h\n\x06labels\x18\x01 \x03(\x0e\x32X.google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel\"\xb3\x01\n\x14\x41\x63\x63ountDefenderLabel\x12&\n\"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED\x10\x00\x12\x11\n\rPROFILE_MATCH\x10\x01\x12\x1d\n\x19SUSPICIOUS_LOGIN_ACTIVITY\x10\x02\x12\x1f\n\x1bSUSPICIOUS_ACCOUNT_CREATION\x10\x03\x12 \n\x1cRELATED_ACCOUNTS_NUMBER_HIGH\x10\x04\x32\xcd\x04\n!RecaptchaEnterpriseServiceV1Beta1\x12\xdd\x01\n\x10\x43reateAssessment\x12\x41.google.cloud.recaptchaenterprise.v1beta1.CreateAssessmentRequest\x1a\x34.google.cloud.recaptchaenterprise.v1beta1.Assessment\"P\x82\xd3\xe4\x93\x02\x36\"(/v1beta1/{parent=projects/*}/assessments:\nassessment\xda\x41\x11parent,assessment\x12\xef\x01\n\x12\x41nnotateAssessment\x12\x43.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest\x1a\x44.google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse\"N\x82\xd3\xe4\x93\x02\x36\"1/v1beta1/{name=projects/*/assessments/*}:annotate:\x01*\xda\x41\x0fname,annotation\x1aV\xca\x41\"recaptchaenterprise.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xb2\x02\n&com.google.recaptchaenterprise.v1beta1B\x18RecaptchaEnterpriseProtoP\x01Zacloud.google.com/go/recaptchaenterprise/v2/apiv1beta1/recaptchaenterprisepb;recaptchaenterprisepb\xa2\x02\x04GCRE\xaa\x02(Google.Cloud.RecaptchaEnterprise.V1Beta1\xca\x02(Google\\Cloud\\RecaptchaEnterprise\\V1beta1\xea\x02+Google::Cloud::RecaptchaEnterprise::V1beta1b\x06proto3"
15
15
 
16
16
  pool = Google::Protobuf::DescriptorPool.generated_pool
17
17
 
@@ -63,6 +63,7 @@ module Google
63
63
  FraudPreventionAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment").msgclass
64
64
  FraudPreventionAssessment::StolenInstrumentVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.StolenInstrumentVerdict").msgclass
65
65
  FraudPreventionAssessment::CardTestingVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.CardTestingVerdict").msgclass
66
+ FraudPreventionAssessment::BehavioralTrustVerdict = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.FraudPreventionAssessment.BehavioralTrustVerdict").msgclass
66
67
  AccountDefenderAssessment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment").msgclass
67
68
  AccountDefenderAssessment::AccountDefenderLabel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recaptchaenterprise.v1beta1.AccountDefenderAssessment.AccountDefenderLabel").enummodule
68
69
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/cloud/recaptchaenterprise/v1beta1/recaptchaenterprise.rb CHANGED
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. The name of the project in which the assessment will be created,
28
- # in the format "projects/\\{project_number}".
28
+ # in the format `projects/{project_number}`.
29
29
  # @!attribute [rw] assessment
30
30
  # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment]
31
31
  # Required. The assessment details.
@@ -159,7 +159,7 @@ module Google
159
159
  # @!attribute [rw] name
160
160
  # @return [::String]
161
161
  # Required. The resource name of the Assessment, in the format
162
- # "projects/\\{project_number}/assessments/\\{assessment_id}".
162
+ # `projects/{project_number}/assessments/{assessment_id}`.
163
163
  # @!attribute [rw] annotation
164
164
  # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Annotation]
165
165
  # Optional. The annotation that will be assigned to the Event. This field can
@@ -167,15 +167,14 @@ module Google
167
167
  # whether the event is legitimate or fraudulent.
168
168
  # @!attribute [rw] reasons
169
169
  # @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
170
- # Optional. Optional reasons for the annotation that will be assigned to the
171
- # Event.
170
+ # Optional. Reasons for the annotation that are assigned to the event.
172
171
  # @!attribute [rw] hashed_account_id
173
172
  # @return [::String]
174
- # Optional. Optional unique stable hashed user identifier to apply to the
175
- # assessment. This is an alternative to setting the hashed_account_id in
176
- # CreateAssessment, for example when the account identifier is not yet known
177
- # in the initial request. It is recommended that the identifier is hashed
178
- # using hmac-sha256 with stable secret.
173
+ # Optional. Unique stable hashed user identifier to apply to the assessment.
174
+ # This is an alternative to setting the `hashed_account_id` in
175
+ # `CreateAssessment`, for example, when the account identifier is not yet
176
+ # known in the initial request. It is recommended that the identifier is
177
+ # hashed using hmac-sha256 with stable secret.
179
178
  # @!attribute [rw] transaction_event
180
179
  # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionEvent]
181
180
  # Optional. If the assessment is part of a payment transaction, provide
@@ -301,7 +300,7 @@ module Google
301
300
  # @!attribute [r] name
302
301
  # @return [::String]
303
302
  # Output only. The resource name for the Assessment in the format
304
- # "projects/\\{project_number}/assessments/\\{assessment_id}".
303
+ # `projects/{project_number}/assessments/{assessment_id}`.
305
304
  # @!attribute [rw] event
306
305
  # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Event]
307
306
  # The event being assessed.
@@ -399,7 +398,6 @@ module Google
399
398
  end
400
399
 
401
400
  # Transaction data associated with a payment protected by reCAPTCHA Enterprise.
402
- # All fields are optional.
403
401
  # @!attribute [rw] transaction_id
404
402
  # @return [::String]
405
403
  # Unique identifier for the transaction. This custom identifier can be used
@@ -617,6 +615,9 @@ module Google
617
615
  # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment::CardTestingVerdict]
618
616
  # Assessment of this transaction for risk of being part of a card testing
619
617
  # attack.
618
+ # @!attribute [rw] behavioral_trust_verdict
619
+ # @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::FraudPreventionAssessment::BehavioralTrustVerdict]
620
+ # Assessment of this transaction for behavioral trust.
620
621
  class FraudPreventionAssessment
621
622
  include ::Google::Protobuf::MessageExts
622
623
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -642,6 +643,16 @@ module Google
642
643
  include ::Google::Protobuf::MessageExts
643
644
  extend ::Google::Protobuf::MessageExts::ClassMethods
644
645
  end
646
+
647
+ # Information about behavioral trust of the transaction.
648
+ # @!attribute [rw] trust
649
+ # @return [::Float]
650
+ # Probability (0-1) of this transaction attempt being executed in a
651
+ # behaviorally trustworthy way.
652
+ class BehavioralTrustVerdict
653
+ include ::Google::Protobuf::MessageExts
654
+ extend ::Google::Protobuf::MessageExts::ClassMethods
655
+ end
645
656
  end
646
657
 
647
658
  # Account defender risk assessment.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-recaptcha_enterprise-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.10.0
4
+ version: 0.12.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-12 00:00:00.000000000 Z
11
+ date: 2024-01-11 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.20.0
19
+ version: 0.21.1
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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
209
209
  - !ruby/object:Gem::Version
210
210
  version: '0'
211
211
  requirements: []
212
- rubygems_version: 3.4.19
212
+ rubygems_version: 3.5.3
213
213
  signing_key:
214
214
  specification_version: 4
215
215
  summary: Help protect your website from fraudulent activity, spam, and abuse without