@finverse/sdk-typescript 0.0.86 → 0.0.88

package/dist/api.d.ts

@@ -897,42 +897,12 @@ export interface CreateRecipientRequest {
  * @interface CreateRecipientResponse
  */
 export interface CreateRecipientResponse {
-    /**
-     * A unique identifier generated after creating recipient
-     * @type {string}
-     * @memberof CreateRecipientResponse
-     */
-    recipient_account_id?: string;
-    /**
-     * Recipient\'s name/nickname (note: this does not need to match the actual accountholder name of the recipient\'s account)
-     * @type {string}
-     * @memberof CreateRecipientResponse
-     */
-    name: string;
     /**
      *
-     * @type {RecipientAccount}
-     * @memberof CreateRecipientResponse
-     */
-    recipient_account: RecipientAccount;
-    /**
-     * Customer App\'s internal ID for the recipient
-     * @type {string}
+     * @type {RecipientResponse}
      * @memberof CreateRecipientResponse
      */
-    user_id?: string;
-    /**
-     * Additional attributes of the recipient in key:value format (e.g. employer_name: Apple Inc for a payroll case where recipient is an employee)
-     * @type {object}
-     * @memberof CreateRecipientResponse
-     */
-    metadata?: object;
-    /**
-     * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
-     * @type {string}
-     * @memberof CreateRecipientResponse
-     */
-    last_update?: string;
+    recipient?: RecipientResponse;
 }
 /**
  *
@@ -1629,6 +1599,19 @@ export interface GetPaymentInstructionsResponse {
      */
     payment_instruction?: PaymentInstruction;
 }
+/**
+ *
+ * @export
+ * @interface GetRecipientResponse
+ */
+export interface GetRecipientResponse {
+    /**
+     *
+     * @type {RecipientResponse}
+     * @memberof GetRecipientResponse
+     */
+    recipient?: RecipientResponse;
+}
 /**
  *
  * @export
@@ -3724,6 +3707,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}
@@ -3902,6 +3921,49 @@ export declare const RecipientAccountNumberTypeEnum: {
     readonly Iban: "IBAN";
 };
 export declare type RecipientAccountNumberTypeEnum = typeof RecipientAccountNumberTypeEnum[keyof typeof RecipientAccountNumberTypeEnum];
+/**
+ *
+ * @export
+ * @interface RecipientResponse
+ */
+export interface RecipientResponse {
+    /**
+     * A unique identifier generated after creating recipient
+     * @type {string}
+     * @memberof RecipientResponse
+     */
+    recipient_account_id?: string;
+    /**
+     * Recipient\'s name/nickname (note: this does not need to match the actual accountholder name of the recipient\'s account)
+     * @type {string}
+     * @memberof RecipientResponse
+     */
+    name: string;
+    /**
+     *
+     * @type {RecipientAccount}
+     * @memberof RecipientResponse
+     */
+    recipient_account: RecipientAccount;
+    /**
+     * Customer App\'s internal ID for the recipient
+     * @type {string}
+     * @memberof RecipientResponse
+     */
+    user_id?: string;
+    /**
+     * Additional attributes of the recipient in key:value format (e.g. employer_name: Apple Inc for a payroll case where recipient is an employee)
+     * @type {object}
+     * @memberof RecipientResponse
+     */
+    metadata?: object;
+    /**
+     * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
+     * @type {string}
+     * @memberof RecipientResponse
+     */
+    last_update?: string;
+}
 /**
  *
  * @export
@@ -4577,6 +4639,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     createRecipient: (createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRecipient: (recipientAccountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4646,6 +4715,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getPayoutInstruction: (payoutInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRecipient: (recipientAccountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -4728,6 +4804,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRecipientResponse>>;
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4797,6 +4880,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRecipientResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -4879,6 +4969,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     createRecipient(createRecipientRequest: CreateRecipientRequest, options?: any): AxiosPromise<CreateRecipientResponse>;
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRecipient(recipientAccountId: string, options?: any): AxiosPromise<void>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4948,6 +5045,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getPayoutInstruction(payoutInstructionId: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRecipient(recipientAccountId: string, options?: any): AxiosPromise<GetRecipientResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -5037,6 +5141,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): AxiosPromise<CreateRecipientResponse>;
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    deleteRecipient(recipientAccountId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -5116,6 +5228,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): AxiosPromise<GetRecipientResponse>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -5210,6 +5330,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRecipientResponse>>;
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    deleteRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -5289,6 +5417,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getPayoutInstruction(payoutInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getRecipient(recipientAccountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRecipientResponse>>;
     /**
      * Get a list of institutions
      * @param {string} [country] (Deprecated) The country the institution belongs to

package/dist/api.js

@@ -445,6 +445,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Delete Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteRecipient: (recipientAccountId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'recipientAccountId' is not null or undefined
+            common_1.assertParamExists('deleteRecipient', 'recipientAccountId', recipientAccountId);
+            const localVarPath = `/recipients/{recipientAccountId}`.replace(`{${'recipientAccountId'}}`, encodeURIComponent(String(recipientAccountId)));
+            // 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: 'DELETE' }, 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,
+            };
+        }),
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -746,6 +776,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRecipient: (recipientAccountId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'recipientAccountId' is not null or undefined
+            common_1.assertParamExists('getRecipient', 'recipientAccountId', recipientAccountId);
+            const localVarPath = `/recipients/{recipientAccountId}`.replace(`{${'recipientAccountId'}}`, encodeURIComponent(String(recipientAccountId)));
+            // 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
@@ -969,6 +1029,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Delete Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteRecipient(recipientAccountId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteRecipient(recipientAccountId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -1088,6 +1160,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRecipient(recipientAccountId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRecipient(recipientAccountId, 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
@@ -1215,6 +1299,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         createRecipient(createRecipientRequest, options) {
             return localVarFp.createRecipient(createRecipientRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Delete Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        deleteRecipient(recipientAccountId, options) {
+            return localVarFp.deleteRecipient(recipientAccountId, options).then((request) => request(axios, basePath));
+        },
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -1308,6 +1401,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         getPayoutInstruction(payoutInstructionId, options) {
             return localVarFp.getPayoutInstruction(payoutInstructionId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Recipient
+         * @param {string} recipientAccountId The institution id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRecipient(recipientAccountId, options) {
+            return localVarFp.getRecipient(recipientAccountId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get a list of institutions
          * @param {string} [country] (Deprecated) The country the institution belongs to
@@ -1435,6 +1537,18 @@ class CustomerApi extends base_1.BaseAPI {
             .createRecipient(createRecipientRequest, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Delete Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    deleteRecipient(recipientAccountId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .deleteRecipient(recipientAccountId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -1554,6 +1668,18 @@ class CustomerApi extends base_1.BaseAPI {
             .getPayoutInstruction(payoutInstructionId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get Recipient
+     * @param {string} recipientAccountId The institution id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getRecipient(recipientAccountId, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getRecipient(recipientAccountId, 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.86",
+  "version": "0.0.88",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [