@google-cloud/recaptcha-enterprise

{ "nested": { "google": { "nested": { "cloud": { "nested": { "recaptchaenterprise": { "nested": { "v1": { "options": { "csharp_namespace": "Google.Cloud.RecaptchaEnterprise.V1", "go_package": "cloud.google.com/go/recaptchaenterprise/v2/apiv1/recaptchaenterprisepb;recaptchaenterprisepb", "java_multiple_files": true, "java_outer_classname": "RecaptchaEnterpriseProto", "java_package": "com.google.recaptchaenterprise.v1", "objc_class_prefix": "GCRE", "php_namespace": "Google\\Cloud\\RecaptchaEnterprise\\V1", "ruby_package": "Google::Cloud::RecaptchaEnterprise::V1" }, "nested": { "RecaptchaEnterpriseService": { "options": { "(google.api.default_host)": "recaptchaenterprise.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "CreateAssessment": { "requestType": "CreateAssessmentRequest", "responseType": "Assessment", "options": { "(google.api.http).post": "/v1/{parent=projects/*}/assessments", "(google.api.http).body": "assessment", "(google.api.method_signature)": "parent,assessment" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*}/assessments", "body": "assessment" } }, { "(google.api.method_signature)": "parent,assessment" } ] }, "AnnotateAssessment": { "requestType": "AnnotateAssessmentRequest", "responseType": "AnnotateAssessmentResponse", "options": { "(google.api.http).post": "/v1/{name=projects/*/assessments/*}:annotate", "(google.api.http).body": "*", "(google.api.method_signature)": "name,annotation" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/assessments/*}:annotate", "body": "*" } }, { "(google.api.method_signature)": "name,annotation" } ] }, "CreateKey": { "requestType": "CreateKeyRequest", "responseType": "Key", "options": { "(google.api.http).post": "/v1/{parent=projects/*}/keys", "(google.api.http).body": "key", "(google.api.method_signature)": "parent,key" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*}/keys", "body": "key" } }, { "(google.api.method_signature)": "parent,key" } ] }, "ListKeys": { "requestType": "ListKeysRequest", "responseType": "ListKeysResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*}/keys", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*}/keys" } }, { "(google.api.method_signature)": "parent" } ] }, "RetrieveLegacySecretKey": { "requestType": "RetrieveLegacySecretKeyRequest", "responseType": "RetrieveLegacySecretKeyResponse", "options": { "(google.api.http).get": "/v1/{key=projects/*/keys/*}:retrieveLegacySecretKey", "(google.api.method_signature)": "key" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{key=projects/*/keys/*}:retrieveLegacySecretKey" } }, { "(google.api.method_signature)": "key" } ] }, "GetKey": { "requestType": "GetKeyRequest", "responseType": "Key", "options": { "(google.api.http).get": "/v1/{name=projects/*/keys/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/keys/*}" } }, { "(google.api.method_signature)": "name" } ] }, "UpdateKey": { "requestType": "UpdateKeyRequest", "responseType": "Key", "options": { "(google.api.http).patch": "/v1/{key.name=projects/*/keys/*}", "(google.api.http).body": "key", "(google.api.method_signature)": "key,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v1/{key.name=projects/*/keys/*}", "body": "key" } }, { "(google.api.method_signature)": "key,update_mask" } ] }, "DeleteKey": { "requestType": "DeleteKeyRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v1/{name=projects/*/keys/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=projects/*/keys/*}" } }, { "(google.api.method_signature)": "name" } ] }, "MigrateKey": { "requestType": "MigrateKeyRequest", "responseType": "Key", "options": { "(google.api.http).post": "/v1/{name=projects/*/keys/*}:migrate", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/keys/*}:migrate", "body": "*" } } ] }, "AddIpOverride": { "requestType": "AddIpOverrideRequest", "responseType": "AddIpOverrideResponse", "options": { "(google.api.http).post": "/v1/{name=projects/*/keys/*}:addIpOverride", "(google.api.http).body": "*", "(google.api.method_signature)": "name,ip_override_data" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/keys/*}:addIpOverride", "body": "*" } }, { "(google.api.method_signature)": "name,ip_override_data" } ] }, "RemoveIpOverride": { "requestType": "RemoveIpOverrideRequest", "responseType": "RemoveIpOverrideResponse", "options": { "(google.api.http).post": "/v1/{name=projects/*/keys/*}:removeIpOverride", "(google.api.http).body": "*", "(google.api.method_signature)": "name,ip_override_data" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/keys/*}:removeIpOverride", "body": "*" } }, { "(google.api.method_signature)": "name,ip_override_data" } ] }, "ListIpOverrides": { "requestType": "ListIpOverridesRequest", "responseType": "ListIpOverridesResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/keys/*}:listIpOverrides", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/keys/*}:listIpOverrides" } }, { "(google.api.method_signature)": "parent" } ] }, "GetMetrics": { "requestType": "GetMetricsRequest", "responseType": "Metrics", "options": { "(google.api.http).get": "/v1/{name=projects/*/keys/*/metrics}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/keys/*/metrics}" } }, { "(google.api.method_signature)": "name" } ] }, "CreateFirewallPolicy": { "requestType": "CreateFirewallPolicyRequest", "responseType": "FirewallPolicy", "options": { "(google.api.http).post": "/v1/{parent=projects/*}/firewallpolicies", "(google.api.http).body": "firewall_policy", "(google.api.method_signature)": "parent,firewall_policy" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*}/firewallpolicies", "body": "firewall_policy" } }, { "(google.api.method_signature)": "parent,firewall_policy" } ] }, "ListFirewallPolicies": { "requestType": "ListFirewallPoliciesRequest", "responseType": "ListFirewallPoliciesResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*}/firewallpolicies", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*}/firewallpolicies" } }, { "(google.api.method_signature)": "parent" } ] }, "GetFirewallPolicy": { "requestType": "GetFirewallPolicyRequest", "responseType": "FirewallPolicy", "options": { "(google.api.http).get": "/v1/{name=projects/*/firewallpolicies/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/firewallpolicies/*}" } }, { "(google.api.method_signature)": "name" } ] }, "UpdateFirewallPolicy": { "requestType": "UpdateFirewallPolicyRequest", "responseType": "FirewallPolicy", "options": { "(google.api.http).patch": "/v1/{firewall_policy.name=projects/*/firewallpolicies/*}", "(google.api.http).body": "firewall_policy", "(google.api.method_signature)": "firewall_policy,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v1/{firewall_policy.name=projects/*/firewallpolicies/*}", "body": "firewall_policy" } }, { "(google.api.method_signature)": "firewall_policy,update_mask" } ] }, "DeleteFirewallPolicy": { "requestType": "DeleteFirewallPolicyRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v1/{name=projects/*/firewallpolicies/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=projects/*/firewallpolicies/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ReorderFirewallPolicies": { "requestType": "ReorderFirewallPoliciesRequest", "responseType": "ReorderFirewallPoliciesResponse", "options": { "(google.api.http).post": "/v1/{parent=projects/*}/firewallpolicies:reorder", "(google.api.http).body": "*", "(google.api.method_signature)": "parent,names" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*}/firewallpolicies:reorder", "body": "*" } }, { "(google.api.method_signature)": "parent,names" } ] }, "ListRelatedAccountGroups": { "requestType": "ListRelatedAccountGroupsRequest", "responseType": "ListRelatedAccountGroupsResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*}/relatedaccountgroups", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*}/relatedaccountgroups" } }, { "(google.api.method_signature)": "parent" } ] }, "ListRelatedAccountGroupMemberships": { "requestType": "ListRelatedAccountGroupMembershipsRequest", "responseType": "ListRelatedAccountGroupMembershipsResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/relatedaccountgroups/*}/memberships", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/relatedaccountgroups/*}/memberships" } }, { "(google.api.method_signature)": "parent" } ] }, "SearchRelatedAccountGroupMemberships": { "requestType": "SearchRelatedAccountGroupMembershipsRequest", "responseType": "SearchRelatedAccountGroupMembershipsResponse", "options": { "(google.api.http).post": "/v1/{project=projects/*}/relatedaccountgroupmemberships:search", "(google.api.http).body": "*", "(google.api.method_signature)": "project,hashed_account_id" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{project=projects/*}/relatedaccountgroupmemberships:search", "body": "*" } }, { "(google.api.method_signature)": "project,hashed_account_id" } ] } } }, "CreateAssessmentRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudresourcemanager.googleapis.com/Project" } }, "assessment": { "type": "Assessment", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "TransactionEvent": { "fields": { "eventType": { "type": "TransactionEventType", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "reason": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "value": { "type": "double", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "eventTime": { "type": "google.protobuf.Timestamp", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "TransactionEventType": { "values": { "TRANSACTION_EVENT_TYPE_UNSPECIFIED": 0, "MERCHANT_APPROVE": 1, "MERCHANT_DENY": 2, "MANUAL_REVIEW": 3, "AUTHORIZATION": 4, "AUTHORIZATION_DECLINE": 5, "PAYMENT_CAPTURE": 6, "PAYMENT_CAPTURE_DECLINE": 7, "CANCEL": 8, "CHARGEBACK_INQUIRY": 9, "CHARGEBACK_ALERT": 10, "FRAUD_NOTIFICATION": 11, "CHARGEBACK": 12, "CHARGEBACK_REPRESENTMENT": 13, "CHARGEBACK_REVERSE": 14, "REFUND_REQUEST": 15, "REFUND_DECLINE": 16, "REFUND": 17, "REFUND_REVERSE": 18 } } } }, "AnnotateAssessmentRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "recaptchaenterprise.googleapis.com/Assessment" } }, "annotation": { "type": "Annotation", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "reasons": { "rule": "repeated", "type": "Reason", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "accountId": { "type": "string", "id": 7, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "hashedAccountId": { "type": "bytes", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "transactionEvent": { "type": "TransactionEvent", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "Annotation": { "valuesOptions": { "PASSWORD_CORRECT": { "deprecated": true }, "PASSWORD_INCORRECT": { "deprecated": true } }, "values": { "ANNOTATION_UNSPECIFIED": 0, "LEGITIMATE": 1, "FRAUDULENT": 2, "PASSWORD_CORRECT": 3, "PASSWORD_INCORRECT": 4 } }, "Reason": { "values": { "REASON_UNSPECIFIED": 0, "CHARGEBACK": 1, "CHARGEBACK_FRAUD": 8, "CHARGEBACK_DISPUTE": 9, "REFUND": 10, "REFUND_FRAUD": 11, "TRANSACTION_ACCEPTED": 12, "TRANSACTION_DECLINED": 13, "PAYMENT_HEURISTICS": 2, "INITIATED_TWO_FACTOR": 7, "PASSED_TWO_FACTOR": 3, "FAILED_TWO_FACTOR": 4, "CORRECT_PASSWORD": 5, "INCORRECT_PASSWORD": 6, "SOCIAL_SPAM": 14 } } } }, "AnnotateAssessmentResponse": { "fields": {} }, "EndpointVerificationInfo": { "oneofs": { "endpoint": { "oneof": [ "emailAddress", "phoneNumber" ] } }, "fields": { "emailAddress": { "type": "string", "id": 1 }, "phoneNumber": { "type": "string", "id": 2 }, "requestToken": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "lastVerificationTime": { "type": "google.protobuf.Timestamp", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "AccountVerificationInfo": { "fields": { "endpoints": { "rule": "repeated", "type": "EndpointVerificationInfo", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "languageCode": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "latestVerificationResult": { "type": "Result", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "username": { "type": "string", "id": 2, "options": { "deprecated": true } } }, "nested": { "Result": { "values": { "RESULT_UNSPECIFIED": 0, "SUCCESS_USER_VERIFIED": 1, "ERROR_USER_NOT_VERIFIED": 2, "ERROR_SITE_ONBOARDING_INCOMPLETE": 3, "ERROR_RECIPIENT_NOT_ALLOWED": 4, "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED": 5, "ERROR_CRITICAL_INTERNAL": 6, "ERROR_CUSTOMER_QUOTA_EXHAUSTED": 7, "ERROR_VERIFICATION_BYPASSED": 8, "ERROR_VERDICT_MISMATCH": 9 } } } }, "PrivatePasswordLeakVerification": { "fields": { "lookupHashPrefix": { "type": "bytes", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "encryptedUserCredentialsHash": { "type": "bytes", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "encryptedLeakMatchPrefixes": { "rule": "repeated", "type": "bytes", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "reencryptedUserCredentialsHash": { "type": "bytes", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "Assessment": { "options": { "(google.api.resource).type": "recaptchaenterprise.googleapis.com/Assessment", "(google.api.resource).pattern": "projects/{project}/assessments/{assessment}", "(google.api.resource).plural": "assessments", "(google.api.resource).singular": "assessment" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IDENTIFIER" } }, "event": { "type": "Event", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "riskAnalysis": { "type": "RiskAnalysis", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "tokenProperties": { "type": "TokenProperties", "id": 4, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "accountVerification": { "type": "AccountVerificationInfo", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "accountDefenderAssessment": { "type": "AccountDefenderAssessment", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "privatePasswordLeakVerification": { "type": "PrivatePasswordLeakVerification", "id": 8, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "firewallPolicyAssessment": { "type": "FirewallPolicyAssessment", "id": 10, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "fraudPreventionAssessment": { "type": "FraudPreventionAssessment", "id": 11, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "fraudSignals": { "type": "FraudSignals", "id": 13, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "phoneFraudAssessment": { "type": "PhoneFraudAssessment", "id": 12, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "assessmentEnvironment": { "type": "AssessmentEnvironment", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "Event": { "fields": { "token": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "siteKey": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "userAgent": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "userIpAddress": { "type": "string", "id": 4, "options": { "(google.api.field_info).format": "IPV4_OR_IPV6", "(google.api.field_behavior)": "OPTIONAL" } }, "expectedAction": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "hashedAccountId": { "type": "bytes", "id": 6, "options": { "deprecated": true, "(google.api.field_behavior)": "OPTIONAL" } }, "express": { "type": "bool", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "requestedUri": { "type": "string", "id": 8, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "wafTokenAssessment": { "type": "bool", "id": 9, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "ja3": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "ja4": { "type": "string", "id": 18, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "headers": { "rule": "repeated", "type": "string", "id": 11, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "firewallPolicyEvaluation": { "type": "bool", "id": 12, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "transactionData": { "type": "TransactionData", "id": 13, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "userInfo": { "type": "UserInfo", "id": 15, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "fraudPrevention": { "type": "FraudPrevention", "id": 17, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "FraudPrevention": { "values": { "FRAUD_PREVENTION_UNSPECIFIED": 0, "ENABLED": 1, "DISABLED": 2 } } } }, "TransactionData": { "oneofs": { "_transactionId": { "oneof": [ "transactionId" ] } }, "fields": { "transactionId": { "type": "string", "id": 11, "options": { "proto3_optional": true } }, "paymentMethod": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "cardBin": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "cardLastFour": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "currencyCode": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "value": { "type": "double", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "shippingValue": { "type": "double", "id": 12, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "shippingAddress": { "type": "Address", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "billingAddress": { "type": "Address", "id": 7, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "user": { "type": "User", "id": 8, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "merchants": { "rule": "repeated", "type": "User", "id": 13, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "items": { "rule": "repeated", "type": "Item", "id": 14, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "gatewayInfo": { "type": "GatewayInfo", "id": 10, "options": { "(google.api.field_behavior)": "OPTIONAL" } } }, "nested": { "Address": { "fields": { "recipient": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "address": { "rule": "repeated", "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "locality": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "administrativeArea": { "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "regionCode": { "type": "string", "id": 5, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "postalCode": { "type": "string", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "User": { "fields": { "accountId": { "type": "string", "id": 6, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "creationMs": { "type": "int64", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } },