Update all services (#1328)

* [reformat][adyen-sdk-automation] automated change

* style(fmt): code formatted

* fix unit tests for management service fixes and manually remove faulty import from balancePlatform model

---------

Co-authored-by: AdyenAutomationBot <Adyen Automation plugins_dev@adyen.com>
Co-authored-by: Wouter Boereboom <62436079+wboereboom@users.noreply.github.com>

Author: 3 people

src/__tests__/management.spec.ts

@@ -246,9 +246,9 @@ describe("Management", (): void => {
 
         it("should support POST /merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins", async (): Promise<void> => {
             scope.post(`/merchants/${merchantId}/apiCredentials/${apiCredentialId}/allowedOrigins`)
-                .reply(200, responses.allowedOriginsResponse);
+                .reply(200, responses.allowedOrigin);
 
-            const response:  management.AllowedOriginsResponse = await managementService.AllowedOriginsMerchantLevelApi.createAllowedOrigin(merchantId, apiCredentialId, requests.allowedOrigin);
+            const response:  management.AllowedOrigin = await managementService.AllowedOriginsMerchantLevelApi.createAllowedOrigin(merchantId, apiCredentialId, requests.allowedOrigin);
 
             expect(response).toBeTruthy();
         });
@@ -706,24 +706,20 @@ describe("Management", (): void => {
             scope.post("/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins", requestBody)
                 .reply(200, {
                     "id": "YOUR_ALLOWED_ORIGIN",
-                    "data": [
-                        {
-                            "domain": "https://www.eu.mystore.com",
-                        }
-                    ], 
+                    "domain": "https://www.eu.mystore.com",
                     "_links": {
                         "self": {
                             "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/apiCredentials/YOUR_API_CREDENTIAL/allowedOrigins/YOUR_ALLOWED_ORIGIN"
                         }
                     }
                 });
 
-            const response: management.AllowedOriginsResponse = await managementService.AllowedOriginsMerchantLevelApi
+            const response: management.AllowedOrigin = await managementService.AllowedOriginsMerchantLevelApi
                 .createAllowedOrigin("YOUR_MERCHANT_ACCOUNT", "YOUR_API_CREDENTIAL", {
                     domain: "https://www.eu.mystore.com",
                 });
 
-            expect(response.data![0].domain).toEqual("https://www.eu.mystore.com");
+            expect(response.domain).toEqual("https://www.eu.mystore.com");
         });
     });
 });

src/services/balancePlatform/index.ts

@@ -13,8 +13,8 @@ import { BankAccountValidationApi } from "./bankAccountValidationApi";
 import { CardOrdersApi } from "./cardOrdersApi";
 import { GrantAccountsApi } from "./grantAccountsApi";
 import { GrantOffersApi } from "./grantOffersApi";
+import { ManageCardPINApi } from "./manageCardPINApi";
 import { NetworkTokensApi } from "./networkTokensApi";
-import { PINFunctionalityApi } from "./pINFunctionalityApi";
 import { PaymentInstrumentGroupsApi } from "./paymentInstrumentGroupsApi";
 import { PaymentInstrumentsApi } from "./paymentInstrumentsApi";
 import { PlatformApi } from "./platformApi";
@@ -54,12 +54,12 @@ export default class BalancePlatformAPI extends Service {
         return new GrantOffersApi(this.client);
     }
 
-    public get NetworkTokensApi() {
-        return new NetworkTokensApi(this.client);
+    public get ManageCardPINApi() {
+        return new ManageCardPINApi(this.client);
     }
 
-    public get PINFunctionalityApi() {
-        return new PINFunctionalityApi(this.client);
+    public get NetworkTokensApi() {
+        return new NetworkTokensApi(this.client);
     }
 
     public get PaymentInstrumentGroupsApi() {

src/services/balancePlatform/pINFunctionalityApi.ts renamed to src/services/balancePlatform/manageCardPINApi.ts

@@ -21,7 +21,7 @@ import {
 import { IRequest } from "../../typings/requestOptions";
 import Resource from "../resource";
 
-export class PINFunctionalityApi extends Service {
+export class ManageCardPINApi extends Service {
 
     private readonly API_BASEPATH: string = "https://balanceplatform-api-test.adyen.com/bcl/v2";
     private baseUrl: string;
@@ -32,12 +32,12 @@ export class PINFunctionalityApi extends Service {
     }
 
     /**
-    * @summary Change Pin
+    * @summary Change a card PIN
     * @param pinChangeRequest {@link PinChangeRequest } 
     * @param requestOptions {@link IRequest.Options }
     * @return {@link PinChangeResponse }
     */
-    public async changePin(pinChangeRequest: PinChangeRequest, requestOptions?: IRequest.Options): Promise<PinChangeResponse> {
+    public async changeCardPin(pinChangeRequest: PinChangeRequest, requestOptions?: IRequest.Options): Promise<PinChangeResponse> {
         const endpoint = `${this.baseUrl}/pins/change`;
         const resource = new Resource(this, endpoint);
         const request: PinChangeRequest = ObjectSerializer.serialize(pinChangeRequest, "PinChangeRequest");
@@ -50,14 +50,14 @@ export class PINFunctionalityApi extends Service {
     }
 
     /**
-    * @summary Get RSA publicKey
+    * @summary Get an RSA public key
     * @param requestOptions {@link IRequest.Options }
-    * @param purpose {@link string } Purpose of publicKey.
-    * @param format {@link string } Format of publicKey.
+    * @param purpose {@link string } The purpose of the public key.  Possible values: **pinChange**, **pinReveal**, **panReveal**.  Default value: **pinReveal**.
+    * @param format {@link string } The encoding format of public key.  Possible values: **jwk**, **pem**.  Default value: **pem**.
     * @return {@link PublicKeyResponse }
     */
-    public async getRsaPublickey(purpose?: string, format?: string, requestOptions?: IRequest.Options): Promise<PublicKeyResponse> {
-        const endpoint = `${this.baseUrl}/pins/publicKey`;
+    public async publicKey(purpose?: string, format?: string, requestOptions?: IRequest.Options): Promise<PublicKeyResponse> {
+        const endpoint = `${this.baseUrl}/publicKey`;
         const resource = new Resource(this, endpoint);
         const hasDefinedQueryParams = purpose ?? format;
         if(hasDefinedQueryParams) {
@@ -75,12 +75,12 @@ export class PINFunctionalityApi extends Service {
     }
 
     /**
-    * @summary Reveal Pin
+    * @summary Reveal a card PIN
     * @param revealPinRequest {@link RevealPinRequest } 
     * @param requestOptions {@link IRequest.Options }
     * @return {@link RevealPinResponse }
     */
-    public async revealPin(revealPinRequest: RevealPinRequest, requestOptions?: IRequest.Options): Promise<RevealPinResponse> {
+    public async revealCardPin(revealPinRequest: RevealPinRequest, requestOptions?: IRequest.Options): Promise<RevealPinResponse> {
         const endpoint = `${this.baseUrl}/pins/reveal`;
         const resource = new Resource(this, endpoint);
         const request: RevealPinRequest = ObjectSerializer.serialize(revealPinRequest, "RevealPinRequest");

src/services/balancePlatform/paymentInstrumentsApi.ts

@@ -15,6 +15,8 @@ import {
     PaymentInstrument,
     PaymentInstrumentInfo,
     PaymentInstrumentRevealInfo,
+    PaymentInstrumentRevealRequest,
+    PaymentInstrumentRevealResponse,
     PaymentInstrumentUpdateRequest,
     TransactionRulesResponse,
     UpdatePaymentInstrument,
@@ -123,6 +125,24 @@ export class PaymentInstrumentsApi extends Service {
         return ObjectSerializer.deserialize(response, "ListNetworkTokensResponse");
     }
 
+    /**
+    * @summary Reveal the data of a payment instrument
+    * @param paymentInstrumentRevealRequest {@link PaymentInstrumentRevealRequest } 
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link PaymentInstrumentRevealResponse }
+    */
+    public async revealDataOfPaymentInstrument(paymentInstrumentRevealRequest: PaymentInstrumentRevealRequest, requestOptions?: IRequest.Options): Promise<PaymentInstrumentRevealResponse> {
+        const endpoint = `${this.baseUrl}/paymentInstruments/reveal`;
+        const resource = new Resource(this, endpoint);
+        const request: PaymentInstrumentRevealRequest = ObjectSerializer.serialize(paymentInstrumentRevealRequest, "PaymentInstrumentRevealRequest");
+        const response = await getJsonResponse<PaymentInstrumentRevealRequest, PaymentInstrumentRevealResponse>(
+            resource,
+            request,
+            { ...requestOptions, method: "POST" }
+        );
+        return ObjectSerializer.deserialize(response, "PaymentInstrumentRevealResponse");
+    }
+
     /**
     * @summary Update a payment instrument
     * @param id {@link string } The unique identifier of the payment instrument.

src/services/legalEntityManagement/documentsApi.ts

@@ -47,12 +47,19 @@ export class DocumentsApi extends Service {
     * @summary Get a document
     * @param id {@link string } The unique identifier of the document.
     * @param requestOptions {@link IRequest.Options }
+    * @param skipContent {@link boolean } Do not load document content while fetching the document.
     * @return {@link Document }
     */
-    public async getDocument(id: string, requestOptions?: IRequest.Options): Promise<Document> {
+    public async getDocument(id: string, skipContent?: boolean, requestOptions?: IRequest.Options): Promise<Document> {
         const endpoint = `${this.baseUrl}/documents/{id}`
             .replace("{" + "id" + "}", encodeURIComponent(String(id)));
         const resource = new Resource(this, endpoint);
+        const hasDefinedQueryParams = skipContent;
+        if(hasDefinedQueryParams) {
+            if(!requestOptions) requestOptions = {};
+            if(!requestOptions.params) requestOptions.params = {};
+            if(skipContent) requestOptions.params["skipContent"] = skipContent;
+        }
         const response = await getJsonResponse<string, Document>(
             resource,
             "",

src/services/management/allowedOriginsCompanyLevelApi.ts

@@ -34,20 +34,20 @@ export class AllowedOriginsCompanyLevelApi extends Service {
     * @param apiCredentialId {@link string } Unique identifier of the API credential.
     * @param allowedOrigin {@link AllowedOrigin } 
     * @param requestOptions {@link IRequest.Options }
-    * @return {@link AllowedOriginsResponse }
+    * @return {@link AllowedOrigin }
     */
-    public async createAllowedOrigin(companyId: string, apiCredentialId: string, allowedOrigin: AllowedOrigin, requestOptions?: IRequest.Options): Promise<AllowedOriginsResponse> {
+    public async createAllowedOrigin(companyId: string, apiCredentialId: string, allowedOrigin: AllowedOrigin, requestOptions?: IRequest.Options): Promise<AllowedOrigin> {
         const endpoint = `${this.baseUrl}/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins`
             .replace("{" + "companyId" + "}", encodeURIComponent(String(companyId)))
             .replace("{" + "apiCredentialId" + "}", encodeURIComponent(String(apiCredentialId)));
         const resource = new Resource(this, endpoint);
         const request: AllowedOrigin = ObjectSerializer.serialize(allowedOrigin, "AllowedOrigin");
-        const response = await getJsonResponse<AllowedOrigin, AllowedOriginsResponse>(
+        const response = await getJsonResponse<AllowedOrigin, AllowedOrigin>(
             resource,
             request,
             { ...requestOptions, method: "POST" }
         );
-        return ObjectSerializer.deserialize(response, "AllowedOriginsResponse");
+        return ObjectSerializer.deserialize(response, "AllowedOrigin");
     }
 
     /**

src/services/management/allowedOriginsMerchantLevelApi.ts

@@ -34,20 +34,20 @@ export class AllowedOriginsMerchantLevelApi extends Service {
     * @param apiCredentialId {@link string } Unique identifier of the API credential.
     * @param allowedOrigin {@link AllowedOrigin } 
     * @param requestOptions {@link IRequest.Options }
-    * @return {@link AllowedOriginsResponse }
+    * @return {@link AllowedOrigin }
     */
-    public async createAllowedOrigin(merchantId: string, apiCredentialId: string, allowedOrigin: AllowedOrigin, requestOptions?: IRequest.Options): Promise<AllowedOriginsResponse> {
+    public async createAllowedOrigin(merchantId: string, apiCredentialId: string, allowedOrigin: AllowedOrigin, requestOptions?: IRequest.Options): Promise<AllowedOrigin> {
         const endpoint = `${this.baseUrl}/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins`
             .replace("{" + "merchantId" + "}", encodeURIComponent(String(merchantId)))
             .replace("{" + "apiCredentialId" + "}", encodeURIComponent(String(apiCredentialId)));
         const resource = new Resource(this, endpoint);
         const request: AllowedOrigin = ObjectSerializer.serialize(allowedOrigin, "AllowedOrigin");
-        const response = await getJsonResponse<AllowedOrigin, AllowedOriginsResponse>(
+        const response = await getJsonResponse<AllowedOrigin, AllowedOrigin>(
             resource,
             request,
             { ...requestOptions, method: "POST" }
         );
-        return ObjectSerializer.deserialize(response, "AllowedOriginsResponse");
+        return ObjectSerializer.deserialize(response, "AllowedOrigin");
     }
 
     /**

src/services/transfers/transfersApi.ts

@@ -10,10 +10,12 @@
 import getJsonResponse from "../../helpers/getJsonResponse";
 import Service from "../../service";
 import Client from "../../client";
-import {
+import { 
+    FindTransfersResponse,
     ReturnTransferRequest,
     ReturnTransferResponse,
     Transfer,
+    TransferData,
     TransferInfo,
     ObjectSerializer
 } from "../../typings/transfers/models";
@@ -30,6 +32,65 @@ export class TransfersApi extends Service {
         this.baseUrl = this.createBaseUrl(this.API_BASEPATH);
     }
 
+    /**
+    * @summary Get all transfers
+    * @param requestOptions {@link IRequest.Options }
+    * @param balancePlatform {@link string } The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id).  Required if you don\'t provide a `balanceAccountId` or `accountHolderId`.
+    * @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 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' | '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 createdSince {@link Date } Only include transfers that have been created on or after this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.
+    * @param createdUntil {@link Date } Only include transfers that have been created on or before this point in time. The value must be in ISO 8601 format. For example, **2021-05-30T15:07:40Z**.
+    * @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 }
+    */
+    public async getAllTransfers(balancePlatform?: string, accountHolderId?: string, balanceAccountId?: string, paymentInstrumentId?: string, reference?: string, category?: "bank" | "card" | "grants" | "internal" | "issuedCard" | "migration" | "platformPayment" | "topUp" | "upgrade", createdSince?: Date, createdUntil?: Date, cursor?: string, limit?: number, requestOptions?: IRequest.Options): Promise<FindTransfersResponse> {
+        const endpoint = `${this.baseUrl}/transfers`;
+        const resource = new Resource(this, endpoint);
+        const hasDefinedQueryParams = balancePlatform ?? accountHolderId ?? balanceAccountId ?? paymentInstrumentId ?? reference ?? category ?? createdSince ?? createdUntil ?? cursor ?? limit;
+        if(hasDefinedQueryParams) {
+            if(!requestOptions) requestOptions = {};
+            if(!requestOptions.params) requestOptions.params = {};
+            if(balancePlatform) requestOptions.params["balancePlatform"] = balancePlatform;
+            if(accountHolderId) requestOptions.params["accountHolderId"] = accountHolderId;
+            if(balanceAccountId) requestOptions.params["balanceAccountId"] = balanceAccountId;
+            if(paymentInstrumentId) requestOptions.params["paymentInstrumentId"] = paymentInstrumentId;
+            if(reference) requestOptions.params["reference"] = reference;
+            if(category) requestOptions.params["category"] = category;
+            if(createdSince) requestOptions.params["createdSince"] = createdSince.toISOString();
+            if(createdUntil) requestOptions.params["createdUntil"] = createdUntil.toISOString();
+            if(cursor) requestOptions.params["cursor"] = cursor;
+            if(limit) requestOptions.params["limit"] = limit;
+        }
+        const response = await getJsonResponse<string, FindTransfersResponse>(
+            resource,
+            "",
+            { ...requestOptions, method: "GET" }
+        );
+        return ObjectSerializer.deserialize(response, "FindTransfersResponse");
+    }
+
+    /**
+    * @summary Get a transfer
+    * @param id {@link string } Unique identifier of the transfer.
+    * @param requestOptions {@link IRequest.Options }
+    * @return {@link TransferData }
+    */
+    public async getTransfer(id: string, requestOptions?: IRequest.Options): Promise<TransferData> {
+        const endpoint = `${this.baseUrl}/transfers/{id}`
+            .replace("{" + "id" + "}", encodeURIComponent(String(id)));
+        const resource = new Resource(this, endpoint);
+        const response = await getJsonResponse<string, TransferData>(
+            resource,
+            "",
+            { ...requestOptions, method: "GET" }
+        );
+        return ObjectSerializer.deserialize(response, "TransferData");
+    }
+
     /**
     * @summary Return a transfer
     * @param transferId {@link string } The unique identifier of the transfer to be returned.

src/typings/balancePlatform/aULocalAccountIdentification.ts

@@ -18,6 +18,10 @@ export class AULocalAccountIdentification {
     */
     'bsbCode': string;
     /**
+    * The form factor of the account.  Possible values: **physical**, **virtual**. Default value: **physical**.
+    */
+    'formFactor'?: string | null;
+    /**
     * **auLocal**
     */
     'type': AULocalAccountIdentification.TypeEnum;
@@ -35,6 +39,11 @@ export class AULocalAccountIdentification {
             "baseName": "bsbCode",
             "type": "string"
         },
+        {
+            "name": "formFactor",
+            "baseName": "formFactor",
+            "type": "string | null"
+        },
         {
             "name": "type",
             "baseName": "type",