@finverse/sdk-typescript 0.0.43 → 0.0.46

package/README.md

@@ -159,7 +159,8 @@ console.log("statements: "  + statementsResp.statements)
 const statementId = statements.data.statements[0].id;
 
 // Can download statement from here 
-const satementLink = await new LoginIdentityApi(configuration).getStatementLink(statementId);
+const statementResp = await new LoginIdentityApi(configuration).getStatement(statementId, true, {responseType: "arraybuffer"});
+writeFileSync("statement.pdf", Buffer.from(statementResp.data));
 ```
 
 ## Getting started (Payment flow)

package/dist/api.d.ts

@@ -97,6 +97,12 @@ export interface Account {
      * @memberof Account
      */
     account_sub_type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account
+     */
+    account_number_masked?: string;
     /**
      *
      * @type {string}
@@ -3034,10 +3040,11 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createMandate: (createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createMandate: (createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create new Payment
      * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
@@ -3128,10 +3135,11 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMandateResponse>>;
+    createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMandateResponse>>;
     /**
      * Create new Payment
      * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
@@ -3222,10 +3230,11 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createMandate(createMandateRequest: CreateMandateRequest, options?: any): AxiosPromise<CreateMandateResponse>;
+    createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: any): AxiosPromise<CreateMandateResponse>;
     /**
      * Create new Payment
      * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
@@ -3317,11 +3326,12 @@ export interface CustomerApiInterface {
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApiInterface
      */
-    createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMandateResponse>;
+    createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<CreateMandateResponse>;
     /**
      * Create new Payment
      * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
@@ -3425,11 +3435,12 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApi
      */
-    createMandate(createMandateRequest: CreateMandateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMandateResponse>>;
+    createMandate(createMandateRequest: CreateMandateRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMandateResponse>>;
     /**
      * Create new Payment
      * @param {CreatePaymentRequest} createPaymentRequest request body for creating payment
@@ -3838,13 +3849,6 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getStatement: (statementId: string, redirect?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatementLink: (statementId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.
@@ -3953,13 +3957,6 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatementLinkResponse>>;
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatementLink(statementId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatementLinkResponse>>;
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.
@@ -4068,13 +4065,6 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getStatement(statementId: string, redirect?: boolean, options?: any): AxiosPromise<GetStatementLinkResponse>;
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getStatementLink(statementId: string, options?: any): AxiosPromise<GetStatementLinkResponse>;
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.
@@ -4194,14 +4184,6 @@ export interface LoginIdentityApiInterface {
      * @memberof LoginIdentityApiInterface
      */
     getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): AxiosPromise<GetStatementLinkResponse>;
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApiInterface
-     */
-    getStatementLink(statementId: string, options?: AxiosRequestConfig): AxiosPromise<GetStatementLinkResponse>;
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.
@@ -4327,14 +4309,6 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
      * @memberof LoginIdentityApi
      */
     getStatement(statementId: string, redirect?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatementLinkResponse>>;
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApi
-     */
-    getStatementLink(statementId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatementLinkResponse>>;
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.

package/dist/api.js

@@ -92,10 +92,11 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createMandate: (createMandateRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        createMandate: (createMandateRequest, idempotencyKey, options = {}) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'createMandateRequest' is not null or undefined
             common_1.assertParamExists('createMandate', 'createMandateRequest', createMandateRequest);
             const localVarPath = `/mandates`;
@@ -111,6 +112,9 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
             // authentication Oauth2 required
             // oauth required
             yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
+            if (idempotencyKey !== undefined && idempotencyKey !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey);
+            }
             localVarHeaderParameter['Content-Type'] = 'application/json';
             common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -488,12 +492,13 @@ exports.CustomerApiFp = function (configuration) {
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createMandate(createMandateRequest, options) {
+        createMandate(createMandateRequest, idempotencyKey, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.createMandate(createMandateRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createMandate(createMandateRequest, idempotencyKey, options);
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -645,11 +650,14 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createMandate(createMandateRequest, options) {
-            return localVarFp.createMandate(createMandateRequest, options).then((request) => request(axios, basePath));
+        createMandate(createMandateRequest, idempotencyKey, options) {
+            return localVarFp
+                .createMandate(createMandateRequest, idempotencyKey, options)
+                .then((request) => request(axios, basePath));
         },
         /**
          * Create new Payment
@@ -774,13 +782,14 @@ class CustomerApi extends base_1.BaseAPI {
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payment. If missing we will generate a random one. The purpose for the Idempotency key is to allow safe retrying without the operation being performed multiple times.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CustomerApi
      */
-    createMandate(createMandateRequest, options) {
+    createMandate(createMandateRequest, idempotencyKey, options) {
         return exports.CustomerApiFp(this.configuration)
-            .createMandate(createMandateRequest, options)
+            .createMandate(createMandateRequest, idempotencyKey, options)
             .then((request) => request(this.axios, this.basePath));
     }
     /**
@@ -1629,36 +1638,6 @@ exports.LoginIdentityApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
-        /**
-         * (Deprecated) Get statement link for download
-         * @param {string} statementId The statement id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getStatementLink: (statementId, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'statementId' is not null or undefined
-            common_1.assertParamExists('getStatementLink', 'statementId', statementId);
-            const localVarPath = `/statement_links/{statementId}`.replace(`{${'statementId'}}`, encodeURIComponent(String(statementId)));
-            // use dummy base URL string because the URL constructor only accepts absolute URLs.
-            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
-            let baseOptions;
-            if (configuration) {
-                baseOptions = configuration.baseOptions;
-            }
-            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
-            const localVarHeaderParameter = {};
-            const localVarQueryParameter = {};
-            // authentication Oauth2 required
-            // oauth required
-            yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
-            common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-            return {
-                url: common_1.toPathString(localVarUrlObj),
-                options: localVarRequestOptions,
-            };
-        }),
         /**
          * Get list of available statements
          * @param {*} [options] Override http request option.
@@ -1939,18 +1918,6 @@ exports.LoginIdentityApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
-        /**
-         * (Deprecated) Get statement link for download
-         * @param {string} statementId The statement id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getStatementLink(statementId, options) {
-            return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getStatementLink(statementId, options);
-                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
-            });
-        },
         /**
          * Get list of available statements
          * @param {*} [options] Override http request option.
@@ -2107,15 +2074,6 @@ exports.LoginIdentityApiFactory = function (configuration, basePath, axios) {
         getStatement(statementId, redirect, options) {
             return localVarFp.getStatement(statementId, redirect, options).then((request) => request(axios, basePath));
         },
-        /**
-         * (Deprecated) Get statement link for download
-         * @param {string} statementId The statement id
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        getStatementLink(statementId, options) {
-            return localVarFp.getStatementLink(statementId, options).then((request) => request(axios, basePath));
-        },
         /**
          * Get list of available statements
          * @param {*} [options] Override http request option.
@@ -2291,18 +2249,6 @@ class LoginIdentityApi extends base_1.BaseAPI {
             .getStatement(statementId, redirect, options)
             .then((request) => request(this.axios, this.basePath));
     }
-    /**
-     * (Deprecated) Get statement link for download
-     * @param {string} statementId The statement id
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LoginIdentityApi
-     */
-    getStatementLink(statementId, options) {
-        return exports.LoginIdentityApiFp(this.configuration)
-            .getStatementLink(statementId, options)
-            .then((request) => request(this.axios, this.basePath));
-    }
     /**
      * Get list of available statements
      * @param {*} [options] Override http request option.

package/dist/test/responses/statement.d.ts

@@ -1,2 +1,3 @@
 import { GetStatementsResponse } from '../../api';
 export declare function getStatements(): GetStatementsResponse;
+export declare function getStatementAsBuffer(): ArrayBuffer;

package/dist/test/responses/statement.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStatements = void 0;
+exports.getStatementAsBuffer = exports.getStatements = void 0;
 const account_1 = require("./account");
 function getStatements() {
     const accountData = account_1.getAccounts();
@@ -18,3 +18,7 @@ function getStatements() {
     };
 }
 exports.getStatements = getStatements;
+function getStatementAsBuffer() {
+    return new TextEncoder().encode("this is statement");
+}
+exports.getStatementAsBuffer = getStatementAsBuffer;

package/dist/test/statements.spec.js

@@ -16,7 +16,6 @@ const __1 = require("..");
 const api_1 = require("../api");
 const loginIdentityToken_1 = require("./responses/loginIdentityToken");
 const statement_1 = require("./responses/statement");
-const statementLink_1 = require("./responses/statementLink");
 const chai_1 = require("chai");
 describe('Statements', function () {
     let mock;
@@ -33,9 +32,9 @@ describe('Statements', function () {
             // Get link to statement
             // Assuming there is only one statement
             const statementId = gotStatements.data.statements[0].id;
-            mock.onGet(`${config_1.config.apiHost}/statement_links/${statementId}`).reply(200, statementLink_1.getStatementLinkByStatementId());
-            const gotStatementLink = yield new api_1.LoginIdentityApi(configuration).getStatementLink(statementId);
-            chai_1.expect(gotStatementLink.data.statement_links).to.be.ok;
+            mock.onGet(`${config_1.config.apiHost}/statements/${statementId}`).reply(200, statement_1.getStatementAsBuffer());
+            const gotStatementLink = yield new api_1.LoginIdentityApi(configuration).getStatement(statementId);
+            chai_1.expect(gotStatementLink.data).to.be.ok;
         });
     });
     after(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.43",
+  "version": "0.0.46",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -27,7 +27,7 @@
     "axios-mock-adapter": "^1.21.1",
     "chai": "^4.3.6",
     "mocha": "^10.0.0",
-    "ts-node": "^10.8.1",
+    "ts-node": "^10.8.2",
     "typescript": "^3.6.4"
   },
   "files": [

package/dist/test/responses/statementLink.d.ts

@@ -1,2 +0,0 @@
-import { GetStatementLinkResponse } from '../../api';
-export declare function getStatementLinkByStatementId(): GetStatementLinkResponse;

package/dist/test/responses/statementLink.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStatementLinkByStatementId = void 0;
-function getStatementLinkByStatementId() {
-    return {
-        statement_links: [
-            {
-                url: 'dummyUrl',
-                statement_id: '01F11PRDNQQV3HE6K57BVPEH09',
-                expiry: 'time',
-            },
-        ],
-    };
-}
-exports.getStatementLinkByStatementId = getStatementLinkByStatementId;