@finverse/sdk-typescript 0.0.18 → 0.0.21

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 (49) hide show
  1. package/dist/api.d.ts +3925 -0
  2. package/dist/api.js +2349 -0
  3. package/dist/base.d.ts +55 -0
  4. package/dist/base.js +60 -0
  5. package/dist/common.d.ts +65 -0
  6. package/dist/common.js +141 -0
  7. package/dist/configuration.d.ts +83 -0
  8. package/dist/configuration.js +42 -0
  9. package/dist/index.d.ts +13 -0
  10. package/dist/index.js +27 -0
  11. package/dist/test/accounts.spec.d.ts +1 -0
  12. package/dist/test/accounts.spec.js +38 -0
  13. package/dist/test/authenticate.spec.d.ts +1 -0
  14. package/dist/test/authenticate.spec.js +46 -0
  15. package/dist/test/config.d.ts +10 -0
  16. package/dist/test/config.js +15 -0
  17. package/dist/test/link.spec.d.ts +1 -0
  18. package/dist/test/link.spec.js +75 -0
  19. package/dist/test/loginIdentity.spec.d.ts +1 -0
  20. package/dist/test/loginIdentity.spec.js +69 -0
  21. package/dist/test/responses/account.d.ts +2 -0
  22. package/dist/test/responses/account.js +104 -0
  23. package/dist/test/responses/accountNumber.d.ts +2 -0
  24. package/dist/test/responses/accountNumber.js +19 -0
  25. package/dist/test/responses/balanceHistory.d.ts +2 -0
  26. package/dist/test/responses/balanceHistory.js +21 -0
  27. package/dist/test/responses/customerToken.d.ts +5 -0
  28. package/dist/test/responses/customerToken.js +8 -0
  29. package/dist/test/responses/identity.d.ts +2 -0
  30. package/dist/test/responses/identity.js +54 -0
  31. package/dist/test/responses/linkToken.d.ts +6 -0
  32. package/dist/test/responses/linkToken.js +9 -0
  33. package/dist/test/responses/loginIdentity.d.ts +2 -0
  34. package/dist/test/responses/loginIdentity.js +85 -0
  35. package/dist/test/responses/loginIdentityHistory.d.ts +2 -0
  36. package/dist/test/responses/loginIdentityHistory.js +37 -0
  37. package/dist/test/responses/loginIdentityToken.d.ts +7 -0
  38. package/dist/test/responses/loginIdentityToken.js +10 -0
  39. package/dist/test/responses/statement.d.ts +2 -0
  40. package/dist/test/responses/statement.js +20 -0
  41. package/dist/test/responses/statementLink.d.ts +2 -0
  42. package/dist/test/responses/statementLink.js +15 -0
  43. package/dist/test/responses/transaction.d.ts +2 -0
  44. package/dist/test/responses/transaction.js +280 -0
  45. package/dist/test/statements.spec.d.ts +1 -0
  46. package/dist/test/statements.spec.js +44 -0
  47. package/dist/test/transactions.spec.d.ts +1 -0
  48. package/dist/test/transactions.spec.js +38 -0
  49. package/package.json +4 -3
package/dist/api.d.ts ADDED
@@ -0,0 +1,3925 @@
1
+ /**
2
+ * Finverse Public
3
+ * Documentation of the early finverse services
4
+ *
5
+ * The version of the OpenAPI document: 0.0.1
6
+ * Contact: devs@finverse.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Configuration } from './configuration';
13
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import { RequestArgs, BaseAPI } from './base';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface AccessTokenResponse
19
+ */
20
+ export interface AccessTokenResponse {
21
+ /**
22
+ *
23
+ * @type {string}
24
+ * @memberof AccessTokenResponse
25
+ */
26
+ access_token: string;
27
+ /**
28
+ *
29
+ * @type {string}
30
+ * @memberof AccessTokenResponse
31
+ */
32
+ login_identity_id: string;
33
+ /**
34
+ *
35
+ * @type {string}
36
+ * @memberof AccessTokenResponse
37
+ */
38
+ token_type: string;
39
+ /**
40
+ * seconds
41
+ * @type {number}
42
+ * @memberof AccessTokenResponse
43
+ */
44
+ expires_in: number;
45
+ /**
46
+ *
47
+ * @type {string}
48
+ * @memberof AccessTokenResponse
49
+ */
50
+ refresh_token: string;
51
+ }
52
+ /**
53
+ *
54
+ * @export
55
+ * @interface Account
56
+ */
57
+ export interface Account {
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof Account
62
+ */
63
+ account_id: string;
64
+ /**
65
+ * The SHA3-256 hash of the account number, salted with the loginIdentityId
66
+ * @type {string}
67
+ * @memberof Account
68
+ */
69
+ group_id: string;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof Account
74
+ */
75
+ account_holder_name?: string;
76
+ /**
77
+ *
78
+ * @type {string}
79
+ * @memberof Account
80
+ */
81
+ account_name: string;
82
+ /**
83
+ *
84
+ * @type {string}
85
+ * @memberof Account
86
+ */
87
+ account_nickname?: string;
88
+ /**
89
+ *
90
+ * @type {string}
91
+ * @memberof Account
92
+ */
93
+ account_type?: string;
94
+ /**
95
+ *
96
+ * @type {string}
97
+ * @memberof Account
98
+ */
99
+ account_sub_type?: string;
100
+ /**
101
+ *
102
+ * @type {string}
103
+ * @memberof Account
104
+ */
105
+ country?: string;
106
+ /**
107
+ *
108
+ * @type {string}
109
+ * @memberof Account
110
+ */
111
+ created_at?: string;
112
+ /**
113
+ *
114
+ * @type {string}
115
+ * @memberof Account
116
+ */
117
+ updated_at?: string;
118
+ /**
119
+ *
120
+ * @type {string}
121
+ * @memberof Account
122
+ */
123
+ account_currency?: string;
124
+ /**
125
+ *
126
+ * @type {CurrencyAmount}
127
+ * @memberof Account
128
+ */
129
+ balance?: CurrencyAmount;
130
+ /**
131
+ *
132
+ * @type {CurrencyAmount}
133
+ * @memberof Account
134
+ */
135
+ statement_balance?: CurrencyAmount;
136
+ /**
137
+ *
138
+ * @type {boolean}
139
+ * @memberof Account
140
+ */
141
+ is_parent: boolean;
142
+ /**
143
+ *
144
+ * @type {boolean}
145
+ * @memberof Account
146
+ */
147
+ is_closed: boolean;
148
+ /**
149
+ *
150
+ * @type {boolean}
151
+ * @memberof Account
152
+ */
153
+ is_excluded: boolean;
154
+ }
155
+ /**
156
+ *
157
+ * @export
158
+ * @interface AccountNumber
159
+ */
160
+ export interface AccountNumber {
161
+ /**
162
+ *
163
+ * @type {string}
164
+ * @memberof AccountNumber
165
+ */
166
+ account_id: string;
167
+ /**
168
+ *
169
+ * @type {string}
170
+ * @memberof AccountNumber
171
+ */
172
+ number?: string;
173
+ /**
174
+ *
175
+ * @type {string}
176
+ * @memberof AccountNumber
177
+ */
178
+ raw: string;
179
+ }
180
+ /**
181
+ *
182
+ * @export
183
+ * @interface AllProductStatus
184
+ */
185
+ export interface AllProductStatus {
186
+ /**
187
+ *
188
+ * @type {ProductStatus}
189
+ * @memberof AllProductStatus
190
+ */
191
+ accounts?: ProductStatus;
192
+ /**
193
+ *
194
+ * @type {ProductStatus}
195
+ * @memberof AllProductStatus
196
+ */
197
+ online_transactions?: ProductStatus;
198
+ /**
199
+ *
200
+ * @type {ProductStatus}
201
+ * @memberof AllProductStatus
202
+ */
203
+ statements?: ProductStatus;
204
+ /**
205
+ *
206
+ * @type {ProductStatus}
207
+ * @memberof AllProductStatus
208
+ */
209
+ historical_transactions?: ProductStatus;
210
+ /**
211
+ *
212
+ * @type {ProductStatus}
213
+ * @memberof AllProductStatus
214
+ */
215
+ account_numbers?: ProductStatus;
216
+ /**
217
+ *
218
+ * @type {ProductStatus}
219
+ * @memberof AllProductStatus
220
+ */
221
+ identity?: ProductStatus;
222
+ /**
223
+ *
224
+ * @type {ProductStatus}
225
+ * @memberof AllProductStatus
226
+ */
227
+ balance_history?: ProductStatus;
228
+ /**
229
+ *
230
+ * @type {ProductStatus}
231
+ * @memberof AllProductStatus
232
+ */
233
+ payments?: ProductStatus;
234
+ /**
235
+ *
236
+ * @type {ProductStatus}
237
+ * @memberof AllProductStatus
238
+ */
239
+ income_estimation?: ProductStatus;
240
+ }
241
+ /**
242
+ *
243
+ * @export
244
+ * @interface BadRequestModel
245
+ */
246
+ export interface BadRequestModel {
247
+ /**
248
+ *
249
+ * @type {BadRequestModelError}
250
+ * @memberof BadRequestModel
251
+ */
252
+ error?: BadRequestModelError;
253
+ }
254
+ /**
255
+ *
256
+ * @export
257
+ * @interface BadRequestModelError
258
+ */
259
+ export interface BadRequestModelError {
260
+ /**
261
+ *
262
+ * @type {number}
263
+ * @memberof BadRequestModelError
264
+ */
265
+ code?: number;
266
+ /**
267
+ *
268
+ * @type {string}
269
+ * @memberof BadRequestModelError
270
+ */
271
+ name?: string;
272
+ /**
273
+ *
274
+ * @type {string}
275
+ * @memberof BadRequestModelError
276
+ */
277
+ message?: string;
278
+ /**
279
+ * A link to visit for further action
280
+ * @type {string}
281
+ * @memberof BadRequestModelError
282
+ */
283
+ link?: string;
284
+ }
285
+ /**
286
+ *
287
+ * @export
288
+ * @interface BalanceHistory
289
+ */
290
+ export interface BalanceHistory {
291
+ /**
292
+ * The date the balance was recorded
293
+ * @type {string}
294
+ * @memberof BalanceHistory
295
+ */
296
+ date: string;
297
+ /**
298
+ * The end of day balance for this account on this specific date
299
+ * @type {number}
300
+ * @memberof BalanceHistory
301
+ */
302
+ amount: number;
303
+ /**
304
+ * The currency the balance
305
+ * @type {string}
306
+ * @memberof BalanceHistory
307
+ */
308
+ currency: string;
309
+ }
310
+ /**
311
+ *
312
+ * @export
313
+ * @interface CreateCustomerRequest
314
+ */
315
+ export interface CreateCustomerRequest {
316
+ /**
317
+ * The email of the customer. This has to be unique.
318
+ * @type {string}
319
+ * @memberof CreateCustomerRequest
320
+ */
321
+ name: string;
322
+ /**
323
+ * The email of the customer. This has to be unique.
324
+ * @type {string}
325
+ * @memberof CreateCustomerRequest
326
+ */
327
+ email: string;
328
+ /**
329
+ * Primary key to identity the customer
330
+ * @type {string}
331
+ * @memberof CreateCustomerRequest
332
+ */
333
+ customer_app_id: string;
334
+ /**
335
+ * The redirect callback
336
+ * @type {Array<string>}
337
+ * @memberof CreateCustomerRequest
338
+ */
339
+ redirect_uris: Array<string>;
340
+ /**
341
+ * The webhook uris
342
+ * @type {Array<string>}
343
+ * @memberof CreateCustomerRequest
344
+ */
345
+ webhook_uris?: Array<string>;
346
+ }
347
+ /**
348
+ *
349
+ * @export
350
+ * @interface CreateCustomerResponse
351
+ */
352
+ export interface CreateCustomerResponse {
353
+ /**
354
+ * The email of the customer. This has to be unique.
355
+ * @type {string}
356
+ * @memberof CreateCustomerResponse
357
+ */
358
+ name: string;
359
+ /**
360
+ * The email of the customer. This has to be unique.
361
+ * @type {string}
362
+ * @memberof CreateCustomerResponse
363
+ */
364
+ email: string;
365
+ /**
366
+ * Primary key to identity the customer
367
+ * @type {string}
368
+ * @memberof CreateCustomerResponse
369
+ */
370
+ customer_app_id: string;
371
+ /**
372
+ * The redirect callback
373
+ * @type {Array<string>}
374
+ * @memberof CreateCustomerResponse
375
+ */
376
+ redirect_uris: Array<string>;
377
+ /**
378
+ *
379
+ * @type {string}
380
+ * @memberof CreateCustomerResponse
381
+ */
382
+ client_id: string;
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof CreateCustomerResponse
387
+ */
388
+ client_secret: string;
389
+ /**
390
+ * The webhook uris
391
+ * @type {Array<string>}
392
+ * @memberof CreateCustomerResponse
393
+ */
394
+ webhook_uris?: Array<string>;
395
+ }
396
+ /**
397
+ *
398
+ * @export
399
+ * @interface CreatePaymentInstructionResponse
400
+ */
401
+ export interface CreatePaymentInstructionResponse {
402
+ /**
403
+ *
404
+ * @type {string}
405
+ * @memberof CreatePaymentInstructionResponse
406
+ */
407
+ payment_instruction_id?: string;
408
+ }
409
+ /**
410
+ *
411
+ * @export
412
+ * @interface CurrencyAmount
413
+ */
414
+ export interface CurrencyAmount {
415
+ /**
416
+ *
417
+ * @type {string}
418
+ * @memberof CurrencyAmount
419
+ */
420
+ currency?: string;
421
+ /**
422
+ *
423
+ * @type {number}
424
+ * @memberof CurrencyAmount
425
+ */
426
+ value: number;
427
+ /**
428
+ *
429
+ * @type {string}
430
+ * @memberof CurrencyAmount
431
+ */
432
+ raw?: string;
433
+ }
434
+ /**
435
+ *
436
+ * @export
437
+ * @interface CustomerPaymentInstruction
438
+ */
439
+ export interface CustomerPaymentInstruction {
440
+ /**
441
+ * A id of the user of this payment, need to equal to userId when creating link
442
+ * @type {string}
443
+ * @memberof CustomerPaymentInstruction
444
+ */
445
+ user_id: string;
446
+ /**
447
+ * Type of payment is being created, please check Documentation on which payment type is supported in each institution
448
+ * @type {string}
449
+ * @memberof CustomerPaymentInstruction
450
+ */
451
+ type: CustomerPaymentInstructionTypeEnum;
452
+ /**
453
+ * The recipient name
454
+ * @type {string}
455
+ * @memberof CustomerPaymentInstruction
456
+ */
457
+ recipient_name?: string;
458
+ /**
459
+ * The recipient account Id
460
+ * @type {string}
461
+ * @memberof CustomerPaymentInstruction
462
+ */
463
+ recipient_account_id?: string;
464
+ /**
465
+ * The sender name
466
+ * @type {string}
467
+ * @memberof CustomerPaymentInstruction
468
+ */
469
+ sender_name?: string;
470
+ /**
471
+ * The sender account Id
472
+ * @type {string}
473
+ * @memberof CustomerPaymentInstruction
474
+ */
475
+ sender_account_id?: string;
476
+ /**
477
+ * When the payment should start
478
+ * @type {string}
479
+ * @memberof CustomerPaymentInstruction
480
+ */
481
+ start_date?: string | null;
482
+ /**
483
+ * When the payment should stop
484
+ * @type {string}
485
+ * @memberof CustomerPaymentInstruction
486
+ */
487
+ end_date?: string | null;
488
+ /**
489
+ * The currency for the payment
490
+ * @type {string}
491
+ * @memberof CustomerPaymentInstruction
492
+ */
493
+ currency?: string;
494
+ /**
495
+ * The payment amount
496
+ * @type {number}
497
+ * @memberof CustomerPaymentInstruction
498
+ */
499
+ amount?: number;
500
+ /**
501
+ * How often the payment should be executed
502
+ * @type {string}
503
+ * @memberof CustomerPaymentInstruction
504
+ */
505
+ frequency?: string;
506
+ /**
507
+ * Related remarks about this instruction
508
+ * @type {string}
509
+ * @memberof CustomerPaymentInstruction
510
+ */
511
+ remarks?: string;
512
+ }
513
+ export declare const CustomerPaymentInstructionTypeEnum: {
514
+ readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
515
+ };
516
+ export declare type CustomerPaymentInstructionTypeEnum = typeof CustomerPaymentInstructionTypeEnum[keyof typeof CustomerPaymentInstructionTypeEnum];
517
+ /**
518
+ *
519
+ * @export
520
+ * @interface CustomizationDetails
521
+ */
522
+ export interface CustomizationDetails {
523
+ /**
524
+ *
525
+ * @type {string}
526
+ * @memberof CustomizationDetails
527
+ */
528
+ logo_id?: string;
529
+ /**
530
+ *
531
+ * @type {string}
532
+ * @memberof CustomizationDetails
533
+ */
534
+ display_name?: string;
535
+ /**
536
+ *
537
+ * @type {string}
538
+ * @memberof CustomizationDetails
539
+ */
540
+ customer_app_name?: string;
541
+ }
542
+ /**
543
+ *
544
+ * @export
545
+ * @interface DeleteInstitutionResponse
546
+ */
547
+ export interface DeleteInstitutionResponse {
548
+ /**
549
+ *
550
+ * @type {boolean}
551
+ * @memberof DeleteInstitutionResponse
552
+ */
553
+ success?: boolean;
554
+ }
555
+ /**
556
+ *
557
+ * @export
558
+ * @interface DeleteLoginIdentityResponse
559
+ */
560
+ export interface DeleteLoginIdentityResponse {
561
+ /**
562
+ *
563
+ * @type {boolean}
564
+ * @memberof DeleteLoginIdentityResponse
565
+ */
566
+ success?: boolean;
567
+ }
568
+ /**
569
+ *
570
+ * @export
571
+ * @interface ErrorResponse
572
+ */
573
+ export interface ErrorResponse {
574
+ /**
575
+ *
576
+ * @type {string}
577
+ * @memberof ErrorResponse
578
+ */
579
+ err?: string;
580
+ /**
581
+ *
582
+ * @type {number}
583
+ * @memberof ErrorResponse
584
+ */
585
+ http_status_code?: number;
586
+ /**
587
+ *
588
+ * @type {string}
589
+ * @memberof ErrorResponse
590
+ */
591
+ status_text?: string;
592
+ /**
593
+ *
594
+ * @type {number}
595
+ * @memberof ErrorResponse
596
+ */
597
+ app_code?: number;
598
+ /**
599
+ *
600
+ * @type {string}
601
+ * @memberof ErrorResponse
602
+ */
603
+ error_category?: string;
604
+ /**
605
+ *
606
+ * @type {string}
607
+ * @memberof ErrorResponse
608
+ */
609
+ error_text?: string;
610
+ /**
611
+ *
612
+ * @type {string}
613
+ * @memberof ErrorResponse
614
+ */
615
+ request_id?: string;
616
+ }
617
+ /**
618
+ *
619
+ * @export
620
+ * @interface GetAccountNumberResponse
621
+ */
622
+ export interface GetAccountNumberResponse {
623
+ /**
624
+ *
625
+ * @type {AccountNumber}
626
+ * @memberof GetAccountNumberResponse
627
+ */
628
+ account_number?: AccountNumber;
629
+ /**
630
+ *
631
+ * @type {Account}
632
+ * @memberof GetAccountNumberResponse
633
+ */
634
+ account?: Account;
635
+ /**
636
+ *
637
+ * @type {LoginIdentityShort}
638
+ * @memberof GetAccountNumberResponse
639
+ */
640
+ login_identity?: LoginIdentityShort;
641
+ /**
642
+ *
643
+ * @type {InstitutionShort}
644
+ * @memberof GetAccountNumberResponse
645
+ */
646
+ institution?: InstitutionShort;
647
+ /**
648
+ *
649
+ * @type {Array<PaymentDetails>}
650
+ * @memberof GetAccountNumberResponse
651
+ */
652
+ payment_details?: Array<PaymentDetails>;
653
+ }
654
+ /**
655
+ *
656
+ * @export
657
+ * @interface GetAccountResponse
658
+ */
659
+ export interface GetAccountResponse {
660
+ /**
661
+ *
662
+ * @type {Account}
663
+ * @memberof GetAccountResponse
664
+ */
665
+ account?: Account;
666
+ /**
667
+ *
668
+ * @type {LoginIdentityShort}
669
+ * @memberof GetAccountResponse
670
+ */
671
+ login_identity?: LoginIdentityShort;
672
+ /**
673
+ *
674
+ * @type {InstitutionShort}
675
+ * @memberof GetAccountResponse
676
+ */
677
+ institution?: InstitutionShort;
678
+ }
679
+ /**
680
+ *
681
+ * @export
682
+ * @interface GetBalanceHistoryResponse
683
+ */
684
+ export interface GetBalanceHistoryResponse {
685
+ /**
686
+ *
687
+ * @type {Account}
688
+ * @memberof GetBalanceHistoryResponse
689
+ */
690
+ account?: Account;
691
+ /**
692
+ *
693
+ * @type {LoginIdentityShort}
694
+ * @memberof GetBalanceHistoryResponse
695
+ */
696
+ login_identity?: LoginIdentityShort;
697
+ /**
698
+ *
699
+ * @type {InstitutionShort}
700
+ * @memberof GetBalanceHistoryResponse
701
+ */
702
+ institution?: InstitutionShort;
703
+ /**
704
+ *
705
+ * @type {Array<BalanceHistory>}
706
+ * @memberof GetBalanceHistoryResponse
707
+ */
708
+ balance_history?: Array<BalanceHistory>;
709
+ }
710
+ /**
711
+ *
712
+ * @export
713
+ * @interface GetIdentityResponse
714
+ */
715
+ export interface GetIdentityResponse {
716
+ /**
717
+ *
718
+ * @type {Identity}
719
+ * @memberof GetIdentityResponse
720
+ */
721
+ identity?: Identity;
722
+ /**
723
+ *
724
+ * @type {LoginIdentityShort}
725
+ * @memberof GetIdentityResponse
726
+ */
727
+ login_identity?: LoginIdentityShort;
728
+ /**
729
+ *
730
+ * @type {InstitutionShort}
731
+ * @memberof GetIdentityResponse
732
+ */
733
+ institution?: InstitutionShort;
734
+ }
735
+ /**
736
+ *
737
+ * @export
738
+ * @interface GetLoginIdentityByIdResponse
739
+ */
740
+ export interface GetLoginIdentityByIdResponse {
741
+ /**
742
+ *
743
+ * @type {LoginIdentity}
744
+ * @memberof GetLoginIdentityByIdResponse
745
+ */
746
+ login_identity?: LoginIdentity;
747
+ /**
748
+ *
749
+ * @type {InstitutionShort}
750
+ * @memberof GetLoginIdentityByIdResponse
751
+ */
752
+ institution?: InstitutionShort;
753
+ }
754
+ /**
755
+ *
756
+ * @export
757
+ * @interface GetLoginIdentityHistoryResponse
758
+ */
759
+ export interface GetLoginIdentityHistoryResponse {
760
+ /**
761
+ *
762
+ * @type {LoginIdentity}
763
+ * @memberof GetLoginIdentityHistoryResponse
764
+ */
765
+ login_identity?: LoginIdentity;
766
+ /**
767
+ *
768
+ * @type {Array<LoginIdentityStatusDetails>}
769
+ * @memberof GetLoginIdentityHistoryResponse
770
+ */
771
+ status_history?: Array<LoginIdentityStatusDetails>;
772
+ }
773
+ /**
774
+ *
775
+ * @export
776
+ * @interface GetPaymentInstructionsResponse
777
+ */
778
+ export interface GetPaymentInstructionsResponse {
779
+ /**
780
+ *
781
+ * @type {PaymentInstruction}
782
+ * @memberof GetPaymentInstructionsResponse
783
+ */
784
+ payment_instruction?: PaymentInstruction;
785
+ }
786
+ /**
787
+ *
788
+ * @export
789
+ * @interface GetStatementLinkResponse
790
+ */
791
+ export interface GetStatementLinkResponse {
792
+ /**
793
+ *
794
+ * @type {Array<StatementLink>}
795
+ * @memberof GetStatementLinkResponse
796
+ */
797
+ statement_links?: Array<StatementLink>;
798
+ }
799
+ /**
800
+ *
801
+ * @export
802
+ * @interface GetStatementsResponse
803
+ */
804
+ export interface GetStatementsResponse {
805
+ /**
806
+ *
807
+ * @type {Array<Statement>}
808
+ * @memberof GetStatementsResponse
809
+ */
810
+ statements?: Array<Statement>;
811
+ /**
812
+ *
813
+ * @type {LoginIdentityShort}
814
+ * @memberof GetStatementsResponse
815
+ */
816
+ login_identity?: LoginIdentityShort;
817
+ /**
818
+ *
819
+ * @type {InstitutionShort}
820
+ * @memberof GetStatementsResponse
821
+ */
822
+ institution?: InstitutionShort;
823
+ }
824
+ /**
825
+ *
826
+ * @export
827
+ * @interface Identity
828
+ */
829
+ export interface Identity {
830
+ /**
831
+ *
832
+ * @type {Array<IdentityName>}
833
+ * @memberof Identity
834
+ */
835
+ names?: Array<IdentityName>;
836
+ /**
837
+ *
838
+ * @type {Array<IdentityAddress>}
839
+ * @memberof Identity
840
+ */
841
+ addresses?: Array<IdentityAddress>;
842
+ /**
843
+ *
844
+ * @type {Array<IdentityEmail>}
845
+ * @memberof Identity
846
+ */
847
+ emails?: Array<IdentityEmail>;
848
+ /**
849
+ *
850
+ * @type {Array<IdentityPhoneNumber>}
851
+ * @memberof Identity
852
+ */
853
+ phone_numbers?: Array<IdentityPhoneNumber>;
854
+ /**
855
+ *
856
+ * @type {Array<IdentityDateOfBirth>}
857
+ * @memberof Identity
858
+ */
859
+ date_of_births?: Array<IdentityDateOfBirth>;
860
+ }
861
+ /**
862
+ *
863
+ * @export
864
+ * @interface IdentityAddress
865
+ */
866
+ export interface IdentityAddress {
867
+ /**
868
+ *
869
+ * @type {string}
870
+ * @memberof IdentityAddress
871
+ */
872
+ raw?: string;
873
+ /**
874
+ *
875
+ * @type {string}
876
+ * @memberof IdentityAddress
877
+ */
878
+ full_address?: string;
879
+ /**
880
+ *
881
+ * @type {string}
882
+ * @memberof IdentityAddress
883
+ */
884
+ unit_number?: string;
885
+ /**
886
+ *
887
+ * @type {string}
888
+ * @memberof IdentityAddress
889
+ */
890
+ floor_number?: string;
891
+ /**
892
+ *
893
+ * @type {string}
894
+ * @memberof IdentityAddress
895
+ */
896
+ building_name?: string;
897
+ /**
898
+ *
899
+ * @type {string}
900
+ * @memberof IdentityAddress
901
+ */
902
+ street_number?: string;
903
+ /**
904
+ *
905
+ * @type {string}
906
+ * @memberof IdentityAddress
907
+ */
908
+ street_name?: string;
909
+ /**
910
+ *
911
+ * @type {string}
912
+ * @memberof IdentityAddress
913
+ */
914
+ city?: string;
915
+ /**
916
+ *
917
+ * @type {string}
918
+ * @memberof IdentityAddress
919
+ */
920
+ district?: string;
921
+ /**
922
+ *
923
+ * @type {string}
924
+ * @memberof IdentityAddress
925
+ */
926
+ ward?: string;
927
+ /**
928
+ *
929
+ * @type {string}
930
+ * @memberof IdentityAddress
931
+ */
932
+ street_address?: string;
933
+ /**
934
+ *
935
+ * @type {string}
936
+ * @memberof IdentityAddress
937
+ */
938
+ province?: string;
939
+ /**
940
+ *
941
+ * @type {string}
942
+ * @memberof IdentityAddress
943
+ */
944
+ country?: string;
945
+ /**
946
+ *
947
+ * @type {string}
948
+ * @memberof IdentityAddress
949
+ */
950
+ postal_code?: string;
951
+ /**
952
+ *
953
+ * @type {string}
954
+ * @memberof IdentityAddress
955
+ */
956
+ source?: string;
957
+ /**
958
+ *
959
+ * @type {Array<string>}
960
+ * @memberof IdentityAddress
961
+ */
962
+ source_ids?: Array<string>;
963
+ /**
964
+ *
965
+ * @type {Array<string>}
966
+ * @memberof IdentityAddress
967
+ */
968
+ account_ids?: Array<string>;
969
+ }
970
+ /**
971
+ *
972
+ * @export
973
+ * @interface IdentityDateOfBirth
974
+ */
975
+ export interface IdentityDateOfBirth {
976
+ /**
977
+ *
978
+ * @type {string}
979
+ * @memberof IdentityDateOfBirth
980
+ */
981
+ raw?: string;
982
+ /**
983
+ *
984
+ * @type {string}
985
+ * @memberof IdentityDateOfBirth
986
+ */
987
+ date_of_birth?: string;
988
+ /**
989
+ *
990
+ * @type {string}
991
+ * @memberof IdentityDateOfBirth
992
+ */
993
+ source?: string;
994
+ /**
995
+ *
996
+ * @type {Array<string>}
997
+ * @memberof IdentityDateOfBirth
998
+ */
999
+ source_ids?: Array<string>;
1000
+ /**
1001
+ *
1002
+ * @type {Array<string>}
1003
+ * @memberof IdentityDateOfBirth
1004
+ */
1005
+ account_ids?: Array<string>;
1006
+ }
1007
+ /**
1008
+ *
1009
+ * @export
1010
+ * @interface IdentityEmail
1011
+ */
1012
+ export interface IdentityEmail {
1013
+ /**
1014
+ *
1015
+ * @type {string}
1016
+ * @memberof IdentityEmail
1017
+ */
1018
+ raw?: string;
1019
+ /**
1020
+ *
1021
+ * @type {string}
1022
+ * @memberof IdentityEmail
1023
+ */
1024
+ email?: string;
1025
+ /**
1026
+ *
1027
+ * @type {string}
1028
+ * @memberof IdentityEmail
1029
+ */
1030
+ masked_email?: string;
1031
+ /**
1032
+ *
1033
+ * @type {string}
1034
+ * @memberof IdentityEmail
1035
+ */
1036
+ source?: string;
1037
+ /**
1038
+ *
1039
+ * @type {Array<string>}
1040
+ * @memberof IdentityEmail
1041
+ */
1042
+ source_ids?: Array<string>;
1043
+ /**
1044
+ *
1045
+ * @type {Array<string>}
1046
+ * @memberof IdentityEmail
1047
+ */
1048
+ account_ids?: Array<string>;
1049
+ }
1050
+ /**
1051
+ *
1052
+ * @export
1053
+ * @interface IdentityName
1054
+ */
1055
+ export interface IdentityName {
1056
+ /**
1057
+ *
1058
+ * @type {string}
1059
+ * @memberof IdentityName
1060
+ */
1061
+ raw?: string;
1062
+ /**
1063
+ *
1064
+ * @type {string}
1065
+ * @memberof IdentityName
1066
+ */
1067
+ full_name?: string;
1068
+ /**
1069
+ *
1070
+ * @type {string}
1071
+ * @memberof IdentityName
1072
+ */
1073
+ first_name?: string;
1074
+ /**
1075
+ *
1076
+ * @type {string}
1077
+ * @memberof IdentityName
1078
+ */
1079
+ last_name?: string;
1080
+ /**
1081
+ *
1082
+ * @type {string}
1083
+ * @memberof IdentityName
1084
+ */
1085
+ other_name?: string;
1086
+ /**
1087
+ *
1088
+ * @type {string}
1089
+ * @memberof IdentityName
1090
+ */
1091
+ source?: string;
1092
+ /**
1093
+ *
1094
+ * @type {Array<string>}
1095
+ * @memberof IdentityName
1096
+ */
1097
+ source_ids?: Array<string>;
1098
+ /**
1099
+ *
1100
+ * @type {Array<string>}
1101
+ * @memberof IdentityName
1102
+ */
1103
+ account_ids?: Array<string>;
1104
+ }
1105
+ /**
1106
+ *
1107
+ * @export
1108
+ * @interface IdentityPhoneNumber
1109
+ */
1110
+ export interface IdentityPhoneNumber {
1111
+ /**
1112
+ *
1113
+ * @type {string}
1114
+ * @memberof IdentityPhoneNumber
1115
+ */
1116
+ raw?: string;
1117
+ /**
1118
+ *
1119
+ * @type {string}
1120
+ * @memberof IdentityPhoneNumber
1121
+ */
1122
+ mobile_phone?: string;
1123
+ /**
1124
+ *
1125
+ * @type {string}
1126
+ * @memberof IdentityPhoneNumber
1127
+ */
1128
+ other_phone?: string;
1129
+ /**
1130
+ *
1131
+ * @type {string}
1132
+ * @memberof IdentityPhoneNumber
1133
+ */
1134
+ masked_phone?: string;
1135
+ /**
1136
+ *
1137
+ * @type {string}
1138
+ * @memberof IdentityPhoneNumber
1139
+ */
1140
+ source?: string;
1141
+ /**
1142
+ *
1143
+ * @type {Array<string>}
1144
+ * @memberof IdentityPhoneNumber
1145
+ */
1146
+ source_ids?: Array<string>;
1147
+ /**
1148
+ *
1149
+ * @type {Array<string>}
1150
+ * @memberof IdentityPhoneNumber
1151
+ */
1152
+ account_ids?: Array<string>;
1153
+ }
1154
+ /**
1155
+ *
1156
+ * @export
1157
+ * @interface IncomeEstimate
1158
+ */
1159
+ export interface IncomeEstimate {
1160
+ /**
1161
+ * Income amount
1162
+ * @type {number}
1163
+ * @memberof IncomeEstimate
1164
+ */
1165
+ amount?: number;
1166
+ /**
1167
+ * Currency
1168
+ * @type {string}
1169
+ * @memberof IncomeEstimate
1170
+ */
1171
+ currency?: string;
1172
+ }
1173
+ /**
1174
+ *
1175
+ * @export
1176
+ * @interface IncomeResponse
1177
+ */
1178
+ export interface IncomeResponse {
1179
+ /**
1180
+ *
1181
+ * @type {Array<SingleSourceIncome>}
1182
+ * @memberof IncomeResponse
1183
+ */
1184
+ income?: Array<SingleSourceIncome>;
1185
+ /**
1186
+ *
1187
+ * @type {LoginIdentityShort}
1188
+ * @memberof IncomeResponse
1189
+ */
1190
+ login_identity?: LoginIdentityShort;
1191
+ /**
1192
+ *
1193
+ * @type {InstitutionShort}
1194
+ * @memberof IncomeResponse
1195
+ */
1196
+ institution?: InstitutionShort;
1197
+ }
1198
+ /**
1199
+ *
1200
+ * @export
1201
+ * @interface IncomeStream
1202
+ */
1203
+ export interface IncomeStream {
1204
+ /**
1205
+ * Account this income estimate is associated with
1206
+ * @type {string}
1207
+ * @memberof IncomeStream
1208
+ */
1209
+ account_id?: string;
1210
+ /**
1211
+ *
1212
+ * @type {IncomeEstimate}
1213
+ * @memberof IncomeStream
1214
+ */
1215
+ estimated_monthly_income?: IncomeEstimate;
1216
+ /**
1217
+ * Number of transactions counted towards income
1218
+ * @type {number}
1219
+ * @memberof IncomeStream
1220
+ */
1221
+ transaction_count?: number;
1222
+ /**
1223
+ *
1224
+ * @type {Array<MonthlyIncomeEstimate>}
1225
+ * @memberof IncomeStream
1226
+ */
1227
+ monthly_history?: Array<MonthlyIncomeEstimate>;
1228
+ }
1229
+ /**
1230
+ *
1231
+ * @export
1232
+ * @interface IncomeTotal
1233
+ */
1234
+ export interface IncomeTotal {
1235
+ /**
1236
+ *
1237
+ * @type {IncomeEstimate}
1238
+ * @memberof IncomeTotal
1239
+ */
1240
+ estimated_monthly_income?: IncomeEstimate;
1241
+ /**
1242
+ * Number of transactions counted towards income
1243
+ * @type {number}
1244
+ * @memberof IncomeTotal
1245
+ */
1246
+ transaction_count?: number;
1247
+ /**
1248
+ *
1249
+ * @type {Array<MonthlyIncomeEstimate>}
1250
+ * @memberof IncomeTotal
1251
+ */
1252
+ monthly_history?: Array<MonthlyIncomeEstimate>;
1253
+ }
1254
+ /**
1255
+ *
1256
+ * @export
1257
+ * @interface Institution
1258
+ */
1259
+ export interface Institution {
1260
+ /**
1261
+ *
1262
+ * @type {string}
1263
+ * @memberof Institution
1264
+ */
1265
+ institution_id: string;
1266
+ /**
1267
+ *
1268
+ * @type {Array<string>}
1269
+ * @memberof Institution
1270
+ */
1271
+ countries: Array<string>;
1272
+ /**
1273
+ *
1274
+ * @type {Array<string>}
1275
+ * @memberof Institution
1276
+ */
1277
+ tags?: Array<string>;
1278
+ /**
1279
+ *
1280
+ * @type {string}
1281
+ * @memberof Institution
1282
+ */
1283
+ institution_type: string;
1284
+ /**
1285
+ *
1286
+ * @type {Array<string>}
1287
+ * @memberof Institution
1288
+ */
1289
+ products_supported: Array<string>;
1290
+ /**
1291
+ *
1292
+ * @type {string}
1293
+ * @memberof Institution
1294
+ */
1295
+ parent_institution_name?: string;
1296
+ /**
1297
+ *
1298
+ * @type {string}
1299
+ * @memberof Institution
1300
+ */
1301
+ institution_name: string;
1302
+ /**
1303
+ *
1304
+ * @type {string}
1305
+ * @memberof Institution
1306
+ */
1307
+ portal_name?: string;
1308
+ /**
1309
+ *
1310
+ * @type {string}
1311
+ * @memberof Institution
1312
+ */
1313
+ user_type: string;
1314
+ /**
1315
+ *
1316
+ * @type {string}
1317
+ * @memberof Institution
1318
+ */
1319
+ status: string;
1320
+ /**
1321
+ *
1322
+ * @type {object}
1323
+ * @memberof Institution
1324
+ */
1325
+ status_details?: object;
1326
+ /**
1327
+ *
1328
+ * @type {string}
1329
+ * @memberof Institution
1330
+ */
1331
+ login_url?: string;
1332
+ /**
1333
+ *
1334
+ * @type {object}
1335
+ * @memberof Institution
1336
+ */
1337
+ login_details?: object;
1338
+ /**
1339
+ *
1340
+ * @type {Array<LoginMethod>}
1341
+ * @memberof Institution
1342
+ */
1343
+ login_methods?: Array<LoginMethod>;
1344
+ /**
1345
+ *
1346
+ * @type {string}
1347
+ * @memberof Institution
1348
+ */
1349
+ color?: string;
1350
+ /**
1351
+ *
1352
+ * @type {string}
1353
+ * @memberof Institution
1354
+ */
1355
+ updated_at?: string;
1356
+ }
1357
+ /**
1358
+ *
1359
+ * @export
1360
+ * @interface InstitutionShort
1361
+ */
1362
+ export interface InstitutionShort {
1363
+ /**
1364
+ *
1365
+ * @type {string}
1366
+ * @memberof InstitutionShort
1367
+ */
1368
+ institution_id?: string;
1369
+ /**
1370
+ *
1371
+ * @type {Array<string>}
1372
+ * @memberof InstitutionShort
1373
+ */
1374
+ countries?: Array<string>;
1375
+ /**
1376
+ *
1377
+ * @type {string}
1378
+ * @memberof InstitutionShort
1379
+ */
1380
+ institution_name?: string;
1381
+ /**
1382
+ *
1383
+ * @type {string}
1384
+ * @memberof InstitutionShort
1385
+ */
1386
+ portal_name?: string;
1387
+ }
1388
+ /**
1389
+ *
1390
+ * @export
1391
+ * @interface LinkRequest
1392
+ */
1393
+ export interface LinkRequest {
1394
+ /**
1395
+ *
1396
+ * @type {string}
1397
+ * @memberof LinkRequest
1398
+ */
1399
+ institution_id: string;
1400
+ /**
1401
+ *
1402
+ * @type {boolean}
1403
+ * @memberof LinkRequest
1404
+ */
1405
+ store_credential: boolean;
1406
+ /**
1407
+ * products that is requested
1408
+ * @type {Array<string>}
1409
+ * @memberof LinkRequest
1410
+ */
1411
+ products_requested?: Array<string>;
1412
+ /**
1413
+ * The identifier returned after creating payment instruction
1414
+ * @type {string}
1415
+ * @memberof LinkRequest
1416
+ */
1417
+ payment_instruction_id?: string;
1418
+ }
1419
+ /**
1420
+ *
1421
+ * @export
1422
+ * @interface LinkResponse
1423
+ */
1424
+ export interface LinkResponse {
1425
+ /**
1426
+ *
1427
+ * @type {string}
1428
+ * @memberof LinkResponse
1429
+ */
1430
+ auth_url?: string;
1431
+ }
1432
+ /**
1433
+ *
1434
+ * @export
1435
+ * @interface LinkTokenRequest
1436
+ */
1437
+ export interface LinkTokenRequest {
1438
+ /**
1439
+ * support only client_credentials
1440
+ * @type {string}
1441
+ * @memberof LinkTokenRequest
1442
+ */
1443
+ grant_type: string;
1444
+ /**
1445
+ *
1446
+ * @type {string}
1447
+ * @memberof LinkTokenRequest
1448
+ */
1449
+ response_type: string;
1450
+ /**
1451
+ *
1452
+ * @type {string}
1453
+ * @memberof LinkTokenRequest
1454
+ */
1455
+ response_mode: string;
1456
+ /**
1457
+ * required when creating new Link, ignored when updating existing Link
1458
+ * @type {string}
1459
+ * @memberof LinkTokenRequest
1460
+ */
1461
+ user_id?: string;
1462
+ /**
1463
+ *
1464
+ * @type {string}
1465
+ * @memberof LinkTokenRequest
1466
+ */
1467
+ client_id: string;
1468
+ /**
1469
+ *
1470
+ * @type {string}
1471
+ * @memberof LinkTokenRequest
1472
+ */
1473
+ redirect_uri: string;
1474
+ /**
1475
+ *
1476
+ * @type {string}
1477
+ * @memberof LinkTokenRequest
1478
+ */
1479
+ state?: string;
1480
+ /**
1481
+ *
1482
+ * @type {string}
1483
+ * @memberof LinkTokenRequest
1484
+ */
1485
+ scope?: string;
1486
+ /**
1487
+ * Space separated list of the tags of the institutions to view.
1488
+ * @type {string}
1489
+ * @memberof LinkTokenRequest
1490
+ */
1491
+ link_mode?: string;
1492
+ /**
1493
+ * The UI mode link is intended to be used in - \"iframe\" (default), \"auto_redirect\" or \"redirect\"
1494
+ * @type {string}
1495
+ * @memberof LinkTokenRequest
1496
+ */
1497
+ ui_mode?: LinkTokenRequestUiModeEnum;
1498
+ /**
1499
+ * ISO639-1 language code. Language to display when user open the link, default to English (en) if not specified
1500
+ * @type {string}
1501
+ * @memberof LinkTokenRequest
1502
+ */
1503
+ language?: string;
1504
+ /**
1505
+ *
1506
+ * @type {string}
1507
+ * @memberof LinkTokenRequest
1508
+ */
1509
+ code_challenge?: string;
1510
+ /**
1511
+ *
1512
+ * @type {string}
1513
+ * @memberof LinkTokenRequest
1514
+ */
1515
+ code_challenge_method?: string;
1516
+ /**
1517
+ * use this to update a specific login identity
1518
+ * @type {string}
1519
+ * @memberof LinkTokenRequest
1520
+ */
1521
+ login_identity_id?: string;
1522
+ /**
1523
+ * The customization id if the customer wishes to embed it into link token for spawning link with their choice of stuffs
1524
+ * @type {string}
1525
+ * @memberof LinkTokenRequest
1526
+ */
1527
+ customization_id?: string;
1528
+ /**
1529
+ * Institution to preselect
1530
+ * @type {string}
1531
+ * @memberof LinkTokenRequest
1532
+ */
1533
+ institution_id?: string;
1534
+ /**
1535
+ * institution\'s country filter
1536
+ * @type {Array<string>}
1537
+ * @memberof LinkTokenRequest
1538
+ */
1539
+ countries?: Array<string>;
1540
+ /**
1541
+ * institution\'s supported user_type filter
1542
+ * @type {Array<string>}
1543
+ * @memberof LinkTokenRequest
1544
+ */
1545
+ user_type?: Array<string>;
1546
+ /**
1547
+ * institution\'s supported product filter
1548
+ * @type {Array<string>}
1549
+ * @memberof LinkTokenRequest
1550
+ */
1551
+ products_supported?: Array<string>;
1552
+ /**
1553
+ * products that is requested
1554
+ * @type {Array<string>}
1555
+ * @memberof LinkTokenRequest
1556
+ */
1557
+ products_requested?: Array<string>;
1558
+ /**
1559
+ * The identifier returned after creating payment instruction
1560
+ * @type {string}
1561
+ * @memberof LinkTokenRequest
1562
+ */
1563
+ payment_instruction_id?: string;
1564
+ }
1565
+ export declare const LinkTokenRequestUiModeEnum: {
1566
+ readonly Iframe: "iframe";
1567
+ readonly Redirect: "redirect";
1568
+ readonly AutoRedirect: "auto_redirect";
1569
+ };
1570
+ export declare type LinkTokenRequestUiModeEnum = typeof LinkTokenRequestUiModeEnum[keyof typeof LinkTokenRequestUiModeEnum];
1571
+ /**
1572
+ *
1573
+ * @export
1574
+ * @interface LinkTokenResponse
1575
+ */
1576
+ export interface LinkTokenResponse {
1577
+ /**
1578
+ *
1579
+ * @type {string}
1580
+ * @memberof LinkTokenResponse
1581
+ */
1582
+ access_token: string;
1583
+ /**
1584
+ *
1585
+ * @type {string}
1586
+ * @memberof LinkTokenResponse
1587
+ */
1588
+ token_type: string;
1589
+ /**
1590
+ * seconds
1591
+ * @type {number}
1592
+ * @memberof LinkTokenResponse
1593
+ */
1594
+ expires_in: number;
1595
+ /**
1596
+ *
1597
+ * @type {string}
1598
+ * @memberof LinkTokenResponse
1599
+ */
1600
+ link_url: string;
1601
+ }
1602
+ /**
1603
+ *
1604
+ * @export
1605
+ * @interface ListAccountsResponse
1606
+ */
1607
+ export interface ListAccountsResponse {
1608
+ /**
1609
+ *
1610
+ * @type {Array<Account>}
1611
+ * @memberof ListAccountsResponse
1612
+ */
1613
+ accounts?: Array<Account>;
1614
+ /**
1615
+ *
1616
+ * @type {LoginIdentityShort}
1617
+ * @memberof ListAccountsResponse
1618
+ */
1619
+ login_identity?: LoginIdentityShort;
1620
+ /**
1621
+ *
1622
+ * @type {InstitutionShort}
1623
+ * @memberof ListAccountsResponse
1624
+ */
1625
+ institution?: InstitutionShort;
1626
+ }
1627
+ /**
1628
+ *
1629
+ * @export
1630
+ * @interface ListTransactionsResponse
1631
+ */
1632
+ export interface ListTransactionsResponse {
1633
+ /**
1634
+ *
1635
+ * @type {Array<Account>}
1636
+ * @memberof ListTransactionsResponse
1637
+ */
1638
+ accounts?: Array<Account>;
1639
+ /**
1640
+ *
1641
+ * @type {Array<Transaction>}
1642
+ * @memberof ListTransactionsResponse
1643
+ */
1644
+ transactions?: Array<Transaction>;
1645
+ /**
1646
+ *
1647
+ * @type {LoginIdentityShort}
1648
+ * @memberof ListTransactionsResponse
1649
+ */
1650
+ login_identity?: LoginIdentityShort;
1651
+ /**
1652
+ *
1653
+ * @type {InstitutionShort}
1654
+ * @memberof ListTransactionsResponse
1655
+ */
1656
+ institution?: InstitutionShort;
1657
+ /**
1658
+ *
1659
+ * @type {number}
1660
+ * @memberof ListTransactionsResponse
1661
+ */
1662
+ total_transactions: number;
1663
+ }
1664
+ /**
1665
+ *
1666
+ * @export
1667
+ * @interface LoginField
1668
+ */
1669
+ export interface LoginField {
1670
+ /**
1671
+ *
1672
+ * @type {string}
1673
+ * @memberof LoginField
1674
+ */
1675
+ key?: string;
1676
+ /**
1677
+ *
1678
+ * @type {string}
1679
+ * @memberof LoginField
1680
+ */
1681
+ name?: string;
1682
+ /**
1683
+ * could be password, text, number
1684
+ * @type {string}
1685
+ * @memberof LoginField
1686
+ */
1687
+ type?: string;
1688
+ }
1689
+ /**
1690
+ *
1691
+ * @export
1692
+ * @interface LoginIdentity
1693
+ */
1694
+ export interface LoginIdentity {
1695
+ /**
1696
+ *
1697
+ * @type {string}
1698
+ * @memberof LoginIdentity
1699
+ */
1700
+ login_identity_id?: string;
1701
+ /**
1702
+ *
1703
+ * @type {string}
1704
+ * @memberof LoginIdentity
1705
+ */
1706
+ customer_app_id: string;
1707
+ /**
1708
+ *
1709
+ * @type {string}
1710
+ * @memberof LoginIdentity
1711
+ */
1712
+ user_id: string;
1713
+ /**
1714
+ *
1715
+ * @type {LoginIdentityLoginMethodsAvailable}
1716
+ * @memberof LoginIdentity
1717
+ */
1718
+ login_methods_available?: LoginIdentityLoginMethodsAvailable;
1719
+ /**
1720
+ *
1721
+ * @type {string}
1722
+ * @memberof LoginIdentity
1723
+ */
1724
+ permissions_grant_date?: string;
1725
+ /**
1726
+ *
1727
+ * @type {string}
1728
+ * @memberof LoginIdentity
1729
+ */
1730
+ permissions_expiry_date?: string;
1731
+ /**
1732
+ *
1733
+ * @type {Array<string>}
1734
+ * @memberof LoginIdentity
1735
+ */
1736
+ permissions?: Array<string>;
1737
+ /**
1738
+ *
1739
+ * @type {LoginIdentityBillingDetails}
1740
+ * @memberof LoginIdentity
1741
+ */
1742
+ billing_details?: LoginIdentityBillingDetails;
1743
+ /**
1744
+ *
1745
+ * @type {string}
1746
+ * @memberof LoginIdentity
1747
+ */
1748
+ status?: string;
1749
+ /**
1750
+ *
1751
+ * @type {LoginIdentityStatusDetails}
1752
+ * @memberof LoginIdentity
1753
+ */
1754
+ status_details?: LoginIdentityStatusDetails;
1755
+ /**
1756
+ *
1757
+ * @type {AllProductStatus}
1758
+ * @memberof LoginIdentity
1759
+ */
1760
+ product_status?: AllProductStatus;
1761
+ /**
1762
+ *
1763
+ * @type {ProductStatus}
1764
+ * @memberof LoginIdentity
1765
+ */
1766
+ authentication_status?: ProductStatus;
1767
+ /**
1768
+ *
1769
+ * @type {LoginIdentityError}
1770
+ * @memberof LoginIdentity
1771
+ */
1772
+ error?: LoginIdentityError;
1773
+ /**
1774
+ *
1775
+ * @type {string}
1776
+ * @memberof LoginIdentity
1777
+ */
1778
+ last_success?: string;
1779
+ /**
1780
+ *
1781
+ * @type {string}
1782
+ * @memberof LoginIdentity
1783
+ */
1784
+ first_success?: string;
1785
+ /**
1786
+ *
1787
+ * @type {string}
1788
+ * @memberof LoginIdentity
1789
+ */
1790
+ webhook?: string;
1791
+ /**
1792
+ *
1793
+ * @type {string}
1794
+ * @memberof LoginIdentity
1795
+ */
1796
+ institution_id: string;
1797
+ /**
1798
+ *
1799
+ * @type {string}
1800
+ * @memberof LoginIdentity
1801
+ */
1802
+ created_at?: string;
1803
+ /**
1804
+ *
1805
+ * @type {string}
1806
+ * @memberof LoginIdentity
1807
+ */
1808
+ updated_at?: string;
1809
+ /**
1810
+ * a login attempt id which is unique per login_identity
1811
+ * @type {string}
1812
+ * @memberof LoginIdentity
1813
+ */
1814
+ linking_attempt_id?: string;
1815
+ /**
1816
+ * a successful login attempt id which is unique per login_identity
1817
+ * @type {string}
1818
+ * @memberof LoginIdentity
1819
+ */
1820
+ authentication_id?: string;
1821
+ /**
1822
+ *
1823
+ * @type {string}
1824
+ * @memberof LoginIdentity
1825
+ */
1826
+ last_session_id?: string;
1827
+ }
1828
+ /**
1829
+ *
1830
+ * @export
1831
+ * @interface LoginIdentityBillingDetails
1832
+ */
1833
+ export interface LoginIdentityBillingDetails {
1834
+ /**
1835
+ *
1836
+ * @type {Array<string>}
1837
+ * @memberof LoginIdentityBillingDetails
1838
+ */
1839
+ billed_products?: Array<string>;
1840
+ }
1841
+ /**
1842
+ *
1843
+ * @export
1844
+ * @interface LoginIdentityError
1845
+ */
1846
+ export interface LoginIdentityError {
1847
+ /**
1848
+ *
1849
+ * @type {number}
1850
+ * @memberof LoginIdentityError
1851
+ */
1852
+ code?: number;
1853
+ /**
1854
+ *
1855
+ * @type {string}
1856
+ * @memberof LoginIdentityError
1857
+ */
1858
+ type?: string;
1859
+ /**
1860
+ *
1861
+ * @type {string}
1862
+ * @memberof LoginIdentityError
1863
+ */
1864
+ message?: string;
1865
+ /**
1866
+ *
1867
+ * @type {string}
1868
+ * @memberof LoginIdentityError
1869
+ */
1870
+ details?: string;
1871
+ }
1872
+ /**
1873
+ *
1874
+ * @export
1875
+ * @interface LoginIdentityLoginMethodsAvailable
1876
+ */
1877
+ export interface LoginIdentityLoginMethodsAvailable {
1878
+ /**
1879
+ *
1880
+ * @type {boolean}
1881
+ * @memberof LoginIdentityLoginMethodsAvailable
1882
+ */
1883
+ havePassword?: boolean;
1884
+ /**
1885
+ *
1886
+ * @type {boolean}
1887
+ * @memberof LoginIdentityLoginMethodsAvailable
1888
+ */
1889
+ haveSecret?: boolean;
1890
+ }
1891
+ /**
1892
+ *
1893
+ * @export
1894
+ * @interface LoginIdentityShort
1895
+ */
1896
+ export interface LoginIdentityShort {
1897
+ /**
1898
+ *
1899
+ * @type {string}
1900
+ * @memberof LoginIdentityShort
1901
+ */
1902
+ login_identity_id?: string;
1903
+ /**
1904
+ *
1905
+ * @type {string}
1906
+ * @memberof LoginIdentityShort
1907
+ */
1908
+ status?: string;
1909
+ /**
1910
+ *
1911
+ * @type {string}
1912
+ * @memberof LoginIdentityShort
1913
+ */
1914
+ last_session_id?: string;
1915
+ }
1916
+ /**
1917
+ *
1918
+ * @export
1919
+ * @interface LoginIdentityStatusDetails
1920
+ */
1921
+ export interface LoginIdentityStatusDetails {
1922
+ /**
1923
+ *
1924
+ * @type {string}
1925
+ * @memberof LoginIdentityStatusDetails
1926
+ */
1927
+ event_date?: string;
1928
+ /**
1929
+ *
1930
+ * @type {string}
1931
+ * @memberof LoginIdentityStatusDetails
1932
+ */
1933
+ event_name?: string;
1934
+ }
1935
+ /**
1936
+ *
1937
+ * @export
1938
+ * @interface LoginMethod
1939
+ */
1940
+ export interface LoginMethod {
1941
+ /**
1942
+ *
1943
+ * @type {string}
1944
+ * @memberof LoginMethod
1945
+ */
1946
+ id?: string;
1947
+ /**
1948
+ *
1949
+ * @type {string}
1950
+ * @memberof LoginMethod
1951
+ */
1952
+ name?: string;
1953
+ /**
1954
+ *
1955
+ * @type {Array<LoginField>}
1956
+ * @memberof LoginMethod
1957
+ */
1958
+ login_fields?: Array<LoginField>;
1959
+ }
1960
+ /**
1961
+ *
1962
+ * @export
1963
+ * @interface MonthlyIncomeEstimate
1964
+ */
1965
+ export interface MonthlyIncomeEstimate {
1966
+ /**
1967
+ *
1968
+ * @type {IncomeEstimate}
1969
+ * @memberof MonthlyIncomeEstimate
1970
+ */
1971
+ estimated_income?: IncomeEstimate;
1972
+ /**
1973
+ * The numeric month
1974
+ * @type {number}
1975
+ * @memberof MonthlyIncomeEstimate
1976
+ */
1977
+ month?: number;
1978
+ /**
1979
+ * The year
1980
+ * @type {number}
1981
+ * @memberof MonthlyIncomeEstimate
1982
+ */
1983
+ year?: number;
1984
+ }
1985
+ /**
1986
+ *
1987
+ * @export
1988
+ * @interface OtherInfo
1989
+ */
1990
+ export interface OtherInfo {
1991
+ /**
1992
+ *
1993
+ * @type {string}
1994
+ * @memberof OtherInfo
1995
+ */
1996
+ bank_code?: string;
1997
+ }
1998
+ /**
1999
+ *
2000
+ * @export
2001
+ * @interface PaymentDetails
2002
+ */
2003
+ export interface PaymentDetails {
2004
+ /**
2005
+ *
2006
+ * @type {string}
2007
+ * @memberof PaymentDetails
2008
+ */
2009
+ format?: string;
2010
+ /**
2011
+ *
2012
+ * @type {string}
2013
+ * @memberof PaymentDetails
2014
+ */
2015
+ bic?: string;
2016
+ /**
2017
+ *
2018
+ * @type {string}
2019
+ * @memberof PaymentDetails
2020
+ */
2021
+ bank_fullname?: string;
2022
+ /**
2023
+ *
2024
+ * @type {string}
2025
+ * @memberof PaymentDetails
2026
+ */
2027
+ bank_shortname?: string;
2028
+ /**
2029
+ *
2030
+ * @type {string}
2031
+ * @memberof PaymentDetails
2032
+ */
2033
+ bank_address?: string;
2034
+ /**
2035
+ *
2036
+ * @type {string}
2037
+ * @memberof PaymentDetails
2038
+ */
2039
+ bank_country?: string;
2040
+ /**
2041
+ *
2042
+ * @type {OtherInfo}
2043
+ * @memberof PaymentDetails
2044
+ */
2045
+ other_info?: OtherInfo;
2046
+ }
2047
+ /**
2048
+ *
2049
+ * @export
2050
+ * @interface PaymentInstruction
2051
+ */
2052
+ export interface PaymentInstruction {
2053
+ /**
2054
+ * A id of the user of this payment, need to equal to userId when creating link
2055
+ * @type {string}
2056
+ * @memberof PaymentInstruction
2057
+ */
2058
+ user_id?: string;
2059
+ /**
2060
+ * An id that links this payment to a specific Login Identity
2061
+ * @type {string}
2062
+ * @memberof PaymentInstruction
2063
+ */
2064
+ login_identity_id?: string;
2065
+ /**
2066
+ * Type of payment is being created, please check Documentation on which payment type is supported in each institution
2067
+ * @type {string}
2068
+ * @memberof PaymentInstruction
2069
+ */
2070
+ type?: PaymentInstructionTypeEnum;
2071
+ /**
2072
+ * The recipient name
2073
+ * @type {string}
2074
+ * @memberof PaymentInstruction
2075
+ */
2076
+ recipient_name?: string;
2077
+ /**
2078
+ * The recipient account Id
2079
+ * @type {string}
2080
+ * @memberof PaymentInstruction
2081
+ */
2082
+ recipient_account_id?: string;
2083
+ /**
2084
+ * The sender name
2085
+ * @type {string}
2086
+ * @memberof PaymentInstruction
2087
+ */
2088
+ sender_name?: string;
2089
+ /**
2090
+ * The sender account Id
2091
+ * @type {string}
2092
+ * @memberof PaymentInstruction
2093
+ */
2094
+ sender_account_id?: string;
2095
+ /**
2096
+ * When the payment should start
2097
+ * @type {string}
2098
+ * @memberof PaymentInstruction
2099
+ */
2100
+ start_date?: string | null;
2101
+ /**
2102
+ * When the payment should stop
2103
+ * @type {string}
2104
+ * @memberof PaymentInstruction
2105
+ */
2106
+ end_date?: string | null;
2107
+ /**
2108
+ * The currency for the payment
2109
+ * @type {string}
2110
+ * @memberof PaymentInstruction
2111
+ */
2112
+ currency?: string;
2113
+ /**
2114
+ * The payment amount
2115
+ * @type {number}
2116
+ * @memberof PaymentInstruction
2117
+ */
2118
+ amount?: number;
2119
+ /**
2120
+ * How often the payment should be executed
2121
+ * @type {string}
2122
+ * @memberof PaymentInstruction
2123
+ */
2124
+ frequency?: string;
2125
+ /**
2126
+ * Related remarks about this instruction
2127
+ * @type {string}
2128
+ * @memberof PaymentInstruction
2129
+ */
2130
+ remarks?: string;
2131
+ /**
2132
+ * Status of the payment
2133
+ * @type {string}
2134
+ * @memberof PaymentInstruction
2135
+ */
2136
+ status?: string;
2137
+ /**
2138
+ * Reference identification returned by institution
2139
+ * @type {string}
2140
+ * @memberof PaymentInstruction
2141
+ */
2142
+ reference_id?: string;
2143
+ /**
2144
+ *
2145
+ * @type {string}
2146
+ * @memberof PaymentInstruction
2147
+ */
2148
+ last_update?: string;
2149
+ /**
2150
+ * Extra information collected for this payment instruction
2151
+ * @type {object}
2152
+ * @memberof PaymentInstruction
2153
+ */
2154
+ info?: object;
2155
+ }
2156
+ export declare const PaymentInstructionTypeEnum: {
2157
+ readonly DebitAuthorization: "DEBIT_AUTHORIZATION";
2158
+ };
2159
+ export declare type PaymentInstructionTypeEnum = typeof PaymentInstructionTypeEnum[keyof typeof PaymentInstructionTypeEnum];
2160
+ /**
2161
+ *
2162
+ * @export
2163
+ * @interface Principal
2164
+ */
2165
+ export interface Principal {
2166
+ /**
2167
+ *
2168
+ * @type {string}
2169
+ * @memberof Principal
2170
+ */
2171
+ subject: string;
2172
+ /**
2173
+ *
2174
+ * @type {string}
2175
+ * @memberof Principal
2176
+ */
2177
+ token?: string;
2178
+ /**
2179
+ *
2180
+ * @type {string}
2181
+ * @memberof Principal
2182
+ */
2183
+ client_id: string;
2184
+ /**
2185
+ *
2186
+ * @type {string}
2187
+ * @memberof Principal
2188
+ */
2189
+ customer_app_id: string;
2190
+ /**
2191
+ *
2192
+ * @type {string}
2193
+ * @memberof Principal
2194
+ */
2195
+ login_identity_id: string;
2196
+ /**
2197
+ *
2198
+ * @type {string}
2199
+ * @memberof Principal
2200
+ */
2201
+ customization_id?: string;
2202
+ /**
2203
+ *
2204
+ * @type {number}
2205
+ * @memberof Principal
2206
+ */
2207
+ expires_in?: number;
2208
+ /**
2209
+ *
2210
+ * @type {Array<string>}
2211
+ * @memberof Principal
2212
+ */
2213
+ scopes?: Array<string>;
2214
+ /**
2215
+ *
2216
+ * @type {LinkTokenRequest}
2217
+ * @memberof Principal
2218
+ */
2219
+ link_token_request?: LinkTokenRequest;
2220
+ }
2221
+ /**
2222
+ *
2223
+ * @export
2224
+ * @interface ProductStatus
2225
+ */
2226
+ export interface ProductStatus {
2227
+ /**
2228
+ * The current health of this product
2229
+ * @type {string}
2230
+ * @memberof ProductStatus
2231
+ */
2232
+ status?: string;
2233
+ /**
2234
+ * The detailed event name
2235
+ * @type {string}
2236
+ * @memberof ProductStatus
2237
+ */
2238
+ status_details?: string;
2239
+ /**
2240
+ *
2241
+ * @type {string}
2242
+ * @memberof ProductStatus
2243
+ */
2244
+ last_update?: string | null;
2245
+ /**
2246
+ *
2247
+ * @type {string}
2248
+ * @memberof ProductStatus
2249
+ */
2250
+ last_successful_update?: string | null;
2251
+ }
2252
+ /**
2253
+ *
2254
+ * @export
2255
+ * @interface RedirectUriResponse
2256
+ */
2257
+ export interface RedirectUriResponse {
2258
+ /**
2259
+ *
2260
+ * @type {string}
2261
+ * @memberof RedirectUriResponse
2262
+ */
2263
+ redirect_uri?: string;
2264
+ }
2265
+ /**
2266
+ *
2267
+ * @export
2268
+ * @interface RefreshRequest
2269
+ */
2270
+ export interface RefreshRequest {
2271
+ /**
2272
+ *
2273
+ * @type {string}
2274
+ * @memberof RefreshRequest
2275
+ */
2276
+ refresh_token: string;
2277
+ }
2278
+ /**
2279
+ *
2280
+ * @export
2281
+ * @interface RelinkRequest
2282
+ */
2283
+ export interface RelinkRequest {
2284
+ /**
2285
+ *
2286
+ * @type {boolean}
2287
+ * @memberof RelinkRequest
2288
+ */
2289
+ store_credential: boolean;
2290
+ }
2291
+ /**
2292
+ *
2293
+ * @export
2294
+ * @interface SingleSourceIncome
2295
+ */
2296
+ export interface SingleSourceIncome {
2297
+ /**
2298
+ *
2299
+ * @type {Array<IncomeStream>}
2300
+ * @memberof SingleSourceIncome
2301
+ */
2302
+ income_streams?: Array<IncomeStream>;
2303
+ /**
2304
+ *
2305
+ * @type {IncomeTotal}
2306
+ * @memberof SingleSourceIncome
2307
+ */
2308
+ income_total?: IncomeTotal;
2309
+ /**
2310
+ * Where the income estimate was sourced from
2311
+ * @type {string}
2312
+ * @memberof SingleSourceIncome
2313
+ */
2314
+ source?: string;
2315
+ /**
2316
+ * Unknown
2317
+ * @type {string}
2318
+ * @memberof SingleSourceIncome
2319
+ */
2320
+ source_id?: string;
2321
+ }
2322
+ /**
2323
+ *
2324
+ * @export
2325
+ * @interface Statement
2326
+ */
2327
+ export interface Statement {
2328
+ /**
2329
+ *
2330
+ * @type {string}
2331
+ * @memberof Statement
2332
+ */
2333
+ id?: string;
2334
+ /**
2335
+ * YYYY-MM-DD
2336
+ * @type {string}
2337
+ * @memberof Statement
2338
+ */
2339
+ date?: string;
2340
+ /**
2341
+ *
2342
+ * @type {string}
2343
+ * @memberof Statement
2344
+ */
2345
+ name?: string;
2346
+ /**
2347
+ *
2348
+ * @type {string}
2349
+ * @memberof Statement
2350
+ */
2351
+ created_at?: string;
2352
+ }
2353
+ /**
2354
+ *
2355
+ * @export
2356
+ * @interface StatementLink
2357
+ */
2358
+ export interface StatementLink {
2359
+ /**
2360
+ * signedURL to download statement
2361
+ * @type {string}
2362
+ * @memberof StatementLink
2363
+ */
2364
+ url?: string;
2365
+ /**
2366
+ * expiry of the signedURL
2367
+ * @type {string}
2368
+ * @memberof StatementLink
2369
+ */
2370
+ expiry?: string;
2371
+ /**
2372
+ *
2373
+ * @type {string}
2374
+ * @memberof StatementLink
2375
+ */
2376
+ statement_id?: string;
2377
+ }
2378
+ /**
2379
+ *
2380
+ * @export
2381
+ * @interface TokenRequest
2382
+ */
2383
+ export interface TokenRequest {
2384
+ /**
2385
+ *
2386
+ * @type {string}
2387
+ * @memberof TokenRequest
2388
+ */
2389
+ client_id: string;
2390
+ /**
2391
+ *
2392
+ * @type {string}
2393
+ * @memberof TokenRequest
2394
+ */
2395
+ client_secret: string;
2396
+ /**
2397
+ * support only client_credentials
2398
+ * @type {string}
2399
+ * @memberof TokenRequest
2400
+ */
2401
+ grant_type: string;
2402
+ }
2403
+ /**
2404
+ *
2405
+ * @export
2406
+ * @interface TokenResponse
2407
+ */
2408
+ export interface TokenResponse {
2409
+ /**
2410
+ *
2411
+ * @type {string}
2412
+ * @memberof TokenResponse
2413
+ */
2414
+ access_token: string;
2415
+ /**
2416
+ *
2417
+ * @type {string}
2418
+ * @memberof TokenResponse
2419
+ */
2420
+ token_type: string;
2421
+ /**
2422
+ * seconds
2423
+ * @type {number}
2424
+ * @memberof TokenResponse
2425
+ */
2426
+ expires_in: number;
2427
+ }
2428
+ /**
2429
+ *
2430
+ * @export
2431
+ * @interface Transaction
2432
+ */
2433
+ export interface Transaction {
2434
+ /**
2435
+ *
2436
+ * @type {string}
2437
+ * @memberof Transaction
2438
+ */
2439
+ transaction_id?: string;
2440
+ /**
2441
+ *
2442
+ * @type {string}
2443
+ * @memberof Transaction
2444
+ */
2445
+ account_id?: string;
2446
+ /**
2447
+ *
2448
+ * @type {string}
2449
+ * @memberof Transaction
2450
+ */
2451
+ transaction_state?: string;
2452
+ /**
2453
+ *
2454
+ * @type {string}
2455
+ * @memberof Transaction
2456
+ */
2457
+ transaction_type?: string;
2458
+ /**
2459
+ *
2460
+ * @type {string}
2461
+ * @memberof Transaction
2462
+ */
2463
+ category?: string;
2464
+ /**
2465
+ *
2466
+ * @type {string}
2467
+ * @memberof Transaction
2468
+ */
2469
+ category_id?: string;
2470
+ /**
2471
+ *
2472
+ * @type {string}
2473
+ * @memberof Transaction
2474
+ */
2475
+ merchant_name?: string;
2476
+ /**
2477
+ *
2478
+ * @type {string}
2479
+ * @memberof Transaction
2480
+ */
2481
+ description?: string;
2482
+ /**
2483
+ *
2484
+ * @type {string}
2485
+ * @memberof Transaction
2486
+ */
2487
+ location?: string;
2488
+ /**
2489
+ *
2490
+ * @type {boolean}
2491
+ * @memberof Transaction
2492
+ */
2493
+ is_pending: boolean;
2494
+ /**
2495
+ *
2496
+ * @type {string}
2497
+ * @memberof Transaction
2498
+ */
2499
+ status?: string;
2500
+ /**
2501
+ * YYYY-MM-DD
2502
+ * @type {string}
2503
+ * @memberof Transaction
2504
+ */
2505
+ posted_date?: string;
2506
+ /**
2507
+ * YYYY-MM-DD
2508
+ * @type {string}
2509
+ * @memberof Transaction
2510
+ */
2511
+ transaction_date?: string;
2512
+ /**
2513
+ *
2514
+ * @type {CurrencyAmount}
2515
+ * @memberof Transaction
2516
+ */
2517
+ amount?: CurrencyAmount;
2518
+ /**
2519
+ *
2520
+ * @type {object}
2521
+ * @memberof Transaction
2522
+ */
2523
+ transfer_details?: object;
2524
+ /**
2525
+ *
2526
+ * @type {string}
2527
+ * @memberof Transaction
2528
+ */
2529
+ created_at?: string;
2530
+ /**
2531
+ *
2532
+ * @type {string}
2533
+ * @memberof Transaction
2534
+ */
2535
+ updated_at?: string;
2536
+ }
2537
+ /**
2538
+ * CustomerApi - axios parameter creator
2539
+ * @export
2540
+ */
2541
+ export declare const CustomerApiAxiosParamCreator: (configuration?: Configuration) => {
2542
+ /**
2543
+ * Create a new payment instruction to be used when linking to perform debit authorization
2544
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
2545
+ * @param {*} [options] Override http request option.
2546
+ * @throws {RequiredError}
2547
+ */
2548
+ createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2549
+ /**
2550
+ * generate a link token that can be used to create link
2551
+ * @param {LinkTokenRequest} linkTokenRequest token request
2552
+ * @param {*} [options] Override http request option.
2553
+ * @throws {RequiredError}
2554
+ */
2555
+ generateLinkToken: (linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2556
+ /**
2557
+ * Get a specific institution by institutionId
2558
+ * @param {string} institutionId The institution id
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ */
2562
+ getInstitution: (institutionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2563
+ /**
2564
+ * Get a specific loginIdentity
2565
+ * @param {string} loginIdentityId The login identity id
2566
+ * @param {*} [options] Override http request option.
2567
+ * @throws {RequiredError}
2568
+ */
2569
+ getLoginIdentityById: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2570
+ /**
2571
+ * Get a history of events for a specific loginIdentity
2572
+ * @param {string} loginIdentityId The login identity id
2573
+ * @param {*} [options] Override http request option.
2574
+ * @throws {RequiredError}
2575
+ */
2576
+ getLoginIdentityHistory: (loginIdentityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2577
+ /**
2578
+ * Get payment instructions to be used when linking to perform debit authorization by id
2579
+ * @param {string} paymentInstructionId The id of a payment instruction
2580
+ * @param {*} [options] Override http request option.
2581
+ * @throws {RequiredError}
2582
+ */
2583
+ getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2584
+ /**
2585
+ * Get a list of institutions
2586
+ * @param {string} [country] The country the institution belongs to
2587
+ * @param {Array<string>} [countries] The countries the institution belongs to
2588
+ * @param {string} [productsSupported] The products that this institution supports
2589
+ * @param {string} [institutionType] The type of institution
2590
+ * @param {*} [options] Override http request option.
2591
+ * @throws {RequiredError}
2592
+ */
2593
+ listInstitutions: (country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2594
+ /**
2595
+ * Refresh an access token
2596
+ * @param {RefreshRequest} refreshRequest The refresh token
2597
+ * @param {*} [options] Override http request option.
2598
+ * @throws {RequiredError}
2599
+ */
2600
+ refreshToken: (refreshRequest: RefreshRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2601
+ };
2602
+ /**
2603
+ * CustomerApi - functional programming interface
2604
+ * @export
2605
+ */
2606
+ export declare const CustomerApiFp: (configuration?: Configuration) => {
2607
+ /**
2608
+ * Create a new payment instruction to be used when linking to perform debit authorization
2609
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
2610
+ * @param {*} [options] Override http request option.
2611
+ * @throws {RequiredError}
2612
+ */
2613
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
2614
+ /**
2615
+ * generate a link token that can be used to create link
2616
+ * @param {LinkTokenRequest} linkTokenRequest token request
2617
+ * @param {*} [options] Override http request option.
2618
+ * @throws {RequiredError}
2619
+ */
2620
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkTokenResponse>>;
2621
+ /**
2622
+ * Get a specific institution by institutionId
2623
+ * @param {string} institutionId The institution id
2624
+ * @param {*} [options] Override http request option.
2625
+ * @throws {RequiredError}
2626
+ */
2627
+ getInstitution(institutionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Institution>>;
2628
+ /**
2629
+ * Get a specific loginIdentity
2630
+ * @param {string} loginIdentityId The login identity id
2631
+ * @param {*} [options] Override http request option.
2632
+ * @throws {RequiredError}
2633
+ */
2634
+ getLoginIdentityById(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityByIdResponse>>;
2635
+ /**
2636
+ * Get a history of events for a specific loginIdentity
2637
+ * @param {string} loginIdentityId The login identity id
2638
+ * @param {*} [options] Override http request option.
2639
+ * @throws {RequiredError}
2640
+ */
2641
+ getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityHistoryResponse>>;
2642
+ /**
2643
+ * Get payment instructions to be used when linking to perform debit authorization by id
2644
+ * @param {string} paymentInstructionId The id of a payment instruction
2645
+ * @param {*} [options] Override http request option.
2646
+ * @throws {RequiredError}
2647
+ */
2648
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
2649
+ /**
2650
+ * Get a list of institutions
2651
+ * @param {string} [country] The country the institution belongs to
2652
+ * @param {Array<string>} [countries] The countries the institution belongs to
2653
+ * @param {string} [productsSupported] The products that this institution supports
2654
+ * @param {string} [institutionType] The type of institution
2655
+ * @param {*} [options] Override http request option.
2656
+ * @throws {RequiredError}
2657
+ */
2658
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Institution>>>;
2659
+ /**
2660
+ * Refresh an access token
2661
+ * @param {RefreshRequest} refreshRequest The refresh token
2662
+ * @param {*} [options] Override http request option.
2663
+ * @throws {RequiredError}
2664
+ */
2665
+ refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessTokenResponse>>;
2666
+ };
2667
+ /**
2668
+ * CustomerApi - factory interface
2669
+ * @export
2670
+ */
2671
+ export declare const CustomerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2672
+ /**
2673
+ * Create a new payment instruction to be used when linking to perform debit authorization
2674
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
2675
+ * @param {*} [options] Override http request option.
2676
+ * @throws {RequiredError}
2677
+ */
2678
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
2679
+ /**
2680
+ * generate a link token that can be used to create link
2681
+ * @param {LinkTokenRequest} linkTokenRequest token request
2682
+ * @param {*} [options] Override http request option.
2683
+ * @throws {RequiredError}
2684
+ */
2685
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: any): AxiosPromise<LinkTokenResponse>;
2686
+ /**
2687
+ * Get a specific institution by institutionId
2688
+ * @param {string} institutionId The institution id
2689
+ * @param {*} [options] Override http request option.
2690
+ * @throws {RequiredError}
2691
+ */
2692
+ getInstitution(institutionId: string, options?: any): AxiosPromise<Institution>;
2693
+ /**
2694
+ * Get a specific loginIdentity
2695
+ * @param {string} loginIdentityId The login identity id
2696
+ * @param {*} [options] Override http request option.
2697
+ * @throws {RequiredError}
2698
+ */
2699
+ getLoginIdentityById(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityByIdResponse>;
2700
+ /**
2701
+ * Get a history of events for a specific loginIdentity
2702
+ * @param {string} loginIdentityId The login identity id
2703
+ * @param {*} [options] Override http request option.
2704
+ * @throws {RequiredError}
2705
+ */
2706
+ getLoginIdentityHistory(loginIdentityId: string, options?: any): AxiosPromise<GetLoginIdentityHistoryResponse>;
2707
+ /**
2708
+ * Get payment instructions to be used when linking to perform debit authorization by id
2709
+ * @param {string} paymentInstructionId The id of a payment instruction
2710
+ * @param {*} [options] Override http request option.
2711
+ * @throws {RequiredError}
2712
+ */
2713
+ getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
2714
+ /**
2715
+ * Get a list of institutions
2716
+ * @param {string} [country] The country the institution belongs to
2717
+ * @param {Array<string>} [countries] The countries the institution belongs to
2718
+ * @param {string} [productsSupported] The products that this institution supports
2719
+ * @param {string} [institutionType] The type of institution
2720
+ * @param {*} [options] Override http request option.
2721
+ * @throws {RequiredError}
2722
+ */
2723
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: any): AxiosPromise<Array<Institution>>;
2724
+ /**
2725
+ * Refresh an access token
2726
+ * @param {RefreshRequest} refreshRequest The refresh token
2727
+ * @param {*} [options] Override http request option.
2728
+ * @throws {RequiredError}
2729
+ */
2730
+ refreshToken(refreshRequest: RefreshRequest, options?: any): AxiosPromise<AccessTokenResponse>;
2731
+ };
2732
+ /**
2733
+ * CustomerApi - interface
2734
+ * @export
2735
+ * @interface CustomerApi
2736
+ */
2737
+ export interface CustomerApiInterface {
2738
+ /**
2739
+ * Create a new payment instruction to be used when linking to perform debit authorization
2740
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
2741
+ * @param {*} [options] Override http request option.
2742
+ * @throws {RequiredError}
2743
+ * @memberof CustomerApiInterface
2744
+ */
2745
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
2746
+ /**
2747
+ * generate a link token that can be used to create link
2748
+ * @param {LinkTokenRequest} linkTokenRequest token request
2749
+ * @param {*} [options] Override http request option.
2750
+ * @throws {RequiredError}
2751
+ * @memberof CustomerApiInterface
2752
+ */
2753
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): AxiosPromise<LinkTokenResponse>;
2754
+ /**
2755
+ * Get a specific institution by institutionId
2756
+ * @param {string} institutionId The institution id
2757
+ * @param {*} [options] Override http request option.
2758
+ * @throws {RequiredError}
2759
+ * @memberof CustomerApiInterface
2760
+ */
2761
+ getInstitution(institutionId: string, options?: AxiosRequestConfig): AxiosPromise<Institution>;
2762
+ /**
2763
+ * Get a specific loginIdentity
2764
+ * @param {string} loginIdentityId The login identity id
2765
+ * @param {*} [options] Override http request option.
2766
+ * @throws {RequiredError}
2767
+ * @memberof CustomerApiInterface
2768
+ */
2769
+ getLoginIdentityById(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityByIdResponse>;
2770
+ /**
2771
+ * Get a history of events for a specific loginIdentity
2772
+ * @param {string} loginIdentityId The login identity id
2773
+ * @param {*} [options] Override http request option.
2774
+ * @throws {RequiredError}
2775
+ * @memberof CustomerApiInterface
2776
+ */
2777
+ getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityHistoryResponse>;
2778
+ /**
2779
+ * Get payment instructions to be used when linking to perform debit authorization by id
2780
+ * @param {string} paymentInstructionId The id of a payment instruction
2781
+ * @param {*} [options] Override http request option.
2782
+ * @throws {RequiredError}
2783
+ * @memberof CustomerApiInterface
2784
+ */
2785
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
2786
+ /**
2787
+ * Get a list of institutions
2788
+ * @param {string} [country] The country the institution belongs to
2789
+ * @param {Array<string>} [countries] The countries the institution belongs to
2790
+ * @param {string} [productsSupported] The products that this institution supports
2791
+ * @param {string} [institutionType] The type of institution
2792
+ * @param {*} [options] Override http request option.
2793
+ * @throws {RequiredError}
2794
+ * @memberof CustomerApiInterface
2795
+ */
2796
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): AxiosPromise<Array<Institution>>;
2797
+ /**
2798
+ * Refresh an access token
2799
+ * @param {RefreshRequest} refreshRequest The refresh token
2800
+ * @param {*} [options] Override http request option.
2801
+ * @throws {RequiredError}
2802
+ * @memberof CustomerApiInterface
2803
+ */
2804
+ refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): AxiosPromise<AccessTokenResponse>;
2805
+ }
2806
+ /**
2807
+ * CustomerApi - object-oriented interface
2808
+ * @export
2809
+ * @class CustomerApi
2810
+ * @extends {BaseAPI}
2811
+ */
2812
+ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
2813
+ /**
2814
+ * Create a new payment instruction to be used when linking to perform debit authorization
2815
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
2816
+ * @param {*} [options] Override http request option.
2817
+ * @throws {RequiredError}
2818
+ * @memberof CustomerApi
2819
+ */
2820
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
2821
+ /**
2822
+ * generate a link token that can be used to create link
2823
+ * @param {LinkTokenRequest} linkTokenRequest token request
2824
+ * @param {*} [options] Override http request option.
2825
+ * @throws {RequiredError}
2826
+ * @memberof CustomerApi
2827
+ */
2828
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkTokenResponse>>;
2829
+ /**
2830
+ * Get a specific institution by institutionId
2831
+ * @param {string} institutionId The institution id
2832
+ * @param {*} [options] Override http request option.
2833
+ * @throws {RequiredError}
2834
+ * @memberof CustomerApi
2835
+ */
2836
+ getInstitution(institutionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Institution>>;
2837
+ /**
2838
+ * Get a specific loginIdentity
2839
+ * @param {string} loginIdentityId The login identity id
2840
+ * @param {*} [options] Override http request option.
2841
+ * @throws {RequiredError}
2842
+ * @memberof CustomerApi
2843
+ */
2844
+ getLoginIdentityById(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityByIdResponse>>;
2845
+ /**
2846
+ * Get a history of events for a specific loginIdentity
2847
+ * @param {string} loginIdentityId The login identity id
2848
+ * @param {*} [options] Override http request option.
2849
+ * @throws {RequiredError}
2850
+ * @memberof CustomerApi
2851
+ */
2852
+ getLoginIdentityHistory(loginIdentityId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityHistoryResponse>>;
2853
+ /**
2854
+ * Get payment instructions to be used when linking to perform debit authorization by id
2855
+ * @param {string} paymentInstructionId The id of a payment instruction
2856
+ * @param {*} [options] Override http request option.
2857
+ * @throws {RequiredError}
2858
+ * @memberof CustomerApi
2859
+ */
2860
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
2861
+ /**
2862
+ * Get a list of institutions
2863
+ * @param {string} [country] The country the institution belongs to
2864
+ * @param {Array<string>} [countries] The countries the institution belongs to
2865
+ * @param {string} [productsSupported] The products that this institution supports
2866
+ * @param {string} [institutionType] The type of institution
2867
+ * @param {*} [options] Override http request option.
2868
+ * @throws {RequiredError}
2869
+ * @memberof CustomerApi
2870
+ */
2871
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Institution[]>>;
2872
+ /**
2873
+ * Refresh an access token
2874
+ * @param {RefreshRequest} refreshRequest The refresh token
2875
+ * @param {*} [options] Override http request option.
2876
+ * @throws {RequiredError}
2877
+ * @memberof CustomerApi
2878
+ */
2879
+ refreshToken(refreshRequest: RefreshRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessTokenResponse>>;
2880
+ }
2881
+ /**
2882
+ * LinkApi - axios parameter creator
2883
+ * @export
2884
+ */
2885
+ export declare const LinkApiAxiosParamCreator: (configuration?: Configuration) => {
2886
+ /**
2887
+ * Creates a new link
2888
+ * @param {LinkRequest} linkRequest Request body for starting a new Link
2889
+ * @param {*} [options] Override http request option.
2890
+ * @throws {RequiredError}
2891
+ */
2892
+ createLink: (linkRequest: LinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2893
+ /**
2894
+ * Get the customization details
2895
+ * @param {*} [options] Override http request option.
2896
+ * @throws {RequiredError}
2897
+ */
2898
+ getCustomization: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
2899
+ /**
2900
+ * Get a list of institutions
2901
+ * @param {string} [country] The country the institution belongs to
2902
+ * @param {Array<string>} [countries] The countries the institution belongs to
2903
+ * @param {string} [productsSupported] The products that this institution supports
2904
+ * @param {string} [institutionType] The type of institution
2905
+ * @param {*} [options] Override http request option.
2906
+ * @throws {RequiredError}
2907
+ */
2908
+ listInstitutions: (country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2909
+ /**
2910
+ * Update an existing link
2911
+ * @param {RelinkRequest} relinkRequest Request body for updating Link
2912
+ * @param {*} [options] Override http request option.
2913
+ * @throws {RequiredError}
2914
+ */
2915
+ relink: (relinkRequest: RelinkRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2916
+ /**
2917
+ * Exchange authorization code for token
2918
+ * @param {string} grantType
2919
+ * @param {string} code
2920
+ * @param {string} clientId
2921
+ * @param {string} redirectUri
2922
+ * @param {*} [options] Override http request option.
2923
+ * @throws {RequiredError}
2924
+ */
2925
+ token: (grantType: string, code: string, clientId: string, redirectUri: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2926
+ };
2927
+ /**
2928
+ * LinkApi - functional programming interface
2929
+ * @export
2930
+ */
2931
+ export declare const LinkApiFp: (configuration?: Configuration) => {
2932
+ /**
2933
+ * Creates a new link
2934
+ * @param {LinkRequest} linkRequest Request body for starting a new Link
2935
+ * @param {*} [options] Override http request option.
2936
+ * @throws {RequiredError}
2937
+ */
2938
+ createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkResponse>>;
2939
+ /**
2940
+ * Get the customization details
2941
+ * @param {*} [options] Override http request option.
2942
+ * @throws {RequiredError}
2943
+ */
2944
+ getCustomization(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomizationDetails>>;
2945
+ /**
2946
+ * Get a list of institutions
2947
+ * @param {string} [country] The country the institution belongs to
2948
+ * @param {Array<string>} [countries] The countries the institution belongs to
2949
+ * @param {string} [productsSupported] The products that this institution supports
2950
+ * @param {string} [institutionType] The type of institution
2951
+ * @param {*} [options] Override http request option.
2952
+ * @throws {RequiredError}
2953
+ */
2954
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Institution>>>;
2955
+ /**
2956
+ * Update an existing link
2957
+ * @param {RelinkRequest} relinkRequest Request body for updating Link
2958
+ * @param {*} [options] Override http request option.
2959
+ * @throws {RequiredError}
2960
+ */
2961
+ relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkResponse>>;
2962
+ /**
2963
+ * Exchange authorization code for token
2964
+ * @param {string} grantType
2965
+ * @param {string} code
2966
+ * @param {string} clientId
2967
+ * @param {string} redirectUri
2968
+ * @param {*} [options] Override http request option.
2969
+ * @throws {RequiredError}
2970
+ */
2971
+ token(grantType: string, code: string, clientId: string, redirectUri: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessTokenResponse>>;
2972
+ };
2973
+ /**
2974
+ * LinkApi - factory interface
2975
+ * @export
2976
+ */
2977
+ export declare const LinkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2978
+ /**
2979
+ * Creates a new link
2980
+ * @param {LinkRequest} linkRequest Request body for starting a new Link
2981
+ * @param {*} [options] Override http request option.
2982
+ * @throws {RequiredError}
2983
+ */
2984
+ createLink(linkRequest: LinkRequest, options?: any): AxiosPromise<LinkResponse>;
2985
+ /**
2986
+ * Get the customization details
2987
+ * @param {*} [options] Override http request option.
2988
+ * @throws {RequiredError}
2989
+ */
2990
+ getCustomization(options?: any): AxiosPromise<CustomizationDetails>;
2991
+ /**
2992
+ * Get a list of institutions
2993
+ * @param {string} [country] The country the institution belongs to
2994
+ * @param {Array<string>} [countries] The countries the institution belongs to
2995
+ * @param {string} [productsSupported] The products that this institution supports
2996
+ * @param {string} [institutionType] The type of institution
2997
+ * @param {*} [options] Override http request option.
2998
+ * @throws {RequiredError}
2999
+ */
3000
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: any): AxiosPromise<Array<Institution>>;
3001
+ /**
3002
+ * Update an existing link
3003
+ * @param {RelinkRequest} relinkRequest Request body for updating Link
3004
+ * @param {*} [options] Override http request option.
3005
+ * @throws {RequiredError}
3006
+ */
3007
+ relink(relinkRequest: RelinkRequest, options?: any): AxiosPromise<LinkResponse>;
3008
+ /**
3009
+ * Exchange authorization code for token
3010
+ * @param {string} grantType
3011
+ * @param {string} code
3012
+ * @param {string} clientId
3013
+ * @param {string} redirectUri
3014
+ * @param {*} [options] Override http request option.
3015
+ * @throws {RequiredError}
3016
+ */
3017
+ token(grantType: string, code: string, clientId: string, redirectUri: string, options?: any): AxiosPromise<AccessTokenResponse>;
3018
+ };
3019
+ /**
3020
+ * LinkApi - interface
3021
+ * @export
3022
+ * @interface LinkApi
3023
+ */
3024
+ export interface LinkApiInterface {
3025
+ /**
3026
+ * Creates a new link
3027
+ * @param {LinkRequest} linkRequest Request body for starting a new Link
3028
+ * @param {*} [options] Override http request option.
3029
+ * @throws {RequiredError}
3030
+ * @memberof LinkApiInterface
3031
+ */
3032
+ createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): AxiosPromise<LinkResponse>;
3033
+ /**
3034
+ * Get the customization details
3035
+ * @param {*} [options] Override http request option.
3036
+ * @throws {RequiredError}
3037
+ * @memberof LinkApiInterface
3038
+ */
3039
+ getCustomization(options?: AxiosRequestConfig): AxiosPromise<CustomizationDetails>;
3040
+ /**
3041
+ * Get a list of institutions
3042
+ * @param {string} [country] The country the institution belongs to
3043
+ * @param {Array<string>} [countries] The countries the institution belongs to
3044
+ * @param {string} [productsSupported] The products that this institution supports
3045
+ * @param {string} [institutionType] The type of institution
3046
+ * @param {*} [options] Override http request option.
3047
+ * @throws {RequiredError}
3048
+ * @memberof LinkApiInterface
3049
+ */
3050
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): AxiosPromise<Array<Institution>>;
3051
+ /**
3052
+ * Update an existing link
3053
+ * @param {RelinkRequest} relinkRequest Request body for updating Link
3054
+ * @param {*} [options] Override http request option.
3055
+ * @throws {RequiredError}
3056
+ * @memberof LinkApiInterface
3057
+ */
3058
+ relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): AxiosPromise<LinkResponse>;
3059
+ /**
3060
+ * Exchange authorization code for token
3061
+ * @param {string} grantType
3062
+ * @param {string} code
3063
+ * @param {string} clientId
3064
+ * @param {string} redirectUri
3065
+ * @param {*} [options] Override http request option.
3066
+ * @throws {RequiredError}
3067
+ * @memberof LinkApiInterface
3068
+ */
3069
+ token(grantType: string, code: string, clientId: string, redirectUri: string, options?: AxiosRequestConfig): AxiosPromise<AccessTokenResponse>;
3070
+ }
3071
+ /**
3072
+ * LinkApi - object-oriented interface
3073
+ * @export
3074
+ * @class LinkApi
3075
+ * @extends {BaseAPI}
3076
+ */
3077
+ export declare class LinkApi extends BaseAPI implements LinkApiInterface {
3078
+ /**
3079
+ * Creates a new link
3080
+ * @param {LinkRequest} linkRequest Request body for starting a new Link
3081
+ * @param {*} [options] Override http request option.
3082
+ * @throws {RequiredError}
3083
+ * @memberof LinkApi
3084
+ */
3085
+ createLink(linkRequest: LinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkResponse>>;
3086
+ /**
3087
+ * Get the customization details
3088
+ * @param {*} [options] Override http request option.
3089
+ * @throws {RequiredError}
3090
+ * @memberof LinkApi
3091
+ */
3092
+ getCustomization(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomizationDetails>>;
3093
+ /**
3094
+ * Get a list of institutions
3095
+ * @param {string} [country] The country the institution belongs to
3096
+ * @param {Array<string>} [countries] The countries the institution belongs to
3097
+ * @param {string} [productsSupported] The products that this institution supports
3098
+ * @param {string} [institutionType] The type of institution
3099
+ * @param {*} [options] Override http request option.
3100
+ * @throws {RequiredError}
3101
+ * @memberof LinkApi
3102
+ */
3103
+ listInstitutions(country?: string, countries?: Array<string>, productsSupported?: string, institutionType?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Institution[]>>;
3104
+ /**
3105
+ * Update an existing link
3106
+ * @param {RelinkRequest} relinkRequest Request body for updating Link
3107
+ * @param {*} [options] Override http request option.
3108
+ * @throws {RequiredError}
3109
+ * @memberof LinkApi
3110
+ */
3111
+ relink(relinkRequest: RelinkRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkResponse>>;
3112
+ /**
3113
+ * Exchange authorization code for token
3114
+ * @param {string} grantType
3115
+ * @param {string} code
3116
+ * @param {string} clientId
3117
+ * @param {string} redirectUri
3118
+ * @param {*} [options] Override http request option.
3119
+ * @throws {RequiredError}
3120
+ * @memberof LinkApi
3121
+ */
3122
+ token(grantType: string, code: string, clientId: string, redirectUri: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessTokenResponse>>;
3123
+ }
3124
+ /**
3125
+ * LoginIdentityApi - axios parameter creator
3126
+ * @export
3127
+ */
3128
+ export declare const LoginIdentityApiAxiosParamCreator: (configuration?: Configuration) => {
3129
+ /**
3130
+ * Delete a specific loginIdentity
3131
+ * @param {*} [options] Override http request option.
3132
+ * @throws {RequiredError}
3133
+ */
3134
+ deleteLoginIdentity: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3135
+ /**
3136
+ * generate a link token that can be used to create link
3137
+ * @param {LinkTokenRequest} linkTokenRequest token request
3138
+ * @param {*} [options] Override http request option.
3139
+ * @throws {RequiredError}
3140
+ */
3141
+ generateLinkToken: (linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3142
+ /**
3143
+ * Get a specific account\'s information
3144
+ * @param {string} accountId The account id
3145
+ * @param {*} [options] Override http request option.
3146
+ * @throws {RequiredError}
3147
+ */
3148
+ getAccount: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3149
+ /**
3150
+ * Get the account number for a specific account
3151
+ * @param {string} accountId The account id
3152
+ * @param {*} [options] Override http request option.
3153
+ * @throws {RequiredError}
3154
+ */
3155
+ getAccountNumber: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3156
+ /**
3157
+ * Get the balance history for a specific account
3158
+ * @param {string} accountId The account id
3159
+ * @param {*} [options] Override http request option.
3160
+ * @throws {RequiredError}
3161
+ */
3162
+ getBalanceHistory: (accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3163
+ /**
3164
+ * \\[BETA] Get a list of identity data for a given login identity
3165
+ * @param {*} [options] Override http request option.
3166
+ * @throws {RequiredError}
3167
+ */
3168
+ getIdentity: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3169
+ /**
3170
+ * Get income figures for a login identity
3171
+ * @param {*} [options] Override http request option.
3172
+ * @throws {RequiredError}
3173
+ */
3174
+ getIncomeEstimateByLoginIdentityId: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3175
+ /**
3176
+ * Get a specific loginIdentity
3177
+ * @param {*} [options] Override http request option.
3178
+ * @throws {RequiredError}
3179
+ */
3180
+ getLoginIdentity: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3181
+ /**
3182
+ * Download statement
3183
+ * @param {string} statementId The statement id
3184
+ * @param {*} [options] Override http request option.
3185
+ * @throws {RequiredError}
3186
+ */
3187
+ getStatement: (statementId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3188
+ /**
3189
+ * Get statement link for download
3190
+ * @param {string} statementId The statement id
3191
+ * @param {*} [options] Override http request option.
3192
+ * @throws {RequiredError}
3193
+ */
3194
+ getStatementLink: (statementId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3195
+ /**
3196
+ * Get list of available statements
3197
+ * @param {*} [options] Override http request option.
3198
+ * @throws {RequiredError}
3199
+ */
3200
+ getStatements: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3201
+ /**
3202
+ * Get a list of accounts for a login identity
3203
+ * @param {*} [options] Override http request option.
3204
+ * @throws {RequiredError}
3205
+ */
3206
+ listAccounts: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3207
+ /**
3208
+ * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
3209
+ * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
3210
+ * @param {number} [offset] default is 0
3211
+ * @param {number} [limit] default is 500, max is 1000
3212
+ * @param {*} [options] Override http request option.
3213
+ * @throws {RequiredError}
3214
+ */
3215
+ listTransactionsByAccountId: (accountId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3216
+ /**
3217
+ * Get a list of transactions for a login identity. The transactions are returned in sorted order, with the most recent one appearing first.
3218
+ * @param {number} [offset] default is 0
3219
+ * @param {number} [limit] default is 500, max is 1000
3220
+ * @param {*} [options] Override http request option.
3221
+ * @throws {RequiredError}
3222
+ */
3223
+ listTransactionsByLoginIdentityId: (offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3224
+ /**
3225
+ * Create a refresh job for a login identity
3226
+ * @param {*} [options] Override http request option.
3227
+ * @throws {RequiredError}
3228
+ */
3229
+ refreshLoginIdentity: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
3230
+ };
3231
+ /**
3232
+ * LoginIdentityApi - functional programming interface
3233
+ * @export
3234
+ */
3235
+ export declare const LoginIdentityApiFp: (configuration?: Configuration) => {
3236
+ /**
3237
+ * Delete a specific loginIdentity
3238
+ * @param {*} [options] Override http request option.
3239
+ * @throws {RequiredError}
3240
+ */
3241
+ deleteLoginIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteLoginIdentityResponse>>;
3242
+ /**
3243
+ * generate a link token that can be used to create link
3244
+ * @param {LinkTokenRequest} linkTokenRequest token request
3245
+ * @param {*} [options] Override http request option.
3246
+ * @throws {RequiredError}
3247
+ */
3248
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkTokenResponse>>;
3249
+ /**
3250
+ * Get a specific account\'s information
3251
+ * @param {string} accountId The account id
3252
+ * @param {*} [options] Override http request option.
3253
+ * @throws {RequiredError}
3254
+ */
3255
+ getAccount(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
3256
+ /**
3257
+ * Get the account number for a specific account
3258
+ * @param {string} accountId The account id
3259
+ * @param {*} [options] Override http request option.
3260
+ * @throws {RequiredError}
3261
+ */
3262
+ getAccountNumber(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountNumberResponse>>;
3263
+ /**
3264
+ * Get the balance history for a specific account
3265
+ * @param {string} accountId The account id
3266
+ * @param {*} [options] Override http request option.
3267
+ * @throws {RequiredError}
3268
+ */
3269
+ getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBalanceHistoryResponse>>;
3270
+ /**
3271
+ * \\[BETA] Get a list of identity data for a given login identity
3272
+ * @param {*} [options] Override http request option.
3273
+ * @throws {RequiredError}
3274
+ */
3275
+ getIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetIdentityResponse>>;
3276
+ /**
3277
+ * Get income figures for a login identity
3278
+ * @param {*} [options] Override http request option.
3279
+ * @throws {RequiredError}
3280
+ */
3281
+ getIncomeEstimateByLoginIdentityId(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IncomeResponse>>;
3282
+ /**
3283
+ * Get a specific loginIdentity
3284
+ * @param {*} [options] Override http request option.
3285
+ * @throws {RequiredError}
3286
+ */
3287
+ getLoginIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginIdentityByIdResponse>>;
3288
+ /**
3289
+ * Download statement
3290
+ * @param {string} statementId The statement id
3291
+ * @param {*} [options] Override http request option.
3292
+ * @throws {RequiredError}
3293
+ */
3294
+ getStatement(statementId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3295
+ /**
3296
+ * Get statement link for download
3297
+ * @param {string} statementId The statement id
3298
+ * @param {*} [options] Override http request option.
3299
+ * @throws {RequiredError}
3300
+ */
3301
+ getStatementLink(statementId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatementLinkResponse>>;
3302
+ /**
3303
+ * Get list of available statements
3304
+ * @param {*} [options] Override http request option.
3305
+ * @throws {RequiredError}
3306
+ */
3307
+ getStatements(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatementsResponse>>;
3308
+ /**
3309
+ * Get a list of accounts for a login identity
3310
+ * @param {*} [options] Override http request option.
3311
+ * @throws {RequiredError}
3312
+ */
3313
+ listAccounts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAccountsResponse>>;
3314
+ /**
3315
+ * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
3316
+ * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
3317
+ * @param {number} [offset] default is 0
3318
+ * @param {number} [limit] default is 500, max is 1000
3319
+ * @param {*} [options] Override http request option.
3320
+ * @throws {RequiredError}
3321
+ */
3322
+ listTransactionsByAccountId(accountId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
3323
+ /**
3324
+ * Get a list of transactions for a login identity. The transactions are returned in sorted order, with the most recent one appearing first.
3325
+ * @param {number} [offset] default is 0
3326
+ * @param {number} [limit] default is 500, max is 1000
3327
+ * @param {*} [options] Override http request option.
3328
+ * @throws {RequiredError}
3329
+ */
3330
+ listTransactionsByLoginIdentityId(offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
3331
+ /**
3332
+ * Create a refresh job for a login identity
3333
+ * @param {*} [options] Override http request option.
3334
+ * @throws {RequiredError}
3335
+ */
3336
+ refreshLoginIdentity(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
3337
+ };
3338
+ /**
3339
+ * LoginIdentityApi - factory interface
3340
+ * @export
3341
+ */
3342
+ export declare const LoginIdentityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3343
+ /**
3344
+ * Delete a specific loginIdentity
3345
+ * @param {*} [options] Override http request option.
3346
+ * @throws {RequiredError}
3347
+ */
3348
+ deleteLoginIdentity(options?: any): AxiosPromise<DeleteLoginIdentityResponse>;
3349
+ /**
3350
+ * generate a link token that can be used to create link
3351
+ * @param {LinkTokenRequest} linkTokenRequest token request
3352
+ * @param {*} [options] Override http request option.
3353
+ * @throws {RequiredError}
3354
+ */
3355
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: any): AxiosPromise<LinkTokenResponse>;
3356
+ /**
3357
+ * Get a specific account\'s information
3358
+ * @param {string} accountId The account id
3359
+ * @param {*} [options] Override http request option.
3360
+ * @throws {RequiredError}
3361
+ */
3362
+ getAccount(accountId: string, options?: any): AxiosPromise<GetAccountResponse>;
3363
+ /**
3364
+ * Get the account number for a specific account
3365
+ * @param {string} accountId The account id
3366
+ * @param {*} [options] Override http request option.
3367
+ * @throws {RequiredError}
3368
+ */
3369
+ getAccountNumber(accountId: string, options?: any): AxiosPromise<GetAccountNumberResponse>;
3370
+ /**
3371
+ * Get the balance history for a specific account
3372
+ * @param {string} accountId The account id
3373
+ * @param {*} [options] Override http request option.
3374
+ * @throws {RequiredError}
3375
+ */
3376
+ getBalanceHistory(accountId: string, options?: any): AxiosPromise<GetBalanceHistoryResponse>;
3377
+ /**
3378
+ * \\[BETA] Get a list of identity data for a given login identity
3379
+ * @param {*} [options] Override http request option.
3380
+ * @throws {RequiredError}
3381
+ */
3382
+ getIdentity(options?: any): AxiosPromise<GetIdentityResponse>;
3383
+ /**
3384
+ * Get income figures for a login identity
3385
+ * @param {*} [options] Override http request option.
3386
+ * @throws {RequiredError}
3387
+ */
3388
+ getIncomeEstimateByLoginIdentityId(options?: any): AxiosPromise<IncomeResponse>;
3389
+ /**
3390
+ * Get a specific loginIdentity
3391
+ * @param {*} [options] Override http request option.
3392
+ * @throws {RequiredError}
3393
+ */
3394
+ getLoginIdentity(options?: any): AxiosPromise<GetLoginIdentityByIdResponse>;
3395
+ /**
3396
+ * Download statement
3397
+ * @param {string} statementId The statement id
3398
+ * @param {*} [options] Override http request option.
3399
+ * @throws {RequiredError}
3400
+ */
3401
+ getStatement(statementId: string, options?: any): AxiosPromise<void>;
3402
+ /**
3403
+ * Get statement link for download
3404
+ * @param {string} statementId The statement id
3405
+ * @param {*} [options] Override http request option.
3406
+ * @throws {RequiredError}
3407
+ */
3408
+ getStatementLink(statementId: string, options?: any): AxiosPromise<GetStatementLinkResponse>;
3409
+ /**
3410
+ * Get list of available statements
3411
+ * @param {*} [options] Override http request option.
3412
+ * @throws {RequiredError}
3413
+ */
3414
+ getStatements(options?: any): AxiosPromise<GetStatementsResponse>;
3415
+ /**
3416
+ * Get a list of accounts for a login identity
3417
+ * @param {*} [options] Override http request option.
3418
+ * @throws {RequiredError}
3419
+ */
3420
+ listAccounts(options?: any): AxiosPromise<ListAccountsResponse>;
3421
+ /**
3422
+ * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
3423
+ * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
3424
+ * @param {number} [offset] default is 0
3425
+ * @param {number} [limit] default is 500, max is 1000
3426
+ * @param {*} [options] Override http request option.
3427
+ * @throws {RequiredError}
3428
+ */
3429
+ listTransactionsByAccountId(accountId: string, offset?: number, limit?: number, options?: any): AxiosPromise<ListTransactionsResponse>;
3430
+ /**
3431
+ * Get a list of transactions for a login identity. The transactions are returned in sorted order, with the most recent one appearing first.
3432
+ * @param {number} [offset] default is 0
3433
+ * @param {number} [limit] default is 500, max is 1000
3434
+ * @param {*} [options] Override http request option.
3435
+ * @throws {RequiredError}
3436
+ */
3437
+ listTransactionsByLoginIdentityId(offset?: number, limit?: number, options?: any): AxiosPromise<ListTransactionsResponse>;
3438
+ /**
3439
+ * Create a refresh job for a login identity
3440
+ * @param {*} [options] Override http request option.
3441
+ * @throws {RequiredError}
3442
+ */
3443
+ refreshLoginIdentity(options?: any): AxiosPromise<void>;
3444
+ };
3445
+ /**
3446
+ * LoginIdentityApi - interface
3447
+ * @export
3448
+ * @interface LoginIdentityApi
3449
+ */
3450
+ export interface LoginIdentityApiInterface {
3451
+ /**
3452
+ * Delete a specific loginIdentity
3453
+ * @param {*} [options] Override http request option.
3454
+ * @throws {RequiredError}
3455
+ * @memberof LoginIdentityApiInterface
3456
+ */
3457
+ deleteLoginIdentity(options?: AxiosRequestConfig): AxiosPromise<DeleteLoginIdentityResponse>;
3458
+ /**
3459
+ * generate a link token that can be used to create link
3460
+ * @param {LinkTokenRequest} linkTokenRequest token request
3461
+ * @param {*} [options] Override http request option.
3462
+ * @throws {RequiredError}
3463
+ * @memberof LoginIdentityApiInterface
3464
+ */
3465
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): AxiosPromise<LinkTokenResponse>;
3466
+ /**
3467
+ * Get a specific account\'s information
3468
+ * @param {string} accountId The account id
3469
+ * @param {*} [options] Override http request option.
3470
+ * @throws {RequiredError}
3471
+ * @memberof LoginIdentityApiInterface
3472
+ */
3473
+ getAccount(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetAccountResponse>;
3474
+ /**
3475
+ * Get the account number for a specific account
3476
+ * @param {string} accountId The account id
3477
+ * @param {*} [options] Override http request option.
3478
+ * @throws {RequiredError}
3479
+ * @memberof LoginIdentityApiInterface
3480
+ */
3481
+ getAccountNumber(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetAccountNumberResponse>;
3482
+ /**
3483
+ * Get the balance history for a specific account
3484
+ * @param {string} accountId The account id
3485
+ * @param {*} [options] Override http request option.
3486
+ * @throws {RequiredError}
3487
+ * @memberof LoginIdentityApiInterface
3488
+ */
3489
+ getBalanceHistory(accountId: string, options?: AxiosRequestConfig): AxiosPromise<GetBalanceHistoryResponse>;
3490
+ /**
3491
+ * \\[BETA] Get a list of identity data for a given login identity
3492
+ * @param {*} [options] Override http request option.
3493
+ * @throws {RequiredError}
3494
+ * @memberof LoginIdentityApiInterface
3495
+ */
3496
+ getIdentity(options?: AxiosRequestConfig): AxiosPromise<GetIdentityResponse>;
3497
+ /**
3498
+ * Get income figures for a login identity
3499
+ * @param {*} [options] Override http request option.
3500
+ * @throws {RequiredError}
3501
+ * @memberof LoginIdentityApiInterface
3502
+ */
3503
+ getIncomeEstimateByLoginIdentityId(options?: AxiosRequestConfig): AxiosPromise<IncomeResponse>;
3504
+ /**
3505
+ * Get a specific loginIdentity
3506
+ * @param {*} [options] Override http request option.
3507
+ * @throws {RequiredError}
3508
+ * @memberof LoginIdentityApiInterface
3509
+ */
3510
+ getLoginIdentity(options?: AxiosRequestConfig): AxiosPromise<GetLoginIdentityByIdResponse>;
3511
+ /**
3512
+ * Download statement
3513
+ * @param {string} statementId The statement id
3514
+ * @param {*} [options] Override http request option.
3515
+ * @throws {RequiredError}
3516
+ * @memberof LoginIdentityApiInterface
3517
+ */
3518
+ getStatement(statementId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
3519
+ /**
3520
+ * Get statement link for download
3521
+ * @param {string} statementId The statement id
3522
+ * @param {*} [options] Override http request option.
3523
+ * @throws {RequiredError}
3524
+ * @memberof LoginIdentityApiInterface
3525
+ */
3526
+ getStatementLink(statementId: string, options?: AxiosRequestConfig): AxiosPromise<GetStatementLinkResponse>;
3527
+ /**
3528
+ * Get list of available statements
3529
+ * @param {*} [options] Override http request option.
3530
+ * @throws {RequiredError}
3531
+ * @memberof LoginIdentityApiInterface
3532
+ */
3533
+ getStatements(options?: AxiosRequestConfig): AxiosPromise<GetStatementsResponse>;
3534
+ /**
3535
+ * Get a list of accounts for a login identity
3536
+ * @param {*} [options] Override http request option.
3537
+ * @throws {RequiredError}
3538
+ * @memberof LoginIdentityApiInterface
3539
+ */
3540
+ listAccounts(options?: AxiosRequestConfig): AxiosPromise<ListAccountsResponse>;
3541
+ /**
3542
+ * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
3543
+ * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
3544
+ * @param {number} [offset] default is 0
3545
+ * @param {number} [limit] default is 500, max is 1000
3546
+ * @param {*} [options] Override http request option.
3547
+ * @throws {RequiredError}
3548
+ * @memberof LoginIdentityApiInterface
3549
+ */
3550
+ listTransactionsByAccountId(accountId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
3551
+ /**
3552
+ * Get a list of transactions for a login identity. The transactions are returned in sorted order, with the most recent one appearing first.
3553
+ * @param {number} [offset] default is 0
3554
+ * @param {number} [limit] default is 500, max is 1000
3555
+ * @param {*} [options] Override http request option.
3556
+ * @throws {RequiredError}
3557
+ * @memberof LoginIdentityApiInterface
3558
+ */
3559
+ listTransactionsByLoginIdentityId(offset?: number, limit?: number, options?: AxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
3560
+ /**
3561
+ * Create a refresh job for a login identity
3562
+ * @param {*} [options] Override http request option.
3563
+ * @throws {RequiredError}
3564
+ * @memberof LoginIdentityApiInterface
3565
+ */
3566
+ refreshLoginIdentity(options?: AxiosRequestConfig): AxiosPromise<void>;
3567
+ }
3568
+ /**
3569
+ * LoginIdentityApi - object-oriented interface
3570
+ * @export
3571
+ * @class LoginIdentityApi
3572
+ * @extends {BaseAPI}
3573
+ */
3574
+ export declare class LoginIdentityApi extends BaseAPI implements LoginIdentityApiInterface {
3575
+ /**
3576
+ * Delete a specific loginIdentity
3577
+ * @param {*} [options] Override http request option.
3578
+ * @throws {RequiredError}
3579
+ * @memberof LoginIdentityApi
3580
+ */
3581
+ deleteLoginIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteLoginIdentityResponse>>;
3582
+ /**
3583
+ * generate a link token that can be used to create link
3584
+ * @param {LinkTokenRequest} linkTokenRequest token request
3585
+ * @param {*} [options] Override http request option.
3586
+ * @throws {RequiredError}
3587
+ * @memberof LoginIdentityApi
3588
+ */
3589
+ generateLinkToken(linkTokenRequest: LinkTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkTokenResponse>>;
3590
+ /**
3591
+ * Get a specific account\'s information
3592
+ * @param {string} accountId The account id
3593
+ * @param {*} [options] Override http request option.
3594
+ * @throws {RequiredError}
3595
+ * @memberof LoginIdentityApi
3596
+ */
3597
+ getAccount(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponse>>;
3598
+ /**
3599
+ * Get the account number for a specific account
3600
+ * @param {string} accountId The account id
3601
+ * @param {*} [options] Override http request option.
3602
+ * @throws {RequiredError}
3603
+ * @memberof LoginIdentityApi
3604
+ */
3605
+ getAccountNumber(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountNumberResponse>>;
3606
+ /**
3607
+ * Get the balance history for a specific account
3608
+ * @param {string} accountId The account id
3609
+ * @param {*} [options] Override http request option.
3610
+ * @throws {RequiredError}
3611
+ * @memberof LoginIdentityApi
3612
+ */
3613
+ getBalanceHistory(accountId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBalanceHistoryResponse>>;
3614
+ /**
3615
+ * \\[BETA] Get a list of identity data for a given login identity
3616
+ * @param {*} [options] Override http request option.
3617
+ * @throws {RequiredError}
3618
+ * @memberof LoginIdentityApi
3619
+ */
3620
+ getIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetIdentityResponse>>;
3621
+ /**
3622
+ * Get income figures for a login identity
3623
+ * @param {*} [options] Override http request option.
3624
+ * @throws {RequiredError}
3625
+ * @memberof LoginIdentityApi
3626
+ */
3627
+ getIncomeEstimateByLoginIdentityId(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IncomeResponse>>;
3628
+ /**
3629
+ * Get a specific loginIdentity
3630
+ * @param {*} [options] Override http request option.
3631
+ * @throws {RequiredError}
3632
+ * @memberof LoginIdentityApi
3633
+ */
3634
+ getLoginIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginIdentityByIdResponse>>;
3635
+ /**
3636
+ * Download statement
3637
+ * @param {string} statementId The statement id
3638
+ * @param {*} [options] Override http request option.
3639
+ * @throws {RequiredError}
3640
+ * @memberof LoginIdentityApi
3641
+ */
3642
+ getStatement(statementId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3643
+ /**
3644
+ * Get statement link for download
3645
+ * @param {string} statementId The statement id
3646
+ * @param {*} [options] Override http request option.
3647
+ * @throws {RequiredError}
3648
+ * @memberof LoginIdentityApi
3649
+ */
3650
+ getStatementLink(statementId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatementLinkResponse>>;
3651
+ /**
3652
+ * Get list of available statements
3653
+ * @param {*} [options] Override http request option.
3654
+ * @throws {RequiredError}
3655
+ * @memberof LoginIdentityApi
3656
+ */
3657
+ getStatements(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStatementsResponse>>;
3658
+ /**
3659
+ * Get a list of accounts for a login identity
3660
+ * @param {*} [options] Override http request option.
3661
+ * @throws {RequiredError}
3662
+ * @memberof LoginIdentityApi
3663
+ */
3664
+ listAccounts(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAccountsResponse>>;
3665
+ /**
3666
+ * Get a list of transactions for a particular account. The transactions are returned in sorted order, with the most recent one appearing first.
3667
+ * @param {string} accountId The account id (ULID, example - 01EP4A1MZDHKETZFRPF0K62S6S)
3668
+ * @param {number} [offset] default is 0
3669
+ * @param {number} [limit] default is 500, max is 1000
3670
+ * @param {*} [options] Override http request option.
3671
+ * @throws {RequiredError}
3672
+ * @memberof LoginIdentityApi
3673
+ */
3674
+ listTransactionsByAccountId(accountId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactionsResponse>>;
3675
+ /**
3676
+ * Get a list of transactions for a login identity. The transactions are returned in sorted order, with the most recent one appearing first.
3677
+ * @param {number} [offset] default is 0
3678
+ * @param {number} [limit] default is 500, max is 1000
3679
+ * @param {*} [options] Override http request option.
3680
+ * @throws {RequiredError}
3681
+ * @memberof LoginIdentityApi
3682
+ */
3683
+ listTransactionsByLoginIdentityId(offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactionsResponse>>;
3684
+ /**
3685
+ * Create a refresh job for a login identity
3686
+ * @param {*} [options] Override http request option.
3687
+ * @throws {RequiredError}
3688
+ * @memberof LoginIdentityApi
3689
+ */
3690
+ refreshLoginIdentity(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void>>;
3691
+ }
3692
+ /**
3693
+ * PaymentApi - axios parameter creator
3694
+ * @export
3695
+ */
3696
+ export declare const PaymentApiAxiosParamCreator: (configuration?: Configuration) => {
3697
+ /**
3698
+ * Create a new payment instruction to be used when linking to perform debit authorization
3699
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
3700
+ * @param {*} [options] Override http request option.
3701
+ * @throws {RequiredError}
3702
+ */
3703
+ createPaymentInstruction: (paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3704
+ /**
3705
+ * Get payment instructions to be used when linking to perform debit authorization by id
3706
+ * @param {string} paymentInstructionId The id of a payment instruction
3707
+ * @param {*} [options] Override http request option.
3708
+ * @throws {RequiredError}
3709
+ */
3710
+ getPaymentInstruction: (paymentInstructionId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3711
+ };
3712
+ /**
3713
+ * PaymentApi - functional programming interface
3714
+ * @export
3715
+ */
3716
+ export declare const PaymentApiFp: (configuration?: Configuration) => {
3717
+ /**
3718
+ * Create a new payment instruction to be used when linking to perform debit authorization
3719
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
3720
+ * @param {*} [options] Override http request option.
3721
+ * @throws {RequiredError}
3722
+ */
3723
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentInstructionResponse>>;
3724
+ /**
3725
+ * Get payment instructions to be used when linking to perform debit authorization by id
3726
+ * @param {string} paymentInstructionId The id of a payment instruction
3727
+ * @param {*} [options] Override http request option.
3728
+ * @throws {RequiredError}
3729
+ */
3730
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentInstructionsResponse>>;
3731
+ };
3732
+ /**
3733
+ * PaymentApi - factory interface
3734
+ * @export
3735
+ */
3736
+ export declare const PaymentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3737
+ /**
3738
+ * Create a new payment instruction to be used when linking to perform debit authorization
3739
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
3740
+ * @param {*} [options] Override http request option.
3741
+ * @throws {RequiredError}
3742
+ */
3743
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: any): AxiosPromise<CreatePaymentInstructionResponse>;
3744
+ /**
3745
+ * Get payment instructions to be used when linking to perform debit authorization by id
3746
+ * @param {string} paymentInstructionId The id of a payment instruction
3747
+ * @param {*} [options] Override http request option.
3748
+ * @throws {RequiredError}
3749
+ */
3750
+ getPaymentInstruction(paymentInstructionId: string, options?: any): AxiosPromise<GetPaymentInstructionsResponse>;
3751
+ };
3752
+ /**
3753
+ * PaymentApi - interface
3754
+ * @export
3755
+ * @interface PaymentApi
3756
+ */
3757
+ export interface PaymentApiInterface {
3758
+ /**
3759
+ * Create a new payment instruction to be used when linking to perform debit authorization
3760
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
3761
+ * @param {*} [options] Override http request option.
3762
+ * @throws {RequiredError}
3763
+ * @memberof PaymentApiInterface
3764
+ */
3765
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): AxiosPromise<CreatePaymentInstructionResponse>;
3766
+ /**
3767
+ * Get payment instructions to be used when linking to perform debit authorization by id
3768
+ * @param {string} paymentInstructionId The id of a payment instruction
3769
+ * @param {*} [options] Override http request option.
3770
+ * @throws {RequiredError}
3771
+ * @memberof PaymentApiInterface
3772
+ */
3773
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): AxiosPromise<GetPaymentInstructionsResponse>;
3774
+ }
3775
+ /**
3776
+ * PaymentApi - object-oriented interface
3777
+ * @export
3778
+ * @class PaymentApi
3779
+ * @extends {BaseAPI}
3780
+ */
3781
+ export declare class PaymentApi extends BaseAPI implements PaymentApiInterface {
3782
+ /**
3783
+ * Create a new payment instruction to be used when linking to perform debit authorization
3784
+ * @param {CustomerPaymentInstruction} paymentInstruction Request body for starting a new Link
3785
+ * @param {*} [options] Override http request option.
3786
+ * @throws {RequiredError}
3787
+ * @memberof PaymentApi
3788
+ */
3789
+ createPaymentInstruction(paymentInstruction: CustomerPaymentInstruction, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentInstructionResponse>>;
3790
+ /**
3791
+ * Get payment instructions to be used when linking to perform debit authorization by id
3792
+ * @param {string} paymentInstructionId The id of a payment instruction
3793
+ * @param {*} [options] Override http request option.
3794
+ * @throws {RequiredError}
3795
+ * @memberof PaymentApi
3796
+ */
3797
+ getPaymentInstruction(paymentInstructionId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentInstructionsResponse>>;
3798
+ }
3799
+ /**
3800
+ * PublicApi - axios parameter creator
3801
+ * @export
3802
+ */
3803
+ export declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => {
3804
+ /**
3805
+ * Callback url to get the oauth authorization token
3806
+ * @param {string} state The state of the client when oauth was initialized
3807
+ * @param {string} [code] The authorization code generated by the Oauth provider
3808
+ * @param {string} [error] error
3809
+ * @param {string} [errorDescription] error description
3810
+ * @param {string} [errorDetails] error details
3811
+ * @param {*} [options] Override http request option.
3812
+ * @throws {RequiredError}
3813
+ */
3814
+ authCallback: (state: string, code?: string, error?: string, errorDescription?: string, errorDetails?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3815
+ /**
3816
+ * generate an access_token
3817
+ * @param {TokenRequest} [tokenRequest] token request
3818
+ * @param {*} [options] Override http request option.
3819
+ * @throws {RequiredError}
3820
+ */
3821
+ generateCustomerAccessToken: (tokenRequest?: TokenRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3822
+ };
3823
+ /**
3824
+ * PublicApi - functional programming interface
3825
+ * @export
3826
+ */
3827
+ export declare const PublicApiFp: (configuration?: Configuration) => {
3828
+ /**
3829
+ * Callback url to get the oauth authorization token
3830
+ * @param {string} state The state of the client when oauth was initialized
3831
+ * @param {string} [code] The authorization code generated by the Oauth provider
3832
+ * @param {string} [error] error
3833
+ * @param {string} [errorDescription] error description
3834
+ * @param {string} [errorDetails] error details
3835
+ * @param {*} [options] Override http request option.
3836
+ * @throws {RequiredError}
3837
+ */
3838
+ authCallback(state: string, code?: string, error?: string, errorDescription?: string, errorDetails?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedirectUriResponse>>;
3839
+ /**
3840
+ * generate an access_token
3841
+ * @param {TokenRequest} [tokenRequest] token request
3842
+ * @param {*} [options] Override http request option.
3843
+ * @throws {RequiredError}
3844
+ */
3845
+ generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponse>>;
3846
+ };
3847
+ /**
3848
+ * PublicApi - factory interface
3849
+ * @export
3850
+ */
3851
+ export declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3852
+ /**
3853
+ * Callback url to get the oauth authorization token
3854
+ * @param {string} state The state of the client when oauth was initialized
3855
+ * @param {string} [code] The authorization code generated by the Oauth provider
3856
+ * @param {string} [error] error
3857
+ * @param {string} [errorDescription] error description
3858
+ * @param {string} [errorDetails] error details
3859
+ * @param {*} [options] Override http request option.
3860
+ * @throws {RequiredError}
3861
+ */
3862
+ authCallback(state: string, code?: string, error?: string, errorDescription?: string, errorDetails?: string, options?: any): AxiosPromise<RedirectUriResponse>;
3863
+ /**
3864
+ * generate an access_token
3865
+ * @param {TokenRequest} [tokenRequest] token request
3866
+ * @param {*} [options] Override http request option.
3867
+ * @throws {RequiredError}
3868
+ */
3869
+ generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: any): AxiosPromise<TokenResponse>;
3870
+ };
3871
+ /**
3872
+ * PublicApi - interface
3873
+ * @export
3874
+ * @interface PublicApi
3875
+ */
3876
+ export interface PublicApiInterface {
3877
+ /**
3878
+ * Callback url to get the oauth authorization token
3879
+ * @param {string} state The state of the client when oauth was initialized
3880
+ * @param {string} [code] The authorization code generated by the Oauth provider
3881
+ * @param {string} [error] error
3882
+ * @param {string} [errorDescription] error description
3883
+ * @param {string} [errorDetails] error details
3884
+ * @param {*} [options] Override http request option.
3885
+ * @throws {RequiredError}
3886
+ * @memberof PublicApiInterface
3887
+ */
3888
+ authCallback(state: string, code?: string, error?: string, errorDescription?: string, errorDetails?: string, options?: AxiosRequestConfig): AxiosPromise<RedirectUriResponse>;
3889
+ /**
3890
+ * generate an access_token
3891
+ * @param {TokenRequest} [tokenRequest] token request
3892
+ * @param {*} [options] Override http request option.
3893
+ * @throws {RequiredError}
3894
+ * @memberof PublicApiInterface
3895
+ */
3896
+ generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): AxiosPromise<TokenResponse>;
3897
+ }
3898
+ /**
3899
+ * PublicApi - object-oriented interface
3900
+ * @export
3901
+ * @class PublicApi
3902
+ * @extends {BaseAPI}
3903
+ */
3904
+ export declare class PublicApi extends BaseAPI implements PublicApiInterface {
3905
+ /**
3906
+ * Callback url to get the oauth authorization token
3907
+ * @param {string} state The state of the client when oauth was initialized
3908
+ * @param {string} [code] The authorization code generated by the Oauth provider
3909
+ * @param {string} [error] error
3910
+ * @param {string} [errorDescription] error description
3911
+ * @param {string} [errorDetails] error details
3912
+ * @param {*} [options] Override http request option.
3913
+ * @throws {RequiredError}
3914
+ * @memberof PublicApi
3915
+ */
3916
+ authCallback(state: string, code?: string, error?: string, errorDescription?: string, errorDetails?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedirectUriResponse>>;
3917
+ /**
3918
+ * generate an access_token
3919
+ * @param {TokenRequest} [tokenRequest] token request
3920
+ * @param {*} [options] Override http request option.
3921
+ * @throws {RequiredError}
3922
+ * @memberof PublicApi
3923
+ */
3924
+ generateCustomerAccessToken(tokenRequest?: TokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TokenResponse>>;
3925
+ }