@finverse/sdk-typescript 0.0.1-1646124671 → 0.0.1-1646284878

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