@finverse/sdk-typescript 0.0.84 → 0.0.85

package/dist/api.d.ts

@@ -815,6 +815,49 @@ export declare const CreatePaymentRequestTypeEnum: {
     readonly Single: "SINGLE";
 };
 export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
+/**
+ *
+ * @export
+ * @interface CreatePayoutInstructionRequest
+ */
+export interface CreatePayoutInstructionRequest {
+    /**
+     * The mandate used to execute payments for this payout instruction. Currency for the mandate must be supported by the recipient account
+     * @type {string}
+     * @memberof CreatePayoutInstructionRequest
+     */
+    mandate_id: string;
+    /**
+     * The recipient account to receive the payment
+     * @type {string}
+     * @memberof CreatePayoutInstructionRequest
+     */
+    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 CreatePayoutInstructionRequest
+     */
+    amount: number;
+    /**
+     * YYYY-MM-DD, date (in UTC) to execute the payment, must be 1 day later than current date
+     * @type {string}
+     * @memberof CreatePayoutInstructionRequest
+     */
+    date: string;
+    /**
+     * A description for the payment (that will appear as the transaction description on bank statements)
+     * @type {string}
+     * @memberof CreatePayoutInstructionRequest
+     */
+    description?: string;
+    /**
+     * The currency code as defined in ISO 4217.
+     * @type {string}
+     * @memberof CreatePayoutInstructionRequest
+     */
+    currency: string;
+}
 /**
  *
  * @export
@@ -3663,6 +3706,39 @@ export declare const PaymentScheduleFrequencyEnum: {
     readonly Yearly: "YEARLY";
 };
 export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequencyEnum[keyof typeof PaymentScheduleFrequencyEnum];
+/**
+ *
+ * @export
+ * @interface PayoutInstructionResponse
+ */
+export interface PayoutInstructionResponse {
+    /**
+     * Finverse Payout Instruction ID
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    payout_instruction_id: string;
+    /**
+     * Possible values - CREATED, PROCESSING, EXECUTED, CANCELLED, FAILED.
+     * @type {string}
+     * @memberof PayoutInstructionResponse
+     */
+    status: PayoutInstructionResponseStatusEnum;
+    /**
+     *
+     * @type {FvErrorModel}
+     * @memberof PayoutInstructionResponse
+     */
+    error?: FvErrorModel;
+}
+export declare const PayoutInstructionResponseStatusEnum: {
+    readonly Created: "CREATED";
+    readonly Processing: "PROCESSING";
+    readonly Executed: "EXECUTED";
+    readonly Cancelled: "CANCELLED";
+    readonly Failed: "FAILED";
+};
+export declare type PayoutInstructionResponseStatusEnum = typeof PayoutInstructionResponseStatusEnum[keyof typeof PayoutInstructionResponseStatusEnum];
 /**
  *
  * @export
@@ -4479,6 +4555,14 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+     */
+    createPayoutInstruction: (createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -4608,6 +4692,14 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+     */
+    createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PayoutInstructionResponse>>;
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -4737,6 +4829,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+     */
+    createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: any): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -4870,6 +4970,15 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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
+     */
+    createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PayoutInstructionResponse>;
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -5018,6 +5127,15 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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
+     */
+    createPayoutInstruction(createPayoutInstructionRequest: CreatePayoutInstructionRequest, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayoutInstructionResponse>>;
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient

package/dist/api.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.RecipientAccountAccountTypeEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderSenderTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreateMandateSenderSenderTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
+exports.PublicApi = exports.PublicApiFactory = exports.PublicApiFp = exports.PublicApiAxiosParamCreator = exports.LoginIdentityApi = exports.LoginIdentityApiFactory = exports.LoginIdentityApiFp = exports.LoginIdentityApiAxiosParamCreator = exports.LinkApi = exports.LinkApiFactory = exports.LinkApiFp = exports.LinkApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.SubmitAuthChecklistResponseMandateStatusEnum = exports.SenderDetailDetailsTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.RecipientAccountAccountTypeEnum = exports.PayoutInstructionResponseStatusEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderSenderTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreateMandateSenderSenderTypeEnum = exports.CreateMandateResponseStatusEnum = exports.BadRequestModelV2ErrorTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = exports.AccountTypeSubtypeEnum = exports.AccountTypeTypeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -204,6 +204,13 @@ exports.PaymentScheduleFrequencyEnum = {
     Quarterly: 'QUARTERLY',
     Yearly: 'YEARLY',
 };
+exports.PayoutInstructionResponseStatusEnum = {
+    Created: 'CREATED',
+    Processing: 'PROCESSING',
+    Executed: 'EXECUTED',
+    Cancelled: 'CANCELLED',
+    Failed: 'FAILED',
+};
 exports.RecipientAccountAccountTypeEnum = {
     ExternalAccount: 'EXTERNAL_ACCOUNT',
 };
@@ -340,6 +347,42 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Create new Payout instruction
+         * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+         */
+        createPayoutInstruction: (createPayoutInstructionRequest, idempotencyKey, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'createPayoutInstructionRequest' is not null or undefined
+            common_1.assertParamExists('createPayoutInstruction', 'createPayoutInstructionRequest', createPayoutInstructionRequest);
+            const localVarPath = `/payout_instruction`;
+            // 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);
+            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 : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = common_1.serializeDataIfNeeded(createPayoutInstructionRequest, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Create Recipients
          * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -829,6 +872,19 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Create new Payout instruction
+         * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+         */
+        createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Create Recipients
          * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -1043,6 +1099,18 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
                 .createPaymentInstruction(paymentInstruction, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Create new Payout instruction
+         * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+         * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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}
+         */
+        createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
+            return localVarFp
+                .createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Create Recipients
          * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
@@ -1226,6 +1294,19 @@ class CustomerApi extends base_1.BaseAPI {
             .createPaymentInstruction(paymentInstruction, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Create new Payout instruction
+     * @param {CreatePayoutInstructionRequest} createPayoutInstructionRequest request body for creating payout instruction
+     * @param {string} [idempotencyKey] A random key provided by the customer, per unique payout. 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
+     */
+    createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .createPayoutInstruction(createPayoutInstructionRequest, idempotencyKey, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Create Recipients
      * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient

package/package.json

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