@finverse/sdk-typescript 0.0.48 → 0.0.49

package/dist/api.d.ts

@@ -987,6 +987,60 @@ export interface GetLoginIdentityHistoryResponse {
      */
     status_history?: Array<LoginIdentityStatusDetails>;
 }
+/**
+ *
+ * @export
+ * @interface GetMandateAuthLinkRequest
+ */
+export interface GetMandateAuthLinkRequest {
+    /**
+     * Mandate ID
+     * @type {string}
+     * @memberof GetMandateAuthLinkRequest
+     */
+    mandate_id: string;
+    /**
+     *
+     * @type {MandateAuthLinkCustomizations}
+     * @memberof GetMandateAuthLinkRequest
+     */
+    link_customizations: MandateAuthLinkCustomizations;
+}
+/**
+ *
+ * @export
+ * @interface GetMandateAuthLinkResponse
+ */
+export interface GetMandateAuthLinkResponse {
+    /**
+     * Short-lived access-token to interact with Finverse Link
+     * @type {string}
+     * @memberof GetMandateAuthLinkResponse
+     */
+    access_token: string;
+    /**
+     * Access token validity duration (in seconds)
+     * @type {number}
+     * @memberof GetMandateAuthLinkResponse
+     */
+    expires_in: number;
+    /**
+     * URL to launch Finverse Link to authorize the mandate
+     * @type {string}
+     * @memberof GetMandateAuthLinkResponse
+     */
+    link_url: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetMandateAuthLinkResponse
+     */
+    token_type: GetMandateAuthLinkResponseTokenTypeEnum;
+}
+export declare const GetMandateAuthLinkResponseTokenTypeEnum: {
+    readonly Bearer: "Bearer";
+};
+export declare type GetMandateAuthLinkResponseTokenTypeEnum = typeof GetMandateAuthLinkResponseTokenTypeEnum[keyof typeof GetMandateAuthLinkResponseTokenTypeEnum];
 /**
  *
  * @export
@@ -2479,6 +2533,68 @@ export interface MandateAuthEncryptionInfo {
      */
     key_id: string;
 }
+/**
+ *
+ * @export
+ * @interface MandateAuthLinkCustomizations
+ */
+export interface MandateAuthLinkCustomizations {
+    /**
+     * institution\'s country filter
+     * @type {Array<string>}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    countries?: Array<string>;
+    /**
+     * Institution to preselect
+     * @type {string}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    institution_id?: string;
+    /**
+     * institution\'s status filter
+     * @type {string}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    institution_status?: string;
+    /**
+     * ISO639-1 language code. Language to display when user open the link, default to English (en) if not specified
+     * @type {string}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    language?: string;
+    /**
+     * Space separated list of the tags of the institutions to view.
+     * @type {string}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    link_mode?: string;
+    /**
+     * institution\'s supported product filter
+     * @type {Array<string>}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    products_supported?: Array<string>;
+    /**
+     * The UI mode link is intended to be used in - \"iframe\" (default), \"auto_redirect\" or \"redirect\" or \"standalone\"
+     * @type {string}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    ui_mode?: MandateAuthLinkCustomizationsUiModeEnum;
+    /**
+     * institution\'s supported user_type filter
+     * @type {Array<string>}
+     * @memberof MandateAuthLinkCustomizations
+     */
+    user_type?: Array<string>;
+}
+export declare const MandateAuthLinkCustomizationsUiModeEnum: {
+    readonly Iframe: "iframe";
+    readonly Redirect: "redirect";
+    readonly AutoRedirect: "auto_redirect";
+    readonly Standalone: "standalone";
+};
+export declare type MandateAuthLinkCustomizationsUiModeEnum = typeof MandateAuthLinkCustomizationsUiModeEnum[keyof typeof MandateAuthLinkCustomizationsUiModeEnum];
 /**
  *
  * @export
@@ -3325,6 +3441,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getMandateAuth: (mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuthLink: (getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3429,6 +3552,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthResponse>>;
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthLinkResponse>>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3533,6 +3663,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: any): AxiosPromise<GetMandateAuthResponse>;
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: any): AxiosPromise<GetMandateAuthLinkResponse>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3647,6 +3784,14 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthResponse>;
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthLinkResponse>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3766,6 +3911,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthResponse>>;
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthLinkResponse>>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id

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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentInstructionTypeEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.GetPaymentResponseStatusEnum = exports.GetPaymentResponseTypeEnum = exports.GetMandateResponseMandateStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = 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.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiAxiosParamCreator = exports.TransactionLimitsPeriodEnum = exports.PaymentScheduleFrequencyEnum = exports.PaymentInstructionTypeEnum = exports.MandateAuthLinkCustomizationsUiModeEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.GetPaymentResponseStatusEnum = exports.GetPaymentResponseTypeEnum = exports.GetMandateResponseMandateStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -55,6 +55,9 @@ exports.CreatePaymentRequestTypeEnum = {
 exports.CustomerPaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
+exports.GetMandateAuthLinkResponseTokenTypeEnum = {
+    Bearer: 'Bearer',
+};
 exports.GetMandateAuthResponseMandateStatusEnum = {
     Created: 'CREATED',
     Processing: 'PROCESSING',
@@ -95,6 +98,12 @@ exports.LinkTokenRequestAutomaticDataRefreshEnum = {
     Off: 'OFF',
     ForcedOn: 'FORCED_ON',
 };
+exports.MandateAuthLinkCustomizationsUiModeEnum = {
+    Iframe: 'iframe',
+    Redirect: 'redirect',
+    AutoRedirect: 'auto_redirect',
+    Standalone: 'standalone',
+};
 exports.PaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
@@ -414,6 +423,38 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get link to launch FV Link UI in mandate authorization mode
+         * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuthLink: (getMandateAuthLinkRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'getMandateAuthLinkRequest' is not null or undefined
+            common_1.assertParamExists('getMandateAuthLink', 'getMandateAuthLinkRequest', getMandateAuthLinkRequest);
+            const localVarPath = `/mandates/link`;
+            // 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(getMandateAuthLinkRequest, localVarRequestOptions, configuration);
+            return {
+                url: common_1.toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Get Payment details by payment_id
          * @param {string} paymentId payment id
@@ -670,6 +711,18 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get link to launch FV Link UI in mandate authorization mode
+         * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuthLink(getMandateAuthLinkRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuthLink(getMandateAuthLinkRequest, options);
+                return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
+            });
+        },
         /**
          * Get Payment details by payment_id
          * @param {string} paymentId payment id
@@ -823,6 +876,17 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
                 .getMandateAuth(mandateId, institutionId, senderType, options)
                 .then((request) => request(axios, basePath));
         },
+        /**
+         * Get link to launch FV Link UI in mandate authorization mode
+         * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuthLink(getMandateAuthLinkRequest, options) {
+            return localVarFp
+                .getMandateAuthLink(getMandateAuthLinkRequest, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Get Payment details by payment_id
          * @param {string} paymentId payment id
@@ -987,6 +1051,18 @@ class CustomerApi extends base_1.BaseAPI {
             .getMandateAuth(mandateId, institutionId, senderType, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get link to launch FV Link UI in mandate authorization mode
+     * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getMandateAuthLink(getMandateAuthLinkRequest, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getMandateAuthLink(getMandateAuthLinkRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id

package/package.json

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