@finverse/sdk-typescript 0.0.82 → 0.0.84

package/dist/api.d.ts

@@ -815,6 +815,82 @@ export declare const CreatePaymentRequestTypeEnum: {
     readonly Single: "SINGLE";
 };
 export declare type CreatePaymentRequestTypeEnum = typeof CreatePaymentRequestTypeEnum[keyof typeof CreatePaymentRequestTypeEnum];
+/**
+ *
+ * @export
+ * @interface CreateRecipientRequest
+ */
+export interface CreateRecipientRequest {
+    /**
+     * Recipient\'s name/nickname (note: this does not need to match the actual accountholder name of the recipient\'s account)
+     * @type {string}
+     * @memberof CreateRecipientRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {RecipientAccount}
+     * @memberof CreateRecipientRequest
+     */
+    recipient_account: RecipientAccount;
+    /**
+     * Customer App\'s internal ID for the recipient
+     * @type {string}
+     * @memberof CreateRecipientRequest
+     */
+    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 {{ [key: string]: string; }}
+     * @memberof CreateRecipientRequest
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
+/**
+ *
+ * @export
+ * @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}
+     * @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;
+}
 /**
  *
  * @export
@@ -1473,12 +1549,6 @@ export interface GetMandateSender {
      * @memberof GetMandateSender
      */
     sender_reference_id?: string;
-    /**
-     * Finverse Institution ID.
-     * @type {string}
-     * @memberof GetMandateSender
-     */
-    institution_id?: string;
     /**
      *
      * @type {PaymentAccount}
@@ -3242,6 +3312,12 @@ export interface PaymentAccount {
      * @memberof PaymentAccount
      */
     raw?: string;
+    /**
+     * Finverse Institution ID. Only returned if institution_id was included in the request.
+     * @type {string}
+     * @memberof PaymentAccount
+     */
+    institution_id?: string;
 }
 /**
  *
@@ -3685,6 +3761,71 @@ export interface ProductStatus {
      */
     last_successful_update?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface RecipientAccount
+ */
+export interface RecipientAccount {
+    /**
+     * Accountholder name of the recipient\'s account
+     * @type {string}
+     * @memberof RecipientAccount
+     */
+    accountholder_name: string;
+    /**
+     *
+     * @type {RecipientAccountNumber}
+     * @memberof RecipientAccount
+     */
+    account_number?: RecipientAccountNumber;
+    /**
+     * Type of recipient account.
+     * @type {string}
+     * @memberof RecipientAccount
+     */
+    account_type: RecipientAccountAccountTypeEnum;
+    /**
+     * List of currencies supported by the recipient account
+     * @type {Array<string>}
+     * @memberof RecipientAccount
+     */
+    currencies: Array<string>;
+    /**
+     * Finverse Institution ID for the recipient’s institution.
+     * @type {string}
+     * @memberof RecipientAccount
+     */
+    institution_id: string;
+}
+export declare const RecipientAccountAccountTypeEnum: {
+    readonly ExternalAccount: "EXTERNAL_ACCOUNT";
+};
+export declare type RecipientAccountAccountTypeEnum = typeof RecipientAccountAccountTypeEnum[keyof typeof RecipientAccountAccountTypeEnum];
+/**
+ *
+ * @export
+ * @interface RecipientAccountNumber
+ */
+export interface RecipientAccountNumber {
+    /**
+     * Type of account number. Possible values: LOCAL, IBAN
+     * @type {string}
+     * @memberof RecipientAccountNumber
+     */
+    type: RecipientAccountNumberTypeEnum;
+    /**
+     * Account number value
+     * @type {string}
+     * @memberof RecipientAccountNumber
+     */
+    number: string;
+}
+export declare const RecipientAccountNumberTypeEnum: {
+    readonly Local: "LOCAL";
+    readonly Iban: "IBAN";
+};
+export declare type RecipientAccountNumberTypeEnum = typeof RecipientAccountNumberTypeEnum[keyof typeof RecipientAccountNumberTypeEnum];
 /**
  *
  * @export
@@ -4338,6 +4479,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRecipient: (createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4460,6 +4608,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRecipientResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4582,6 +4737,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRecipient(createRecipientRequest: CreateRecipientRequest, options?: any): AxiosPromise<CreateRecipientResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4708,6 +4870,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): AxiosPromise<CreateRecipientResponse>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request
@@ -4848,6 +5018,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createRecipient(createRecipientRequest: CreateRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRecipientResponse>>;
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request

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.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.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.RecipientAccountAccountTypeEnum = {
+    ExternalAccount: 'EXTERNAL_ACCOUNT',
+};
+exports.RecipientAccountNumberTypeEnum = {
+    Local: 'LOCAL',
+    Iban: 'IBAN',
+};
 exports.SenderDetailDetailsTypeEnum = {
     HkId: 'HK_ID',
     Passport: 'PASSPORT',
@@ -333,6 +340,38 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Create Recipients
+         * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createRecipient: (createRecipientRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'createRecipientRequest' is not null or undefined
+            common_1.assertParamExists('createRecipient', 'createRecipientRequest', createRecipientRequest);
+            const localVarPath = `/recipients`;
+            // 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);
+            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(createRecipientRequest, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -790,6 +829,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Create Recipients
+         * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createRecipient(createRecipientRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createRecipient(createRecipientRequest, 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
@@ -992,6 +1043,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
                 .createPaymentInstruction(paymentInstruction, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Create Recipients
+         * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createRecipient(createRecipientRequest, options) {
+            return localVarFp.createRecipient(createRecipientRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * generate a link token that can be used to create link
          * @param {LinkTokenRequest} linkTokenRequest token request
@@ -1166,6 +1226,18 @@ class CustomerApi extends base_1.BaseAPI {
             .createPaymentInstruction(paymentInstruction, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Create Recipients
+     * @param {CreateRecipientRequest} createRecipientRequest request body for creating recipient
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    createRecipient(createRecipientRequest, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .createRecipient(createRecipientRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * generate a link token that can be used to create link
      * @param {LinkTokenRequest} linkTokenRequest token request

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@finverse/sdk-typescript",
-  "version": "0.0.82",
+  "version": "0.0.84",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -22,7 +22,7 @@
   },
   "devDependencies": {
     "@types/chai": "^4.3.4",
-    "@types/mocha": "^10.0.0",
+    "@types/mocha": "^10.0.1",
     "@types/node": "^12.11.5",
     "axios-mock-adapter": "^1.21.2",
     "chai": "^4.3.7",