@finverse/sdk-typescript 0.0.47 → 0.0.48

package/dist/api.d.ts

@@ -244,6 +244,85 @@ export interface AllProductStatus {
      */
     income_estimation?: ProductStatus;
 }
+/**
+ *
+ * @export
+ * @interface AuthChecklistFactor
+ */
+export interface AuthChecklistFactor {
+    /**
+     * Type of authorization factor
+     * @type {string}
+     * @memberof AuthChecklistFactor
+     */
+    type: AuthChecklistFactorTypeEnum;
+    /**
+     * Allows grouping similar checklist item types together
+     * @type {string}
+     * @memberof AuthChecklistFactor
+     */
+    group_id: string;
+    /**
+     * Indicates whether authorization factor is known to be required at this time.  Possible values are YES, NO, OPTIONAL
+     * @type {string}
+     * @memberof AuthChecklistFactor
+     */
+    required: AuthChecklistFactorRequiredEnum;
+    /**
+     * Array of the options accepted for a specific authorization factor
+     * @type {Array<AuthChecklistOptions>}
+     * @memberof AuthChecklistFactor
+     */
+    options: Array<AuthChecklistOptions>;
+}
+export declare const AuthChecklistFactorTypeEnum: {
+    readonly AccountIdentification: "ACCOUNT_IDENTIFICATION";
+    readonly UserIdentification: "USER_IDENTIFICATION";
+    readonly EnduserConsent: "ENDUSER_CONSENT";
+    readonly AccountholderAuthentication: "ACCOUNTHOLDER_AUTHENTICATION";
+};
+export declare type AuthChecklistFactorTypeEnum = typeof AuthChecklistFactorTypeEnum[keyof typeof AuthChecklistFactorTypeEnum];
+export declare const AuthChecklistFactorRequiredEnum: {
+    readonly Yes: "YES";
+    readonly No: "NO";
+    readonly Optional: "OPTIONAL";
+};
+export declare type AuthChecklistFactorRequiredEnum = typeof AuthChecklistFactorRequiredEnum[keyof typeof AuthChecklistFactorRequiredEnum];
+/**
+ *
+ * @export
+ * @interface AuthChecklistOptions
+ */
+export interface AuthChecklistOptions {
+    /**
+     * Name of authorization factor. Possible values are INSTITUTION_CREDENTIALS_LOGIN, INSTITUTION_OAUTH_LOGIN,
+     * @type {string}
+     * @memberof AuthChecklistOptions
+     */
+    name: AuthChecklistOptionsNameEnum;
+    /**
+     * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ) for when the authorization factor was submitted to Finverse
+     * @type {string}
+     * @memberof AuthChecklistOptions
+     */
+    submitted_at: string;
+    /**
+     * Indicates who submitted the authorization factor to Finverse. Possible values are CUSTOMER_APP, FINVERSE_LINK
+     * @type {string}
+     * @memberof AuthChecklistOptions
+     */
+    submitted_by: AuthChecklistOptionsSubmittedByEnum;
+}
+export declare const AuthChecklistOptionsNameEnum: {
+    readonly CredentialsLogin: "INSTITUTION_CREDENTIALS_LOGIN";
+    readonly OauthLogin: "INSTITUTION_OAUTH_LOGIN";
+};
+export declare type AuthChecklistOptionsNameEnum = typeof AuthChecklistOptionsNameEnum[keyof typeof AuthChecklistOptionsNameEnum];
+export declare const AuthChecklistOptionsSubmittedByEnum: {
+    readonly CustomerApp: "CUSTOMER_APP";
+    readonly FinverseLink: "FINVERSE_LINK";
+};
+export declare type AuthChecklistOptionsSubmittedByEnum = typeof AuthChecklistOptionsSubmittedByEnum[keyof typeof AuthChecklistOptionsSubmittedByEnum];
 /**
  *
  * @export
@@ -908,6 +987,73 @@ export interface GetLoginIdentityHistoryResponse {
      */
     status_history?: Array<LoginIdentityStatusDetails>;
 }
+/**
+ *
+ * @export
+ * @interface GetMandateAuthResponse
+ */
+export interface GetMandateAuthResponse {
+    /**
+     * Finverse Mandate ID
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    mandate_id: string;
+    /**
+     * Mandate status
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    mandate_status: GetMandateAuthResponseMandateStatusEnum;
+    /**
+     * Merchant account ID assigned by Finverse
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    recipient_account_id: string;
+    /**
+     * Finverse Institution ID. Only returned if institution_id was included in the request.
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    institution_id: string;
+    /**
+     * Type of account held by the Sender at the Institution. Possible values are PERSONAL, BUSINESS
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    sender_type: GetMandateAuthResponseSenderTypeEnum;
+    /**
+     * Checklist of the authorization factors needed to complete Mandate authorization
+     * @type {Array<AuthChecklistFactor>}
+     * @memberof GetMandateAuthResponse
+     */
+    auth_checklist: Array<AuthChecklistFactor>;
+    /**
+     *
+     * @type {MandateAuthEncryptionInfo}
+     * @memberof GetMandateAuthResponse
+     */
+    encryption_info: MandateAuthEncryptionInfo;
+    /**
+     * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
+     * @type {string}
+     * @memberof GetMandateAuthResponse
+     */
+    last_update: string;
+}
+export declare const GetMandateAuthResponseMandateStatusEnum: {
+    readonly Created: "CREATED";
+    readonly Processing: "PROCESSING";
+    readonly Submitted: "SUBMITTED";
+    readonly Error: "ERROR";
+};
+export declare type GetMandateAuthResponseMandateStatusEnum = typeof GetMandateAuthResponseMandateStatusEnum[keyof typeof GetMandateAuthResponseMandateStatusEnum];
+export declare const GetMandateAuthResponseSenderTypeEnum: {
+    readonly Personal: "PERSONAL";
+    readonly Business: "BUSINESS";
+};
+export declare type GetMandateAuthResponseSenderTypeEnum = typeof GetMandateAuthResponseSenderTypeEnum[keyof typeof GetMandateAuthResponseSenderTypeEnum];
 /**
  *
  * @export
@@ -953,7 +1099,7 @@ export interface GetMandateResponse {
 }
 export declare const GetMandateResponseMandateStatusEnum: {
     readonly Created: "CREATED";
-    readonly Used: "USED";
+    readonly Processing: "PROCESSING";
     readonly Submitted: "SUBMITTED";
     readonly Error: "ERROR";
 };
@@ -2314,6 +2460,25 @@ export interface LoginMethod {
      */
     login_fields?: Array<LoginField>;
 }
+/**
+ *
+ * @export
+ * @interface MandateAuthEncryptionInfo
+ */
+export interface MandateAuthEncryptionInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof MandateAuthEncryptionInfo
+     */
+    jwks_url: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MandateAuthEncryptionInfo
+     */
+    key_id: string;
+}
 /**
  *
  * @export
@@ -3151,6 +3316,15 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getMandate: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuth: (mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3246,6 +3420,15 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthResponse>>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3341,6 +3524,15 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getMandate(mandateId: string, options?: any): AxiosPromise<GetMandateResponse>;
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: any): AxiosPromise<GetMandateAuthResponse>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3445,6 +3637,16 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getMandate(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthResponse>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id
@@ -3554,6 +3756,16 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthResponse>>;
     /**
      * Get Payment details by payment_id
      * @param {string} paymentId payment id

package/dist/api.js

@@ -22,13 +22,32 @@ 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.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = 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.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;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
 const common_1 = require("./common");
 // @ts-ignore
 const base_1 = require("./base");
+exports.AuthChecklistFactorTypeEnum = {
+    AccountIdentification: 'ACCOUNT_IDENTIFICATION',
+    UserIdentification: 'USER_IDENTIFICATION',
+    EnduserConsent: 'ENDUSER_CONSENT',
+    AccountholderAuthentication: 'ACCOUNTHOLDER_AUTHENTICATION',
+};
+exports.AuthChecklistFactorRequiredEnum = {
+    Yes: 'YES',
+    No: 'NO',
+    Optional: 'OPTIONAL',
+};
+exports.AuthChecklistOptionsNameEnum = {
+    CredentialsLogin: 'INSTITUTION_CREDENTIALS_LOGIN',
+    OauthLogin: 'INSTITUTION_OAUTH_LOGIN',
+};
+exports.AuthChecklistOptionsSubmittedByEnum = {
+    CustomerApp: 'CUSTOMER_APP',
+    FinverseLink: 'FINVERSE_LINK',
+};
 exports.CreatePaymentRequestTypeEnum = {
     Mandate: 'MANDATE',
     Single: 'SINGLE',
@@ -36,9 +55,19 @@ exports.CreatePaymentRequestTypeEnum = {
 exports.CustomerPaymentInstructionTypeEnum = {
     DebitAuthorization: 'DEBIT_AUTHORIZATION',
 };
+exports.GetMandateAuthResponseMandateStatusEnum = {
+    Created: 'CREATED',
+    Processing: 'PROCESSING',
+    Submitted: 'SUBMITTED',
+    Error: 'ERROR',
+};
+exports.GetMandateAuthResponseSenderTypeEnum = {
+    Personal: 'PERSONAL',
+    Business: 'BUSINESS',
+};
 exports.GetMandateResponseMandateStatusEnum = {
     Created: 'CREATED',
-    Used: 'USED',
+    Processing: 'PROCESSING',
     Submitted: 'SUBMITTED',
     Error: 'ERROR',
 };
@@ -345,6 +374,46 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get Mandate Authorization by mandate id
+         * @param {string} mandateId Finverse Mandate ID
+         * @param {string} institutionId Finverse Institution ID
+         * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuth: (mandateId, institutionId, senderType, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'mandateId' is not null or undefined
+            common_1.assertParamExists('getMandateAuth', 'mandateId', mandateId);
+            // verify required parameter 'institutionId' is not null or undefined
+            common_1.assertParamExists('getMandateAuth', 'institutionId', institutionId);
+            const localVarPath = `/mandates/{mandateId}/auth`.replace(`{${'mandateId'}}`, encodeURIComponent(String(mandateId)));
+            // 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);
+            if (institutionId !== undefined) {
+                localVarQueryParameter['institution_id'] = institutionId;
+            }
+            if (senderType !== undefined) {
+                localVarQueryParameter['sender_type'] = senderType;
+            }
+            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 Payment details by payment_id
          * @param {string} paymentId payment id
@@ -587,6 +656,20 @@ exports.CustomerApiFp = function (configuration) {
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Get Mandate Authorization by mandate id
+         * @param {string} mandateId Finverse Mandate ID
+         * @param {string} institutionId Finverse Institution ID
+         * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuth(mandateId, institutionId, senderType, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuth(mandateId, institutionId, senderType, 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
@@ -727,6 +810,19 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
         getMandate(mandateId, options) {
             return localVarFp.getMandate(mandateId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Mandate Authorization by mandate id
+         * @param {string} mandateId Finverse Mandate ID
+         * @param {string} institutionId Finverse Institution ID
+         * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getMandateAuth(mandateId, institutionId, senderType, options) {
+            return localVarFp
+                .getMandateAuth(mandateId, institutionId, senderType, options)
+                .then((request) => request(axios, basePath));
+        },
         /**
          * Get Payment details by payment_id
          * @param {string} paymentId payment id
@@ -877,6 +973,20 @@ class CustomerApi extends base_1.BaseAPI {
             .getMandate(mandateId, options)
             .then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get Mandate Authorization by mandate id
+     * @param {string} mandateId Finverse Mandate ID
+     * @param {string} institutionId Finverse Institution ID
+     * @param {'PERSONAL' | 'BUSINESS'} [senderType] Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getMandateAuth(mandateId, institutionId, senderType, options) {
+        return exports.CustomerApiFp(this.configuration)
+            .getMandateAuth(mandateId, institutionId, senderType, 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.47",
+  "version": "0.0.48",
   "description": "OpenAPI client for @finverse/sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [