@finverse/sdk-typescript 0.0.34 → 0.0.37

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 +423 -0
  2. package/dist/api.js +263 -1
  3. package/package.json +1 -1
package/dist/api.d.ts CHANGED
@@ -307,6 +307,25 @@ export interface BalanceHistory {
307
307
  */
308
308
  currency: string;
309
309
  }
310
+ /**
311
+ *
312
+ * @export
313
+ * @interface CompositeStatementLink
314
+ */
315
+ export interface CompositeStatementLink {
316
+ /**
317
+ * signedURL to download statement
318
+ * @type {string}
319
+ * @memberof CompositeStatementLink
320
+ */
321
+ url: string;
322
+ /**
323
+ * expiry of the signedURL
324
+ * @type {string}
325
+ * @memberof CompositeStatementLink
326
+ */
327
+ expiry: string;
328
+ }
310
329
  /**
311
330
  *
312
331
  * @export
@@ -770,6 +789,87 @@ export interface GetLoginIdentityHistoryResponse {
770
789
  */
771
790
  status_history?: Array<LoginIdentityStatusDetails>;
772
791
  }
792
+ /**
793
+ *
794
+ * @export
795
+ * @interface GetMandateSender
796
+ */
797
+ export interface GetMandateSender {
798
+ /**
799
+ *
800
+ * @type {string}
801
+ * @memberof GetMandateSender
802
+ */
803
+ name?: string;
804
+ /**
805
+ * Customer App\'s user ID, representing the end-user making the payment.
806
+ * @type {string}
807
+ * @memberof GetMandateSender
808
+ */
809
+ user_id: string;
810
+ /**
811
+ * Customer App\'s reference ID, representing the sender\'s account or billing reference number.
812
+ * @type {string}
813
+ * @memberof GetMandateSender
814
+ */
815
+ sender_reference_id?: string;
816
+ /**
817
+ *
818
+ * @type {PaymentAccount}
819
+ * @memberof GetMandateSender
820
+ */
821
+ sender_account: PaymentAccount;
822
+ }
823
+ /**
824
+ *
825
+ * @export
826
+ * @interface GetMandatesResponse
827
+ */
828
+ export interface GetMandatesResponse {
829
+ /**
830
+ * Timestamp in ISO format (YYYY-MM-DDTHH:MM:SS.SSSZ)
831
+ * @type {string}
832
+ * @memberof GetMandatesResponse
833
+ */
834
+ last_update: string;
835
+ /**
836
+ * Finverse Mandate ID (ULID)
837
+ * @type {string}
838
+ * @memberof GetMandatesResponse
839
+ */
840
+ mandate_id: string;
841
+ /**
842
+ * Mandate status
843
+ * @type {string}
844
+ * @memberof GetMandatesResponse
845
+ */
846
+ mandate_status: GetMandatesResponseMandateStatusEnum;
847
+ /**
848
+ *
849
+ * @type {MandateRecipient}
850
+ * @memberof GetMandatesResponse
851
+ */
852
+ recipient: MandateRecipient;
853
+ /**
854
+ *
855
+ * @type {GetMandateSender}
856
+ * @memberof GetMandatesResponse
857
+ */
858
+ sender: GetMandateSender;
859
+ /**
860
+ *
861
+ * @type {MandateDetails}
862
+ * @memberof GetMandatesResponse
863
+ */
864
+ mandate_details: MandateDetails;
865
+ }
866
+ export declare const GetMandatesResponseMandateStatusEnum: {
867
+ readonly Created: "CREATED";
868
+ readonly Used: "USED";
869
+ readonly Submitted: "SUBMITTED";
870
+ readonly Error: "ERROR";
871
+ };
872
+ export declare type GetMandatesResponseMandateStatusEnum = typeof GetMandatesResponseMandateStatusEnum[keyof typeof GetMandatesResponseMandateStatusEnum];
773
873
  /**
774
874
  *
775
875
  * @export
@@ -1994,6 +2094,62 @@ export interface LoginMethod {
1994
2094
  */
1995
2095
  login_fields?: Array<LoginField>;
1996
2096
  }
2097
+ /**
2098
+ *
2099
+ * @export
2100
+ * @interface MandateDetails
2101
+ */
2102
+ export interface MandateDetails {
2103
+ /**
2104
+ * ISO currency code
2105
+ * @type {string}
2106
+ * @memberof MandateDetails
2107
+ */
2108
+ currency: string;
2109
+ /**
2110
+ * YYYY-MM-DD, must be later than or the same as the date of creation. If unspecified, default to the date of creation.
2111
+ * @type {string}
2112
+ * @memberof MandateDetails
2113
+ */
2114
+ start_date?: string;
2115
+ /**
2116
+ * YYYY-MM-DD, must be later than the date of creation.
2117
+ * @type {string}
2118
+ * @memberof MandateDetails
2119
+ */
2120
+ end_date?: string;
2121
+ /**
2122
+ *
2123
+ * @type {PaymentSchedule}
2124
+ * @memberof MandateDetails
2125
+ */
2126
+ payment_schedule?: PaymentSchedule;
2127
+ /**
2128
+ *
2129
+ * @type {TransactionLimits}
2130
+ * @memberof MandateDetails
2131
+ */
2132
+ transaction_limits?: TransactionLimits;
2133
+ /**
2134
+ * End-user facing description of the mandate (used in notifications, and in payments if no description is provided)
2135
+ * @type {string}
2136
+ * @memberof MandateDetails
2137
+ */
2138
+ description?: string;
2139
+ }
2140
+ /**
2141
+ *
2142
+ * @export
2143
+ * @interface MandateRecipient
2144
+ */
2145
+ export interface MandateRecipient {
2146
+ /**
2147
+ * Merchant account ID assigned by Finverse
2148
+ * @type {string}
2149
+ * @memberof MandateRecipient
2150
+ */
2151
+ recipient_account_id: string;
2152
+ }
1997
2153
  /**
1998
2154
  *
1999
2155
  * @export
@@ -2219,6 +2375,96 @@ export declare const PaymentInstructionTypeEnum: {
2219
2375
  readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
2220
2376
  };
2221
2377
  export declare type PaymentInstructionTypeEnum = typeof PaymentInstructionTypeEnum[keyof typeof PaymentInstructionTypeEnum];
2378
+ /**
2379
+ *
2380
+ * @export
2381
+ * @interface PaymentSchedule
2382
+ */
2383
+ export interface PaymentSchedule {
2384
+ /**
2385
+ * Amount to be paid, in currency’s smallest unit or “minor unit”, as defined in ISO 4217. For example, HKD 100.01 is represented as amount = 10001 (minor unit = cents). For currencies without minor units (e.g. VND, JPY), the amount is represented as is, without modification. For example, VND 15101 is represented as amount = 15101.
2386
+ * @type {number}
2387
+ * @memberof PaymentSchedule
2388
+ */
2389
+ amount: number;
2390
+ /**
2391
+ * Frequency of the payment. Possible values (DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)
2392
+ * @type {string}
2393
+ * @memberof PaymentSchedule
2394
+ */
2395
+ frequency: PaymentScheduleFrequencyEnum;
2396
+ }
2397
+ export declare const PaymentScheduleFrequencyEnum: {
2398
+ readonly Daily: "DAILY";
2399
+ readonly Weekly: "WEEKLY";
2400
+ readonly Monthly: "MONTHLY";
2401
+ readonly Quarterly: "QUARTERLY";
2402
+ readonly Yearly: "YEARLY";
2403
+ };
2404
+ export declare type PaymentScheduleFrequencyEnum = typeof PaymentScheduleFrequencyEnum[keyof typeof PaymentScheduleFrequencyEnum];
2405
+ /**
2406
+ *
2407
+ * @export
2408
+ * @interface PostMandateSender
2409
+ */
2410
+ export interface PostMandateSender {
2411
+ /**
2412
+ *
2413
+ * @type {string}
2414
+ * @memberof PostMandateSender
2415
+ */
2416
+ name?: string;
2417
+ /**
2418
+ * Customer App\'s user ID, representing the end-user making the payment.
2419
+ * @type {string}
2420
+ * @memberof PostMandateSender
2421
+ */
2422
+ user_id: string;
2423
+ /**
2424
+ * Customer App\'s reference ID, representing the sender\'s account or billing reference number.
2425
+ * @type {string}
2426
+ * @memberof PostMandateSender
2427
+ */
2428
+ sender_reference_id?: string;
2429
+ }
2430
+ /**
2431
+ *
2432
+ * @export
2433
+ * @interface PostMandatesRequest
2434
+ */
2435
+ export interface PostMandatesRequest {
2436
+ /**
2437
+ *
2438
+ * @type {MandateRecipient}
2439
+ * @memberof PostMandatesRequest
2440
+ */
2441
+ recipient: MandateRecipient;
2442
+ /**
2443
+ *
2444
+ * @type {PostMandateSender}
2445
+ * @memberof PostMandatesRequest
2446
+ */
2447
+ sender: PostMandateSender;
2448
+ /**
2449
+ *
2450
+ * @type {MandateDetails}
2451
+ * @memberof PostMandatesRequest
2452
+ */
2453
+ mandate_details: MandateDetails;
2454
+ }
2455
+ /**
2456
+ *
2457
+ * @export
2458
+ * @interface PostMandatesResponse
2459
+ */
2460
+ export interface PostMandatesResponse {
2461
+ /**
2462
+ * Finverse Mandate ID
2463
+ * @type {string}
2464
+ * @memberof PostMandatesResponse
2465
+ */
2466
+ mandate_id?: string;
2467
+ }
2222
2468
  /**
2223
2469
  *
2224
2470
  * @export
@@ -2621,6 +2867,45 @@ export interface Transaction {
2621
2867
  */
2622
2868
  updated_at?: string;
2623
2869
  }
2870
+ /**
2871
+ *
2872
+ * @export
2873
+ * @interface TransactionLimits
2874
+ */
2875
+ export interface TransactionLimits {
2876
+ /**
2877
+ * Maximum amount of money that can be paid during the reference period (across any number of transactions). Expressed in currency’s smallest unit or “minor unit”, as defined in ISO 4217.
2878
+ * @type {number}
2879
+ * @memberof TransactionLimits
2880
+ */
2881
+ max_period_amount?: number;
2882
+ /**
2883
+ * Maximum number of transactions (of any amount) that can be executed during the reference period.
2884
+ * @type {number}
2885
+ * @memberof TransactionLimits
2886
+ */
2887
+ max_period_count?: number;
2888
+ /**
2889
+ * The maximum amount of money that can be transferred in a single transaction under this mandate. Expressed in currency’s smallest unit or “minor unit”, as defined in ISO 4217.
2890
+ * @type {number}
2891
+ * @memberof TransactionLimits
2892
+ */
2893
+ max_transaction_amount?: number;
2894
+ /**
2895
+ * Reference calendar periods for the payment limits. Possible values (DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)
2896
+ * @type {string}
2897
+ * @memberof TransactionLimits
2898
+ */
2899
+ period: TransactionLimitsPeriodEnum;
2900
+ }
2901
+ export declare const TransactionLimitsPeriodEnum: {
2902
+ readonly Daily: "DAILY";
2903
+ readonly Weekly: "WEEKLY";
2904
+ readonly Monthly: "MONTHLY";
2905
+ readonly Quarterly: "QUARTERLY";
2906
+ readonly Yearly: "YEARLY";
2907
+ };
2908
+ export declare type TransactionLimitsPeriodEnum = typeof TransactionLimitsPeriodEnum[keyof typeof TransactionLimitsPeriodEnum];
2624
2909
  /**
2625
2910
  * CustomerApi - axios parameter creator
2626
2911
  * @export
@@ -2661,6 +2946,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
2661
2946
  * @throws {RequiredError}
2662
2947
  */
2663
2948
  getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2949
+ /**
2950
+ * Get Mandates details by mandate_id
2951
+ * @param {string} mandateId mandate id
2952
+ * @param {*} [options] Override http request option.
2953
+ * @throws {RequiredError}
2954
+ */
2955
+ getMandates: (mandateId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2664
2956
  /**
2665
2957
  * Get payment instructions by payment_instruction_id
2666
2958
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2678,6 +2970,13 @@ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuratio
2678
2970
  * @throws {RequiredError}
2679
2971
  */
2680
2972
  listInstitutions: (country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2973
+ /**
2974
+ * CREATE Mandates
2975
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
2976
+ * @param {*} [options] Override http request option.
2977
+ * @throws {RequiredError}
2978
+ */
2979
+ postMandates: (postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2681
2980
  /**
2682
2981
  * Refresh an access token
2683
2982
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -2726,6 +3025,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
2726
3025
  * @throws {RequiredError}
2727
3026
  */
2728
3027
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityHistoryResponse>>;
3028
+ /**
3029
+ * Get Mandates details by mandate_id
3030
+ * @param {string} mandateId mandate id
3031
+ * @param {*} [options] Override http request option.
3032
+ * @throws {RequiredError}
3033
+ */
3034
+ getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMandatesResponse>>;
2729
3035
  /**
2730
3036
  * Get payment instructions by payment_instruction_id
2731
3037
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2743,6 +3049,13 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
2743
3049
  * @throws {RequiredError}
2744
3050
  */
2745
3051
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Institution>>>;
3052
+ /**
3053
+ * CREATE Mandates
3054
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3055
+ * @param {*} [options] Override http request option.
3056
+ * @throws {RequiredError}
3057
+ */
3058
+ postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostMandatesResponse>>;
2746
3059
  /**
2747
3060
  * Refresh an access token
2748
3061
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -2791,6 +3104,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
2791
3104
  * @throws {RequiredError}
2792
3105
  */
2793
3106
  getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
3107
+ /**
3108
+ * Get Mandates details by mandate_id
3109
+ * @param {string} mandateId mandate id
3110
+ * @param {*} [options] Override http request option.
3111
+ * @throws {RequiredError}
3112
+ */
3113
+ getMandates(mandateId: string, options?: any): AxiosPromise<GetMandatesResponse>;
2794
3114
  /**
2795
3115
  * Get payment instructions by payment_instruction_id
2796
3116
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2808,6 +3128,13 @@ export declare const CustomerApiFactory: (configuration?: Configuration, basePat
2808
3128
  * @throws {RequiredError}
2809
3129
  */
2810
3130
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: any): AxiosPromise<Array<Institution>>;
3131
+ /**
3132
+ * CREATE Mandates
3133
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3134
+ * @param {*} [options] Override http request option.
3135
+ * @throws {RequiredError}
3136
+ */
3137
+ postMandates(postMandatesRequest: PostMandatesRequest, options?: any): AxiosPromise<PostMandatesResponse>;
2811
3138
  /**
2812
3139
  * Refresh an access token
2813
3140
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -2862,6 +3189,14 @@ export interface CustomerApiInterface {
2862
3189
  * @memberof CustomerApiInterface
2863
3190
  */
2864
3191
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
3192
+ /**
3193
+ * Get Mandates details by mandate_id
3194
+ * @param {string} mandateId mandate id
3195
+ * @param {*} [options] Override http request option.
3196
+ * @throws {RequiredError}
3197
+ * @memberof CustomerApiInterface
3198
+ */
3199
+ getMandates(mandateId: string, options?: AxiosRequestConfig): AxiosPromise<GetMandatesResponse>;
2865
3200
  /**
2866
3201
  * Get payment instructions by payment_instruction_id
2867
3202
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2881,6 +3216,14 @@ export interface CustomerApiInterface {
2881
3216
  * @memberof CustomerApiInterface
2882
3217
  */
2883
3218
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): AxiosPromise<Array<Institution>>;
3219
+ /**
3220
+ * CREATE Mandates
3221
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3222
+ * @param {*} [options] Override http request option.
3223
+ * @throws {RequiredError}
3224
+ * @memberof CustomerApiInterface
3225
+ */
3226
+ postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): AxiosPromise<PostMandatesResponse>;
2884
3227
  /**
2885
3228
  * Refresh an access token
2886
3229
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -2937,6 +3280,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
2937
3280
  * @memberof CustomerApi
2938
3281
  */
2939
3282
  getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
3283
+ /**
3284
+ * Get Mandates details by mandate_id
3285
+ * @param {string} mandateId mandate id
3286
+ * @param {*} [options] Override http request option.
3287
+ * @throws {RequiredError}
3288
+ * @memberof CustomerApi
3289
+ */
3290
+ getMandates(mandateId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMandatesResponse>>;
2940
3291
  /**
2941
3292
  * Get payment instructions by payment_instruction_id
2942
3293
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -2956,6 +3307,14 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
2956
3307
  * @memberof CustomerApi
2957
3308
  */
2958
3309
  listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Institution[]>>;
3310
+ /**
3311
+ * CREATE Mandates
3312
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
3313
+ * @param {*} [options] Override http request option.
3314
+ * @throws {RequiredError}
3315
+ * @memberof CustomerApi
3316
+ */
3317
+ postMandates(postMandatesRequest: PostMandatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PostMandatesResponse>>;
2959
3318
  /**
2960
3319
  * Refresh an access token
2961
3320
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -3247,6 +3606,18 @@ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configu
3247
3606
  * @throws {RequiredError}
3248
3607
  */
3249
3608
  getBalanceHistory: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3609
+ /**
3610
+ * Download composite statement
3611
+ * @param {*} [options] Override http request option.
3612
+ * @throws {RequiredError}
3613
+ */
3614
+ getCompositeStatement: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3615
+ /**
3616
+ * Get composite statement link for download
3617
+ * @param {*} [options] Override http request option.
3618
+ * @throws {RequiredError}
3619
+ */
3620
+ getCompositeStatementLink: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3250
3621
  /**
3251
3622
  * \\[BETA] Get a list of identity data for a given login identity
3252
3623
  * @param {*} [options] Override http request option.
@@ -3354,6 +3725,18 @@ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
3354
3725
  * @throws {RequiredError}
3355
3726
  */
3356
3727
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceHistoryResponse>>;
3728
+ /**
3729
+ * Download composite statement
3730
+ * @param {*} [options] Override http request option.
3731
+ * @throws {RequiredError}
3732
+ */
3733
+ getCompositeStatement(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3734
+ /**
3735
+ * Get composite statement link for download
3736
+ * @param {*} [options] Override http request option.
3737
+ * @throws {RequiredError}
3738
+ */
3739
+ getCompositeStatementLink(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompositeStatementLink>>;
3357
3740
  /**
3358
3741
  * \\[BETA] Get a list of identity data for a given login identity
3359
3742
  * @param {*} [options] Override http request option.
@@ -3461,6 +3844,18 @@ export declare const LoginIdentityApiFactory: (configuration?: Configuration, ba
3461
3844
  * @throws {RequiredError}
3462
3845
  */
3463
3846
  getBalanceHistory(accountId: string, options?: any): AxiosPromise<GetBalanceHistoryResponse>;
3847
+ /**
3848
+ * Download composite statement
3849
+ * @param {*} [options] Override http request option.
3850
+ * @throws {RequiredError}
3851
+ */
3852
+ getCompositeStatement(options?: any): AxiosPromise<void>;
3853
+ /**
3854
+ * Get composite statement link for download
3855
+ * @param {*} [options] Override http request option.
3856
+ * @throws {RequiredError}
3857
+ */
3858
+ getCompositeStatementLink(options?: any): AxiosPromise<CompositeStatementLink>;
3464
3859
  /**
3465
3860
  * \\[BETA] Get a list of identity data for a given login identity
3466
3861
  * @param {*} [options] Override http request option.
@@ -3574,6 +3969,20 @@ export interface LoginIdentityApiInterface {
3574
3969
  * @memberof LoginIdentityApiInterface
3575
3970
  */
3576
3971
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetBalanceHistoryResponse>;
3972
+ /**
3973
+ * Download composite statement
3974
+ * @param {*} [options] Override http request option.
3975
+ * @throws {RequiredError}
3976
+ * @memberof LoginIdentityApiInterface
3977
+ */
3978
+ getCompositeStatement(options?: AxiosRequestConfig): AxiosPromise<void>;
3979
+ /**
3980
+ * Get composite statement link for download
3981
+ * @param {*} [options] Override http request option.
3982
+ * @throws {RequiredError}
3983
+ * @memberof LoginIdentityApiInterface
3984
+ */
3985
+ getCompositeStatementLink(options?: AxiosRequestConfig): AxiosPromise<CompositeStatementLink>;
3577
3986
  /**
3578
3987
  * \\[BETA] Get a list of identity data for a given login identity
3579
3988
  * @param {*} [options] Override http request option.
@@ -3698,6 +4107,20 @@ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityAp
3698
4107
  * @memberof LoginIdentityApi
3699
4108
  */
3700
4109
  getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceHistoryResponse>>;
4110
+ /**
4111
+ * Download composite statement
4112
+ * @param {*} [options] Override http request option.
4113
+ * @throws {RequiredError}
4114
+ * @memberof LoginIdentityApi
4115
+ */
4116
+ getCompositeStatement(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
4117
+ /**
4118
+ * Get composite statement link for download
4119
+ * @param {*} [options] Override http request option.
4120
+ * @throws {RequiredError}
4121
+ * @memberof LoginIdentityApi
4122
+ */
4123
+ getCompositeStatementLink(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompositeStatementLink>>;
3701
4124
  /**
3702
4125
  * \\[BETA] Get a list of identity data for a given login identity
3703
4126
  * @param {*} [options] Override http request option.
package/dist/api.js CHANGED
@@ -22,7 +22,7 @@ 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.PaymentInstructionTypeEnum = exports.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.CustomerPaymentInstructionTypeEnum = 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.LinkTokenRequestAutomaticDataRefreshEnum = exports.LinkTokenRequestUiModeEnum = exports.GetMandatesResponseMandateStatusEnum = exports.CustomerPaymentInstructionTypeEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
@@ -32,6 +32,12 @@ const base_1 = require("./base");
32
32
  exports.CustomerPaymentInstructionTypeEnum = {
33
33
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
34
34
  };
35
+ exports.GetMandatesResponseMandateStatusEnum = {
36
+ Created: 'CREATED',
37
+ Used: 'USED',
38
+ Submitted: 'SUBMITTED',
39
+ Error: 'ERROR',
40
+ };
35
41
  exports.LinkTokenRequestUiModeEnum = {
36
42
  Iframe: 'iframe',
37
43
  Redirect: 'redirect',
@@ -46,6 +52,20 @@ exports.LinkTokenRequestAutomaticDataRefreshEnum = {
46
52
  exports.PaymentInstructionTypeEnum = {
47
53
  DebitAuthorization: 'DEBIT_AUTHORIZATION',
48
54
  };
55
+ exports.PaymentScheduleFrequencyEnum = {
56
+ Daily: 'DAILY',
57
+ Weekly: 'WEEKLY',
58
+ Monthly: 'MONTHLY',
59
+ Quarterly: 'QUARTERLY',
60
+ Yearly: 'YEARLY',
61
+ };
62
+ exports.TransactionLimitsPeriodEnum = {
63
+ Daily: 'DAILY',
64
+ Weekly: 'WEEKLY',
65
+ Monthly: 'MONTHLY',
66
+ Quarterly: 'QUARTERLY',
67
+ Yearly: 'YEARLY',
68
+ };
49
69
  /**
50
70
  * CustomerApi - axios parameter creator
51
71
  * @export
@@ -206,6 +226,36 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
206
226
  options: localVarRequestOptions,
207
227
  };
208
228
  }),
229
+ /**
230
+ * Get Mandates details by mandate_id
231
+ * @param {string} mandateId mandate id
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ getMandates: (mandateId, options = {}) => __awaiter(this, void 0, void 0, function* () {
236
+ // verify required parameter 'mandateId' is not null or undefined
237
+ common_1.assertParamExists('getMandates', 'mandateId', mandateId);
238
+ const localVarPath = `/mandates/{mandateId}`.replace(`{${'mandateId'}}`, encodeURIComponent(String(mandateId)));
239
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
240
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
241
+ let baseOptions;
242
+ if (configuration) {
243
+ baseOptions = configuration.baseOptions;
244
+ }
245
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
246
+ const localVarHeaderParameter = {};
247
+ const localVarQueryParameter = {};
248
+ // authentication Oauth2 required
249
+ // oauth required
250
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
251
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
252
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
253
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
254
+ return {
255
+ url: common_1.toPathString(localVarUrlObj),
256
+ options: localVarRequestOptions,
257
+ };
258
+ }),
209
259
  /**
210
260
  * Get payment instructions by payment_instruction_id
211
261
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -279,6 +329,38 @@ exports.CustomerApiAxiosParamCreator = function (configuration) {
279
329
  options: localVarRequestOptions,
280
330
  };
281
331
  }),
332
+ /**
333
+ * CREATE Mandates
334
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
335
+ * @param {*} [options] Override http request option.
336
+ * @throws {RequiredError}
337
+ */
338
+ postMandates: (postMandatesRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
339
+ // verify required parameter 'postMandatesRequest' is not null or undefined
340
+ common_1.assertParamExists('postMandates', 'postMandatesRequest', postMandatesRequest);
341
+ const localVarPath = `/mandates`;
342
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
343
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
344
+ let baseOptions;
345
+ if (configuration) {
346
+ baseOptions = configuration.baseOptions;
347
+ }
348
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
349
+ const localVarHeaderParameter = {};
350
+ const localVarQueryParameter = {};
351
+ // authentication Oauth2 required
352
+ // oauth required
353
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
354
+ localVarHeaderParameter['Content-Type'] = 'application/json';
355
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
356
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
357
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
358
+ localVarRequestOptions.data = common_1.serializeDataIfNeeded(postMandatesRequest, localVarRequestOptions, configuration);
359
+ return {
360
+ url: common_1.toPathString(localVarUrlObj),
361
+ options: localVarRequestOptions,
362
+ };
363
+ }),
282
364
  /**
283
365
  * Refresh an access token
284
366
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -380,6 +462,18 @@ exports.CustomerApiFp = function (configuration) {
380
462
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
381
463
  });
382
464
  },
465
+ /**
466
+ * Get Mandates details by mandate_id
467
+ * @param {string} mandateId mandate id
468
+ * @param {*} [options] Override http request option.
469
+ * @throws {RequiredError}
470
+ */
471
+ getMandates(mandateId, options) {
472
+ return __awaiter(this, void 0, void 0, function* () {
473
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMandates(mandateId, options);
474
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
475
+ });
476
+ },
383
477
  /**
384
478
  * Get payment instructions by payment_instruction_id
385
479
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -407,6 +501,18 @@ exports.CustomerApiFp = function (configuration) {
407
501
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
408
502
  });
409
503
  },
504
+ /**
505
+ * CREATE Mandates
506
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ */
510
+ postMandates(postMandatesRequest, options) {
511
+ return __awaiter(this, void 0, void 0, function* () {
512
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.postMandates(postMandatesRequest, options);
513
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
514
+ });
515
+ },
410
516
  /**
411
517
  * Refresh an access token
412
518
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -475,6 +581,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
475
581
  getLoginIdentityHistory(loginIdentityId, options) {
476
582
  return localVarFp.getLoginIdentityHistory(loginIdentityId, options).then((request) => request(axios, basePath));
477
583
  },
584
+ /**
585
+ * Get Mandates details by mandate_id
586
+ * @param {string} mandateId mandate id
587
+ * @param {*} [options] Override http request option.
588
+ * @throws {RequiredError}
589
+ */
590
+ getMandates(mandateId, options) {
591
+ return localVarFp.getMandates(mandateId, options).then((request) => request(axios, basePath));
592
+ },
478
593
  /**
479
594
  * Get payment instructions by payment_instruction_id
480
595
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -500,6 +615,15 @@ exports.CustomerApiFactory = function (configuration, basePath, axios) {
500
615
  .listInstitutions(country, countries, productsSupported, institutionType, options)
501
616
  .then((request) => request(axios, basePath));
502
617
  },
618
+ /**
619
+ * CREATE Mandates
620
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
621
+ * @param {*} [options] Override http request option.
622
+ * @throws {RequiredError}
623
+ */
624
+ postMandates(postMandatesRequest, options) {
625
+ return localVarFp.postMandates(postMandatesRequest, options).then((request) => request(axios, basePath));
626
+ },
503
627
  /**
504
628
  * Refresh an access token
505
629
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -578,6 +702,18 @@ class CustomerApi extends base_1.BaseAPI {
578
702
  .getLoginIdentityHistory(loginIdentityId, options)
579
703
  .then((request) => request(this.axios, this.basePath));
580
704
  }
705
+ /**
706
+ * Get Mandates details by mandate_id
707
+ * @param {string} mandateId mandate id
708
+ * @param {*} [options] Override http request option.
709
+ * @throws {RequiredError}
710
+ * @memberof CustomerApi
711
+ */
712
+ getMandates(mandateId, options) {
713
+ return exports.CustomerApiFp(this.configuration)
714
+ .getMandates(mandateId, options)
715
+ .then((request) => request(this.axios, this.basePath));
716
+ }
581
717
  /**
582
718
  * Get payment instructions by payment_instruction_id
583
719
  * @param {string} paymentInstructionId The id of a payment instruction
@@ -605,6 +741,18 @@ class CustomerApi extends base_1.BaseAPI {
605
741
  .listInstitutions(country, countries, productsSupported, institutionType, options)
606
742
  .then((request) => request(this.axios, this.basePath));
607
743
  }
744
+ /**
745
+ * CREATE Mandates
746
+ * @param {PostMandatesRequest} postMandatesRequest request body for creating mandate
747
+ * @param {*} [options] Override http request option.
748
+ * @throws {RequiredError}
749
+ * @memberof CustomerApi
750
+ */
751
+ postMandates(postMandatesRequest, options) {
752
+ return exports.CustomerApiFp(this.configuration)
753
+ .postMandates(postMandatesRequest, options)
754
+ .then((request) => request(this.axios, this.basePath));
755
+ }
608
756
  /**
609
757
  * Refresh an access token
610
758
  * @param {RefreshRequest} refreshRequest The refresh token
@@ -1181,6 +1329,60 @@ exports.LoginIdentityApiAxiosParamCreator = function (configuration) {
1181
1329
  options: localVarRequestOptions,
1182
1330
  };
1183
1331
  }),
1332
+ /**
1333
+ * Download composite statement
1334
+ * @param {*} [options] Override http request option.
1335
+ * @throws {RequiredError}
1336
+ */
1337
+ getCompositeStatement: (options = {}) => __awaiter(this, void 0, void 0, function* () {
1338
+ const localVarPath = `/composite_statement`;
1339
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1340
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1341
+ let baseOptions;
1342
+ if (configuration) {
1343
+ baseOptions = configuration.baseOptions;
1344
+ }
1345
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1346
+ const localVarHeaderParameter = {};
1347
+ const localVarQueryParameter = {};
1348
+ // authentication Oauth2 required
1349
+ // oauth required
1350
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
1351
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
1352
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1353
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1354
+ return {
1355
+ url: common_1.toPathString(localVarUrlObj),
1356
+ options: localVarRequestOptions,
1357
+ };
1358
+ }),
1359
+ /**
1360
+ * Get composite statement link for download
1361
+ * @param {*} [options] Override http request option.
1362
+ * @throws {RequiredError}
1363
+ */
1364
+ getCompositeStatementLink: (options = {}) => __awaiter(this, void 0, void 0, function* () {
1365
+ const localVarPath = `/composite_statement_link`;
1366
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1367
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1368
+ let baseOptions;
1369
+ if (configuration) {
1370
+ baseOptions = configuration.baseOptions;
1371
+ }
1372
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1373
+ const localVarHeaderParameter = {};
1374
+ const localVarQueryParameter = {};
1375
+ // authentication Oauth2 required
1376
+ // oauth required
1377
+ yield common_1.setOAuthToObject(localVarHeaderParameter, 'Oauth2', [], configuration);
1378
+ common_1.setSearchParams(localVarUrlObj, localVarQueryParameter);
1379
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1380
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1381
+ return {
1382
+ url: common_1.toPathString(localVarUrlObj),
1383
+ options: localVarRequestOptions,
1384
+ };
1385
+ }),
1184
1386
  /**
1185
1387
  * \\[BETA] Get a list of identity data for a given login identity
1186
1388
  * @param {*} [options] Override http request option.
@@ -1544,6 +1746,28 @@ exports.LoginIdentityApiFp = function (configuration) {
1544
1746
  return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1545
1747
  });
1546
1748
  },
1749
+ /**
1750
+ * Download composite statement
1751
+ * @param {*} [options] Override http request option.
1752
+ * @throws {RequiredError}
1753
+ */
1754
+ getCompositeStatement(options) {
1755
+ return __awaiter(this, void 0, void 0, function* () {
1756
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCompositeStatement(options);
1757
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1758
+ });
1759
+ },
1760
+ /**
1761
+ * Get composite statement link for download
1762
+ * @param {*} [options] Override http request option.
1763
+ * @throws {RequiredError}
1764
+ */
1765
+ getCompositeStatementLink(options) {
1766
+ return __awaiter(this, void 0, void 0, function* () {
1767
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCompositeStatementLink(options);
1768
+ return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
1769
+ });
1770
+ },
1547
1771
  /**
1548
1772
  * \\[BETA] Get a list of identity data for a given login identity
1549
1773
  * @param {*} [options] Override http request option.
@@ -1714,6 +1938,22 @@ exports.LoginIdentityApiFactory = function (configuration, basePath, axios) {
1714
1938
  getBalanceHistory(accountId, options) {
1715
1939
  return localVarFp.getBalanceHistory(accountId, options).then((request) => request(axios, basePath));
1716
1940
  },
1941
+ /**
1942
+ * Download composite statement
1943
+ * @param {*} [options] Override http request option.
1944
+ * @throws {RequiredError}
1945
+ */
1946
+ getCompositeStatement(options) {
1947
+ return localVarFp.getCompositeStatement(options).then((request) => request(axios, basePath));
1948
+ },
1949
+ /**
1950
+ * Get composite statement link for download
1951
+ * @param {*} [options] Override http request option.
1952
+ * @throws {RequiredError}
1953
+ */
1954
+ getCompositeStatementLink(options) {
1955
+ return localVarFp.getCompositeStatementLink(options).then((request) => request(axios, basePath));
1956
+ },
1717
1957
  /**
1718
1958
  * \\[BETA] Get a list of identity data for a given login identity
1719
1959
  * @param {*} [options] Override http request option.
@@ -1873,6 +2113,28 @@ class LoginIdentityApi extends base_1.BaseAPI {
1873
2113
  .getBalanceHistory(accountId, options)
1874
2114
  .then((request) => request(this.axios, this.basePath));
1875
2115
  }
2116
+ /**
2117
+ * Download composite statement
2118
+ * @param {*} [options] Override http request option.
2119
+ * @throws {RequiredError}
2120
+ * @memberof LoginIdentityApi
2121
+ */
2122
+ getCompositeStatement(options) {
2123
+ return exports.LoginIdentityApiFp(this.configuration)
2124
+ .getCompositeStatement(options)
2125
+ .then((request) => request(this.axios, this.basePath));
2126
+ }
2127
+ /**
2128
+ * Get composite statement link for download
2129
+ * @param {*} [options] Override http request option.
2130
+ * @throws {RequiredError}
2131
+ * @memberof LoginIdentityApi
2132
+ */
2133
+ getCompositeStatementLink(options) {
2134
+ return exports.LoginIdentityApiFp(this.configuration)
2135
+ .getCompositeStatementLink(options)
2136
+ .then((request) => request(this.axios, this.basePath));
2137
+ }
1876
2138
  /**
1877
2139
  * \\[BETA] Get a list of identity data for a given login identity
1878
2140
  * @param {*} [options] Override http request option.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@finverse/sdk-typescript",
3
- "version": "0.0.34",
3
+ "version": "0.0.37",
4
4
  "description": "OpenAPI client for @finverse/sdk-typescript",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [