From 85bf9110ba2ab06d6cc22e8b6c4b7b74309ea0fd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 13 Dec 2022 07:09:04 +0000 Subject: [PATCH] feat(recaptchaenterprise): update the api #### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo (Total Keys: 8) - schemas.GoogleCloudRecaptchaenterpriseV1Assessment.properties.accountVerification.$ref (Total Keys: 1) - schemas.GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo (Total Keys: 8) - schemas.GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest.properties.skipBillingCheck.type (Total Keys: 1) --- ...chaenterprise_v1.projects.assessments.html | 26 ++++++ .../recaptchaenterprise_v1.projects.keys.html | 1 + .../documents/recaptchaenterprise.v1.json | 92 ++++++++++++++++++- 3 files changed, 116 insertions(+), 3 deletions(-) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 1dbe3e83759..56d0a2581bc 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -133,6 +133,19 @@

Method Details

"A String", ], }, + "accountVerification": { # Information about account verification, used for identity verification. # Account verification information for identity verification. The assessment event must include a token and site key to use this feature. + "endpoints": [ # Endpoints that can be used for identity verification. + { # Information about a verification endpoint that can be used for 2FA. + "emailAddress": "A String", # Email address for which to trigger a verification request. + "lastVerificationTime": "A String", # Output only. Timestamp of the last successful verification for the endpoint, if any. + "phoneNumber": "A String", # Phone number for which to trigger a verification request. Should be given in E.164 format. + "requestToken": "A String", # Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes. + }, + ], + "languageCode": "A String", # Language code preference for the verification message, set as a IETF BCP 47 language code. + "latestVerificationResult": "A String", # Output only. Result of the latest account verification challenge. + "username": "A String", # Username of the account that is being verified. Deprecated. Customers should now provide the hashed account ID field in Event. + }, "event": { # The event being assessed. "expectedAction": "A String", # 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. "hashedAccountId": "A String", # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. @@ -181,6 +194,19 @@

Method Details

"A String", ], }, + "accountVerification": { # Information about account verification, used for identity verification. # Account verification information for identity verification. The assessment event must include a token and site key to use this feature. + "endpoints": [ # Endpoints that can be used for identity verification. + { # Information about a verification endpoint that can be used for 2FA. + "emailAddress": "A String", # Email address for which to trigger a verification request. + "lastVerificationTime": "A String", # Output only. Timestamp of the last successful verification for the endpoint, if any. + "phoneNumber": "A String", # Phone number for which to trigger a verification request. Should be given in E.164 format. + "requestToken": "A String", # Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes. + }, + ], + "languageCode": "A String", # Language code preference for the verification message, set as a IETF BCP 47 language code. + "latestVerificationResult": "A String", # Output only. Result of the latest account verification challenge. + "username": "A String", # Username of the account that is being verified. Deprecated. Customers should now provide the hashed account ID field in Event. + }, "event": { # The event being assessed. "expectedAction": "A String", # 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. "hashedAccountId": "A String", # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index f02402cfe6e..c428bcec658 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -403,6 +403,7 @@

Method Details

The object takes the form of: { # The migrate key request message. + "skipBillingCheck": True or False, # Optional. Whether or not to do billing check. A reCAPTCHA Enterprise or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information. } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 6c2fe536831..1cc19c5f96d 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -12,7 +12,7 @@ "baseUrl": "https://recaptchaenterprise.googleapis.com/", "batchPath": "batch", "canonicalName": "Recaptcha Enterprise", - "description": "", + "description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recaptcha-enterprise/", "fullyEncodeReservedExpansion": true, @@ -514,7 +514,7 @@ } } }, - "revision": "20221112", + "revision": "20221204", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -545,6 +545,57 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo": { + "description": "Information about account verification, used for identity verification.", + "id": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", + "properties": { + "endpoints": { + "description": "Endpoints that can be used for identity verification.", + "items": { + "$ref": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo" + }, + "type": "array" + }, + "languageCode": { + "description": "Language code preference for the verification message, set as a IETF BCP 47 language code.", + "type": "string" + }, + "latestVerificationResult": { + "description": "Output only. Result of the latest account verification challenge.", + "enum": [ + "RESULT_UNSPECIFIED", + "SUCCESS_USER_VERIFIED", + "ERROR_USER_NOT_VERIFIED", + "ERROR_SITE_ONBOARDING_INCOMPLETE", + "ERROR_RECIPIENT_NOT_ALLOWED", + "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED", + "ERROR_CRITICAL_INTERNAL", + "ERROR_CUSTOMER_QUOTA_EXHAUSTED", + "ERROR_VERIFICATION_BYPASSED", + "ERROR_VERDICT_MISMATCH" + ], + "enumDescriptions": [ + "No information about the latest account verification.", + "The user was successfully verified. This means the account verification challenge was successfully completed.", + "The user failed the verification challenge.", + "The site is not properly onboarded to use the account verification feature.", + "The recipient is not allowed for account verification. This can occur during integration but should not occur in production.", + "The recipient has already been sent too many verification codes in a short amount of time.", + "The verification flow could not be completed due to a critical internal error.", + "The client has exceeded their two factor request quota for this period of time.", + "The request cannot be processed at the time because of an incident. This bypass can be restricted to a problematic destination email domain, a customer, or could affect the entire service.", + "The request parameters do not match with the token provided and cannot be processed." + ], + "readOnly": true, + "type": "string" + }, + "username": { + "description": "Username of the account that is being verified. Deprecated. Customers should now provide the hashed account ID field in Event.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": { "description": "Settings specific to keys that can be used by Android apps.", "id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings", @@ -648,6 +699,10 @@ "$ref": "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment", "description": "Assessment returned by account defender when a hashed_account_id is provided." }, + "accountVerification": { + "$ref": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", + "description": "Account verification information for identity verification. The assessment event must include a token and site key to use this feature." + }, "event": { "$ref": "GoogleCloudRecaptchaenterpriseV1Event", "description": "The event being assessed." @@ -701,6 +756,32 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo": { + "description": "Information about a verification endpoint that can be used for 2FA.", + "id": "GoogleCloudRecaptchaenterpriseV1EndpointVerificationInfo", + "properties": { + "emailAddress": { + "description": "Email address for which to trigger a verification request.", + "type": "string" + }, + "lastVerificationTime": { + "description": "Output only. Timestamp of the last successful verification for the endpoint, if any.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "phoneNumber": { + "description": "Phone number for which to trigger a verification request. Should be given in E.164 format.", + "type": "string" + }, + "requestToken": { + "description": "Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1Event": { "id": "GoogleCloudRecaptchaenterpriseV1Event", "properties": { @@ -885,7 +966,12 @@ "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest": { "description": "The migrate key request message.", "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", - "properties": {}, + "properties": { + "skipBillingCheck": { + "description": "Optional. Whether or not to do billing check. A reCAPTCHA Enterprise or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudRecaptchaenterpriseV1PrivatePasswordLeakVerification": {