Merge branch 'main' into predefinedcontent-referenceid-helper

Author: gcatanese

README.md

@@ -53,6 +53,7 @@ The library supports all webhooks under the following model directories:
 | [Management Webhooks](https://docs.adyen.com/api-explorer/ManagementNotification/3/overview)      | Adyen uses webhooks to inform your system about events that happen with your Adyen company and merchant accounts, stores, payment terminals, and payment methods when using Management API. | [ManagementWebhooks](src/typings/managementWebhooks)           | **v3**            |
 | [Notification Webhooks](https://docs.adyen.com/api-explorer/Webhooks/1/overview)                  | We use webhooks to send you updates about payment status updates, newly available reports, and other events that you can subscribe to. For more information, refer to our documentation     | [Notification](src/typings/notification)                       | **v1**            |
 | [Transaction Webhooks](https://docs.adyen.com/api-explorer/transaction-webhooks/4/overview)                  | Adyen sends webhooks to inform your system about incoming and outgoing transfers in your platform. You can use these webhooks to build your implementation. For example, you can use this information to update balances in your own dashboards or to keep track of incoming funds.     | [TransactionWebhooks](src/typings/transactionWebhooks)                       | **v4**            |
+| [Tokenization Webhooks](https://docs.adyen.com/api-explorer/Tokenization-webhooks/1/overview)      | Adyen sends webhooks to inform you about the creation and changes to the recurring tokens.                                                                                                                         | [tokenizationwebhooks](src/main/java/com/adyen/model/tokenizationwebhooks)                                    | **v1**            |
 
 For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 

VERSION

@@ -1 +1 @@
-28.0.0
+28.1.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/api-library",
-  "version": "28.0.0",
+  "version": "28.1.0",
   "description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",

src/__tests__/webhooks/tokenizationWebhooks.spec.ts

@@ -0,0 +1,119 @@
+import { TokenizationAlreadyExistingDetailsNotificationRequest } from "../../typings/tokenizationWebhooks/tokenizationAlreadyExistingDetailsNotificationRequest";
+import { TokenizationCreatedDetailsNotificationRequest } from "../../typings/tokenizationWebhooks/tokenizationCreatedDetailsNotificationRequest";
+import { TokenizationDisabledDetailsNotificationRequest } from "../../typings/tokenizationWebhooks/tokenizationDisabledDetailsNotificationRequest";
+import { TokenizationUpdatedDetailsNotificationRequest } from "../../typings/tokenizationWebhooks/tokenizationUpdatedDetailsNotificationRequest";
+import { TokenizationWebhooksHandler } from "../../typings/tokenizationWebhooks/tokenizationWebhooksHandler";
+
+describe("TokenizationWebhooksHandler", () => {
+    it("should deserialize TokenizationAlreadyExistingDetailsNotificationRequest", () => {
+        const json = {
+            "createdAt": "2025-06-30T16:40:23+02:00",
+            "eventId": "QBQQ9DLNRHHKGK38",
+            "environment": "test",
+            "data": {
+                "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+                "storedPaymentMethodId": "M5N7TQ4TG5PFWR50",
+                "type": "visastandarddebit",
+                "operation": "alreadyExisting",
+                "shopperReference": "YOUR_SHOPPER_REFERENCE"
+            },
+            "type": "recurring.token.alreadyExisting"
+        };
+        const handler = new TokenizationWebhooksHandler(JSON.stringify(json));
+        const request = handler.getTokenizationAlreadyExistingDetailsNotificationRequest();
+        expect(request).toBeTruthy();
+        expect(request.type).toBe(TokenizationAlreadyExistingDetailsNotificationRequest.TypeEnum.RecurringTokenAlreadyExisting);
+        expect(request.data.type).toBe("visastandarddebit");
+        // test GenericWebhook
+        const genericWebhook = handler.getGenericWebhook();
+        expect(genericWebhook).toBeInstanceOf(TokenizationAlreadyExistingDetailsNotificationRequest);
+        expect(genericWebhook.type).toBe("recurring.token.alreadyExisting");
+    });
+
+    it("should deserialize TokenizationCreatedDetailsNotificationRequest", () => {
+        const json = {
+            "createdAt": "2025-06-30T16:40:23+02:00",
+            "eventId": "QBQQ9DLNRHHKGK38",
+            "environment": "test",
+            "data": {
+                "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+                "storedPaymentMethodId": "M5N7TQ4TG5PFWR50",
+                "type": "visastandarddebit",
+                "operation": "created",
+                "shopperReference": "YOUR_SHOPPER_REFERENCE"
+            },
+            "type": "recurring.token.created"
+        };
+        const handler = new TokenizationWebhooksHandler(JSON.stringify(json));
+        const request = handler.getTokenizationCreatedDetailsNotificationRequest();
+        expect(request).toBeTruthy();
+        expect(request.type).toBe(TokenizationCreatedDetailsNotificationRequest.TypeEnum.RecurringTokenCreated);
+        expect(request.data.type).toBe("visastandarddebit");
+        // test GenericWebhook
+        const genericWebhook = handler.getGenericWebhook();
+        expect(genericWebhook).toBeInstanceOf(TokenizationCreatedDetailsNotificationRequest);
+        expect(genericWebhook.type).toBe("recurring.token.created");
+    });
+
+    it("should deserialize TokenizationUpdatedDetailsNotificationRequest", () => {
+        const json = {
+            "createdAt": "2025-06-30T16:40:23+02:00",
+            "eventId": "QBQQ9DLNRHHKGK38",
+            "environment": "test",
+            "data": {
+                "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+                "storedPaymentMethodId": "M5N7TQ4TG5PFWR50",
+                "type": "visastandarddebit",
+                "operation": "updated",
+                "shopperReference": "YOUR_SHOPPER_REFERENCE"
+            },
+            "type": "recurring.token.updated"
+        };
+        const handler = new TokenizationWebhooksHandler(JSON.stringify(json));
+        const request = handler.getTokenizationUpdatedDetailsNotificationRequest();
+        expect(request).toBeTruthy();
+        expect(request.type).toBe(TokenizationUpdatedDetailsNotificationRequest.TypeEnum.RecurringTokenUpdated);
+        expect(request.data.type).toBe("visastandarddebit");
+        // test GenericWebhook
+        const genericWebhook = handler.getGenericWebhook();
+        expect(genericWebhook).toBeInstanceOf(TokenizationUpdatedDetailsNotificationRequest);
+        expect(genericWebhook.type).toBe("recurring.token.updated");
+    });
+
+    it("should deserialize TokenizationDisabledDetailsNotificationRequest", () => {
+        const json = {
+            "createdAt": "2025-06-30T16:40:23+02:00",
+            "eventId": "QBQQ9DLNRHHKGK38",
+            "environment": "test",
+            "data": {
+                "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+                "storedPaymentMethodId": "M5N7TQ4TG5PFWR50",
+                "type": "visastandarddebit",
+                "shopperReference": "YOUR_SHOPPER_REFERENCE"
+            },
+            "type": "recurring.token.disabled"
+        };
+        const handler = new TokenizationWebhooksHandler(JSON.stringify(json));
+        const request = handler.getTokenizationDisabledDetailsNotificationRequest();
+        expect(request).toBeTruthy();
+        expect(request.type).toBe(TokenizationDisabledDetailsNotificationRequest.TypeEnum.RecurringTokenDisabled);
+        expect(request.data.type).toBe("visastandarddebit");
+        // test GenericWebhook
+        const genericWebhook = handler.getGenericWebhook();
+        expect(genericWebhook).toBeInstanceOf(TokenizationDisabledDetailsNotificationRequest);
+        expect(genericWebhook.type).toBe("recurring.token.disabled");
+    });
+
+    it("should throw error for unknown type", () => {
+        const json = {
+            type: "unknown.type",
+            data: {}
+        };
+        const handler = new TokenizationWebhooksHandler(JSON.stringify(json));
+        expect(() => handler.getGenericWebhook()).toThrow("Could not parse the json payload");
+    });
+
+    it("should throw SyntaxError for invalid JSON", () => {
+        expect(() => new TokenizationWebhooksHandler("{ invalid json }")).toThrow(SyntaxError);
+    });
+});

src/services/balancePlatform/paymentInstrumentsApi.ts

@@ -41,13 +41,13 @@ export class PaymentInstrumentsApi extends Service {
     }
 
     /**
-    * @summary Create network token activation data
+    * @summary Create network token provisioning data
     * @param id {@link string } The unique identifier of the payment instrument.
     * @param networkTokenActivationDataRequest {@link NetworkTokenActivationDataRequest } 
     * @param requestOptions {@link IRequest.Options }
     * @return {@link NetworkTokenActivationDataResponse }
     */
-    public async createNetworkTokenActivationData(id: string, networkTokenActivationDataRequest: NetworkTokenActivationDataRequest, requestOptions?: IRequest.Options): Promise<NetworkTokenActivationDataResponse> {
+    public async createNetworkTokenProvisioningData(id: string, networkTokenActivationDataRequest: NetworkTokenActivationDataRequest, requestOptions?: IRequest.Options): Promise<NetworkTokenActivationDataResponse> {
         const endpoint = `${this.baseUrl}/paymentInstruments/{id}/networkTokenActivationData`
             .replace("{" + "id" + "}", encodeURIComponent(String(id)));
         const resource = new Resource(this, endpoint);

src/services/transfers/transactionsApi.ts

@@ -41,7 +41,7 @@ export class TransactionsApi extends Service {
     * @param accountHolderId {@link string } The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/accountHolders/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `balancePlatform`.  If you provide a `balanceAccountId`, the `accountHolderId` must be related to the `balanceAccountId`.
     * @param balanceAccountId {@link string } The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id).  Required if you don\'t provide an `accountHolderId` or `balancePlatform`.  If you provide an `accountHolderId`, the `balanceAccountId` must be related to the `accountHolderId`.
     * @param cursor {@link string } The `cursor` returned in the links of the previous response.
-    * @param sortOrder {@link 'asc' | 'desc' } The transactions sorting order.  Possible values:   - **asc**: Ascending order, from older to most recent.  - **desc**: Descending order, from most recent to older.
+    * @param sortOrder {@link 'asc' | 'desc' } Determines the sort order of the returned transactions. The sort order is based on the creation date of the transaction.  Possible values:   - **asc**: Ascending order, from oldest to most recent.  - **desc**: Descending order, from most recent to oldest.  Default value: **asc**.
     * @param limit {@link number } The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.
     * @return {@link TransactionSearchResponse }
     */

src/services/transfers/transfersApi.ts

@@ -84,7 +84,7 @@ export class TransfersApi extends Service {
     * @param paymentInstrumentId {@link string } The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/paymentInstruments/_id_).  To use this parameter, you must also provide a `balanceAccountId`, `accountHolderId`, or `balancePlatform`.  The `paymentInstrumentId` must be related to the `balanceAccountId` or `accountHolderId` that you provide.
     * @param reference {@link string } The reference you provided in the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) request
     * @param category {@link 'bank' | 'card' | 'grants' | 'interest' | 'internal' | 'issuedCard' | 'migration' | 'platformPayment' | 'topUp' | 'upgrade' } The type of transfer.  Possible values:   - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.  - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform.  - **issuedCard**: Transfer initiated by a Adyen-issued card.  - **platformPayment**: Fund movements related to payments that are acquired for your users.
-    * @param sortOrder {@link 'asc' | 'desc' } The transfers sorting order.  Possible values:   - **asc**: Ascending order, from older to most recent.  - **desc**: Descending order, from most recent to older.
+    * @param sortOrder {@link 'asc' | 'desc' } Determines the sort order of the returned transfers. The sort order is based on the creation date of the transfers.  Possible values:   - **asc**: Ascending order, from oldest to most recent.  - **desc**: Descending order, from most recent to oldest.  Default value: **asc**.
     * @param cursor {@link string } The `cursor` returned in the links of the previous response.
     * @param limit {@link number } The number of items returned per page, maximum of 100 items. By default, the response returns 10 items per page.
     * @return {@link FindTransfersResponse }

src/typings/acsWebhooks/balancePlatformNotificationResponse.ts

@@ -10,7 +10,7 @@
 
 export class BalancePlatformNotificationResponse {
     /**
-    * Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).
+    * Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks/#accept-webhooks).
     */
     "notificationResponse"?: string;
 

src/typings/acsWebhooks/resource.ts

@@ -14,7 +14,7 @@ export class Resource {
     */
     "balancePlatform"?: string;
     /**
-    * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
+    * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2025-03-19T10:15:30+01:00**.
     */
     "creationDate"?: Date;
     /**

src/typings/balancePlatform/additionalBankIdentificationRequirement.ts

@@ -0,0 +1,67 @@
+/*
+ * The version of the OpenAPI document: v2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit this class manually.
+ */
+
+
+export class AdditionalBankIdentificationRequirement {
+    /**
+    * The type of additional bank identification, depending on the country.  Possible values:   * **auBsbCode**: The 6-digit [Australian Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or spaces.  * **caRoutingNumber**: The 9-digit [Canadian routing number](https://en.wikipedia.org/wiki/Routing_number_(Canada)), in EFT format, without separators or spaces.  * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces  * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces.
+    */
+    "additionalBankIdentificationType"?: AdditionalBankIdentificationRequirement.AdditionalBankIdentificationTypeEnum;
+    /**
+    * The description of the additional bank identification requirement.
+    */
+    "description"?: string;
+    /**
+    * **additionalBankIdentificationRequirement**
+    */
+    "type": AdditionalBankIdentificationRequirement.TypeEnum;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly mapping: {[index: string]: string} | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "additionalBankIdentificationType",
+            "baseName": "additionalBankIdentificationType",
+            "type": "AdditionalBankIdentificationRequirement.AdditionalBankIdentificationTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "description",
+            "baseName": "description",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "AdditionalBankIdentificationRequirement.TypeEnum",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return AdditionalBankIdentificationRequirement.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+export namespace AdditionalBankIdentificationRequirement {
+    export enum AdditionalBankIdentificationTypeEnum {
+        AuBsbCode = 'auBsbCode',
+        CaRoutingNumber = 'caRoutingNumber',
+        GbSortCode = 'gbSortCode',
+        UsRoutingNumber = 'usRoutingNumber'
+    }
+    export enum TypeEnum {
+        AdditionalBankIdentificationRequirement = 'additionalBankIdentificationRequirement'
+    }
+}