Merge branch 'main' into improve-issue-templates

Author: ayodejidev

VERSION

@@ -1 +1 @@
-24.0.0
+25.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adyen/api-library",
-  "version": "24.0.0",
+  "version": "25.0.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__/binLookup.spec.ts

@@ -81,7 +81,6 @@ describe("Bin Lookup", function (): void {
                 value: 10
             },
             resultCode: "Unsupported",
-            surchargeType: "ZERO"
         };
         const costEstimateRequest:  binlookup.CostEstimateRequest = {
             amount: { currency: "EUR", value: 1000 },

src/services/balancePlatform/grantAccountsApi.ts

@@ -32,6 +32,9 @@ export class GrantAccountsApi extends Service {
     * @param id {@link string } The unique identifier of the grant account.
     * @param requestOptions {@link IRequest.Options }
     * @return {@link CapitalGrantAccount }
+    *
+	* @deprecated since Configuration API v2
+	* Use the `/grantAccounts/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantAccounts/(id)) instead.
     */
     public async getGrantAccount(id: string, requestOptions?: IRequest.Options): Promise<CapitalGrantAccount> {
         const endpoint = `${this.baseUrl}/grantAccounts/{id}`

src/services/balancePlatform/grantOffersApi.ts

@@ -33,6 +33,9 @@ export class GrantOffersApi extends Service {
     * @param requestOptions {@link IRequest.Options }
     * @param accountHolderId {@link string } The unique identifier of the grant account.
     * @return {@link GrantOffers }
+    *
+	* @deprecated since Configuration API v2
+	* Use the `/grantOffers` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.
     */
     public async getAllAvailableGrantOffers(accountHolderId?: string, requestOptions?: IRequest.Options): Promise<GrantOffers> {
         const endpoint = `${this.baseUrl}/grantOffers`;
@@ -56,6 +59,9 @@ export class GrantOffersApi extends Service {
     * @param grantOfferId {@link string } The unique identifier of the grant offer.
     * @param requestOptions {@link IRequest.Options }
     * @return {@link GrantOffer }
+    *
+	* @deprecated since Configuration API v2
+	* Use the `/grantOffers/{id}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.
     */
     public async getGrantOffer(grantOfferId: string, requestOptions?: IRequest.Options): Promise<GrantOffer> {
         const endpoint = `${this.baseUrl}/grantOffers/{grantOfferId}`

src/services/balancePlatform/manageSCADevicesApi.ts

@@ -11,6 +11,10 @@ import getJsonResponse from "../../helpers/getJsonResponse";
 import Service from "../../service";
 import Client from "../../client";
 import { 
+    AssociationFinaliseRequest,
+    AssociationFinaliseResponse,
+    AssociationInitiateRequest,
+    AssociationInitiateResponse,
     RegisterSCAFinalResponse,
     RegisterSCARequest,
     RegisterSCAResponse,
@@ -30,6 +34,26 @@ export class ManageSCADevicesApi extends Service {
         this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
     }
 
+    /**
+    * @summary Complete an association between an SCA device and a resource
+    * @param deviceId {@link string } The unique identifier of the SCA device that you are associating with a resource.
+    * @param associationFinaliseRequest {@link AssociationFinaliseRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link AssociationFinaliseResponse }
+    */
+    public async completeAssociationBetweenScaDeviceAndResource(deviceId: string, associationFinaliseRequest: AssociationFinaliseRequest, requestOptions?: IRequest.Options): Promise<AssociationFinaliseResponse> {
+        const endpoint = `${this.baseUrl}/registeredDevices/{deviceId}/associations`
+            .replace("{" + "deviceId" + "}", encodeURIComponent(String(deviceId)));
+        const resource = new Resource(this, endpoint);
+        const request: AssociationFinaliseRequest = ObjectSerializer.serialize(associationFinaliseRequest, "AssociationFinaliseRequest");
+        const response = await getJsonResponse<AssociationFinaliseRequest, AssociationFinaliseResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "PATCH" }
+        );
+        return ObjectSerializer.deserialize(response, "AssociationFinaliseResponse");
+    }
+
     /**
     * @summary Complete the registration of an SCA device
     * @param id {@link string } The unique identifier of the SCA device. You obtain this &#x60;id&#x60; in the response of a POST&amp;nbsp;[/registeredDevices](https://docs.adyen.com/api-explorer/balanceplatform/2/post/registeredDevices#responses-200-id) request.
@@ -73,6 +97,26 @@ export class ManageSCADevicesApi extends Service {
         );
     }
 
+    /**
+    * @summary Initiate an association between an SCA device and a resource
+    * @param deviceId {@link string } The unique identifier of the SCA device that you are associating with a resource.
+    * @param associationInitiateRequest {@link AssociationInitiateRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link AssociationInitiateResponse }
+    */
+    public async initiateAssociationBetweenScaDeviceAndResource(deviceId: string, associationInitiateRequest: AssociationInitiateRequest, requestOptions?: IRequest.Options): Promise<AssociationInitiateResponse> {
+        const endpoint = `${this.baseUrl}/registeredDevices/{deviceId}/associations`
+            .replace("{" + "deviceId" + "}", encodeURIComponent(String(deviceId)));
+        const resource = new Resource(this, endpoint);
+        const request: AssociationInitiateRequest = ObjectSerializer.serialize(associationInitiateRequest, "AssociationInitiateRequest");
+        const response = await getJsonResponse<AssociationInitiateRequest, AssociationInitiateResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+        return ObjectSerializer.deserialize(response, "AssociationInitiateResponse");
+    }
+
     /**
     * @summary Initiate the registration of an SCA device
     * @param registerSCARequest {@link RegisterSCARequest } 

src/services/index.ts

@@ -6,6 +6,7 @@ export { default as RecurringAPI } from "./recurringApi";
 export { default as BinLookupAPI } from "./binLookupApi";
 export { default as PayoutAPI } from "./payout";
 export { default as Platforms } from "./platforms";
+export { default as PosMobileAPI } from "./posMobileApi";
 export { default as StoredValueAPI} from "./storedValueApi";
 export { default as TerminalManagementAPI } from "./terminalManagementApi";
 export { default as ManagementAPI } from "./management";

src/services/transfers/capitalApi.ts

@@ -34,6 +34,9 @@ export class CapitalApi extends Service {
     * @param requestOptions {@link IRequest.Options }
     * @param counterpartyAccountHolderId {@link string } The counterparty account holder id.
     * @return {@link CapitalGrants }
+    *
+	* @deprecated since Transfers API v4
+	* Use the `/grants` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grants) instead.
     */
     public async getCapitalAccount(counterpartyAccountHolderId?: string, requestOptions?: IRequest.Options): Promise<CapitalGrants> {
         const endpoint = `${this.baseUrl}/grants`;
@@ -57,6 +60,9 @@ export class CapitalApi extends Service {
     * @param id {@link string } The unique identifier of the grant.
     * @param requestOptions {@link IRequest.Options }
     * @return {@link CapitalGrant }
+    *
+	* @deprecated since Transfers API v4
+	* Use the `/grants/{grantId}` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/get/grants/(grantId)) instead.
     */
     public async getGrantReferenceDetails(id: string, requestOptions?: IRequest.Options): Promise<CapitalGrant> {
         const endpoint = `${this.baseUrl}/grants/{id}`
@@ -75,6 +81,9 @@ export class CapitalApi extends Service {
     * @param capitalGrantInfo {@link CapitalGrantInfo } 
     * @param requestOptions {@link IRequest.Options }
     * @return {@link CapitalGrant }
+    *
+	* @deprecated since Transfers API v4
+	* Use the `/grants` endpoint from the [Capital API](https://docs.adyen.com/api-explorer/capital/latest/post/grants) instead.
     */
     public async requestGrantPayout(capitalGrantInfo: CapitalGrantInfo, requestOptions?: IRequest.Options): Promise<CapitalGrant> {
         const endpoint = `${this.baseUrl}/grants`;

src/typings/acsWebhooks/challengeInfo.ts

@@ -10,7 +10,7 @@
 
 export class ChallengeInfo {
     /**
-    * Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
+    * Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. Possible values: * **00**: Data element is absent or value has been sent back with the key `challengeCancel`. * **01**: Cardholder selected **Cancel**. * **02**: 3DS Requestor cancelled Authentication. * **03**: Transaction abandoned. * **04**: Transaction timed out at ACS — other timeouts. * **05**: Transaction timed out at ACS — first CReq not received by ACS. * **06**: Transaction error. * **07**: Unknown. * **08**: Transaction time out at SDK.
     */
     'challengeCancel'?: ChallengeInfo.ChallengeCancelEnum;
     /**
@@ -75,13 +75,15 @@ export class ChallengeInfo {
 
 export namespace ChallengeInfo {
     export enum ChallengeCancelEnum {
+        _00 = '00',
         _01 = '01',
         _02 = '02',
         _03 = '03',
         _04 = '04',
         _05 = '05',
         _06 = '06',
-        _07 = '07'
+        _07 = '07',
+        _08 = '08'
     }
     export enum FlowEnum {
         OtpSms = 'OTP_SMS',

src/typings/balancePlatform/accountHolder.ts

@@ -53,7 +53,7 @@ export class AccountHolder {
     */
     'reference'?: string;
     /**
-    * The status of the account holder.  Possible values:    * **active**: The account holder is active. This is the default status when creating an account holder.    * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone.   * **closed**: The account holder is permanently deactivated by you. This action cannot be undone.
+    * The status of the account holder.  Possible values:    * **active**: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to **suspended** or **closed**.    * **suspended**: The account holder is temporarily disabled and payouts are blocked. You can change this status to **active** or **closed**.   * **closed**: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.
     */
     'status'?: AccountHolder.StatusEnum;
     /**