@finverse/sdk-typescript 0.0.46 → 0.0.49

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 +454 -1
  2. package/dist/api.js +245 -2
  3. package/package.json +2 -2
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
@@ -857,6 +936,19 @@ export interface GetIdentityResponse {
857
936
  */
858
937
  institution?: InstitutionShort;
859
938
  }
939
+ /**
940
+ *
941
+ * @export
942
+ * @interface GetJWKSResponse
943
+ */
944
+ export interface GetJWKSResponse {
945
+ /**
946
+ *
947
+ * @type {Array<JWKSKey>}
948
+ * @memberof GetJWKSResponse
949
+ */
950
+ keys?: Array<JWKSKey>;
951
+ }
860
952
  /**
861
953
  *
862
954
  * @export
@@ -895,6 +987,127 @@ export interface GetLoginIdentityHistoryResponse {
895
987
  */
896
988
  status_history?: Array<LoginIdentityStatusDetails>;
897
989
  }
990
+ /**
991
+ *
992
+ * @export
993
+ * @interface GetMandateAuthLinkRequest
994
+ */
995
+ export interface GetMandateAuthLinkRequest {
996
+ /**
997
+ * Mandate ID
998
+ * @type {string}
999
+ * @memberof GetMandateAuthLinkRequest
1000
+ */
1001
+ mandate_id: string;
1002
+ /**
1003
+ *
1004
+ * @type {MandateAuthLinkCustomizations}
1005
+ * @memberof GetMandateAuthLinkRequest
1006
+ */
1007
+ link_customizations: MandateAuthLinkCustomizations;
1008
+ }
1009
+ /**
1010
+ *
1011
+ * @export
1012
+ * @interface GetMandateAuthLinkResponse
1013
+ */
1014
+ export interface GetMandateAuthLinkResponse {
1015
+ /**
1016
+ * Short-lived access-token to interact with Finverse Link
1017
+ * @type {string}
1018
+ * @memberof GetMandateAuthLinkResponse
1019
+ */
1020
+ access_token: string;
1021
+ /**
1022
+ * Access token validity duration (in seconds)
1023
+ * @type {number}
1024
+ * @memberof GetMandateAuthLinkResponse
1025
+ */
1026
+ expires_in: number;
1027
+ /**
1028
+ * URL to launch Finverse Link to authorize the mandate
1029
+ * @type {string}
1030
+ * @memberof GetMandateAuthLinkResponse
1031
+ */
1032
+ link_url: string;
1033
+ /**
1034
+ *
1035
+ * @type {string}
1036
+ * @memberof GetMandateAuthLinkResponse
1037
+ */
1038
+ token_type: GetMandateAuthLinkResponseTokenTypeEnum;
1039
+ }
1040
+ export declare const GetMandateAuthLinkResponseTokenTypeEnum: {
1041
+ readonly Bearer: "Bearer";
1042
+ };
1043
+ export declare type GetMandateAuthLinkResponseTokenTypeEnum = typeof GetMandateAuthLinkResponseTokenTypeEnum[keyof typeof GetMandateAuthLinkResponseTokenTypeEnum];
1044
+ /**
1045
+ *
1046
+ * @export
1047
+ * @interface GetMandateAuthResponse
1048
+ */
1049
+ export interface GetMandateAuthResponse {
1050
+ /**
1051
+ * Finverse Mandate ID
1052
+ * @type {string}
1053
+ * @memberof GetMandateAuthResponse
1054
+ */
1055
+ mandate_id: string;
1056
+ /**
1057
+ * Mandate status
1058
+ * @type {string}
1059
+ * @memberof GetMandateAuthResponse
1060
+ */
1061
+ mandate_status: GetMandateAuthResponseMandateStatusEnum;
1062
+ /**
1063
+ * Merchant account ID assigned by Finverse
1064
+ * @type {string}
1065
+ * @memberof GetMandateAuthResponse
1066
+ */
1067
+ recipient_account_id: string;
1068
+ /**
1069
+ * Finverse Institution ID. Only returned if institution_id was included in the request.
1070
+ * @type {string}
1071
+ * @memberof GetMandateAuthResponse
1072
+ */
1073
+ institution_id: string;
1074
+ /**
1075
+ * Type of account held by the Sender at the Institution. Possible values are PERSONAL, BUSINESS
1076
+ * @type {string}
1077
+ * @memberof GetMandateAuthResponse
1078
+ */
1079
+ sender_type: GetMandateAuthResponseSenderTypeEnum;
1080
+ /**
1081
+ * Checklist of the authorization factors needed to complete Mandate authorization
1082
+ * @type {Array<AuthChecklistFactor>}
1083
+ * @memberof GetMandateAuthResponse
1084
+ */
1085
+ auth_checklist: Array<AuthChecklistFactor>;
1086
+ /**
1087
+ *
1088
+ * @type {MandateAuthEncryptionInfo}
1089
+ * @memberof GetMandateAuthResponse
1090
+ */
1091
+ encryption_info: MandateAuthEncryptionInfo;
1092
+ /**
1093
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
1094
+ * @type {string}
1095
+ * @memberof GetMandateAuthResponse
1096
+ */
1097
+ last_update: string;
1098
+ }
1099
+ export declare const GetMandateAuthResponseMandateStatusEnum: {
1100
+ readonly Created: "CREATED";
1101
+ readonly Processing: "PROCESSING";
1102
+ readonly Submitted: "SUBMITTED";
1103
+ readonly Error: "ERROR";
1104
+ };
1105
+ export declare type GetMandateAuthResponseMandateStatusEnum = typeof GetMandateAuthResponseMandateStatusEnum[keyof typeof GetMandateAuthResponseMandateStatusEnum];
1106
+ export declare const GetMandateAuthResponseSenderTypeEnum: {
1107
+ readonly Personal: "PERSONAL";
1108
+ readonly Business: "BUSINESS";
1109
+ };
1110
+ export declare type GetMandateAuthResponseSenderTypeEnum = typeof GetMandateAuthResponseSenderTypeEnum[keyof typeof GetMandateAuthResponseSenderTypeEnum];
898
1111
  /**
899
1112
  *
900
1113
  * @export
@@ -940,7 +1153,7 @@ export interface GetMandateResponse {
940
1153
  }
941
1154
  export declare const GetMandateResponseMandateStatusEnum: {
942
1155
  readonly Created: "CREATED";
943
- readonly Used: "USED";
1156
+ readonly Processing: "PROCESSING";
944
1157
  readonly Submitted: "SUBMITTED";
945
1158
  readonly Error: "ERROR";
946
1159
  };
@@ -1649,6 +1862,49 @@ export interface InstitutionShort {
1649
1862
  */
1650
1863
  portal_name?: string;
1651
1864
  }
1865
+ /**
1866
+ *
1867
+ * @export
1868
+ * @interface JWKSKey
1869
+ */
1870
+ export interface JWKSKey {
1871
+ /**
1872
+ * The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\".
1873
+ * @type {string}
1874
+ * @memberof JWKSKey
1875
+ */
1876
+ kty?: string;
1877
+ /**
1878
+ * The \"kid\" (key ID) parameter is used to match a specific key
1879
+ * @type {string}
1880
+ * @memberof JWKSKey
1881
+ */
1882
+ kid?: string;
1883
+ /**
1884
+ * The \"use\" (public key use) parameter identifies the intended use of the public key
1885
+ * @type {string}
1886
+ * @memberof JWKSKey
1887
+ */
1888
+ use?: string;
1889
+ /**
1890
+ * RSA key value \"e\"
1891
+ * @type {string}
1892
+ * @memberof JWKSKey
1893
+ */
1894
+ e?: string;
1895
+ /**
1896
+ * RSA key value \"n\"
1897
+ * @type {string}
1898
+ * @memberof JWKSKey
1899
+ */
1900
+ n?: string;
1901
+ /**
1902
+ * The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates
1903
+ * @type {Array<string>}
1904
+ * @memberof JWKSKey
1905
+ */
1906
+ x5c?: Array<string>;
1907
+ }
1652
1908
  /**
1653
1909
  *
1654
1910
  * @export
@@ -2258,6 +2514,87 @@ export interface LoginMethod {
2258
2514
  */
2259
2515
  login_fields?: Array<LoginField>;
2260
2516
  }
2517
+ /**
2518
+ *
2519
+ * @export
2520
+ * @interface MandateAuthEncryptionInfo
2521
+ */
2522
+ export interface MandateAuthEncryptionInfo {
2523
+ /**
2524
+ *
2525
+ * @type {string}
2526
+ * @memberof MandateAuthEncryptionInfo
2527
+ */
2528
+ jwks_url: string;
2529
+ /**
2530
+ *
2531
+ * @type {string}
2532
+ * @memberof MandateAuthEncryptionInfo
2533
+ */
2534
+ key_id: string;
2535
+ }
2536
+ /**
2537
+ *
2538
+ * @export
2539
+ * @interface MandateAuthLinkCustomizations
2540
+ */
2541
+ export interface MandateAuthLinkCustomizations {
2542
+ /**
2543
+ * institution\'s country filter
2544
+ * @type {Array<string>}
2545
+ * @memberof MandateAuthLinkCustomizations
2546
+ */
2547
+ countries?: Array<string>;
2548
+ /**
2549
+ * Institution to preselect
2550
+ * @type {string}
2551
+ * @memberof MandateAuthLinkCustomizations
2552
+ */
2553
+ institution_id?: string;
2554
+ /**
2555
+ * institution\'s status filter
2556
+ * @type {string}
2557
+ * @memberof MandateAuthLinkCustomizations
2558
+ */
2559
+ institution_status?: string;
2560
+ /**
2561
+ * ISO639-1 language code. Language to display when user open the link, default to English (en) if not specified
2562
+ * @type {string}
2563
+ * @memberof MandateAuthLinkCustomizations
2564
+ */
2565
+ language?: string;
2566
+ /**
2567
+ * Space separated list of the tags of the institutions to view.
2568
+ * @type {string}
2569
+ * @memberof MandateAuthLinkCustomizations
2570
+ */
2571
+ link_mode?: string;
2572
+ /**
2573
+ * institution\'s supported product filter
2574
+ * @type {Array<string>}
2575
+ * @memberof MandateAuthLinkCustomizations
2576
+ */
2577
+ products_supported?: Array<string>;
2578
+ /**
2579
+ * The UI mode link is intended to be used in - \"iframe\" (default), \"auto_redirect\" or \"redirect\" or \"standalone\"
2580
+ * @type {string}
2581
+ * @memberof MandateAuthLinkCustomizations
2582
+ */
2583
+ ui_mode?: MandateAuthLinkCustomizationsUiModeEnum;
2584
+ /**
2585
+ * institution\'s supported user_type filter
2586
+ * @type {Array<string>}
2587
+ * @memberof MandateAuthLinkCustomizations
2588
+ */
2589
+ user_type?: Array<string>;
2590
+ }
2591
+ export declare const MandateAuthLinkCustomizationsUiModeEnum: {
2592
+ readonly Iframe: "iframe";
2593
+ readonly Redirect: "redirect";
2594
+ readonly AutoRedirect: "auto_redirect";
2595
+ readonly Standalone: "standalone";
2596
+ };
2597
+ export declare type MandateAuthLinkCustomizationsUiModeEnum = typeof MandateAuthLinkCustomizationsUiModeEnum[keyof typeof MandateAuthLinkCustomizationsUiModeEnum];
2261
2598
  /**
2262
2599
  *
2263
2600
  * @export
@@ -3095,6 +3432,22 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
3095
3432
  * @throws {RequiredError}
3096
3433
  */
3097
3434
  getMandate: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3435
+ /**
3436
+ * Get Mandate Authorization by mandate id
3437
+ * @param {string} mandateId Finverse Mandate ID
3438
+ * @param {string} institutionId Finverse Institution ID
3439
+ * @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
3440
+ * @param {*} [options] Override http request option.
3441
+ * @throws {RequiredError}
3442
+ */
3443
+ getMandateAuth: (mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig) => Promise<RequestArgs>;
3444
+ /**
3445
+ * Get link to launch FV Link UI in mandate authorization mode
3446
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3447
+ * @param {*} [options] Override http request option.
3448
+ * @throws {RequiredError}
3449
+ */
3450
+ getMandateAuthLink: (getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3098
3451
  /**
3099
3452
  * Get Payment details by payment_id
3100
3453
  * @param {string} paymentId payment id
@@ -3190,6 +3543,22 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
3190
3543
  * @throws {RequiredError}
3191
3544
  */
3192
3545
  getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateResponse>>;
3546
+ /**
3547
+ * Get Mandate Authorization by mandate id
3548
+ * @param {string} mandateId Finverse Mandate ID
3549
+ * @param {string} institutionId Finverse Institution ID
3550
+ * @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
3551
+ * @param {*} [options] Override http request option.
3552
+ * @throws {RequiredError}
3553
+ */
3554
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthResponse>>;
3555
+ /**
3556
+ * Get link to launch FV Link UI in mandate authorization mode
3557
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3558
+ * @param {*} [options] Override http request option.
3559
+ * @throws {RequiredError}
3560
+ */
3561
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandateAuthLinkResponse>>;
3193
3562
  /**
3194
3563
  * Get Payment details by payment_id
3195
3564
  * @param {string} paymentId payment id
@@ -3285,6 +3654,22 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
3285
3654
  * @throws {RequiredError}
3286
3655
  */
3287
3656
  getMandate(mandateId: string, options?: any): AxiosPromise<GetMandateResponse>;
3657
+ /**
3658
+ * Get Mandate Authorization by mandate id
3659
+ * @param {string} mandateId Finverse Mandate ID
3660
+ * @param {string} institutionId Finverse Institution ID
3661
+ * @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
3662
+ * @param {*} [options] Override http request option.
3663
+ * @throws {RequiredError}
3664
+ */
3665
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: any): AxiosPromise<GetMandateAuthResponse>;
3666
+ /**
3667
+ * Get link to launch FV Link UI in mandate authorization mode
3668
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3669
+ * @param {*} [options] Override http request option.
3670
+ * @throws {RequiredError}
3671
+ */
3672
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: any): AxiosPromise<GetMandateAuthLinkResponse>;
3288
3673
  /**
3289
3674
  * Get Payment details by payment_id
3290
3675
  * @param {string} paymentId payment id
@@ -3389,6 +3774,24 @@ export interface CustomerApiInterface {
3389
3774
  * @memberof CustomerApiInterface
3390
3775
  */
3391
3776
  getMandate(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandateResponse>;
3777
+ /**
3778
+ * Get Mandate Authorization by mandate id
3779
+ * @param {string} mandateId Finverse Mandate ID
3780
+ * @param {string} institutionId Finverse Institution ID
3781
+ * @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
3782
+ * @param {*} [options] Override http request option.
3783
+ * @throws {RequiredError}
3784
+ * @memberof CustomerApiInterface
3785
+ */
3786
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthResponse>;
3787
+ /**
3788
+ * Get link to launch FV Link UI in mandate authorization mode
3789
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3790
+ * @param {*} [options] Override http request option.
3791
+ * @throws {RequiredError}
3792
+ * @memberof CustomerApiInterface
3793
+ */
3794
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): AxiosPromise<GetMandateAuthLinkResponse>;
3392
3795
  /**
3393
3796
  * Get Payment details by payment_id
3394
3797
  * @param {string} paymentId payment id
@@ -3498,6 +3901,24 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
3498
3901
  * @memberof CustomerApi
3499
3902
  */
3500
3903
  getMandate(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateResponse>>;
3904
+ /**
3905
+ * Get Mandate Authorization by mandate id
3906
+ * @param {string} mandateId Finverse Mandate ID
3907
+ * @param {string} institutionId Finverse Institution ID
3908
+ * @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
3909
+ * @param {*} [options] Override http request option.
3910
+ * @throws {RequiredError}
3911
+ * @memberof CustomerApi
3912
+ */
3913
+ getMandateAuth(mandateId: string, institutionId: string, senderType?: 'PERSONAL' | 'BUSINESS', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthResponse>>;
3914
+ /**
3915
+ * Get link to launch FV Link UI in mandate authorization mode
3916
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
3917
+ * @param {*} [options] Override http request option.
3918
+ * @throws {RequiredError}
3919
+ * @memberof CustomerApi
3920
+ */
3921
+ getMandateAuthLink(getMandateAuthLinkRequest: GetMandateAuthLinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandateAuthLinkResponse>>;
3501
3922
  /**
3502
3923
  * Get Payment details by payment_id
3503
3924
  * @param {string} paymentId payment id
@@ -4373,6 +4794,12 @@ export declare const PublicApiAxiosParamCreator: (configuration?: Configuration)
4373
4794
  * @throws {RequiredError}
4374
4795
  */
4375
4796
  generateCustomerAccessToken: (tokenRequest?: TokenRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4797
+ /**
4798
+ * get payment jwks
4799
+ * @param {*} [options] Override http request option.
4800
+ * @throws {RequiredError}
4801
+ */
4802
+ getPaymentsJwks: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
4376
4803
  };
4377
4804
  /**
4378
4805
  * PublicApi - functional programming interface
@@ -4397,6 +4824,12 @@ export declare const PublicApiFp: (configuration?: Configuration) => {
4397
4824
  * @throws {RequiredError}
4398
4825
  */
4399
4826
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponse>>;
4827
+ /**
4828
+ * get payment jwks
4829
+ * @param {*} [options] Override http request option.
4830
+ * @throws {RequiredError}
4831
+ */
4832
+ getPaymentsJwks(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJWKSResponse>>;
4400
4833
  };
4401
4834
  /**
4402
4835
  * PublicApi - factory interface
@@ -4421,6 +4854,12 @@ export declare const PublicApiFactory: (configuration?: Configuration, basePath?
4421
4854
  * @throws {RequiredError}
4422
4855
  */
4423
4856
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: any): AxiosPromise<TokenResponse>;
4857
+ /**
4858
+ * get payment jwks
4859
+ * @param {*} [options] Override http request option.
4860
+ * @throws {RequiredError}
4861
+ */
4862
+ getPaymentsJwks(options?: any): AxiosPromise<GetJWKSResponse>;
4424
4863
  };
4425
4864
  /**
4426
4865
  * PublicApi - interface
@@ -4448,6 +4887,13 @@ export interface PublicApiInterface {
4448
4887
  * @memberof PublicApiInterface
4449
4888
  */
4450
4889
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): AxiosPromise<TokenResponse>;
4890
+ /**
4891
+ * get payment jwks
4892
+ * @param {*} [options] Override http request option.
4893
+ * @throws {RequiredError}
4894
+ * @memberof PublicApiInterface
4895
+ */
4896
+ getPaymentsJwks(options?: AxiosRequestConfig): AxiosPromise<GetJWKSResponse>;
4451
4897
  }
4452
4898
  /**
4453
4899
  * PublicApi - object-oriented interface
@@ -4476,4 +4922,11 @@ export declare class PublicApi extends BaseAPI implements PublicApiInterface {
4476
4922
  * @memberof PublicApi
4477
4923
  */
4478
4924
  generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TokenResponse>>;
4925
+ /**
4926
+ * get payment jwks
4927
+ * @param {*} [options] Override http request option.
4928
+ * @throws {RequiredError}
4929
+ * @memberof PublicApi
4930
+ */
4931
+ getPaymentsJwks(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJWKSResponse>>;
4479
4932
  }
package/dist/api.js CHANGED
@@ -22,13 +22,32 @@ 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.GetMandateResponseMandateStatusEnum = exports.GetMandateAuthResponseSenderTypeEnum = exports.GetMandateAuthResponseMandateStatusEnum = exports.GetMandateAuthLinkResponseTokenTypeEnum = exports.CustomerPaymentInstructionTypeEnum = exports.CreatePaymentRequestTypeEnum = 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
+ };
32
51
  exports.CreatePaymentRequestTypeEnum = {
33
52
  Mandate: 'MANDATE',
34
53
  Single: 'SINGLE',
@@ -36,9 +55,22 @@ exports.CreatePaymentRequestTypeEnum = {
36
55
  exports.CustomerPaymentInstructionTypeEnum = {
37
56
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
38
57
  };
58
+ exports.GetMandateAuthLinkResponseTokenTypeEnum = {
59
+ Bearer: 'Bearer',
60
+ };
61
+ exports.GetMandateAuthResponseMandateStatusEnum = {
62
+ Created: 'CREATED',
63
+ Processing: 'PROCESSING',
64
+ Submitted: 'SUBMITTED',
65
+ Error: 'ERROR',
66
+ };
67
+ exports.GetMandateAuthResponseSenderTypeEnum = {
68
+ Personal: 'PERSONAL',
69
+ Business: 'BUSINESS',
70
+ };
39
71
  exports.GetMandateResponseMandateStatusEnum = {
40
72
  Created: 'CREATED',
41
- Used: 'USED',
73
+ Processing: 'PROCESSING',
42
74
  Submitted: 'SUBMITTED',
43
75
  Error: 'ERROR',
44
76
  };
@@ -66,6 +98,12 @@ exports.LinkTokenRequestAutomaticDataRefreshEnum = {
66
98
  Off: 'OFF',
67
99
  ForcedOn: 'FORCED_ON',
68
100
  };
101
+ exports.MandateAuthLinkCustomizationsUiModeEnum = {
102
+ Iframe: 'iframe',
103
+ Redirect: 'redirect',
104
+ AutoRedirect: 'auto_redirect',
105
+ Standalone: 'standalone',
106
+ };
69
107
  exports.PaymentInstructionTypeEnum = {
70
108
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
71
109
  };
@@ -345,6 +383,78 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
345
383
  options: localVarRequestOptions,
346
384
  };
347
385
  }),
386
+ /**
387
+ * Get Mandate Authorization by mandate id
388
+ * @param {string} mandateId Finverse Mandate ID
389
+ * @param {string} institutionId Finverse Institution ID
390
+ * @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
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ */
394
+ getMandateAuth: (mandateId, institutionId, senderType, options = {}) => __awaiter(this, void 0, void 0, function* () {
395
+ // verify required parameter 'mandateId' is not null or undefined
396
+ common_1.assertParamExists('getMandateAuth', 'mandateId', mandateId);
397
+ // verify required parameter 'institutionId' is not null or undefined
398
+ common_1.assertParamExists('getMandateAuth', 'institutionId', institutionId);
399
+ const localVarPath = `/mandates/{mandateId}/auth`.replace(`{${'mandateId'}}`, encodeURIComponent(String(mandateId)));
400
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
401
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
402
+ let baseOptions;
403
+ if (configuration) {
404
+ baseOptions = configuration.baseOptions;
405
+ }
406
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
407
+ const localVarHeaderParameter = {};
408
+ const localVarQueryParameter = {};
409
+ // authentication Oauth2 required
410
+ // oauth required
411
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
412
+ if (institutionId !== undefined) {
413
+ localVarQueryParameter['institution_id'] = institutionId;
414
+ }
415
+ if (senderType !== undefined) {
416
+ localVarQueryParameter['sender_type'] = senderType;
417
+ }
418
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
419
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
420
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
421
+ return {
422
+ url: common_1.toPathString(localVarUrlObj),
423
+ options: localVarRequestOptions,
424
+ };
425
+ }),
426
+ /**
427
+ * Get link to launch FV Link UI in mandate authorization mode
428
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ */
432
+ getMandateAuthLink: (getMandateAuthLinkRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
433
+ // verify required parameter 'getMandateAuthLinkRequest' is not null or undefined
434
+ common_1.assertParamExists('getMandateAuthLink', 'getMandateAuthLinkRequest', getMandateAuthLinkRequest);
435
+ const localVarPath = `/mandates/link`;
436
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
437
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
438
+ let baseOptions;
439
+ if (configuration) {
440
+ baseOptions = configuration.baseOptions;
441
+ }
442
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
443
+ const localVarHeaderParameter = {};
444
+ const localVarQueryParameter = {};
445
+ // authentication Oauth2 required
446
+ // oauth required
447
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
448
+ localVarHeaderParameter['Content-Type'] = 'application/json';
449
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
450
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
451
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
452
+ localVarRequestOptions.data = common_1.serializeDataIfNeeded(getMandateAuthLinkRequest, localVarRequestOptions, configuration);
453
+ return {
454
+ url: common_1.toPathString(localVarUrlObj),
455
+ options: localVarRequestOptions,
456
+ };
457
+ }),
348
458
  /**
349
459
  * Get Payment details by payment_id
350
460
  * @param {string} paymentId payment id
@@ -587,6 +697,32 @@ exports.CustomerApiFp = function (configuration) {
587
697
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
588
698
  });
589
699
  },
700
+ /**
701
+ * Get Mandate Authorization by mandate id
702
+ * @param {string} mandateId Finverse Mandate ID
703
+ * @param {string} institutionId Finverse Institution ID
704
+ * @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
705
+ * @param {*} [options] Override http request option.
706
+ * @throws {RequiredError}
707
+ */
708
+ getMandateAuth(mandateId, institutionId, senderType, options) {
709
+ return __awaiter(this, void 0, void 0, function* () {
710
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuth(mandateId, institutionId, senderType, options);
711
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
712
+ });
713
+ },
714
+ /**
715
+ * Get link to launch FV Link UI in mandate authorization mode
716
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
717
+ * @param {*} [options] Override http request option.
718
+ * @throws {RequiredError}
719
+ */
720
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
721
+ return __awaiter(this, void 0, void 0, function* () {
722
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandateAuthLink(getMandateAuthLinkRequest, options);
723
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
724
+ });
725
+ },
590
726
  /**
591
727
  * Get Payment details by payment_id
592
728
  * @param {string} paymentId payment id
@@ -727,6 +863,30 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
727
863
  getMandate(mandateId, options) {
728
864
  return localVarFp.getMandate(mandateId, options).then((request) => request(axios, basePath));
729
865
  },
866
+ /**
867
+ * Get Mandate Authorization by mandate id
868
+ * @param {string} mandateId Finverse Mandate ID
869
+ * @param {string} institutionId Finverse Institution ID
870
+ * @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
871
+ * @param {*} [options] Override http request option.
872
+ * @throws {RequiredError}
873
+ */
874
+ getMandateAuth(mandateId, institutionId, senderType, options) {
875
+ return localVarFp
876
+ .getMandateAuth(mandateId, institutionId, senderType, options)
877
+ .then((request) => request(axios, basePath));
878
+ },
879
+ /**
880
+ * Get link to launch FV Link UI in mandate authorization mode
881
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
882
+ * @param {*} [options] Override http request option.
883
+ * @throws {RequiredError}
884
+ */
885
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
886
+ return localVarFp
887
+ .getMandateAuthLink(getMandateAuthLinkRequest, options)
888
+ .then((request) => request(axios, basePath));
889
+ },
730
890
  /**
731
891
  * Get Payment details by payment_id
732
892
  * @param {string} paymentId payment id
@@ -877,6 +1037,32 @@ class CustomerApi extends base_1.BaseAPI {
877
1037
  .getMandate(mandateId, options)
878
1038
  .then((request) => request(this.axios, this.basePath));
879
1039
  }
1040
+ /**
1041
+ * Get Mandate Authorization by mandate id
1042
+ * @param {string} mandateId Finverse Mandate ID
1043
+ * @param {string} institutionId Finverse Institution ID
1044
+ * @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
1045
+ * @param {*} [options] Override http request option.
1046
+ * @throws {RequiredError}
1047
+ * @memberof CustomerApi
1048
+ */
1049
+ getMandateAuth(mandateId, institutionId, senderType, options) {
1050
+ return exports.CustomerApiFp(this.configuration)
1051
+ .getMandateAuth(mandateId, institutionId, senderType, options)
1052
+ .then((request) => request(this.axios, this.basePath));
1053
+ }
1054
+ /**
1055
+ * Get link to launch FV Link UI in mandate authorization mode
1056
+ * @param {GetMandateAuthLinkRequest} getMandateAuthLinkRequest request body for mandate authorization link
1057
+ * @param {*} [options] Override http request option.
1058
+ * @throws {RequiredError}
1059
+ * @memberof CustomerApi
1060
+ */
1061
+ getMandateAuthLink(getMandateAuthLinkRequest, options) {
1062
+ return exports.CustomerApiFp(this.configuration)
1063
+ .getMandateAuthLink(getMandateAuthLinkRequest, options)
1064
+ .then((request) => request(this.axios, this.basePath));
1065
+ }
880
1066
  /**
881
1067
  * Get Payment details by payment_id
882
1068
  * @param {string} paymentId payment id
@@ -2396,6 +2582,33 @@ exports.PublicApiAxiosParamCreator = function (configuration) {
2396
2582
  options: localVarRequestOptions,
2397
2583
  };
2398
2584
  }),
2585
+ /**
2586
+ * get payment jwks
2587
+ * @param {*} [options] Override http request option.
2588
+ * @throws {RequiredError}
2589
+ */
2590
+ getPaymentsJwks: (options = {}) => __awaiter(this, void 0, void 0, function* () {
2591
+ const localVarPath = `/payments/jwks`;
2592
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2593
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2594
+ let baseOptions;
2595
+ if (configuration) {
2596
+ baseOptions = configuration.baseOptions;
2597
+ }
2598
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
2599
+ const localVarHeaderParameter = {};
2600
+ const localVarQueryParameter = {};
2601
+ // authentication Oauth2 required
2602
+ // oauth required
2603
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', ['test'], configuration);
2604
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
2605
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2606
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2607
+ return {
2608
+ url: common_1.toPathString(localVarUrlObj),
2609
+ options: localVarRequestOptions,
2610
+ };
2611
+ }),
2399
2612
  };
2400
2613
  };
2401
2614
  /**
@@ -2433,6 +2646,17 @@ exports.PublicApiFp = function (configuration) {
2433
2646
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2434
2647
  });
2435
2648
  },
2649
+ /**
2650
+ * get payment jwks
2651
+ * @param {*} [options] Override http request option.
2652
+ * @throws {RequiredError}
2653
+ */
2654
+ getPaymentsJwks(options) {
2655
+ return __awaiter(this, void 0, void 0, function* () {
2656
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPaymentsJwks(options);
2657
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
2658
+ });
2659
+ },
2436
2660
  };
2437
2661
  };
2438
2662
  /**
@@ -2466,6 +2690,14 @@ exports.PublicApiFactory = function (configuration, basePath, axios) {
2466
2690
  generateCustomerAccessToken(tokenRequest, options) {
2467
2691
  return localVarFp.generateCustomerAccessToken(tokenRequest, options).then((request) => request(axios, basePath));
2468
2692
  },
2693
+ /**
2694
+ * get payment jwks
2695
+ * @param {*} [options] Override http request option.
2696
+ * @throws {RequiredError}
2697
+ */
2698
+ getPaymentsJwks(options) {
2699
+ return localVarFp.getPaymentsJwks(options).then((request) => request(axios, basePath));
2700
+ },
2469
2701
  };
2470
2702
  };
2471
2703
  /**
@@ -2503,5 +2735,16 @@ class PublicApi extends base_1.BaseAPI {
2503
2735
  .generateCustomerAccessToken(tokenRequest, options)
2504
2736
  .then((request) => request(this.axios, this.basePath));
2505
2737
  }
2738
+ /**
2739
+ * get payment jwks
2740
+ * @param {*} [options] Override http request option.
2741
+ * @throws {RequiredError}
2742
+ * @memberof PublicApi
2743
+ */
2744
+ getPaymentsJwks(options) {
2745
+ return exports.PublicApiFp(this.configuration)
2746
+ .getPaymentsJwks(options)
2747
+ .then((request) => request(this.axios, this.basePath));
2748
+ }
2506
2749
  }
2507
2750
  exports.PublicApi = PublicApi;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@finverse/sdk-typescript",
3
- "version": "0.0.46",
3
+ "version": "0.0.49",
4
4
  "description": "OpenAPI client for @finverse/sdk-typescript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -27,7 +27,7 @@
27
27
  "axios-mock-adapter": "^1.21.1",
28
28
  "chai": "^4.3.6",
29
29
  "mocha": "^10.0.0",
30
- "ts-node": "^10.8.2",
30
+ "ts-node": "^10.9.1",
31
31
  "typescript": "^3.6.4"
32
32
  },
33
33
  "files": [