@finverse/sdk-typescript 0.0.142 → 0.0.144

package/dist/api.d.ts

@@ -968,19 +968,6 @@ 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
@@ -4053,6 +4040,133 @@ export interface PaymentLinkRecipientAccount {
      */
     recipient_account_id: string;
 }
+/**
+ *
+ * @export
+ * @interface PaymentLinkResponse
+ */
+export interface PaymentLinkResponse {
+    /**
+     * Finverse Payment Link ID
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    payment_link_id?: string;
+    /**
+     * The amount of the payment. Expressed in currency\'s smallest unit or “minor unit”, as defined in ISO 4217.
+     * @type {number}
+     * @memberof PaymentLinkResponse
+     */
+    amount?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    currency?: string;
+    /**
+     * Specifies language to be used in Finverse UI
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    language?: string;
+    /**
+     * The payment link mode
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    mode?: PaymentLinkResponseModeEnum;
+    /**
+     *
+     * @type {PaymentLinkDetails}
+     * @memberof PaymentLinkResponse
+     */
+    payment_details?: PaymentLinkDetails;
+    /**
+     * Unique reference id to identifying the payment to be collected.
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    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 PaymentLinkResponse
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The URL for payment link
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    url?: string;
+    /**
+     * The status of payment link
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    status?: PaymentLinkResponseStatusEnum;
+    /**
+     * Timestamp of when the payment link was or will expired in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    expires_at?: string;
+    /**
+     * Timestamp of when the payment link was created in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    created_at?: string;
+    /**
+     * Timestamp of when the payment link was last updated in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
+     * @type {string}
+     * @memberof PaymentLinkResponse
+     */
+    updated_at?: string;
+    /**
+     *
+     * @type {GetMandateResponse}
+     * @memberof PaymentLinkResponse
+     */
+    mandate?: GetMandateResponse;
+    /**
+     *
+     * @type {PaymentResponse}
+     * @memberof PaymentLinkResponse
+     */
+    payment?: PaymentResponse;
+    /**
+     *
+     * @type {MandateRecipient}
+     * @memberof PaymentLinkResponse
+     */
+    recipient?: MandateRecipient;
+    /**
+     *
+     * @type {MandateRecipientAccount}
+     * @memberof PaymentLinkResponse
+     */
+    recipient_account?: MandateRecipientAccount;
+    /**
+     *
+     * @type {PaymentLinkSenderResponse}
+     * @memberof PaymentLinkResponse
+     */
+    sender?: PaymentLinkSenderResponse;
+}
+export declare const PaymentLinkResponseModeEnum: {
+    readonly Payment: "PAYMENT";
+};
+export declare type PaymentLinkResponseModeEnum = (typeof PaymentLinkResponseModeEnum)[keyof typeof PaymentLinkResponseModeEnum];
+export declare const PaymentLinkResponseStatusEnum: {
+    readonly Created: "CREATED";
+    readonly Paid: "PAID";
+    readonly Expired: "EXPIRED";
+};
+export declare type PaymentLinkResponseStatusEnum = (typeof PaymentLinkResponseStatusEnum)[keyof typeof PaymentLinkResponseStatusEnum];
 /**
  *
  * @export
@@ -4078,6 +4192,37 @@ export interface PaymentLinkSender {
      */
     name: string;
 }
+/**
+ *
+ * @export
+ * @interface PaymentLinkSenderResponse
+ */
+export interface PaymentLinkSenderResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PaymentLinkSenderResponse
+     */
+    email?: string;
+    /**
+     * Customer App\'s user ID, representing the end-user making the payment.
+     * @type {string}
+     * @memberof PaymentLinkSenderResponse
+     */
+    external_user_id?: string;
+    /**
+     * Accountholder name of the sender\'s account
+     * @type {string}
+     * @memberof PaymentLinkSenderResponse
+     */
+    name?: string;
+    /**
+     * A unique identifier generated after creating sender
+     * @type {string}
+     * @memberof PaymentLinkSenderResponse
+     */
+    user_id?: string;
+}
 /**
  *
  * @export
@@ -6038,6 +6183,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     createPaymentLinkMandate: (createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentLink: (paymentLinkId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get sender payment user for mandate
      * @param {*} [options] Override http request option.
@@ -6113,7 +6265,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentLinkResponse>>;
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentLinkResponse>>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6127,6 +6279,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentLinkMandateResponse>>;
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentLinkResponse>>;
     /**
      * Get sender payment user for mandate
      * @param {*} [options] Override http request option.
@@ -6202,7 +6361,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: any): AxiosPromise<CreatePaymentLinkResponse>;
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: any): AxiosPromise<PaymentLinkResponse>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6216,6 +6375,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: any): AxiosPromise<CreatePaymentLinkMandateResponse>;
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentLink(paymentLinkId: string, options?: any): AxiosPromise<PaymentLinkResponse>;
     /**
      * Get sender payment user for mandate
      * @param {*} [options] Override http request option.
@@ -6296,7 +6462,7 @@ export interface DefaultApiInterface {
      * @throws {RequiredError}
      * @memberof DefaultApiInterface
      */
-    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentLinkResponse>;
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): AxiosPromise<PaymentLinkResponse>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6312,6 +6478,14 @@ export interface DefaultApiInterface {
      * @memberof DefaultApiInterface
      */
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentLinkMandateResponse>;
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApiInterface
+     */
+    getPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): AxiosPromise<PaymentLinkResponse>;
     /**
      * Get sender payment user for mandate
      * @param {*} [options] Override http request option.
@@ -6397,7 +6571,7 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentLinkResponse>>;
+    createPaymentLink(createPaymentLinkRequest: CreatePaymentLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkResponse>>;
     /**
      * Initiate Card Payment for a Payment Link
      * @param {*} [options] Override http request option.
@@ -6413,6 +6587,14 @@ export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
      * @memberof DefaultApi
      */
     createPaymentLinkMandate(createPaymentLinkMandateRequest: CreatePaymentLinkMandateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentLinkMandateResponse>>;
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getPaymentLink(paymentLinkId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentLinkResponse>>;
     /**
      * Get sender payment user for mandate
      * @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.CreatePaymentLinkRequestModeEnum = 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.PaymentLinkResponseStatusEnum = exports.PaymentLinkResponseModeEnum = 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
@@ -209,6 +209,14 @@ exports.PaymentInfoPaymentsSupportedEnum = {
 exports.PaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
+exports.PaymentLinkResponseModeEnum = {
+    Payment: 'PAYMENT',
+};
+exports.PaymentLinkResponseStatusEnum = {
+    Created: 'CREATED',
+    Paid: 'PAID',
+    Expired: 'EXPIRED',
+};
 exports.PaymentLinkTokenResponseTokenTypeEnum = {
     Bearer: 'Bearer',
 };
@@ -1754,6 +1762,36 @@ exports.DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get payment link
+         * @param {string} paymentLinkId The payment link id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentLink: (paymentLinkId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'paymentLinkId' is not null or undefined
+            common_1.assertParamExists('getPaymentLink', 'paymentLinkId', paymentLinkId);
+            const localVarPath = `/payment_links/{paymentLinkId}`.replace(`{${'paymentLinkId'}}`, encodeURIComponent(String(paymentLinkId)));
+            // 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 sender payment user for mandate
          * @param {*} [options] Override http request option.
@@ -2025,6 +2063,18 @@ exports.DefaultApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get payment link
+         * @param {string} paymentLinkId The payment link id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentLink(paymentLinkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentLink(paymentLinkId, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get sender payment user for mandate
          * @param {*} [options] Override http request option.
@@ -2155,6 +2205,15 @@ exports.DefaultApiFactory = function (configuration, basePath, axios) {
                 .createPaymentLinkMandate(createPaymentLinkMandateRequest, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Get payment link
+         * @param {string} paymentLinkId The payment link id
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPaymentLink(paymentLinkId, options) {
+            return localVarFp.getPaymentLink(paymentLinkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get sender payment user for mandate
          * @param {*} [options] Override http request option.
@@ -2291,6 +2350,18 @@ class DefaultApi extends base_1.BaseAPI {
             .createPaymentLinkMandate(createPaymentLinkMandateRequest, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get payment link
+     * @param {string} paymentLinkId The payment link id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    getPaymentLink(paymentLinkId, options) {
+        return exports.DefaultApiFp(this.configuration)
+            .getPaymentLink(paymentLinkId, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get sender payment user for mandate
      * @param {*} [options] Override http request option.

package/package.json

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