@finverse/sdk-typescript 0.0.47 → 0.0.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/api.d.ts +388 -1
  2. package/dist/api.js +196 -2
  3. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -244,6 +244,85 @@ export interface AllProductStatus {
244
244
  */
245
245
  income_estimation?: ProductStatus;
246
246
  }
247
+ /**
248
+ *
249
+ * @export
250
+ * @interface AuthChecklistFactor
251
+ */
252
+ export interface AuthChecklistFactor {
253
+ /**
254
+ * Type of authorization factor
255
+ * @type {string}
256
+ * @memberof AuthChecklistFactor
257
+ */
258
+ type: AuthChecklistFactorTypeEnum;
259
+ /**
260
+ * Allows grouping similar checklist item types together
261
+ * @type {string}
262
+ * @memberof AuthChecklistFactor
263
+ */
264
+ group_id: string;
265
+ /**
266
+ * Indicates whether authorization factor is known to be required at this time. Possible values are YES, NO, OPTIONAL
267
+ * @type {string}
268
+ * @memberof AuthChecklistFactor
269
+ */
270
+ required: AuthChecklistFactorRequiredEnum;
271
+ /**
272
+ * Array of the options accepted for a specific authorization factor
273
+ * @type {Array<AuthChecklistOptions>}
274
+ * @memberof AuthChecklistFactor
275
+ */
276
+ options: Array<AuthChecklistOptions>;
277
+ }
278
+ export declare const AuthChecklistFactorTypeEnum: {
279
+ readonly AccountIdentification: "ACCOUNT_IDENTIFICATION";
280
+ readonly UserIdentification: "USER_IDENTIFICATION";
281
+ readonly EnduserConsent: "ENDUSER_CONSENT";
282
+ readonly AccountholderAuthentication: "ACCOUNTHOLDER_AUTHENTICATION";
283
+ };
284
+ export declare type AuthChecklistFactorTypeEnum = typeof AuthChecklistFactorTypeEnum[keyof typeof AuthChecklistFactorTypeEnum];
285
+ export declare const AuthChecklistFactorRequiredEnum: {
286
+ readonly Yes: "YES";
287
+ readonly No: "NO";
288
+ readonly Optional: "OPTIONAL";
289
+ };
290
+ export declare type AuthChecklistFactorRequiredEnum = typeof AuthChecklistFactorRequiredEnum[keyof typeof AuthChecklistFactorRequiredEnum];
291
+ /**
292
+ *
293
+ * @export
294
+ * @interface AuthChecklistOptions
295
+ */
296
+ export interface AuthChecklistOptions {
297
+ /**
298
+ * Name of authorization factor. Possible values are INSTITUTION_CREDENTIALS_LOGIN, INSTITUTION_OAUTH_LOGIN,
299
+ * @type {string}
300
+ * @memberof AuthChecklistOptions
301
+ */
302
+ name: AuthChecklistOptionsNameEnum;
303
+ /**
304
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ) for when the authorization factor was submitted to Finverse
305
+ * @type {string}
306
+ * @memberof AuthChecklistOptions
307
+ */
308
+ submitted_at: string;
309
+ /**
310
+ * Indicates who submitted the authorization factor to Finverse. Possible values are CUSTOMER_APP, FINVERSE_LINK
311
+ * @type {string}
312
+ * @memberof AuthChecklistOptions
313
+ */
314
+ submitted_by: AuthChecklistOptionsSubmittedByEnum;
315
+ }
316
+ export declare const AuthChecklistOptionsNameEnum: {
317
+ readonly CredentialsLogin: "INSTITUTION_CREDENTIALS_LOGIN";
318
+ readonly OauthLogin: "INSTITUTION_OAUTH_LOGIN";
319
+ };
320
+ export declare type AuthChecklistOptionsNameEnum = typeof AuthChecklistOptionsNameEnum[keyof typeof AuthChecklistOptionsNameEnum];
321
+ export declare const AuthChecklistOptionsSubmittedByEnum: {
322
+ readonly CustomerApp: "CUSTOMER_APP";
323
+ readonly FinverseLink: "FINVERSE_LINK";
324
+ };
325
+ export declare type AuthChecklistOptionsSubmittedByEnum = typeof AuthChecklistOptionsSubmittedByEnum[keyof typeof AuthChecklistOptionsSubmittedByEnum];
247
326
  /**
248
327
  *
249
328
  * @export
@@ -480,7 +559,18 @@ export interface CreateMandateSender {
480
559
  * @memberof CreateMandateSender
481
560
  */
482
561
  sender_reference_id?: string;
562
+ /**
563
+ * Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
564
+ * @type {string}
565
+ * @memberof CreateMandateSender
566
+ */
567
+ sender_type?: CreateMandateSenderSenderTypeEnum;
483
568
  }
569
+ export declare const CreateMandateSenderSenderTypeEnum: {
570
+ readonly Personal: "PERSONAL";
571
+ readonly Business: "BUSINESS";
572
+ };
573
+ export declare type CreateMandateSenderSenderTypeEnum = typeof CreateMandateSenderSenderTypeEnum[keyof typeof CreateMandateSenderSenderTypeEnum];
484
574
  /**
485
575
  *
486
576
  * @export
@@ -908,6 +998,127 @@ export interface GetLoginIdentityHistoryResponse {
908
998
  */
909
999
  status_history?: Array<LoginIdentityStatusDetails>;
910
1000
  }
1001
+ /**
1002
+ *
1003
+ * @export
1004
+ * @interface GetMandateAuthLinkRequest
1005
+ */
1006
+ export interface GetMandateAuthLinkRequest {
1007
+ /**
1008
+ * Mandate ID
1009
+ * @type {string}
1010
+ * @memberof GetMandateAuthLinkRequest
1011
+ */
1012
+ mandate_id: string;
1013
+ /**
1014
+ *
1015
+ * @type {MandateAuthLinkCustomizations}
1016
+ * @memberof GetMandateAuthLinkRequest
1017
+ */
1018
+ link_customizations: MandateAuthLinkCustomizations;
1019
+ }
1020
+ /**
1021
+ *
1022
+ * @export
1023
+ * @interface GetMandateAuthLinkResponse
1024
+ */
1025
+ export interface GetMandateAuthLinkResponse {
1026
+ /**
1027
+ * Short-lived access-token to interact with Finverse Link
1028
+ * @type {string}
1029
+ * @memberof GetMandateAuthLinkResponse
1030
+ */
1031
+ access_token: string;
1032
+ /**
1033
+ * Access token validity duration (in seconds)
1034
+ * @type {number}
1035
+ * @memberof GetMandateAuthLinkResponse
1036
+ */
1037
+ expires_in: number;
1038
+ /**
1039
+ * URL to launch Finverse Link to authorize the mandate
1040
+ * @type {string}
1041
+ * @memberof GetMandateAuthLinkResponse
1042
+ */
1043
+ link_url: string;
1044
+ /**
1045
+ *
1046
+ * @type {string}
1047
+ * @memberof GetMandateAuthLinkResponse
1048
+ */
1049
+ token_type: GetMandateAuthLinkResponseTokenTypeEnum;
1050
+ }
1051
+ export declare const GetMandateAuthLinkResponseTokenTypeEnum: {
1052
+ readonly Bearer: "Bearer";
1053
+ };
1054
+ export declare type GetMandateAuthLinkResponseTokenTypeEnum = typeof GetMandateAuthLinkResponseTokenTypeEnum[keyof typeof GetMandateAuthLinkResponseTokenTypeEnum];
1055
+ /**
1056
+ *
1057
+ * @export
1058
+ * @interface GetMandateAuthResponse
1059
+ */
1060
+ export interface GetMandateAuthResponse {
1061
+ /**
1062
+ * Finverse Mandate ID
1063
+ * @type {string}
1064
+ * @memberof GetMandateAuthResponse
1065
+ */
1066
+ mandate_id: string;
1067
+ /**
1068
+ * Mandate status
1069
+ * @type {string}
1070
+ * @memberof GetMandateAuthResponse
1071
+ */
1072
+ mandate_status: GetMandateAuthResponseMandateStatusEnum;
1073
+ /**
1074
+ * Merchant account ID assigned by Finverse
1075
+ * @type {string}
1076
+ * @memberof GetMandateAuthResponse
1077
+ */
1078
+ recipient_account_id: string;
1079
+ /**
1080
+ * Finverse Institution ID. Only returned if institution_id was included in the request.
1081
+ * @type {string}
1082
+ * @memberof GetMandateAuthResponse
1083
+ */
1084
+ institution_id: string;
1085
+ /**
1086
+ * Type of account held by the Sender at the Institution. Possible values are PERSONAL, BUSINESS
1087
+ * @type {string}
1088
+ * @memberof GetMandateAuthResponse
1089
+ */
1090
+ sender_type: GetMandateAuthResponseSenderTypeEnum;
1091
+ /**
1092
+ * Checklist of the authorization factors needed to complete Mandate authorization
1093
+ * @type {Array<AuthChecklistFactor>}
1094
+ * @memberof GetMandateAuthResponse
1095
+ */
1096
+ auth_checklist: Array<AuthChecklistFactor>;
1097
+ /**
1098
+ *
1099
+ * @type {MandateAuthEncryptionInfo}
1100
+ * @memberof GetMandateAuthResponse
1101
+ */
1102
+ encryption_info: MandateAuthEncryptionInfo;
1103
+ /**
1104
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
1105
+ * @type {string}
1106
+ * @memberof GetMandateAuthResponse
1107
+ */
1108
+ last_update: string;
1109
+ }
1110
+ export declare const GetMandateAuthResponseMandateStatusEnum: {
1111
+ readonly Created: "CREATED";
1112
+ readonly Processing: "PROCESSING";
1113
+ readonly Submitted: "SUBMITTED";
1114
+ readonly Error: "ERROR";
1115
+ };
1116
+ export declare type GetMandateAuthResponseMandateStatusEnum = typeof GetMandateAuthResponseMandateStatusEnum[keyof typeof GetMandateAuthResponseMandateStatusEnum];
1117
+ export declare const GetMandateAuthResponseSenderTypeEnum: {
1118
+ readonly Personal: "PERSONAL";
1119
+ readonly Business: "BUSINESS";
1120
+ };
1121
+ export declare type GetMandateAuthResponseSenderTypeEnum = typeof GetMandateAuthResponseSenderTypeEnum[keyof typeof GetMandateAuthResponseSenderTypeEnum];
911
1122
  /**
912
1123
  *
913
1124
  * @export
@@ -953,7 +1164,7 @@ export interface GetMandateResponse {
953
1164
  }
954
1165
  export declare const GetMandateResponseMandateStatusEnum: {
955
1166
  readonly Created: "CREATED";
956
- readonly Used: "USED";
1167
+ readonly Processing: "PROCESSING";
957
1168
  readonly Submitted: "SUBMITTED";
958
1169
  readonly Error: "ERROR";
959
1170
  };
@@ -988,7 +1199,18 @@ export interface GetMandateSender {
988
1199
  * @memberof GetMandateSender
989
1200
  */
990
1201
  sender_account: PaymentAccount;
1202
+ /**
1203
+ * Type of account held by the Sender at the Institution. Required if institution.user_type is undefined. Possible values are PERSONAL, BUSINESS
1204
+ * @type {string}
1205
+ * @memberof GetMandateSender
1206
+ */
1207
+ sender_type?: GetMandateSenderSenderTypeEnum;
991
1208
  }
1209
+ export declare const GetMandateSenderSenderTypeEnum: {
1210
+ readonly Personal: "PERSONAL";
1211
+ readonly Business: "BUSINESS";
1212
+ };
1213
+ export declare type GetMandateSenderSenderTypeEnum = typeof GetMandateSenderSenderTypeEnum[keyof typeof GetMandateSenderSenderTypeEnum];
992
1214
  /**
993
1215
  *
994
1216
  * @export
@@ -2314,6 +2536,87 @@ export interface LoginMethod {
2314
2536
  */
2315
2537
  login_fields?: Array<LoginField>;
2316
2538
  }
2539
+ /**
2540
+ *
2541
+ * @export
2542
+ * @interface MandateAuthEncryptionInfo
2543
+ */
2544
+ export interface MandateAuthEncryptionInfo {
2545
+ /**
2546
+ *
2547
+ * @type {string}
2548
+ * @memberof MandateAuthEncryptionInfo
2549
+ */
2550
+ jwks_url: string;
2551
+ /**
2552
+ *
2553
+ * @type {string}
2554
+ * @memberof MandateAuthEncryptionInfo
2555
+ */
2556
+ key_id: string;
2557
+ }
2558
+ /**
2559
+ *
2560
+ * @export
2561
+ * @interface MandateAuthLinkCustomizations
2562
+ */
2563
+ export interface MandateAuthLinkCustomizations {
2564
+ /**
2565
+ * institution\'s country filter
2566
+ * @type {Array<string>}
2567
+ * @memberof MandateAuthLinkCustomizations
2568
+ */
2569
+ countries?: Array<string>;
2570
+ /**
2571
+ * Institution to preselect
2572
+ * @type {string}
2573
+ * @memberof MandateAuthLinkCustomizations
2574
+ */
2575
+ institution_id?: string;
2576
+ /**
2577
+ * institution\'s status filter
2578
+ * @type {string}
2579
+ * @memberof MandateAuthLinkCustomizations
2580
+ */
2581
+ institution_status?: string;
2582
+ /**
2583
+ * ISO639-1 language code. Language to display when user open the link, default to English (en) if not specified
2584
+ * @type {string}
2585
+ * @memberof MandateAuthLinkCustomizations
2586
+ */
2587
+ language?: string;
2588
+ /**
2589
+ * Space separated list of the tags of the institutions to view.
2590
+ * @type {string}
2591
+ * @memberof MandateAuthLinkCustomizations
2592
+ */
2593
+ link_mode?: string;
2594
+ /**
2595
+ * institution\'s supported product filter
2596
+ * @type {Array<string>}
2597
+ * @memberof MandateAuthLinkCustomizations
2598
+ */
2599
+ products_supported?: Array<string>;
2600
+ /**
2601
+ * The UI mode link is intended to be used in - \"iframe\" (default), \"auto_redirect\" or \"redirect\" or \"standalone\"
2602
+ * @type {string}
2603
+ * @memberof MandateAuthLinkCustomizations
2604
+ */
2605
+ ui_mode?: MandateAuthLinkCustomizationsUiModeEnum;
2606
+ /**
2607
+ * institution\'s supported user_type filter
2608
+ * @type {Array<string>}
2609
+ * @memberof MandateAuthLinkCustomizations
2610
+ */
2611
+ user_type?: Array<string>;
2612
+ }
2613
+ export declare const MandateAuthLinkCustomizationsUiModeEnum: {
2614
+ readonly Iframe: "iframe";
2615
+ readonly Redirect: "redirect";
2616
+ readonly AutoRedirect: "auto_redirect";
2617
+ readonly Standalone: "standalone";
2618
+ };
2619
+ export declare type MandateAuthLinkCustomizationsUiModeEnum = typeof MandateAuthLinkCustomizationsUiModeEnum[keyof typeof MandateAuthLinkCustomizationsUiModeEnum];
2317
2620
  /**
2318
2621
  *
2319
2622
  * @export
@@ -3151,6 +3454,22 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
3151
3454
  * @throws {RequiredError}
3152
3455
  */
3153
3456
  getMandate: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3457
+ /**
3458
+ * Get Mandate Authorization by mandate id
3459
+ * @param {string} mandateId Finverse Mandate ID
3460
+ * @param {string} institutionId Finverse Institution ID
3461
+ * @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
3462
+ * @param {*} [options] Override http request option.
3463
+ * @throws {RequiredError}
3464
+ */
3465
+ getMandateAuth: (mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig) => Promise<RequestArgs>;
3466
+ /**
3467
+ * Get link to launch FV Link UI in mandate authorization mode
3468
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3469
+ * @param {*} [options] Override http request option.
3470
+ * @throws {RequiredError}
3471
+ */
3472
+ getMandateAuthLink: (getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3154
3473
  /**
3155
3474
  * Get Payment details by payment_id
3156
3475
  * @param {string} paymentId payment id
@@ -3246,6 +3565,22 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3246
3565
  * @throws {RequiredError}
3247
3566
  */
3248
3567
  getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
3568
+ /**
3569
+ * Get Mandate Authorization by mandate id
3570
+ * @param {string} mandateId Finverse Mandate ID
3571
+ * @param {string} institutionId Finverse Institution ID
3572
+ * @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
3573
+ * @param {*} [options] Override http request option.
3574
+ * @throws {RequiredError}
3575
+ */
3576
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthResponse>>;
3577
+ /**
3578
+ * Get link to launch FV Link UI in mandate authorization mode
3579
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3580
+ * @param {*} [options] Override http request option.
3581
+ * @throws {RequiredError}
3582
+ */
3583
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthLinkResponse>>;
3249
3584
  /**
3250
3585
  * Get Payment details by payment_id
3251
3586
  * @param {string} paymentId payment id
@@ -3341,6 +3676,22 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3341
3676
  * @throws {RequiredError}
3342
3677
  */
3343
3678
  getMandate(mandateId: string, options?: any): AxiosPromise<GetMandateResponse>;
3679
+ /**
3680
+ * Get Mandate Authorization by mandate id
3681
+ * @param {string} mandateId Finverse Mandate ID
3682
+ * @param {string} institutionId Finverse Institution ID
3683
+ * @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
3684
+ * @param {*} [options] Override http request option.
3685
+ * @throws {RequiredError}
3686
+ */
3687
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: any): AxiosPromise<GetMandateAuthResponse>;
3688
+ /**
3689
+ * Get link to launch FV Link UI in mandate authorization mode
3690
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3691
+ * @param {*} [options] Override http request option.
3692
+ * @throws {RequiredError}
3693
+ */
3694
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: any): AxiosPromise<GetMandateAuthLinkResponse>;
3344
3695
  /**
3345
3696
  * Get Payment details by payment_id
3346
3697
  * @param {string} paymentId payment id
@@ -3445,6 +3796,24 @@ export interface CustomerApiInterface {
3445
3796
  * @memberof CustomerApiInterface
3446
3797
  */
3447
3798
  getMandate(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
3799
+ /**
3800
+ * Get Mandate Authorization by mandate id
3801
+ * @param {string} mandateId Finverse Mandate ID
3802
+ * @param {string} institutionId Finverse Institution ID
3803
+ * @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
3804
+ * @param {*} [options] Override http request option.
3805
+ * @throws {RequiredError}
3806
+ * @memberof CustomerApiInterface
3807
+ */
3808
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthResponse>;
3809
+ /**
3810
+ * Get link to launch FV Link UI in mandate authorization mode
3811
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3812
+ * @param {*} [options] Override http request option.
3813
+ * @throws {RequiredError}
3814
+ * @memberof CustomerApiInterface
3815
+ */
3816
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthLinkResponse>;
3448
3817
  /**
3449
3818
  * Get Payment details by payment_id
3450
3819
  * @param {string} paymentId payment id
@@ -3554,6 +3923,24 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3554
3923
  * @memberof CustomerApi
3555
3924
  */
3556
3925
  getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
3926
+ /**
3927
+ * Get Mandate Authorization by mandate id
3928
+ * @param {string} mandateId Finverse Mandate ID
3929
+ * @param {string} institutionId Finverse Institution ID
3930
+ * @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
3931
+ * @param {*} [options] Override http request option.
3932
+ * @throws {RequiredError}
3933
+ * @memberof CustomerApi
3934
+ */
3935
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthResponse>>;
3936
+ /**
3937
+ * Get link to launch FV Link UI in mandate authorization mode
3938
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3939
+ * @param {*} [options] Override http request option.
3940
+ * @throws {RequiredError}
3941
+ * @memberof CustomerApi
3942
+ */
3943
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthLinkResponse>>;
3557
3944
  /**
3558
3945
  * Get Payment details by payment_id
3559
3946
  * @param {string} paymentId payment id
package/dist/api.js CHANGED
@@ -22,13 +22,36 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- 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;
25
+ 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.GetMandateSenderSenderTypeEnum = exports.GetMandateResponseMandateStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = exports.CreateMandateSenderSenderTypeEnum = exports.AuthChecklistOptionsSubmittedByEnum = exports.AuthChecklistOptionsNameEnum = exports.AuthChecklistFactorRequiredEnum = exports.AuthChecklistFactorTypeEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
29
29
  const common_1 = require("./common");
30
30
  // @ts-ignore
31
31
  const base_1 = require("./base");
32
+ exports.AuthChecklistFactorTypeEnum = {
33
+ AccountIdentification: 'ACCOUNT_IDENTIFICATION',
34
+ UserIdentification: 'USER_IDENTIFICATION',
35
+ EnduserConsent: 'ENDUSER_CONSENT',
36
+ AccountholderAuthentication: 'ACCOUNTHOLDER_AUTHENTICATION',
37
+ };
38
+ exports.AuthChecklistFactorRequiredEnum = {
39
+ Yes: 'YES',
40
+ No: 'NO',
41
+ Optional: 'OPTIONAL',
42
+ };
43
+ exports.AuthChecklistOptionsNameEnum = {
44
+ CredentialsLogin: 'INSTITUTION_CREDENTIALS_LOGIN',
45
+ OauthLogin: 'INSTITUTION_OAUTH_LOGIN',
46
+ };
47
+ exports.AuthChecklistOptionsSubmittedByEnum = {
48
+ CustomerApp: 'CUSTOMER_APP',
49
+ FinverseLink: 'FINVERSE_LINK',
50
+ };
51
+ exports.CreateMandateSenderSenderTypeEnum = {
52
+ Personal: 'PERSONAL',
53
+ Business: 'BUSINESS',
54
+ };
32
55
  exports.CreatePaymentRequestTypeEnum = {
33
56
  Mandate: 'MANDATE',
34
57
  Single: 'SINGLE',
@@ -36,12 +59,29 @@ exports.CreatePaymentRequestTypeEnum = {
36
59
  exports.CustomerPaymentInstructionTypeEnum = {
37
60
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
38
61
  };
62
+ exports.GetMandateAuthLinkResponseTokenTypeEnum = {
63
+ Bearer: 'Bearer',
64
+ };
65
+ exports.GetMandateAuthResponseMandateStatusEnum = {
66
+ Created: 'CREATED',
67
+ Processing: 'PROCESSING',
68
+ Submitted: 'SUBMITTED',
69
+ Error: 'ERROR',
70
+ };
71
+ exports.GetMandateAuthResponseSenderTypeEnum = {
72
+ Personal: 'PERSONAL',
73
+ Business: 'BUSINESS',
74
+ };
39
75
  exports.GetMandateResponseMandateStatusEnum = {
40
76
  Created: 'CREATED',
41
- Used: 'USED',
77
+ Processing: 'PROCESSING',
42
78
  Submitted: 'SUBMITTED',
43
79
  Error: 'ERROR',
44
80
  };
81
+ exports.GetMandateSenderSenderTypeEnum = {
82
+ Personal: 'PERSONAL',
83
+ Business: 'BUSINESS',
84
+ };
45
85
  exports.GetPaymentResponseTypeEnum = {
46
86
  Mandate: 'MANDATE',
47
87
  Single: 'SINGLE',
@@ -66,6 +106,12 @@ exports.LinkTokenRequestAutomaticDataRefreshEnum = {
66
106
  Off: 'OFF',
67
107
  ForcedOn: 'FORCED_ON',
68
108
  };
109
+ exports.MandateAuthLinkCustomizationsUiModeEnum = {
110
+ Iframe: 'iframe',
111
+ Redirect: 'redirect',
112
+ AutoRedirect: 'auto_redirect',
113
+ Standalone: 'standalone',
114
+ };
69
115
  exports.PaymentInstructionTypeEnum = {
70
116
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
71
117
  };
@@ -345,6 +391,78 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
345
391
  options: localVarRequestOptions,
346
392
  };
347
393
  }),
394
+ /**
395
+ * Get Mandate Authorization by mandate id
396
+ * @param {string} mandateId Finverse Mandate ID
397
+ * @param {string} institutionId Finverse Institution ID
398
+ * @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
399
+ * @param {*} [options] Override http request option.
400
+ * @throws {RequiredError}
401
+ */
402
+ getMandateAuth: (mandateId, institutionId, senderType, options = {}) => __awaiter(this, void 0, void 0, function* () {
403
+ // verify required parameter 'mandateId' is not null or undefined
404
+ common_1.assertParamExists('getMandateAuth', 'mandateId', mandateId);
405
+ // verify required parameter 'institutionId' is not null or undefined
406
+ common_1.assertParamExists('getMandateAuth', 'institutionId', institutionId);
407
+ const localVarPath = `/mandates/{mandateId}/auth`.replace(`{${'mandateId'}}`, encodeURIComponent(String(mandateId)));
408
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
409
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
410
+ let baseOptions;
411
+ if (configuration) {
412
+ baseOptions = configuration.baseOptions;
413
+ }
414
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
415
+ const localVarHeaderParameter = {};
416
+ const localVarQueryParameter = {};
417
+ // authentication Oauth2 required
418
+ // oauth required
419
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
420
+ if (institutionId !== undefined) {
421
+ localVarQueryParameter['institution_id'] = institutionId;
422
+ }
423
+ if (senderType !== undefined) {
424
+ localVarQueryParameter['sender_type'] = senderType;
425
+ }
426
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
427
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
428
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
429
+ return {
430
+ url: common_1.toPathString(localVarUrlObj),
431
+ options: localVarRequestOptions,
432
+ };
433
+ }),
434
+ /**
435
+ * Get link to launch FV Link UI in mandate authorization mode
436
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
437
+ * @param {*} [options] Override http request option.
438
+ * @throws {RequiredError}
439
+ */
440
+ getMandateAuthLink: (getMandateAuthLinkRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
441
+ // verify required parameter 'getMandateAuthLinkRequest' is not null or undefined
442
+ common_1.assertParamExists('getMandateAuthLink', 'getMandateAuthLinkRequest', getMandateAuthLinkRequest);
443
+ const localVarPath = `/mandates/link`;
444
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
445
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
446
+ let baseOptions;
447
+ if (configuration) {
448
+ baseOptions = configuration.baseOptions;
449
+ }
450
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
451
+ const localVarHeaderParameter = {};
452
+ const localVarQueryParameter = {};
453
+ // authentication Oauth2 required
454
+ // oauth required
455
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
456
+ localVarHeaderParameter['Content-Type'] = 'application/json';
457
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
458
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
459
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
460
+ localVarRequestOptions.data = common_1.serializeDataIfNeeded(getMandateAuthLinkRequest, localVarRequestOptions, configuration);
461
+ return {
462
+ url: common_1.toPathString(localVarUrlObj),
463
+ options: localVarRequestOptions,
464
+ };
465
+ }),
348
466
  /**
349
467
  * Get Payment details by payment_id
350
468
  * @param {string} paymentId payment id
@@ -587,6 +705,32 @@ exports.CustomerApiFp = function (configuration) {
587
705
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
588
706
  });
589
707
  },
708
+ /**
709
+ * Get Mandate Authorization by mandate id
710
+ * @param {string} mandateId Finverse Mandate ID
711
+ * @param {string} institutionId Finverse Institution ID
712
+ * @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
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ */
716
+ getMandateAuth(mandateId, institutionId, senderType, options) {
717
+ return __awaiter(this, void 0, void 0, function* () {
718
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuth(mandateId, institutionId, senderType, options);
719
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
720
+ });
721
+ },
722
+ /**
723
+ * Get link to launch FV Link UI in mandate authorization mode
724
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
725
+ * @param {*} [options] Override http request option.
726
+ * @throws {RequiredError}
727
+ */
728
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
729
+ return __awaiter(this, void 0, void 0, function* () {
730
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuthLink(getMandateAuthLinkRequest, options);
731
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
732
+ });
733
+ },
590
734
  /**
591
735
  * Get Payment details by payment_id
592
736
  * @param {string} paymentId payment id
@@ -727,6 +871,30 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
727
871
  getMandate(mandateId, options) {
728
872
  return localVarFp.getMandate(mandateId, options).then((request) => request(axios, basePath));
729
873
  },
874
+ /**
875
+ * Get Mandate Authorization by mandate id
876
+ * @param {string} mandateId Finverse Mandate ID
877
+ * @param {string} institutionId Finverse Institution ID
878
+ * @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
879
+ * @param {*} [options] Override http request option.
880
+ * @throws {RequiredError}
881
+ */
882
+ getMandateAuth(mandateId, institutionId, senderType, options) {
883
+ return localVarFp
884
+ .getMandateAuth(mandateId, institutionId, senderType, options)
885
+ .then((request) => request(axios, basePath));
886
+ },
887
+ /**
888
+ * Get link to launch FV Link UI in mandate authorization mode
889
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
890
+ * @param {*} [options] Override http request option.
891
+ * @throws {RequiredError}
892
+ */
893
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
894
+ return localVarFp
895
+ .getMandateAuthLink(getMandateAuthLinkRequest, options)
896
+ .then((request) => request(axios, basePath));
897
+ },
730
898
  /**
731
899
  * Get Payment details by payment_id
732
900
  * @param {string} paymentId payment id
@@ -877,6 +1045,32 @@ class CustomerApi extends base_1.BaseAPI {
877
1045
  .getMandate(mandateId, options)
878
1046
  .then((request) => request(this.axios, this.basePath));
879
1047
  }
1048
+ /**
1049
+ * Get Mandate Authorization by mandate id
1050
+ * @param {string} mandateId Finverse Mandate ID
1051
+ * @param {string} institutionId Finverse Institution ID
1052
+ * @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
1053
+ * @param {*} [options] Override http request option.
1054
+ * @throws {RequiredError}
1055
+ * @memberof CustomerApi
1056
+ */
1057
+ getMandateAuth(mandateId, institutionId, senderType, options) {
1058
+ return exports.CustomerApiFp(this.configuration)
1059
+ .getMandateAuth(mandateId, institutionId, senderType, options)
1060
+ .then((request) => request(this.axios, this.basePath));
1061
+ }
1062
+ /**
1063
+ * Get link to launch FV Link UI in mandate authorization mode
1064
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
1065
+ * @param {*} [options] Override http request option.
1066
+ * @throws {RequiredError}
1067
+ * @memberof CustomerApi
1068
+ */
1069
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
1070
+ return exports.CustomerApiFp(this.configuration)
1071
+ .getMandateAuthLink(getMandateAuthLinkRequest, options)
1072
+ .then((request) => request(this.axios, this.basePath));
1073
+ }
880
1074
  /**
881
1075
  * Get Payment details by payment_id
882
1076
  * @param {string} paymentId payment id
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@finverse/sdk-typescript",
3
- "version": "0.0.47",
3
+ "version": "0.0.50",
4
4
  "description": "OpenAPI client for @finverse/sdk-typescript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [