@finverse/sdk-typescript 0.0.18 → 0.0.19

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