feat(recaptchaenterprise): update the api

yoshi-automation · yoshi-automation · commit 2985fd0f9c76 · 2023-10-31T14:06:07.000Z
#### recaptchaenterprise:v1

The following keys were added:
- schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.accountId.type (Total Keys: 1)
- schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.hashedAccountId.deprecated (Total Keys: 1)
- schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.userInfo.$ref (Total Keys: 1)
- schemas.GoogleCloudRecaptchaenterpriseV1UserId (Total Keys: 4)
- schemas.GoogleCloudRecaptchaenterpriseV1UserInfo (Total Keys: 7)
diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html
@@ -94,8 +94,9 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # The request message to annotate an Assessment.
+  &quot;accountId&quot;: &quot;A String&quot;, # Optional. A stable account identifier to apply to the assessment. This is an alternative to setting `account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request.
   &quot;annotation&quot;: &quot;A String&quot;, # Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.
-  &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. Unique stable hashed user identifier to apply to the assessment. This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.
+  &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request.
   &quot;reasons&quot;: [ # Optional. Reasons for the annotation that are assigned to the event.
     &quot;A String&quot;,
   ],
@@ -134,7 +135,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # A reCAPTCHA Enterprise assessment resource.
-  &quot;accountDefenderAssessment&quot;: { # Account defender risk assessment. # Output only. Assessment returned by account defender when a hashed_account_id is provided.
+  &quot;accountDefenderAssessment&quot;: { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided.
     &quot;labels&quot;: [ # Output only. Labels for this request.
       &quot;A String&quot;,
     ],
@@ -156,7 +157,7 @@ <h3>Method Details</h3>
     &quot;expectedAction&quot;: &quot;A String&quot;, # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.
     &quot;express&quot;: True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS.
     &quot;firewallPolicyEvaluation&quot;: True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.
-    &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
+    &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
     &quot;headers&quot;: [ # Optional. HTTP header information about the request.
       &quot;A String&quot;,
     ],
@@ -226,6 +227,17 @@ <h3>Method Details</h3>
       &quot;value&quot;: 3.14, # Optional. The decimal value of the transaction in the specified currency.
     },
     &quot;userAgent&quot;: &quot;A String&quot;, # Optional. The user agent present in the request from the user&#x27;s device related to this event.
+    &quot;userInfo&quot;: { # User information associated with a request protected by reCAPTCHA Enterprise. # Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.
+      &quot;accountId&quot;: &quot;A String&quot;, # Optional. For logged-in requests or login/registration requests, the unique account identifier associated with this user. You can use the username if it is stable (meaning it is the same for every request associated with the same user), or any stable user ID of your choice. Leave blank for non logged-in actions or guest checkout.
+      &quot;createAccountTime&quot;: &quot;A String&quot;, # Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.
+      &quot;userIds&quot;: [ # Optional. Identifiers associated with this user or request.
+        { # An identifier associated with a user.
+          &quot;email&quot;: &quot;A String&quot;, # Optional. An email address.
+          &quot;phoneNumber&quot;: &quot;A String&quot;, # Optional. A phone number. Should use the E.164 format.
+          &quot;username&quot;: &quot;A String&quot;, # Optional. A unique username, if different from all the other identifiers and `account_id` that are provided. Can be a unique login handle or display name for a user.
+        },
+      ],
+    },
     &quot;userIpAddress&quot;: &quot;A String&quot;, # Optional. The IP address in the request from the user&#x27;s device related to this event.
     &quot;wafTokenAssessment&quot;: True or False, # Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.
   },
@@ -324,7 +336,7 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # A reCAPTCHA Enterprise assessment resource.
-  &quot;accountDefenderAssessment&quot;: { # Account defender risk assessment. # Output only. Assessment returned by account defender when a hashed_account_id is provided.
+  &quot;accountDefenderAssessment&quot;: { # Account defender risk assessment. # Output only. Assessment returned by account defender when an account identifier is provided.
     &quot;labels&quot;: [ # Output only. Labels for this request.
       &quot;A String&quot;,
     ],
@@ -346,7 +358,7 @@ <h3>Method Details</h3>
     &quot;expectedAction&quot;: &quot;A String&quot;, # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise.
     &quot;express&quot;: True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS.
     &quot;firewallPolicyEvaluation&quot;: True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.
-    &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
+    &quot;hashedAccountId&quot;: &quot;A String&quot;, # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
     &quot;headers&quot;: [ # Optional. HTTP header information about the request.
       &quot;A String&quot;,
     ],
@@ -416,6 +428,17 @@ <h3>Method Details</h3>
       &quot;value&quot;: 3.14, # Optional. The decimal value of the transaction in the specified currency.
     },
     &quot;userAgent&quot;: &quot;A String&quot;, # Optional. The user agent present in the request from the user&#x27;s device related to this event.
+    &quot;userInfo&quot;: { # User information associated with a request protected by reCAPTCHA Enterprise. # Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout.
+      &quot;accountId&quot;: &quot;A String&quot;, # Optional. For logged-in requests or login/registration requests, the unique account identifier associated with this user. You can use the username if it is stable (meaning it is the same for every request associated with the same user), or any stable user ID of your choice. Leave blank for non logged-in actions or guest checkout.
+      &quot;createAccountTime&quot;: &quot;A String&quot;, # Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.
+      &quot;userIds&quot;: [ # Optional. Identifiers associated with this user or request.
+        { # An identifier associated with a user.
+          &quot;email&quot;: &quot;A String&quot;, # Optional. An email address.
+          &quot;phoneNumber&quot;: &quot;A String&quot;, # Optional. A phone number. Should use the E.164 format.
+          &quot;username&quot;: &quot;A String&quot;, # Optional. A unique username, if different from all the other identifiers and `account_id` that are provided. Can be a unique login handle or display name for a user.
+        },
+      ],
+    },
     &quot;userIpAddress&quot;: &quot;A String&quot;, # Optional. The IP address in the request from the user&#x27;s device related to this event.
     &quot;wafTokenAssessment&quot;: True or False, # Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.
   },
diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json
@@ -666,7 +666,7 @@
       }
     }
   },
-  "revision": "20231015",
+  "revision": "20231022",
   "rootUrl": "https://recaptchaenterprise.googleapis.com/",
   "schemas": {
     "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
@@ -776,6 +776,10 @@
       "description": "The request message to annotate an Assessment.",
       "id": "GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest",
       "properties": {
+        "accountId": {
+          "description": "Optional. A stable account identifier to apply to the assessment. This is an alternative to setting `account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request.",
+          "type": "string"
+        },
         "annotation": {
           "description": "Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.",
           "enum": [
@@ -802,7 +806,7 @@
           "type": "string"
         },
         "hashedAccountId": {
-          "description": "Optional. Unique stable hashed user identifier to apply to the assessment. This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret.",
+          "description": "Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request.",
           "format": "byte",
           "type": "string"
         },
@@ -885,7 +889,7 @@
       "properties": {
         "accountDefenderAssessment": {
           "$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment",
-          "description": "Output only. Assessment returned by account defender when a hashed_account_id is provided.",
+          "description": "Output only. Assessment returned by account defender when an account identifier is provided.",
           "readOnly": true
         },
         "accountVerification": {
@@ -1003,7 +1007,8 @@
           "type": "boolean"
         },
         "hashedAccountId": {
-          "description": "Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.",
+          "deprecated": true,
+          "description": "Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.",
           "format": "byte",
           "type": "string"
         },
@@ -1038,6 +1043,10 @@
           "description": "Optional. The user agent present in the request from the user's device related to this event.",
           "type": "string"
         },
+        "userInfo": {
+          "$ref": "GoogleCloudRecaptchaenterpriseV1UserInfo",
+          "description": "Optional. Information about the user that generates this event, when they can be identified. They are often identified through the use of an account for logged-in requests or login/registration requests, or by providing user identifiers for guest actions like checkout."
+        },
         "userIpAddress": {
           "description": "Optional. The IP address in the request from the user's device related to this event.",
           "type": "string"
@@ -2007,6 +2016,48 @@
       },
       "type": "object"
     },
+    "GoogleCloudRecaptchaenterpriseV1UserId": {
+      "description": "An identifier associated with a user.",
+      "id": "GoogleCloudRecaptchaenterpriseV1UserId",
+      "properties": {
+        "email": {
+          "description": "Optional. An email address.",
+          "type": "string"
+        },
+        "phoneNumber": {
+          "description": "Optional. A phone number. Should use the E.164 format.",
+          "type": "string"
+        },
+        "username": {
+          "description": "Optional. A unique username, if different from all the other identifiers and `account_id` that are provided. Can be a unique login handle or display name for a user.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "GoogleCloudRecaptchaenterpriseV1UserInfo": {
+      "description": "User information associated with a request protected by reCAPTCHA Enterprise.",
+      "id": "GoogleCloudRecaptchaenterpriseV1UserInfo",
+      "properties": {
+        "accountId": {
+          "description": "Optional. For logged-in requests or login/registration requests, the unique account identifier associated with this user. You can use the username if it is stable (meaning it is the same for every request associated with the same user), or any stable user ID of your choice. Leave blank for non logged-in actions or guest checkout.",
+          "type": "string"
+        },
+        "createAccountTime": {
+          "description": "Optional. Creation time for this account associated with this user. Leave blank for non logged-in actions, guest checkout, or when there is no account associated with the current user.",
+          "format": "google-datetime",
+          "type": "string"
+        },
+        "userIds": {
+          "description": "Optional. Identifiers associated with this user or request.",
+          "items": {
+            "$ref": "GoogleCloudRecaptchaenterpriseV1UserId"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudRecaptchaenterpriseV1WafSettings": {
       "description": "Settings specific to keys that can be used for WAF (Web Application Firewall).",
       "id": "GoogleCloudRecaptchaenterpriseV1WafSettings",
