feat(recaptchaenterprise): update the API

#### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.transactionEvent.$ref - schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.transactionEvent.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.id - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventTime.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventTime.format - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventTime.type - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventType.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventType.enum - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventType.enumDescriptions - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.eventType.type - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.reason.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.reason.type - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.value.description - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.value.format - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.properties.value.type - schemas.GoogleCloudRecaptchaenterpriseV1TransactionEvent.type The following keys were changed: - schemas.GoogleCloudRecaptchaenterpriseV1Assessment.description - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.siteKey.description - schemas.GoogleCloudRecaptchaenterpriseV1Event.properties.token.description
googleapis · Feb 2, 2023 · a42a0c8 · a42a0c8
1 parent f102db0
commit a42a0c8
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 8 deletions.
diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json
@@ -514,7 +514,7 @@
       }
     }
   },
-  "revision": "20221219",
+  "revision": "20230129",
   "rootUrl": "https://recaptchaenterprise.googleapis.com/",
   "schemas": {
     "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
@@ -681,6 +681,10 @@
             "type": "string"
           },
           "type": "array"
+        },
+        "transactionEvent": {
+          "$ref": "GoogleCloudRecaptchaenterpriseV1TransactionEvent",
+          "description": "Optional. If the Assessment is part of a Payment Transaction, provide details on Payment Lifecycle Events that occur in the Transaction."
         }
       },
       "type": "object"
@@ -692,7 +696,7 @@
       "type": "object"
     },
     "GoogleCloudRecaptchaenterpriseV1Assessment": {
-      "description": "A recaptcha assessment resource.",
+      "description": "A reCAPTCHA Enterprise assessment resource.",
       "id": "GoogleCloudRecaptchaenterpriseV1Assessment",
       "properties": {
         "accountDefenderAssessment": {
@@ -795,11 +799,11 @@
           "type": "string"
         },
         "siteKey": {
-          "description": "Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.",
+          "description": "Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.",
           "type": "string"
         },
         "token": {
-          "description": "Optional. The user response token provided by the reCAPTCHA client-side integration on your site.",
+          "description": "Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.",
           "type": "string"
         },
         "userAgent": {
@@ -1230,6 +1234,73 @@
       },
       "type": "object"
     },
+    "GoogleCloudRecaptchaenterpriseV1TransactionEvent": {
+      "description": "Describes an event in the lifecycle of a payment transaction.",
+      "id": "GoogleCloudRecaptchaenterpriseV1TransactionEvent",
+      "properties": {
+        "eventTime": {
+          "description": "Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.",
+          "format": "google-datetime",
+          "type": "string"
+        },
+        "eventType": {
+          "description": "Optional. The type of this transaction event.",
+          "enum": [
+            "TRANSACTION_EVENT_TYPE_UNSPECIFIED",
+            "MERCHANT_APPROVE",
+            "MERCHANT_DENY",
+            "MANUAL_REVIEW",
+            "AUTHORIZATION",
+            "AUTHORIZATION_DECLINE",
+            "PAYMENT_CAPTURE",
+            "PAYMENT_CAPTURE_DECLINE",
+            "CANCEL",
+            "CHARGEBACK_INQUIRY",
+            "CHARGEBACK_ALERT",
+            "FRAUD_NOTIFICATION",
+            "CHARGEBACK",
+            "CHARGEBACK_REPRESENTMENT",
+            "CHARGEBACK_REVERSE",
+            "REFUND_REQUEST",
+            "REFUND_DECLINE",
+            "REFUND",
+            "REFUND_REVERSE"
+          ],
+          "enumDescriptions": [
+            "Default, unspecified event type.",
+            "Indicates that the transaction is approved by the merchant's risk engine. The accompanying reasons can include 'INHOUSE', 'ACCERTIFY', or 'RECAPTCHA'.",
+            "Indicates that the transaction is denied and concluded due to risks detected by the merchant's risk engine. The accompanying reasons can include 'INHOUSE', 'ACCERTIFY', 'MANUAL_REVIEW', or 'RECAPTCHA'.",
+            "Indicates that the transaction is being evaluated by a human, due to suspicion or risk.",
+            "Indicates that the authorization attempt with the card issuer succeeded.",
+            "Indicates that the authorization attempt with the card issuer failed. The accompanying reasons can include Visa's '54' indicating that the card is expired or '82' indicating that the CVV is incorrect.",
+            "Indicates that the transaction is completed because the funds were settled.",
+            "Indicates that the transaction could not be completed because the funds were not settled.",
+            "Indicates that the transaction has been canceled. Specify the reason for the cancellation. For example, 'INSUFFICIENT_INVENTORY'.",
+            "Indicates that the merchant has received a chargeback inquiry for the transaction, requesting additional information before a chargeback is officially issued and a formal chargeback notification is sent.",
+            "Indicates that the merchant has received a chargeback alert for the transaction. The process of resolving the dispute without involving the payment network is started.",
+            "Indicates that a fraud notification is issued for the transaction, sent by the payment instrument's issuing bank because the transaction appears to be fraudulent. We recommend including TC40 or SAFE data in the `reason` field for this event type. For partial chargebacks, we recommend that you include an amount in the `value` field.",
+            "Indicates that the merchant is informed by the payment network that the transaction has entered the chargeback process. Reason code examples include Discover's '4553' and '6041'. For partial chargebacks, we recommend that you include an amount in the `value` field.",
+            "Indicates that the transaction has entered the chargeback process, and that the merchant has chosen to enter representment. Reason examples include Discover's '4553' and '6041'. For partial chargebacks, we recommend that you include an amount in the `value` field.",
+            "Indicates that the transaction has had a chargeback which was illegitimate and was reversed as a result. For partial chargebacks, we recommend that you include an amount in the `value` field.",
+            "Indicates that the merchant has received a refund for a completed transaction. For partial refunds, we recommend that you include an amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax)",
+            "Indicates that the merchant has received a refund request for this transaction, but that they have declined it. For partial refunds, we recommend that you include an amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax)",
+            "Indicates that the completed transaction was refunded by the merchant. For partial refunds, we recommend that you include an amount in the `value` field. Reason example: 'TAX_EXEMPT' (partial refund of exempt tax)",
+            "Indicates that the completed transaction was refunded by the merchant, and that this refund was reversed. For partial refunds, we recommend that you include an amount in the `value` field."
+          ],
+          "type": "string"
+        },
+        "reason": {
+          "description": "Optional. The reason or standardized code which corresponds with this transaction event, if one exists. E.g. a CHARGEBACK Event with code 4553.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Optional. The value that corresponds with this transaction event, if one exists. E.g. A refund event where $5.00 was refunded. Currency is obtained from the original transaction data.",
+          "format": "double",
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudRecaptchaenterpriseV1WafSettings": {
       "description": "Settings specific to keys that can be used for WAF (Web Application Firewall).",
       "id": "GoogleCloudRecaptchaenterpriseV1WafSettings",

diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts
@@ -183,13 +183,17 @@ export namespace recaptchaenterprise_v1 {
      * Optional. Optional reasons for the annotation that will be assigned to the Event.
      */
     reasons?: string[] | null;
+    /**
+     * Optional. If the Assessment is part of a Payment Transaction, provide details on Payment Lifecycle Events that occur in the Transaction.
+     */
+    transactionEvent?: Schema$GoogleCloudRecaptchaenterpriseV1TransactionEvent;
   }
   /**
    * Empty response for AnnotateAssessment.
    */
   export interface Schema$GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse {}
   /**
-   * A recaptcha assessment resource.
+   * A reCAPTCHA Enterprise assessment resource.
    */
   export interface Schema$GoogleCloudRecaptchaenterpriseV1Assessment {
     /**
@@ -273,11 +277,11 @@ export namespace recaptchaenterprise_v1 {
      */
     hashedAccountId?: string | null;
     /**
-     * Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.
+     * Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
      */
     siteKey?: string | null;
     /**
-     * Optional. The user response token provided by the reCAPTCHA client-side integration on your site.
+     * Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
      */
     token?: string | null;
     /**
@@ -574,6 +578,27 @@ export namespace recaptchaenterprise_v1 {
      */
     valid?: boolean | null;
   }
+  /**
+   * Describes an event in the lifecycle of a payment transaction.
+   */
+  export interface Schema$GoogleCloudRecaptchaenterpriseV1TransactionEvent {
+    /**
+     * Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.
+     */
+    eventTime?: string | null;
+    /**
+     * Optional. The type of this transaction event.
+     */
+    eventType?: string | null;
+    /**
+     * Optional. The reason or standardized code which corresponds with this transaction event, if one exists. E.g. a CHARGEBACK Event with code 4553.
+     */
+    reason?: string | null;
+    /**
+     * Optional. The value that corresponds with this transaction event, if one exists. E.g. A refund event where $5.00 was refunded. Currency is obtained from the original transaction data.
+     */
+    value?: number | null;
+  }
   /**
    * Settings specific to keys that can be used for WAF (Web Application Firewall).
    */
@@ -677,7 +702,8 @@ export namespace recaptchaenterprise_v1 {
      *       // {
      *       //   "annotation": "my_annotation",
      *       //   "hashedAccountId": "my_hashedAccountId",
-     *       //   "reasons": []
+     *       //   "reasons": [],
+     *       //   "transactionEvent": {}
      *       // }
      *     },
      *   });