@finverse/sdk-typescript 0.0.85 → 0.0.87

package/dist/api.d.ts

@@ -3724,6 +3724,42 @@ export interface PayoutInstructionResponse {
      * @memberof PayoutInstructionResponse
      */
     status: PayoutInstructionResponseStatusEnum;
+    /**
+     * The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    mandate_id?: string;
+    /**
+     * The recipient account to receive the payment
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    recipient_account_id?: string;
+    /**
+     * Amount to be paid, in currency\'s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
+     * @type {number}
+     * @memberof PayoutInstructionResponse
+     */
+    amount?: number;
+    /**
+     * YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    date?: string;
+    /**
+     * A description for the payment (that will appear as the transaction description on bank statements)
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    description?: string;
+    /**
+     * The currency code as defined in ISO 4217.
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    currency?: string;
     /**
      *
      * @type {FvErrorModel}
@@ -4532,6 +4568,13 @@ export interface UserMessage {
  * @export
  */
 export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayoutInstruction: (payoutInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -4632,6 +4675,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayoutInstruction: (payoutInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -4669,6 +4719,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const CustomerApiFp: (configuration?: Configuration) => {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -4769,6 +4826,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -4806,6 +4870,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelPayoutInstruction(payoutInstructionId: string, options?: any): AxiosPromise<void>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -4906,6 +4977,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPayoutInstruction(payoutInstructionId: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -4944,6 +5022,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
  * @interface CustomerApi
  */
 export interface CustomerApiInterface {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -5058,6 +5144,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -5101,6 +5195,14 @@ export interface CustomerApiInterface {
  * @extends {BaseAPI}
  */
 export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    cancelPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -5215,6 +5317,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to

package/dist/api.js

@@ -243,6 +243,36 @@ exports.TransactionLimitsPeriodEnum = {
  */
 exports.CustomerApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         * Cancel Payout Instruction by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayoutInstruction: (payoutInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'payoutInstructionId' is not null or undefined
+            common_1.assertParamExists('cancelPayoutInstruction', 'payoutInstructionId', payoutInstructionId);
+            const localVarPath = `/payout_instruction/{payoutInstructionId}/cancel`.replace(`{${'payoutInstructionId'}}`, encodeURIComponent(String(payoutInstructionId)));
+            // 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: 'POST' }, 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,
+            };
+        }),
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -686,6 +716,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get Payout Instruction details by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayoutInstruction: (payoutInstructionId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'payoutInstructionId' is not null or undefined
+            common_1.assertParamExists('getPayoutInstruction', 'payoutInstructionId', payoutInstructionId);
+            const localVarPath = `/payout_instruction/{payoutInstructionId}`.replace(`{${'payoutInstructionId'}}`, encodeURIComponent(String(payoutInstructionId)));
+            // 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 a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -834,6 +894,18 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
 exports.CustomerApiFp = function (configuration) {
     const localVarAxiosParamCreator = exports.CustomerApiAxiosParamCreator(configuration);
     return {
+        /**
+         * Cancel Payout Instruction by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayoutInstruction(payoutInstructionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.cancelPayoutInstruction(payoutInstructionId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1004,6 +1076,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get Payout Instruction details by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayoutInstruction(payoutInstructionId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPayoutInstruction(payoutInstructionId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1064,6 +1148,17 @@ exports.CustomerApiFp = function (configuration) {
 exports.CustomerApiFactory = function (configuration, basePath, axios) {
     const localVarFp = exports.CustomerApiFp(configuration);
     return {
+        /**
+         * Cancel Payout Instruction by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        cancelPayoutInstruction(payoutInstructionId, options) {
+            return localVarFp
+                .cancelPayoutInstruction(payoutInstructionId, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * CREATE Mandate
          * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1204,6 +1299,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
                 .getPaymentInstruction(paymentInstructionId, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Get Payout Instruction details by payout_instruction_id
+         * @param {string} payoutInstructionId payout instruction id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPayoutInstruction(payoutInstructionId, options) {
+            return localVarFp.getPayoutInstruction(payoutInstructionId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1256,6 +1360,18 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
  * @extends {BaseAPI}
  */
 class CustomerApi extends base_1.BaseAPI {
+    /**
+     * Cancel Payout Instruction by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    cancelPayoutInstruction(payoutInstructionId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .cancelPayoutInstruction(payoutInstructionId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * CREATE Mandate
      * @param {CreateMandateRequest} createMandateRequest request body for creating mandate
@@ -1426,6 +1542,18 @@ class CustomerApi extends base_1.BaseAPI {
             .getPaymentInstruction(paymentInstructionId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get Payout Instruction details by payout_instruction_id
+     * @param {string} payoutInstructionId payout instruction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getPayoutInstruction(payoutInstructionId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getPayoutInstruction(payoutInstructionId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.85",
+  "version": "0.0.87",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [