@finverse/sdk-typescript 0.0.140 → 0.0.141

package/dist/api.d.ts

@@ -901,6 +901,86 @@ export interface CreatePaymentLinkMandateResponse {
      */
     mandate_link_token: PaymentLinkTokenResponse;
 }
+/**
+ *
+ * @export
+ * @interface CreatePaymentLinkRequest
+ */
+export interface CreatePaymentLinkRequest {
+    /**
+     * The amount of the payment. Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
+     * @type {number}
+     * @memberof CreatePaymentLinkRequest
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePaymentLinkRequest
+     */
+    currency: string;
+    /**
+     * Specifies language to be used in Finverse UI
+     * @type {string}
+     * @memberof CreatePaymentLinkRequest
+     */
+    language?: string;
+    /**
+     * The payment link mode
+     * @type {string}
+     * @memberof CreatePaymentLinkRequest
+     */
+    mode: CreatePaymentLinkRequestModeEnum;
+    /**
+     *
+     * @type {PaymentLinkDetails}
+     * @memberof CreatePaymentLinkRequest
+     */
+    payment_details: PaymentLinkDetails;
+    /**
+     *
+     * @type {PaymentLinkRecipientAccount}
+     * @memberof CreatePaymentLinkRequest
+     */
+    recipient_account: PaymentLinkRecipientAccount;
+    /**
+     *
+     * @type {PaymentLinkSender}
+     * @memberof CreatePaymentLinkRequest
+     */
+    sender: PaymentLinkSender;
+    /**
+     * Unique reference id to identifying the payment to be collected.
+     * @type {string}
+     * @memberof CreatePaymentLinkRequest
+     */
+    unique_reference_id: string;
+    /**
+     * Additional attributes of the payment link in key:value format (e.g. payment_id: 1234). It supports up to 10 key:value pairs, whereas the key and value supports up to 50 and 500 characters respectively.
+     * @type {{ [key: string]: string; }}
+     * @memberof CreatePaymentLinkRequest
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+}
+export declare const CreatePaymentLinkRequestModeEnum: {
+    readonly Payment: "PAYMENT";
+};
+export declare type CreatePaymentLinkRequestModeEnum = (typeof CreatePaymentLinkRequestModeEnum)[keyof typeof CreatePaymentLinkRequestModeEnum];
+/**
+ *
+ * @export
+ * @interface CreatePaymentLinkResponse
+ */
+export interface CreatePaymentLinkResponse {
+    /**
+     * The URL for payment link
+     * @type {string}
+     * @memberof CreatePaymentLinkResponse
+     */
+    payment_link_url: string;
+}
 /**
  *
  * @export
@@ -3941,6 +4021,63 @@ export declare const PaymentInstructionTypeEnum: {
     readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
 };
 export declare type PaymentInstructionTypeEnum = (typeof PaymentInstructionTypeEnum)[keyof typeof PaymentInstructionTypeEnum];
+/**
+ *
+ * @export
+ * @interface PaymentLinkDetails
+ */
+export interface PaymentLinkDetails {
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentLinkDetails
+     */
+    description?: string;
+    /**
+     * For external invoice reference
+     * @type {string}
+     * @memberof PaymentLinkDetails
+     */
+    external_invoice_id?: string;
+}
+/**
+ *
+ * @export
+ * @interface PaymentLinkRecipientAccount
+ */
+export interface PaymentLinkRecipientAccount {
+    /**
+     * Merchant account ID assigned by Finverse
+     * @type {string}
+     * @memberof PaymentLinkRecipientAccount
+     */
+    recipient_account_id: string;
+}
+/**
+ *
+ * @export
+ * @interface PaymentLinkSender
+ */
+export interface PaymentLinkSender {
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentLinkSender
+     */
+    email?: string;
+    /**
+     * Customer App\'s user ID, representing the end-user making the payment.
+     * @type {string}
+     * @memberof PaymentLinkSender
+     */
+    external_user_id: string;
+    /**
+     * Accountholder name of the sender\'s account
+     * @type {string}
+     * @memberof PaymentLinkSender
+     */
+    name: string;
+}
 /**
  *
  * @export
@@ -5881,6 +6018,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     createFpsToken: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentLink: (createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -5963,6 +6107,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createFpsToken(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFpsTokenResponse>>;
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentLinkResponse>>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6045,6 +6196,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     createFpsToken(options?: any): AxiosPromise<CreateFpsTokenResponse>;
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: any): AxiosPromise<CreatePaymentLinkResponse>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6131,6 +6289,14 @@ export interface DefaultApiInterface {
      * @memberof DefaultApiInterface
      */
     createFpsToken(options?: AxiosRequestConfig): AxiosPromise<CreateFpsTokenResponse>;
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentLinkResponse>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6224,6 +6390,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @memberof DefaultApi
      */
     createFpsToken(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFpsTokenResponse>>;
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentLinkResponse>>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.

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.RecipientAccountResponseAccountTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.PayoutInstructionResponseStatusEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateSenderAccountAccountTypeEnum = exports.MandateRecipientAccountAccountTypeEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderUserTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelV2TypeEnum = exports.FvErrorModelTypeEnum = exports.FeePaidByEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreatePaymentLinkMandateRequestSenderTypeEnum = exports.CreateMandateSenderUserTypeEnum = 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.RecipientAccountResponseAccountTypeEnum = exports.RecipientAccountNumberTypeEnum = exports.PayoutInstructionResponseStatusEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentResponseStatusEnum = exports.PaymentResponseTypeEnum = exports.PaymentLinkTokenResponseTokenTypeEnum = exports.PaymentInstructionTypeEnum = exports.PaymentInfoPaymentsSupportedEnum = exports.MandateSenderAccountAccountTypeEnum = exports.MandateRecipientAccountAccountTypeEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LoginMethodStatusEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.InstitutionStatusEnum = exports.InstitutionUserTypeEnum = exports.InstitutionProductsSupportedEnum = exports.InstitutionInstitutionTypeEnum = exports.InstitutionTagsEnum = exports.GetMandateSenderUserTypeEnum = exports.GetMandateResponseStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.GetBalanceHistoryResponseSourceEnum = exports.FvErrorModelV2TypeEnum = exports.FvErrorModelTypeEnum = exports.FeePaidByEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreateRecipientAccountAccountTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreatePaymentLinkRequestModeEnum = exports.CreatePaymentLinkMandateRequestSenderTypeEnum = exports.CreateMandateSenderUserTypeEnum = 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
@@ -92,6 +92,9 @@ exports.CreatePaymentLinkMandateRequestSenderTypeEnum = {
     Individual: 'INDIVIDUAL',
     Business: 'BUSINESS',
 };
+exports.CreatePaymentLinkRequestModeEnum = {
+    Payment: 'PAYMENT',
+};
 exports.CreatePaymentRequestTypeEnum = {
     Mandate: 'MANDATE',
     Single: 'SINGLE',
@@ -1660,6 +1663,38 @@ exports.DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Create payment link
+         * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentLink: (createPaymentLinkRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'createPaymentLinkRequest' is not null or undefined
+            common_1.assertParamExists('createPaymentLink', 'createPaymentLinkRequest', createPaymentLinkRequest);
+            const localVarPath = `/payment_links`;
+            // 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(createPaymentLinkRequest, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Initiate Card Payment for a Payment Link
          * @param {*} [options] Override http request option.
@@ -1955,6 +1990,18 @@ exports.DefaultApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Create payment link
+         * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentLink(createPaymentLinkRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.createPaymentLink(createPaymentLinkRequest, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Initiate Card Payment for a Payment Link
          * @param {*} [options] Override http request option.
@@ -2078,6 +2125,17 @@ exports.DefaultApiFactory = function (configuration, basePath, axios) {
         createFpsToken(options) {
             return localVarFp.createFpsToken(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Create payment link
+         * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createPaymentLink(createPaymentLinkRequest, options) {
+            return localVarFp
+                .createPaymentLink(createPaymentLinkRequest, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Initiate Card Payment for a Payment Link
          * @param {*} [options] Override http request option.
@@ -2198,6 +2256,18 @@ class DefaultApi extends base_1.BaseAPI {
             .createFpsToken(options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Create payment link
+     * @param {CreatePaymentLinkRequest} createPaymentLinkRequest Parameters required to create a payment link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    createPaymentLink(createPaymentLinkRequest, options) {
+        return exports.DefaultApiFp(this.configuration)
+            .createPaymentLink(createPaymentLinkRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.

package/package.json

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