@getivy/node-sdk 2.0.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/client.d.mts +0 -3
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +0 -3
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -3
  7. package/client.js.map +1 -1
  8. package/client.mjs +0 -3
  9. package/client.mjs.map +1 -1
  10. package/internal/utils/env.js +2 -2
  11. package/internal/utils/env.js.map +1 -1
  12. package/internal/utils/env.mjs +2 -2
  13. package/internal/utils/env.mjs.map +1 -1
  14. package/package.json +1 -1
  15. package/resources/index.d.mts +0 -1
  16. package/resources/index.d.mts.map +1 -1
  17. package/resources/index.d.ts +0 -1
  18. package/resources/index.d.ts.map +1 -1
  19. package/resources/index.js +1 -3
  20. package/resources/index.js.map +1 -1
  21. package/resources/index.mjs +0 -1
  22. package/resources/index.mjs.map +1 -1
  23. package/resources/orders.d.mts +3 -3
  24. package/resources/orders.d.mts.map +1 -1
  25. package/resources/orders.d.ts +3 -3
  26. package/resources/orders.d.ts.map +1 -1
  27. package/resources/transactions.d.mts +5 -0
  28. package/resources/transactions.d.mts.map +1 -1
  29. package/resources/transactions.d.ts +5 -0
  30. package/resources/transactions.d.ts.map +1 -1
  31. package/src/client.ts +0 -5
  32. package/src/internal/utils/env.ts +2 -2
  33. package/src/resources/index.ts +0 -1
  34. package/src/resources/orders.ts +3 -0
  35. package/src/resources/transactions.ts +6 -0
  36. package/src/version.ts +1 -1
  37. package/version.d.mts +1 -1
  38. package/version.d.ts +1 -1
  39. package/version.js +1 -1
  40. package/version.mjs +1 -1
  41. package/resources/data/accounts.d.mts +0 -95
  42. package/resources/data/accounts.d.mts.map +0 -1
  43. package/resources/data/accounts.d.ts +0 -95
  44. package/resources/data/accounts.d.ts.map +0 -1
  45. package/resources/data/accounts.js +0 -15
  46. package/resources/data/accounts.js.map +0 -1
  47. package/resources/data/accounts.mjs +0 -11
  48. package/resources/data/accounts.mjs.map +0 -1
  49. package/resources/data/balances.d.mts +0 -49
  50. package/resources/data/balances.d.mts.map +0 -1
  51. package/resources/data/balances.d.ts +0 -49
  52. package/resources/data/balances.d.ts.map +0 -1
  53. package/resources/data/balances.js +0 -15
  54. package/resources/data/balances.js.map +0 -1
  55. package/resources/data/balances.mjs +0 -11
  56. package/resources/data/balances.mjs.map +0 -1
  57. package/resources/data/consent.d.mts +0 -81
  58. package/resources/data/consent.d.mts.map +0 -1
  59. package/resources/data/consent.d.ts +0 -81
  60. package/resources/data/consent.d.ts.map +0 -1
  61. package/resources/data/consent.js +0 -21
  62. package/resources/data/consent.js.map +0 -1
  63. package/resources/data/consent.mjs +0 -17
  64. package/resources/data/consent.mjs.map +0 -1
  65. package/resources/data/data.d.mts +0 -26
  66. package/resources/data/data.d.mts.map +0 -1
  67. package/resources/data/data.d.ts +0 -26
  68. package/resources/data/data.d.ts.map +0 -1
  69. package/resources/data/data.js +0 -33
  70. package/resources/data/data.js.map +0 -1
  71. package/resources/data/data.mjs +0 -28
  72. package/resources/data/data.mjs.map +0 -1
  73. package/resources/data/index.d.mts +0 -7
  74. package/resources/data/index.d.mts.map +0 -1
  75. package/resources/data/index.d.ts +0 -7
  76. package/resources/data/index.d.ts.map +0 -1
  77. package/resources/data/index.js +0 -17
  78. package/resources/data/index.js.map +0 -1
  79. package/resources/data/index.mjs +0 -8
  80. package/resources/data/index.mjs.map +0 -1
  81. package/resources/data/session.d.mts +0 -259
  82. package/resources/data/session.d.mts.map +0 -1
  83. package/resources/data/session.d.ts +0 -259
  84. package/resources/data/session.d.ts.map +0 -1
  85. package/resources/data/session.js +0 -21
  86. package/resources/data/session.js.map +0 -1
  87. package/resources/data/session.mjs +0 -17
  88. package/resources/data/session.mjs.map +0 -1
  89. package/resources/data/transactions.d.mts +0 -62
  90. package/resources/data/transactions.d.mts.map +0 -1
  91. package/resources/data/transactions.d.ts +0 -62
  92. package/resources/data/transactions.d.ts.map +0 -1
  93. package/resources/data/transactions.js +0 -16
  94. package/resources/data/transactions.js.map +0 -1
  95. package/resources/data/transactions.mjs +0 -12
  96. package/resources/data/transactions.mjs.map +0 -1
  97. package/resources/data.d.mts +0 -2
  98. package/resources/data.d.mts.map +0 -1
  99. package/resources/data.d.ts +0 -2
  100. package/resources/data.d.ts.map +0 -1
  101. package/resources/data.js +0 -6
  102. package/resources/data.js.map +0 -1
  103. package/resources/data.mjs +0 -3
  104. package/resources/data.mjs.map +0 -1
  105. package/src/resources/data/accounts.ts +0 -128
  106. package/src/resources/data/balances.ts +0 -61
  107. package/src/resources/data/consent.ts +0 -108
  108. package/src/resources/data/data.ts +0 -75
  109. package/src/resources/data/index.ts +0 -20
  110. package/src/resources/data/session.ts +0 -1315
  111. package/src/resources/data/transactions.ts +0 -80
  112. package/src/resources/data.ts +0 -3
@@ -1,1315 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- import { APIResource } from '../../core/resource';
4
- import { APIPromise } from '../../core/api-promise';
5
- import { RequestOptions } from '../../internal/request-options';
6
-
7
- export class Session extends APIResource {
8
- /**
9
- * Creates a data session for the merchant corresponding to the API key.
10
- */
11
- create(body: SessionCreateParams, options?: RequestOptions): APIPromise<SessionCreateResponse> {
12
- return this._client.post('/api/service/data/session/create', { body, ...options });
13
- }
14
-
15
- /**
16
- * Retrieves the details of a data session by its ID.
17
- */
18
- retrieve(body: SessionRetrieveParams, options?: RequestOptions): APIPromise<SessionRetrieveResponse> {
19
- return this._client.post('/api/service/data/session/details', { body, ...options });
20
- }
21
- }
22
-
23
- export interface SessionCreateResponse {
24
- /**
25
- * The id of the data session.
26
- */
27
- id: string;
28
-
29
- /**
30
- * The markets where the user of the Data Session can select banks from.
31
- */
32
- availableMarkets: Array<
33
- | 'AF'
34
- | 'AL'
35
- | 'DZ'
36
- | 'AS'
37
- | 'AD'
38
- | 'AO'
39
- | 'AI'
40
- | 'AQ'
41
- | 'AG'
42
- | 'AR'
43
- | 'AM'
44
- | 'AW'
45
- | 'AU'
46
- | 'AT'
47
- | 'AZ'
48
- | 'BS'
49
- | 'BH'
50
- | 'BD'
51
- | 'BB'
52
- | 'BY'
53
- | 'BE'
54
- | 'BZ'
55
- | 'BJ'
56
- | 'BM'
57
- | 'BT'
58
- | 'BO'
59
- | 'BA'
60
- | 'BW'
61
- | 'BV'
62
- | 'BR'
63
- | 'IO'
64
- | 'BN'
65
- | 'BG'
66
- | 'BF'
67
- | 'BI'
68
- | 'KH'
69
- | 'CM'
70
- | 'CA'
71
- | 'CV'
72
- | 'KY'
73
- | 'CF'
74
- | 'TD'
75
- | 'CL'
76
- | 'CN'
77
- | 'CX'
78
- | 'CC'
79
- | 'CO'
80
- | 'KM'
81
- | 'CG'
82
- | 'CD'
83
- | 'CK'
84
- | 'CR'
85
- | 'CI'
86
- | 'HR'
87
- | 'CU'
88
- | 'CY'
89
- | 'CZ'
90
- | 'DK'
91
- | 'DJ'
92
- | 'DM'
93
- | 'DO'
94
- | 'EC'
95
- | 'EG'
96
- | 'SV'
97
- | 'GQ'
98
- | 'ER'
99
- | 'EE'
100
- | 'ET'
101
- | 'FK'
102
- | 'FO'
103
- | 'FJ'
104
- | 'FI'
105
- | 'FR'
106
- | 'GF'
107
- | 'PF'
108
- | 'TF'
109
- | 'GA'
110
- | 'GM'
111
- | 'GE'
112
- | 'DE'
113
- | 'GH'
114
- | 'GI'
115
- | 'GR'
116
- | 'GL'
117
- | 'GD'
118
- | 'GP'
119
- | 'GU'
120
- | 'GT'
121
- | 'GN'
122
- | 'GW'
123
- | 'GY'
124
- | 'HT'
125
- | 'HM'
126
- | 'VA'
127
- | 'HN'
128
- | 'HK'
129
- | 'HU'
130
- | 'IS'
131
- | 'IN'
132
- | 'ID'
133
- | 'IR'
134
- | 'IQ'
135
- | 'IE'
136
- | 'IL'
137
- | 'IT'
138
- | 'JM'
139
- | 'JP'
140
- | 'JO'
141
- | 'KZ'
142
- | 'KE'
143
- | 'KI'
144
- | 'KP'
145
- | 'KR'
146
- | 'KW'
147
- | 'KG'
148
- | 'LA'
149
- | 'LV'
150
- | 'LB'
151
- | 'LS'
152
- | 'LR'
153
- | 'LY'
154
- | 'LI'
155
- | 'LT'
156
- | 'LU'
157
- | 'MO'
158
- | 'MG'
159
- | 'MW'
160
- | 'MY'
161
- | 'MV'
162
- | 'ML'
163
- | 'MT'
164
- | 'MH'
165
- | 'MQ'
166
- | 'MR'
167
- | 'MU'
168
- | 'YT'
169
- | 'MX'
170
- | 'FM'
171
- | 'MD'
172
- | 'MC'
173
- | 'MN'
174
- | 'MS'
175
- | 'MA'
176
- | 'MZ'
177
- | 'MM'
178
- | 'NA'
179
- | 'NR'
180
- | 'NP'
181
- | 'NL'
182
- | 'NC'
183
- | 'NZ'
184
- | 'NI'
185
- | 'NE'
186
- | 'NG'
187
- | 'NU'
188
- | 'NF'
189
- | 'MP'
190
- | 'MK'
191
- | 'NO'
192
- | 'OM'
193
- | 'PK'
194
- | 'PW'
195
- | 'PS'
196
- | 'PA'
197
- | 'PG'
198
- | 'PY'
199
- | 'PE'
200
- | 'PH'
201
- | 'PN'
202
- | 'PL'
203
- | 'PT'
204
- | 'PR'
205
- | 'QA'
206
- | 'RE'
207
- | 'RO'
208
- | 'RU'
209
- | 'RW'
210
- | 'SH'
211
- | 'KN'
212
- | 'LC'
213
- | 'PM'
214
- | 'VC'
215
- | 'WS'
216
- | 'SM'
217
- | 'ST'
218
- | 'SA'
219
- | 'SN'
220
- | 'SC'
221
- | 'SL'
222
- | 'SG'
223
- | 'SK'
224
- | 'SI'
225
- | 'SB'
226
- | 'SO'
227
- | 'ZA'
228
- | 'GS'
229
- | 'ES'
230
- | 'LK'
231
- | 'SD'
232
- | 'SR'
233
- | 'SJ'
234
- | 'SZ'
235
- | 'SE'
236
- | 'CH'
237
- | 'SY'
238
- | 'TW'
239
- | 'TJ'
240
- | 'TZ'
241
- | 'TH'
242
- | 'TL'
243
- | 'TG'
244
- | 'TK'
245
- | 'TO'
246
- | 'TT'
247
- | 'TN'
248
- | 'TR'
249
- | 'TM'
250
- | 'TC'
251
- | 'TV'
252
- | 'UG'
253
- | 'UA'
254
- | 'AE'
255
- | 'GB'
256
- | 'US'
257
- | 'UM'
258
- | 'UY'
259
- | 'UZ'
260
- | 'VU'
261
- | 'VE'
262
- | 'VN'
263
- | 'VG'
264
- | 'VI'
265
- | 'WF'
266
- | 'EH'
267
- | 'YE'
268
- | 'ZM'
269
- | 'ZW'
270
- | 'AX'
271
- | 'BQ'
272
- | 'CW'
273
- | 'GG'
274
- | 'IM'
275
- | 'JE'
276
- | 'ME'
277
- | 'BL'
278
- | 'MF'
279
- | 'RS'
280
- | 'SX'
281
- | 'SS'
282
- | 'XK'
283
- >;
284
-
285
- /**
286
- * The Epoch time in seconds at which the Session was created.
287
- */
288
- createdAt: number;
289
-
290
- /**
291
- * Whether customers can choose another bank than the pre-selected one.
292
- */
293
- disableBankSelection: boolean;
294
-
295
- /**
296
- * Currently only visible in the merchant dashboard. This id used to be displayed
297
- * to the user during the checkout.
298
- */
299
- displayId: string;
300
-
301
- /**
302
- * The URL where users will be redirected after an unsuccessful session.
303
- */
304
- errorCallbackUrl: string;
305
-
306
- /**
307
- * The Epoch time in seconds at which the Session will expire.
308
- */
309
- expiresAt: number;
310
-
311
- /**
312
- * The id of the merchant.
313
- */
314
- merchantId: string;
315
-
316
- /**
317
- * The redirect URL of the data session.
318
- */
319
- redirectUrl: string;
320
-
321
- /**
322
- * An internal reference id for the data session.
323
- */
324
- referenceId: string;
325
-
326
- /**
327
- * The status of the data session.
328
- */
329
- status: 'open' | 'closed' | 'expired';
330
-
331
- /**
332
- * The URL where users will be redirected after a successful session.
333
- */
334
- successCallbackUrl: string;
335
-
336
- /**
337
- * The Epoch time in seconds at which the Session was updated.
338
- */
339
- updatedAt: number;
340
-
341
- /**
342
- * The locale of the data session.
343
- */
344
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
345
-
346
- /**
347
- * ISO 3166-1 alpha-2 country code of the market.
348
- */
349
- market?:
350
- | 'AF'
351
- | 'AL'
352
- | 'DZ'
353
- | 'AS'
354
- | 'AD'
355
- | 'AO'
356
- | 'AI'
357
- | 'AQ'
358
- | 'AG'
359
- | 'AR'
360
- | 'AM'
361
- | 'AW'
362
- | 'AU'
363
- | 'AT'
364
- | 'AZ'
365
- | 'BS'
366
- | 'BH'
367
- | 'BD'
368
- | 'BB'
369
- | 'BY'
370
- | 'BE'
371
- | 'BZ'
372
- | 'BJ'
373
- | 'BM'
374
- | 'BT'
375
- | 'BO'
376
- | 'BA'
377
- | 'BW'
378
- | 'BV'
379
- | 'BR'
380
- | 'IO'
381
- | 'BN'
382
- | 'BG'
383
- | 'BF'
384
- | 'BI'
385
- | 'KH'
386
- | 'CM'
387
- | 'CA'
388
- | 'CV'
389
- | 'KY'
390
- | 'CF'
391
- | 'TD'
392
- | 'CL'
393
- | 'CN'
394
- | 'CX'
395
- | 'CC'
396
- | 'CO'
397
- | 'KM'
398
- | 'CG'
399
- | 'CD'
400
- | 'CK'
401
- | 'CR'
402
- | 'CI'
403
- | 'HR'
404
- | 'CU'
405
- | 'CY'
406
- | 'CZ'
407
- | 'DK'
408
- | 'DJ'
409
- | 'DM'
410
- | 'DO'
411
- | 'EC'
412
- | 'EG'
413
- | 'SV'
414
- | 'GQ'
415
- | 'ER'
416
- | 'EE'
417
- | 'ET'
418
- | 'FK'
419
- | 'FO'
420
- | 'FJ'
421
- | 'FI'
422
- | 'FR'
423
- | 'GF'
424
- | 'PF'
425
- | 'TF'
426
- | 'GA'
427
- | 'GM'
428
- | 'GE'
429
- | 'DE'
430
- | 'GH'
431
- | 'GI'
432
- | 'GR'
433
- | 'GL'
434
- | 'GD'
435
- | 'GP'
436
- | 'GU'
437
- | 'GT'
438
- | 'GN'
439
- | 'GW'
440
- | 'GY'
441
- | 'HT'
442
- | 'HM'
443
- | 'VA'
444
- | 'HN'
445
- | 'HK'
446
- | 'HU'
447
- | 'IS'
448
- | 'IN'
449
- | 'ID'
450
- | 'IR'
451
- | 'IQ'
452
- | 'IE'
453
- | 'IL'
454
- | 'IT'
455
- | 'JM'
456
- | 'JP'
457
- | 'JO'
458
- | 'KZ'
459
- | 'KE'
460
- | 'KI'
461
- | 'KP'
462
- | 'KR'
463
- | 'KW'
464
- | 'KG'
465
- | 'LA'
466
- | 'LV'
467
- | 'LB'
468
- | 'LS'
469
- | 'LR'
470
- | 'LY'
471
- | 'LI'
472
- | 'LT'
473
- | 'LU'
474
- | 'MO'
475
- | 'MG'
476
- | 'MW'
477
- | 'MY'
478
- | 'MV'
479
- | 'ML'
480
- | 'MT'
481
- | 'MH'
482
- | 'MQ'
483
- | 'MR'
484
- | 'MU'
485
- | 'YT'
486
- | 'MX'
487
- | 'FM'
488
- | 'MD'
489
- | 'MC'
490
- | 'MN'
491
- | 'MS'
492
- | 'MA'
493
- | 'MZ'
494
- | 'MM'
495
- | 'NA'
496
- | 'NR'
497
- | 'NP'
498
- | 'NL'
499
- | 'NC'
500
- | 'NZ'
501
- | 'NI'
502
- | 'NE'
503
- | 'NG'
504
- | 'NU'
505
- | 'NF'
506
- | 'MP'
507
- | 'MK'
508
- | 'NO'
509
- | 'OM'
510
- | 'PK'
511
- | 'PW'
512
- | 'PS'
513
- | 'PA'
514
- | 'PG'
515
- | 'PY'
516
- | 'PE'
517
- | 'PH'
518
- | 'PN'
519
- | 'PL'
520
- | 'PT'
521
- | 'PR'
522
- | 'QA'
523
- | 'RE'
524
- | 'RO'
525
- | 'RU'
526
- | 'RW'
527
- | 'SH'
528
- | 'KN'
529
- | 'LC'
530
- | 'PM'
531
- | 'VC'
532
- | 'WS'
533
- | 'SM'
534
- | 'ST'
535
- | 'SA'
536
- | 'SN'
537
- | 'SC'
538
- | 'SL'
539
- | 'SG'
540
- | 'SK'
541
- | 'SI'
542
- | 'SB'
543
- | 'SO'
544
- | 'ZA'
545
- | 'GS'
546
- | 'ES'
547
- | 'LK'
548
- | 'SD'
549
- | 'SR'
550
- | 'SJ'
551
- | 'SZ'
552
- | 'SE'
553
- | 'CH'
554
- | 'SY'
555
- | 'TW'
556
- | 'TJ'
557
- | 'TZ'
558
- | 'TH'
559
- | 'TL'
560
- | 'TG'
561
- | 'TK'
562
- | 'TO'
563
- | 'TT'
564
- | 'TN'
565
- | 'TR'
566
- | 'TM'
567
- | 'TC'
568
- | 'TV'
569
- | 'UG'
570
- | 'UA'
571
- | 'AE'
572
- | 'GB'
573
- | 'US'
574
- | 'UM'
575
- | 'UY'
576
- | 'UZ'
577
- | 'VU'
578
- | 'VE'
579
- | 'VN'
580
- | 'VG'
581
- | 'VI'
582
- | 'WF'
583
- | 'EH'
584
- | 'YE'
585
- | 'ZM'
586
- | 'ZW'
587
- | 'AX'
588
- | 'BQ'
589
- | 'CW'
590
- | 'GG'
591
- | 'IM'
592
- | 'JE'
593
- | 'ME'
594
- | 'BL'
595
- | 'MF'
596
- | 'RS'
597
- | 'SX'
598
- | 'SS'
599
- | 'XK';
600
-
601
- /**
602
- * Any data stored with this data session.
603
- */
604
- metadata?: { [key: string]: unknown };
605
-
606
- /**
607
- * Prefill options for the data session
608
- */
609
- prefill?: SessionCreateResponse.Prefill;
610
- }
611
-
612
- export namespace SessionCreateResponse {
613
- /**
614
- * Prefill options for the data session
615
- */
616
- export interface Prefill {
617
- /**
618
- * The preselected bank ID.
619
- */
620
- bankId?: string;
621
- }
622
- }
623
-
624
- export interface SessionRetrieveResponse {
625
- /**
626
- * The id of the data session.
627
- */
628
- id: string;
629
-
630
- /**
631
- * The Epoch time in seconds at which the Session was created.
632
- */
633
- createdAt: number;
634
-
635
- /**
636
- * Whether customers can choose another bank than the pre-selected one.
637
- */
638
- disableBankSelection: boolean;
639
-
640
- /**
641
- * Currently only visible in the merchant dashboard. This id used to be displayed
642
- * to the user during the checkout.
643
- */
644
- displayId: string;
645
-
646
- /**
647
- * The URL where users will be redirected after an unsuccessful session.
648
- */
649
- errorCallbackUrl: string;
650
-
651
- /**
652
- * The Epoch time in seconds at which the Session will expire.
653
- */
654
- expiresAt: number;
655
-
656
- /**
657
- * The id of the merchant.
658
- */
659
- merchantId: string;
660
-
661
- /**
662
- * An internal reference id for the data session.
663
- */
664
- referenceId: string;
665
-
666
- /**
667
- * The status of the data session.
668
- */
669
- status: 'open' | 'closed' | 'expired';
670
-
671
- /**
672
- * The URL where users will be redirected after a successful session.
673
- */
674
- successCallbackUrl: string;
675
-
676
- /**
677
- * The Epoch time in seconds at which the Session was updated.
678
- */
679
- updatedAt: number;
680
-
681
- /**
682
- * The locale of the data session.
683
- */
684
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
685
-
686
- /**
687
- * ISO 3166-1 alpha-2 country code of the market.
688
- */
689
- market?:
690
- | 'AF'
691
- | 'AL'
692
- | 'DZ'
693
- | 'AS'
694
- | 'AD'
695
- | 'AO'
696
- | 'AI'
697
- | 'AQ'
698
- | 'AG'
699
- | 'AR'
700
- | 'AM'
701
- | 'AW'
702
- | 'AU'
703
- | 'AT'
704
- | 'AZ'
705
- | 'BS'
706
- | 'BH'
707
- | 'BD'
708
- | 'BB'
709
- | 'BY'
710
- | 'BE'
711
- | 'BZ'
712
- | 'BJ'
713
- | 'BM'
714
- | 'BT'
715
- | 'BO'
716
- | 'BA'
717
- | 'BW'
718
- | 'BV'
719
- | 'BR'
720
- | 'IO'
721
- | 'BN'
722
- | 'BG'
723
- | 'BF'
724
- | 'BI'
725
- | 'KH'
726
- | 'CM'
727
- | 'CA'
728
- | 'CV'
729
- | 'KY'
730
- | 'CF'
731
- | 'TD'
732
- | 'CL'
733
- | 'CN'
734
- | 'CX'
735
- | 'CC'
736
- | 'CO'
737
- | 'KM'
738
- | 'CG'
739
- | 'CD'
740
- | 'CK'
741
- | 'CR'
742
- | 'CI'
743
- | 'HR'
744
- | 'CU'
745
- | 'CY'
746
- | 'CZ'
747
- | 'DK'
748
- | 'DJ'
749
- | 'DM'
750
- | 'DO'
751
- | 'EC'
752
- | 'EG'
753
- | 'SV'
754
- | 'GQ'
755
- | 'ER'
756
- | 'EE'
757
- | 'ET'
758
- | 'FK'
759
- | 'FO'
760
- | 'FJ'
761
- | 'FI'
762
- | 'FR'
763
- | 'GF'
764
- | 'PF'
765
- | 'TF'
766
- | 'GA'
767
- | 'GM'
768
- | 'GE'
769
- | 'DE'
770
- | 'GH'
771
- | 'GI'
772
- | 'GR'
773
- | 'GL'
774
- | 'GD'
775
- | 'GP'
776
- | 'GU'
777
- | 'GT'
778
- | 'GN'
779
- | 'GW'
780
- | 'GY'
781
- | 'HT'
782
- | 'HM'
783
- | 'VA'
784
- | 'HN'
785
- | 'HK'
786
- | 'HU'
787
- | 'IS'
788
- | 'IN'
789
- | 'ID'
790
- | 'IR'
791
- | 'IQ'
792
- | 'IE'
793
- | 'IL'
794
- | 'IT'
795
- | 'JM'
796
- | 'JP'
797
- | 'JO'
798
- | 'KZ'
799
- | 'KE'
800
- | 'KI'
801
- | 'KP'
802
- | 'KR'
803
- | 'KW'
804
- | 'KG'
805
- | 'LA'
806
- | 'LV'
807
- | 'LB'
808
- | 'LS'
809
- | 'LR'
810
- | 'LY'
811
- | 'LI'
812
- | 'LT'
813
- | 'LU'
814
- | 'MO'
815
- | 'MG'
816
- | 'MW'
817
- | 'MY'
818
- | 'MV'
819
- | 'ML'
820
- | 'MT'
821
- | 'MH'
822
- | 'MQ'
823
- | 'MR'
824
- | 'MU'
825
- | 'YT'
826
- | 'MX'
827
- | 'FM'
828
- | 'MD'
829
- | 'MC'
830
- | 'MN'
831
- | 'MS'
832
- | 'MA'
833
- | 'MZ'
834
- | 'MM'
835
- | 'NA'
836
- | 'NR'
837
- | 'NP'
838
- | 'NL'
839
- | 'NC'
840
- | 'NZ'
841
- | 'NI'
842
- | 'NE'
843
- | 'NG'
844
- | 'NU'
845
- | 'NF'
846
- | 'MP'
847
- | 'MK'
848
- | 'NO'
849
- | 'OM'
850
- | 'PK'
851
- | 'PW'
852
- | 'PS'
853
- | 'PA'
854
- | 'PG'
855
- | 'PY'
856
- | 'PE'
857
- | 'PH'
858
- | 'PN'
859
- | 'PL'
860
- | 'PT'
861
- | 'PR'
862
- | 'QA'
863
- | 'RE'
864
- | 'RO'
865
- | 'RU'
866
- | 'RW'
867
- | 'SH'
868
- | 'KN'
869
- | 'LC'
870
- | 'PM'
871
- | 'VC'
872
- | 'WS'
873
- | 'SM'
874
- | 'ST'
875
- | 'SA'
876
- | 'SN'
877
- | 'SC'
878
- | 'SL'
879
- | 'SG'
880
- | 'SK'
881
- | 'SI'
882
- | 'SB'
883
- | 'SO'
884
- | 'ZA'
885
- | 'GS'
886
- | 'ES'
887
- | 'LK'
888
- | 'SD'
889
- | 'SR'
890
- | 'SJ'
891
- | 'SZ'
892
- | 'SE'
893
- | 'CH'
894
- | 'SY'
895
- | 'TW'
896
- | 'TJ'
897
- | 'TZ'
898
- | 'TH'
899
- | 'TL'
900
- | 'TG'
901
- | 'TK'
902
- | 'TO'
903
- | 'TT'
904
- | 'TN'
905
- | 'TR'
906
- | 'TM'
907
- | 'TC'
908
- | 'TV'
909
- | 'UG'
910
- | 'UA'
911
- | 'AE'
912
- | 'GB'
913
- | 'US'
914
- | 'UM'
915
- | 'UY'
916
- | 'UZ'
917
- | 'VU'
918
- | 'VE'
919
- | 'VN'
920
- | 'VG'
921
- | 'VI'
922
- | 'WF'
923
- | 'EH'
924
- | 'YE'
925
- | 'ZM'
926
- | 'ZW'
927
- | 'AX'
928
- | 'BQ'
929
- | 'CW'
930
- | 'GG'
931
- | 'IM'
932
- | 'JE'
933
- | 'ME'
934
- | 'BL'
935
- | 'MF'
936
- | 'RS'
937
- | 'SX'
938
- | 'SS'
939
- | 'XK';
940
-
941
- /**
942
- * Any data stored with this data session.
943
- */
944
- metadata?: { [key: string]: unknown };
945
-
946
- /**
947
- * Prefill options for the data session
948
- */
949
- prefill?: SessionRetrieveResponse.Prefill;
950
- }
951
-
952
- export namespace SessionRetrieveResponse {
953
- /**
954
- * Prefill options for the data session
955
- */
956
- export interface Prefill {
957
- /**
958
- * The preselected bank ID.
959
- */
960
- bankId?: string;
961
- }
962
- }
963
-
964
- export interface SessionCreateParams {
965
- /**
966
- * An internal reference id which will be stored with the data session. Needs to be
967
- * unique per data session. Maximum length is 200 characters.
968
- */
969
- referenceId: string;
970
-
971
- /**
972
- * Required when setting expiresAt. The Epoch time in seconds at which the Session
973
- * was created.
974
- */
975
- createdAt?: number;
976
-
977
- /**
978
- * False by default. If set to true, customers cannot choose another bank than the
979
- * pre-selected one.
980
- */
981
- disableBankSelection?: boolean;
982
-
983
- /**
984
- * Currently only visible in the merchant dashboard. This id used to be displayed
985
- * to the user during the checkout.
986
- */
987
- displayId?: string;
988
-
989
- /**
990
- * Required if not set in the dashboard. Users will be redirected here after a
991
- * unsuccessful session.
992
- */
993
- errorCallbackUrl?: string;
994
-
995
- /**
996
- * The Epoch time in seconds at which the Session should expire. It can be anywhere
997
- * from 30 minutes to 24 hours after Session creation. By default, this value is 1
998
- * hour from creation. When setting this field, you also need to set `created`.
999
- */
1000
- expiresAt?: number;
1001
-
1002
- /**
1003
- * The locale of the data session. If not provided, the default locale will be
1004
- * used.
1005
- */
1006
- locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'fi' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
1007
-
1008
- /**
1009
- * ISO 3166-1 alpha-2 country code of the market. If set, the market's default
1010
- * banks will be displayed during the Data Session.
1011
- */
1012
- market?:
1013
- | 'AF'
1014
- | 'AL'
1015
- | 'DZ'
1016
- | 'AS'
1017
- | 'AD'
1018
- | 'AO'
1019
- | 'AI'
1020
- | 'AQ'
1021
- | 'AG'
1022
- | 'AR'
1023
- | 'AM'
1024
- | 'AW'
1025
- | 'AU'
1026
- | 'AT'
1027
- | 'AZ'
1028
- | 'BS'
1029
- | 'BH'
1030
- | 'BD'
1031
- | 'BB'
1032
- | 'BY'
1033
- | 'BE'
1034
- | 'BZ'
1035
- | 'BJ'
1036
- | 'BM'
1037
- | 'BT'
1038
- | 'BO'
1039
- | 'BA'
1040
- | 'BW'
1041
- | 'BV'
1042
- | 'BR'
1043
- | 'IO'
1044
- | 'BN'
1045
- | 'BG'
1046
- | 'BF'
1047
- | 'BI'
1048
- | 'KH'
1049
- | 'CM'
1050
- | 'CA'
1051
- | 'CV'
1052
- | 'KY'
1053
- | 'CF'
1054
- | 'TD'
1055
- | 'CL'
1056
- | 'CN'
1057
- | 'CX'
1058
- | 'CC'
1059
- | 'CO'
1060
- | 'KM'
1061
- | 'CG'
1062
- | 'CD'
1063
- | 'CK'
1064
- | 'CR'
1065
- | 'CI'
1066
- | 'HR'
1067
- | 'CU'
1068
- | 'CY'
1069
- | 'CZ'
1070
- | 'DK'
1071
- | 'DJ'
1072
- | 'DM'
1073
- | 'DO'
1074
- | 'EC'
1075
- | 'EG'
1076
- | 'SV'
1077
- | 'GQ'
1078
- | 'ER'
1079
- | 'EE'
1080
- | 'ET'
1081
- | 'FK'
1082
- | 'FO'
1083
- | 'FJ'
1084
- | 'FI'
1085
- | 'FR'
1086
- | 'GF'
1087
- | 'PF'
1088
- | 'TF'
1089
- | 'GA'
1090
- | 'GM'
1091
- | 'GE'
1092
- | 'DE'
1093
- | 'GH'
1094
- | 'GI'
1095
- | 'GR'
1096
- | 'GL'
1097
- | 'GD'
1098
- | 'GP'
1099
- | 'GU'
1100
- | 'GT'
1101
- | 'GN'
1102
- | 'GW'
1103
- | 'GY'
1104
- | 'HT'
1105
- | 'HM'
1106
- | 'VA'
1107
- | 'HN'
1108
- | 'HK'
1109
- | 'HU'
1110
- | 'IS'
1111
- | 'IN'
1112
- | 'ID'
1113
- | 'IR'
1114
- | 'IQ'
1115
- | 'IE'
1116
- | 'IL'
1117
- | 'IT'
1118
- | 'JM'
1119
- | 'JP'
1120
- | 'JO'
1121
- | 'KZ'
1122
- | 'KE'
1123
- | 'KI'
1124
- | 'KP'
1125
- | 'KR'
1126
- | 'KW'
1127
- | 'KG'
1128
- | 'LA'
1129
- | 'LV'
1130
- | 'LB'
1131
- | 'LS'
1132
- | 'LR'
1133
- | 'LY'
1134
- | 'LI'
1135
- | 'LT'
1136
- | 'LU'
1137
- | 'MO'
1138
- | 'MG'
1139
- | 'MW'
1140
- | 'MY'
1141
- | 'MV'
1142
- | 'ML'
1143
- | 'MT'
1144
- | 'MH'
1145
- | 'MQ'
1146
- | 'MR'
1147
- | 'MU'
1148
- | 'YT'
1149
- | 'MX'
1150
- | 'FM'
1151
- | 'MD'
1152
- | 'MC'
1153
- | 'MN'
1154
- | 'MS'
1155
- | 'MA'
1156
- | 'MZ'
1157
- | 'MM'
1158
- | 'NA'
1159
- | 'NR'
1160
- | 'NP'
1161
- | 'NL'
1162
- | 'NC'
1163
- | 'NZ'
1164
- | 'NI'
1165
- | 'NE'
1166
- | 'NG'
1167
- | 'NU'
1168
- | 'NF'
1169
- | 'MP'
1170
- | 'MK'
1171
- | 'NO'
1172
- | 'OM'
1173
- | 'PK'
1174
- | 'PW'
1175
- | 'PS'
1176
- | 'PA'
1177
- | 'PG'
1178
- | 'PY'
1179
- | 'PE'
1180
- | 'PH'
1181
- | 'PN'
1182
- | 'PL'
1183
- | 'PT'
1184
- | 'PR'
1185
- | 'QA'
1186
- | 'RE'
1187
- | 'RO'
1188
- | 'RU'
1189
- | 'RW'
1190
- | 'SH'
1191
- | 'KN'
1192
- | 'LC'
1193
- | 'PM'
1194
- | 'VC'
1195
- | 'WS'
1196
- | 'SM'
1197
- | 'ST'
1198
- | 'SA'
1199
- | 'SN'
1200
- | 'SC'
1201
- | 'SL'
1202
- | 'SG'
1203
- | 'SK'
1204
- | 'SI'
1205
- | 'SB'
1206
- | 'SO'
1207
- | 'ZA'
1208
- | 'GS'
1209
- | 'ES'
1210
- | 'LK'
1211
- | 'SD'
1212
- | 'SR'
1213
- | 'SJ'
1214
- | 'SZ'
1215
- | 'SE'
1216
- | 'CH'
1217
- | 'SY'
1218
- | 'TW'
1219
- | 'TJ'
1220
- | 'TZ'
1221
- | 'TH'
1222
- | 'TL'
1223
- | 'TG'
1224
- | 'TK'
1225
- | 'TO'
1226
- | 'TT'
1227
- | 'TN'
1228
- | 'TR'
1229
- | 'TM'
1230
- | 'TC'
1231
- | 'TV'
1232
- | 'UG'
1233
- | 'UA'
1234
- | 'AE'
1235
- | 'GB'
1236
- | 'US'
1237
- | 'UM'
1238
- | 'UY'
1239
- | 'UZ'
1240
- | 'VU'
1241
- | 'VE'
1242
- | 'VN'
1243
- | 'VG'
1244
- | 'VI'
1245
- | 'WF'
1246
- | 'EH'
1247
- | 'YE'
1248
- | 'ZM'
1249
- | 'ZW'
1250
- | 'AX'
1251
- | 'BQ'
1252
- | 'CW'
1253
- | 'GG'
1254
- | 'IM'
1255
- | 'JE'
1256
- | 'ME'
1257
- | 'BL'
1258
- | 'MF'
1259
- | 'RS'
1260
- | 'SX'
1261
- | 'SS'
1262
- | 'XK';
1263
-
1264
- /**
1265
- * Any data which will be stored and returned for this data session. See
1266
- * [here](https://docs.getivy.de/reference/metadata) for more info.
1267
- */
1268
- metadata?: { [key: string]: unknown };
1269
-
1270
- /**
1271
- * Prefill options for the data session
1272
- */
1273
- prefill?: SessionCreateParams.Prefill;
1274
-
1275
- /**
1276
- * Required if not set in the dashboard. Users will be redirected here after a
1277
- * successful session.
1278
- */
1279
- successCallbackUrl?: string;
1280
-
1281
- /**
1282
- * The theme variant which will be used in the data session. If not provided, the
1283
- * default light theme will be used.
1284
- */
1285
- themeVariant?: 'light' | 'dark';
1286
- }
1287
-
1288
- export namespace SessionCreateParams {
1289
- /**
1290
- * Prefill options for the data session
1291
- */
1292
- export interface Prefill {
1293
- /**
1294
- * The preselected bank. Provide a valid bankId from the bank endpoints. If given,
1295
- * the user will skip the bank selection.
1296
- */
1297
- bankId?: string;
1298
- }
1299
- }
1300
-
1301
- export interface SessionRetrieveParams {
1302
- /**
1303
- * The id of the data session.
1304
- */
1305
- id: string;
1306
- }
1307
-
1308
- export declare namespace Session {
1309
- export {
1310
- type SessionCreateResponse as SessionCreateResponse,
1311
- type SessionRetrieveResponse as SessionRetrieveResponse,
1312
- type SessionCreateParams as SessionCreateParams,
1313
- type SessionRetrieveParams as SessionRetrieveParams,
1314
- };
1315
- }