@maxim_mazurok/gapi.client.recaptchaenterprise-v1 - npm Package Compare versions

Comparing version 0.0.20230216 to 0.0.20230219

index.d.ts

@@ -12,3 +12,3 @@ /* Type definitions for non-npm package reCAPTCHA Enterprise API v1 0.0 */
 // Generated from: https://recaptchaenterprise.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230216
+// Revision: 20230219
 
@@ -72,2 +72,4 @@ /// <reference types="gapi.client" />
             event?: GoogleCloudRecaptchaenterpriseV1Event;
+            /** Assessment returned by Fraud Prevention when TransactionData is provided. */
+            fraudPreventionAssessment?: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment;
             /** Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}". */
@@ -114,2 +116,7 @@ name?: string;
             token?: string;
+            /**
+             * Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the
+             * response.
+             */
+            transactionData?: GoogleCloudRecaptchaenterpriseV1TransactionData;
             /** Optional. The user agent present in the request from the user's device related to this event. */
@@ -120,2 +127,18 @@ userAgent?: string;
         }
+        interface GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessment {
+            /** Assessment of this transaction for risk of being part of a card testing attack. */
+            cardTestingVerdict?: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict;
+            /** Assessment of this transaction for risk of a stolen instrument. */
+            stolenInstrumentVerdict?: GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict;
+            /** Probability (0-1) of this transaction being fraudulent. Summarizes the combined risk of attack vectors below. */
+            transactionRisk?: number;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentCardTestingVerdict {
+            /** Probability (0-1) of this transaction attempt being part of a card testing attack. */
+            risk?: number;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1FraudPreventionAssessmentStolenInstrumentVerdict {
+            /** Probability (0-1) of this transaction being executed with a stolen instrument. */
+            risk?: number;
+        }
         interface GoogleCloudRecaptchaenterpriseV1IOSKeySettings {
@@ -277,2 +300,84 @@ /** If set to true, allowed_bundle_ids are not enforced. */
         }
+        interface GoogleCloudRecaptchaenterpriseV1TransactionData {
+            /** Address associated with the payment method when applicable. */
+            billingAddress?: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress;
+            /** The Bank Identification Number - generally the first 6 or 8 digits of the card. */
+            cardBin?: string;
+            /** The last four digits of the card. */
+            cardLastFour?: string;
+            /** The currency code in ISO-4217 format. */
+            currencyCode?: string;
+            /** Information about the payment gateway's response to the transaction. */
+            gatewayInfo?: GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo;
+            /** Items purchased in this transaction. */
+            items?: GoogleCloudRecaptchaenterpriseV1TransactionDataItem[];
+            /** Information about the user or users fulfilling the transaction. */
+            merchants?: GoogleCloudRecaptchaenterpriseV1TransactionDataUser[];
+            /**
+             * The payment method for the transaction. The allowed values are: * credit-card * debit-card * gift-card * processor-{name} (If a third-party is used, for example, processor-paypal) *
+             * custom-{name} (If an alternative method is used, for example, custom-crypto)
+             */
+            paymentMethod?: string;
+            /** Destination address if this transaction involves shipping a physical item. */
+            shippingAddress?: GoogleCloudRecaptchaenterpriseV1TransactionDataAddress;
+            /** The value of shipping in the specified currency. 0 for free or no shipping. */
+            shippingValue?: number;
+            /**
+             * Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two
+             * attempts at the same transaction should use the same transaction id.
+             */
+            transactionId?: string;
+            /** Information about the user paying/initiating the transaction. */
+            user?: GoogleCloudRecaptchaenterpriseV1TransactionDataUser;
+            /** The decimal value of the transaction in the specified currency. */
+            value?: number;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1TransactionDataAddress {
+            /** The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number. */
+            address?: string[];
+            /** The state, province, or otherwise administrative area of the address. */
+            administrativeArea?: string;
+            /** The town/city of the address. */
+            locality?: string;
+            /** The postal or ZIP code of the address. */
+            postalCode?: string;
+            /** The recipient name, potentially including information such as "care of". */
+            recipient?: string;
+            /** The CLDR country/region of the address. */
+            regionCode?: string;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1TransactionDataGatewayInfo {
+            /** AVS response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization). */
+            avsResponseCode?: string;
+            /** CVV response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization). */
+            cvvResponseCode?: string;
+            /** Gateway response code describing the state of the transaction. */
+            gatewayResponseCode?: string;
+            /** Name of the gateway service (for example, stripe, square, paypal). */
+            name?: string;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1TransactionDataItem {
+            /** When a merchant is specified, its corresponding account_id. Necessary to populate marketplace-style transactions. */
+            merchantAccountId?: string;
+            /** The full name of the item. */
+            name?: string;
+            /** The quantity of this item that is being purchased. */
+            quantity?: string;
+            /** The value per item that the user is paying, in the transaction currency, after discounts. */
+            value?: number;
+        }
+        interface GoogleCloudRecaptchaenterpriseV1TransactionDataUser {
+            /** Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account. */
+            accountId?: string;
+            /** The epoch milliseconds of the user's account creation. */
+            creationMs?: string;
+            /** The email address of the user. */
+            email?: string;
+            /** Whether the email has been verified to be accessible by the user (OTP or similar). */
+            emailVerified?: boolean;
+            /** The phone number of the user, with country code. */
+            phoneNumber?: string;
+            /** Whether the phone number has been verified to be accessible by the user (OTP or similar). */
+            phoneVerified?: boolean;
+        }
         interface GoogleCloudRecaptchaenterpriseV1TransactionEvent {
@@ -279,0 +384,0 @@ /** Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call. */

package.json

 {
   "name": "@maxim_mazurok/gapi.client.recaptchaenterprise-v1",
-  "version": "0.0.20230216",
+  "version": "0.0.20230219",
   "description": "TypeScript typings for reCAPTCHA Enterprise API v1",
@@ -5,0 +5,0 @@ "license": "MIT",

tests.ts

@@ -6,3 +6,3 @@ /* This is stub file for gapi.client.recaptchaenterprise-v1 definition tests */
 
-// Revision: 20230216
+// Revision: 20230219
 
@@ -76,5 +76,75 @@ gapi.load('client', async () => {
                 token: "Test string",
+                transactionData: {
+                    billingAddress: {
+                        address: [
+                            "Test string"
+                        ],
+                        administrativeArea: "Test string",
+                        locality: "Test string",
+                        postalCode: "Test string",
+                        recipient: "Test string",
+                        regionCode: "Test string",
+                    },
+                    cardBin: "Test string",
+                    cardLastFour: "Test string",
+                    currencyCode: "Test string",
+                    gatewayInfo: {
+                        avsResponseCode: "Test string",
+                        cvvResponseCode: "Test string",
+                        gatewayResponseCode: "Test string",
+                        name: "Test string",
+                    },
+                    items: [
+                        {
+                            merchantAccountId: "Test string",
+                            name: "Test string",
+                            quantity: "Test string",
+                            value: 42,
+                        }
+                    ],
+                    merchants: [
+                        {
+                            accountId: "Test string",
+                            creationMs: "Test string",
+                            email: "Test string",
+                            emailVerified: true,
+                            phoneNumber: "Test string",
+                            phoneVerified: true,
+                        }
+                    ],
+                    paymentMethod: "Test string",
+                    shippingAddress: {
+                        address: [
+                            "Test string"
+                        ],
+                        administrativeArea: "Test string",
+                        locality: "Test string",
+                        postalCode: "Test string",
+                        recipient: "Test string",
+                        regionCode: "Test string",
+                    },
+                    shippingValue: 42,
+                    transactionId: "Test string",
+                    user: {
+                        accountId: "Test string",
+                        creationMs: "Test string",
+                        email: "Test string",
+                        emailVerified: true,
+                        phoneNumber: "Test string",
+                        phoneVerified: true,
+                    },
+                    value: 42,
+                },
                 userAgent: "Test string",
                 userIpAddress: "Test string",
             },
+            fraudPreventionAssessment: {
+                cardTestingVerdict: {
+                    risk: 42,
+                },
+                stolenInstrumentVerdict: {
+                    risk: 42,
+                },
+                transactionRisk: 42,
+            },
             name: "Test string",
@@ -81,0 +151,0 @@ privatePasswordLeakVerification: {

No alert changes

Improved metrics

Total package byte prevSize

77184

increased by14.39%

Lines of code

1309

increased by15.43%

No dependency changes