@getivy/node-sdk 0.1.0-alpha.30 → 0.1.0-alpha.32
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/CHANGELOG.md +26 -0
- package/README.md +13 -25
- package/package.json +1 -1
- package/resources/charges.d.ts +2 -2
- package/resources/checkoutsession.d.ts +25 -344
- package/resources/checkoutsession.d.ts.map +1 -1
- package/resources/data/session.d.ts +9 -8
- package/resources/data/session.d.ts.map +1 -1
- package/resources/orders.d.ts +16 -312
- package/resources/orders.d.ts.map +1 -1
- package/src/resources/charges.ts +2 -2
- package/src/resources/checkoutsession.ts +258 -2164
- package/src/resources/data/session.ts +9 -8
- package/src/resources/orders.ts +608 -1940
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -28,8 +28,8 @@ export interface CheckoutsessionCreateResponse {
|
|
|
28
28
|
availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
29
29
|
createdAt: string;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
32
|
+
* displayed to the user during the checkout.
|
|
33
33
|
*/
|
|
34
34
|
displayId: string;
|
|
35
35
|
/**
|
|
@@ -70,7 +70,7 @@ export interface CheckoutsessionCreateResponse {
|
|
|
70
70
|
abortReason?: string;
|
|
71
71
|
appId?: string;
|
|
72
72
|
/**
|
|
73
|
-
* The billing address of the customer.
|
|
73
|
+
* The billing address of the customer.
|
|
74
74
|
*/
|
|
75
75
|
billingAddress?: CheckoutsessionCreateResponse.BillingAddress;
|
|
76
76
|
/**
|
|
@@ -114,21 +114,16 @@ export interface CheckoutsessionCreateResponse {
|
|
|
114
114
|
* complete callback endpoint. Always true for express sessions.
|
|
115
115
|
*/
|
|
116
116
|
handshake?: boolean;
|
|
117
|
-
impactOffsetProjects?: Array<string>;
|
|
118
117
|
/**
|
|
119
|
-
*
|
|
120
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
121
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
122
|
-
* session will contain sustainable incentives for users.
|
|
118
|
+
* @deprecated
|
|
123
119
|
*/
|
|
124
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
125
120
|
lineItems?: Array<CheckoutsessionCreateResponse.LineItem>;
|
|
126
121
|
/**
|
|
127
122
|
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
128
123
|
* given language. Users can change the language in the Checkout. If not provided,
|
|
129
124
|
* the language of the Checkout is determined by the browser's language.
|
|
130
125
|
*/
|
|
131
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
126
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
132
127
|
mandate?: CheckoutsessionCreateResponse.Mandate;
|
|
133
128
|
/**
|
|
134
129
|
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
@@ -146,12 +141,7 @@ export interface CheckoutsessionCreateResponse {
|
|
|
146
141
|
* more info.
|
|
147
142
|
*/
|
|
148
143
|
metadata?: Record<string, unknown>;
|
|
149
|
-
offsetProject?: string;
|
|
150
144
|
paymentSchemeSelection?: string;
|
|
151
|
-
/**
|
|
152
|
-
* The shop-plugin version.
|
|
153
|
-
*/
|
|
154
|
-
plugin?: string;
|
|
155
145
|
/**
|
|
156
146
|
* Prefill known data to skip steps in the checkout.
|
|
157
147
|
*/
|
|
@@ -166,9 +156,6 @@ export interface CheckoutsessionCreateResponse {
|
|
|
166
156
|
* input within the Ivy express Checkout.
|
|
167
157
|
*/
|
|
168
158
|
required?: CheckoutsessionCreateResponse.Required;
|
|
169
|
-
selectedShippingMethodId?: string;
|
|
170
|
-
shippingAddress?: CheckoutsessionCreateResponse.ShippingAddress;
|
|
171
|
-
shippingMethods?: Array<CheckoutsessionCreateResponse.ShippingMethod>;
|
|
172
159
|
/**
|
|
173
160
|
* The logo of the shop provided as a URL.
|
|
174
161
|
*/
|
|
@@ -217,7 +204,7 @@ export declare namespace CheckoutsessionCreateResponse {
|
|
|
217
204
|
vat?: number;
|
|
218
205
|
}
|
|
219
206
|
/**
|
|
220
|
-
* The billing address of the customer.
|
|
207
|
+
* The billing address of the customer.
|
|
221
208
|
*/
|
|
222
209
|
interface BillingAddress {
|
|
223
210
|
city: string;
|
|
@@ -236,9 +223,6 @@ export declare namespace CheckoutsessionCreateResponse {
|
|
|
236
223
|
interface Customer {
|
|
237
224
|
id: string;
|
|
238
225
|
}
|
|
239
|
-
/**
|
|
240
|
-
* The line items of the Checkout.
|
|
241
|
-
*/
|
|
242
226
|
interface LineItem {
|
|
243
227
|
/**
|
|
244
228
|
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
@@ -311,96 +295,6 @@ export declare namespace CheckoutsessionCreateResponse {
|
|
|
311
295
|
*/
|
|
312
296
|
phone: boolean;
|
|
313
297
|
}
|
|
314
|
-
interface ShippingAddress {
|
|
315
|
-
city: string;
|
|
316
|
-
/**
|
|
317
|
-
* The country code in
|
|
318
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
319
|
-
*/
|
|
320
|
-
country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
321
|
-
line1: string;
|
|
322
|
-
zipCode: string;
|
|
323
|
-
firstName?: string;
|
|
324
|
-
lastName?: string;
|
|
325
|
-
line2?: string;
|
|
326
|
-
region?: string;
|
|
327
|
-
}
|
|
328
|
-
/**
|
|
329
|
-
* The shipping methods of the Checkout.
|
|
330
|
-
*/
|
|
331
|
-
interface ShippingMethod {
|
|
332
|
-
/**
|
|
333
|
-
* The customer-facing name of the shipping method.
|
|
334
|
-
*/
|
|
335
|
-
name: string;
|
|
336
|
-
/**
|
|
337
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
338
|
-
*/
|
|
339
|
-
price: number;
|
|
340
|
-
/**
|
|
341
|
-
* The unique identifier of the shipping method within Ivy.
|
|
342
|
-
*/
|
|
343
|
-
id?: string;
|
|
344
|
-
/**
|
|
345
|
-
* The list of countries where the shipping method is available.
|
|
346
|
-
*/
|
|
347
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
348
|
-
/**
|
|
349
|
-
* The delivery estimate of the shipping method.
|
|
350
|
-
*/
|
|
351
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
352
|
-
/**
|
|
353
|
-
* The unique identifier within your system of the shipping method.
|
|
354
|
-
*/
|
|
355
|
-
reference?: string;
|
|
356
|
-
/**
|
|
357
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
358
|
-
*/
|
|
359
|
-
timeFrame?: string;
|
|
360
|
-
}
|
|
361
|
-
namespace ShippingMethod {
|
|
362
|
-
/**
|
|
363
|
-
* The delivery estimate of the shipping method.
|
|
364
|
-
*/
|
|
365
|
-
interface DeliveryEstimate {
|
|
366
|
-
/**
|
|
367
|
-
* The maximum delivery time.
|
|
368
|
-
*/
|
|
369
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
370
|
-
/**
|
|
371
|
-
* The minimum delivery time.
|
|
372
|
-
*/
|
|
373
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
374
|
-
}
|
|
375
|
-
namespace DeliveryEstimate {
|
|
376
|
-
/**
|
|
377
|
-
* The maximum delivery time.
|
|
378
|
-
*/
|
|
379
|
-
interface Maximum {
|
|
380
|
-
/**
|
|
381
|
-
* The unit of the time duration.
|
|
382
|
-
*/
|
|
383
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
384
|
-
/**
|
|
385
|
-
* The value of the time duration.
|
|
386
|
-
*/
|
|
387
|
-
value: number;
|
|
388
|
-
}
|
|
389
|
-
/**
|
|
390
|
-
* The minimum delivery time.
|
|
391
|
-
*/
|
|
392
|
-
interface Minimum {
|
|
393
|
-
/**
|
|
394
|
-
* The unit of the time duration.
|
|
395
|
-
*/
|
|
396
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
397
|
-
/**
|
|
398
|
-
* The value of the time duration.
|
|
399
|
-
*/
|
|
400
|
-
value: number;
|
|
401
|
-
}
|
|
402
|
-
}
|
|
403
|
-
}
|
|
404
298
|
}
|
|
405
299
|
export interface CheckoutsessionRetrieveResponse {
|
|
406
300
|
/**
|
|
@@ -413,8 +307,8 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
413
307
|
availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
414
308
|
createdAt: string;
|
|
415
309
|
/**
|
|
416
|
-
*
|
|
417
|
-
*
|
|
310
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
311
|
+
* displayed to the user during the checkout.
|
|
418
312
|
*/
|
|
419
313
|
displayId: string;
|
|
420
314
|
/**
|
|
@@ -455,7 +349,7 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
455
349
|
abortReason?: string;
|
|
456
350
|
appId?: string;
|
|
457
351
|
/**
|
|
458
|
-
* The billing address of the customer.
|
|
352
|
+
* The billing address of the customer.
|
|
459
353
|
*/
|
|
460
354
|
billingAddress?: CheckoutsessionRetrieveResponse.BillingAddress;
|
|
461
355
|
/**
|
|
@@ -499,21 +393,16 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
499
393
|
* complete callback endpoint. Always true for express sessions.
|
|
500
394
|
*/
|
|
501
395
|
handshake?: boolean;
|
|
502
|
-
impactOffsetProjects?: Array<string>;
|
|
503
396
|
/**
|
|
504
|
-
*
|
|
505
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
506
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
507
|
-
* session will contain sustainable incentives for users.
|
|
397
|
+
* @deprecated
|
|
508
398
|
*/
|
|
509
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
510
399
|
lineItems?: Array<CheckoutsessionRetrieveResponse.LineItem>;
|
|
511
400
|
/**
|
|
512
401
|
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
513
402
|
* given language. Users can change the language in the Checkout. If not provided,
|
|
514
403
|
* the language of the Checkout is determined by the browser's language.
|
|
515
404
|
*/
|
|
516
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
405
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
517
406
|
mandate?: CheckoutsessionRetrieveResponse.Mandate;
|
|
518
407
|
/**
|
|
519
408
|
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
@@ -531,12 +420,7 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
531
420
|
* more info.
|
|
532
421
|
*/
|
|
533
422
|
metadata?: Record<string, unknown>;
|
|
534
|
-
offsetProject?: string;
|
|
535
423
|
paymentSchemeSelection?: string;
|
|
536
|
-
/**
|
|
537
|
-
* The shop-plugin version.
|
|
538
|
-
*/
|
|
539
|
-
plugin?: string;
|
|
540
424
|
/**
|
|
541
425
|
* Prefill known data to skip steps in the checkout.
|
|
542
426
|
*/
|
|
@@ -551,9 +435,6 @@ export interface CheckoutsessionRetrieveResponse {
|
|
|
551
435
|
* input within the Ivy express Checkout.
|
|
552
436
|
*/
|
|
553
437
|
required?: CheckoutsessionRetrieveResponse.Required;
|
|
554
|
-
selectedShippingMethodId?: string;
|
|
555
|
-
shippingAddress?: CheckoutsessionRetrieveResponse.ShippingAddress;
|
|
556
|
-
shippingMethods?: Array<CheckoutsessionRetrieveResponse.ShippingMethod>;
|
|
557
438
|
/**
|
|
558
439
|
* The logo of the shop provided as a URL.
|
|
559
440
|
*/
|
|
@@ -602,7 +483,7 @@ export declare namespace CheckoutsessionRetrieveResponse {
|
|
|
602
483
|
vat?: number;
|
|
603
484
|
}
|
|
604
485
|
/**
|
|
605
|
-
* The billing address of the customer.
|
|
486
|
+
* The billing address of the customer.
|
|
606
487
|
*/
|
|
607
488
|
interface BillingAddress {
|
|
608
489
|
city: string;
|
|
@@ -621,9 +502,6 @@ export declare namespace CheckoutsessionRetrieveResponse {
|
|
|
621
502
|
interface Customer {
|
|
622
503
|
id: string;
|
|
623
504
|
}
|
|
624
|
-
/**
|
|
625
|
-
* The line items of the Checkout.
|
|
626
|
-
*/
|
|
627
505
|
interface LineItem {
|
|
628
506
|
/**
|
|
629
507
|
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
@@ -696,96 +574,6 @@ export declare namespace CheckoutsessionRetrieveResponse {
|
|
|
696
574
|
*/
|
|
697
575
|
phone: boolean;
|
|
698
576
|
}
|
|
699
|
-
interface ShippingAddress {
|
|
700
|
-
city: string;
|
|
701
|
-
/**
|
|
702
|
-
* The country code in
|
|
703
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
704
|
-
*/
|
|
705
|
-
country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
706
|
-
line1: string;
|
|
707
|
-
zipCode: string;
|
|
708
|
-
firstName?: string;
|
|
709
|
-
lastName?: string;
|
|
710
|
-
line2?: string;
|
|
711
|
-
region?: string;
|
|
712
|
-
}
|
|
713
|
-
/**
|
|
714
|
-
* The shipping methods of the Checkout.
|
|
715
|
-
*/
|
|
716
|
-
interface ShippingMethod {
|
|
717
|
-
/**
|
|
718
|
-
* The customer-facing name of the shipping method.
|
|
719
|
-
*/
|
|
720
|
-
name: string;
|
|
721
|
-
/**
|
|
722
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
723
|
-
*/
|
|
724
|
-
price: number;
|
|
725
|
-
/**
|
|
726
|
-
* The unique identifier of the shipping method within Ivy.
|
|
727
|
-
*/
|
|
728
|
-
id?: string;
|
|
729
|
-
/**
|
|
730
|
-
* The list of countries where the shipping method is available.
|
|
731
|
-
*/
|
|
732
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
733
|
-
/**
|
|
734
|
-
* The delivery estimate of the shipping method.
|
|
735
|
-
*/
|
|
736
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
737
|
-
/**
|
|
738
|
-
* The unique identifier within your system of the shipping method.
|
|
739
|
-
*/
|
|
740
|
-
reference?: string;
|
|
741
|
-
/**
|
|
742
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
743
|
-
*/
|
|
744
|
-
timeFrame?: string;
|
|
745
|
-
}
|
|
746
|
-
namespace ShippingMethod {
|
|
747
|
-
/**
|
|
748
|
-
* The delivery estimate of the shipping method.
|
|
749
|
-
*/
|
|
750
|
-
interface DeliveryEstimate {
|
|
751
|
-
/**
|
|
752
|
-
* The maximum delivery time.
|
|
753
|
-
*/
|
|
754
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
755
|
-
/**
|
|
756
|
-
* The minimum delivery time.
|
|
757
|
-
*/
|
|
758
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
759
|
-
}
|
|
760
|
-
namespace DeliveryEstimate {
|
|
761
|
-
/**
|
|
762
|
-
* The maximum delivery time.
|
|
763
|
-
*/
|
|
764
|
-
interface Maximum {
|
|
765
|
-
/**
|
|
766
|
-
* The unit of the time duration.
|
|
767
|
-
*/
|
|
768
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
769
|
-
/**
|
|
770
|
-
* The value of the time duration.
|
|
771
|
-
*/
|
|
772
|
-
value: number;
|
|
773
|
-
}
|
|
774
|
-
/**
|
|
775
|
-
* The minimum delivery time.
|
|
776
|
-
*/
|
|
777
|
-
interface Minimum {
|
|
778
|
-
/**
|
|
779
|
-
* The unit of the time duration.
|
|
780
|
-
*/
|
|
781
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
782
|
-
/**
|
|
783
|
-
* The value of the time duration.
|
|
784
|
-
*/
|
|
785
|
-
value: number;
|
|
786
|
-
}
|
|
787
|
-
}
|
|
788
|
-
}
|
|
789
577
|
}
|
|
790
578
|
export interface CheckoutsessionExpireResponse {
|
|
791
579
|
/**
|
|
@@ -798,8 +586,8 @@ export interface CheckoutsessionExpireResponse {
|
|
|
798
586
|
availableMarkets: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
799
587
|
createdAt: string;
|
|
800
588
|
/**
|
|
801
|
-
*
|
|
802
|
-
*
|
|
589
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
590
|
+
* displayed to the user during the checkout.
|
|
803
591
|
*/
|
|
804
592
|
displayId: string;
|
|
805
593
|
/**
|
|
@@ -840,7 +628,7 @@ export interface CheckoutsessionExpireResponse {
|
|
|
840
628
|
abortReason?: string;
|
|
841
629
|
appId?: string;
|
|
842
630
|
/**
|
|
843
|
-
* The billing address of the customer.
|
|
631
|
+
* The billing address of the customer.
|
|
844
632
|
*/
|
|
845
633
|
billingAddress?: CheckoutsessionExpireResponse.BillingAddress;
|
|
846
634
|
/**
|
|
@@ -884,21 +672,16 @@ export interface CheckoutsessionExpireResponse {
|
|
|
884
672
|
* complete callback endpoint. Always true for express sessions.
|
|
885
673
|
*/
|
|
886
674
|
handshake?: boolean;
|
|
887
|
-
impactOffsetProjects?: Array<string>;
|
|
888
675
|
/**
|
|
889
|
-
*
|
|
890
|
-
* e-commerce, please use `white_label` as the value. If set to `white_label`, the
|
|
891
|
-
* checkout session will be white labeled. If set to `sustainable`, the checkout
|
|
892
|
-
* session will contain sustainable incentives for users.
|
|
676
|
+
* @deprecated
|
|
893
677
|
*/
|
|
894
|
-
incentiveMode?: 'white_label' | 'sustainable';
|
|
895
678
|
lineItems?: Array<CheckoutsessionExpireResponse.LineItem>;
|
|
896
679
|
/**
|
|
897
680
|
* The locale of the Checkout. If provided, the Checkout will be displayed in the
|
|
898
681
|
* given language. Users can change the language in the Checkout. If not provided,
|
|
899
682
|
* the language of the Checkout is determined by the browser's language.
|
|
900
683
|
*/
|
|
901
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
684
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
902
685
|
mandate?: CheckoutsessionExpireResponse.Mandate;
|
|
903
686
|
/**
|
|
904
687
|
* ISO 3166-1 alpha-2 country code. The market where the user of the Checkout is
|
|
@@ -916,12 +699,7 @@ export interface CheckoutsessionExpireResponse {
|
|
|
916
699
|
* more info.
|
|
917
700
|
*/
|
|
918
701
|
metadata?: Record<string, unknown>;
|
|
919
|
-
offsetProject?: string;
|
|
920
702
|
paymentSchemeSelection?: string;
|
|
921
|
-
/**
|
|
922
|
-
* The shop-plugin version.
|
|
923
|
-
*/
|
|
924
|
-
plugin?: string;
|
|
925
703
|
/**
|
|
926
704
|
* Prefill known data to skip steps in the checkout.
|
|
927
705
|
*/
|
|
@@ -936,9 +714,6 @@ export interface CheckoutsessionExpireResponse {
|
|
|
936
714
|
* input within the Ivy express Checkout.
|
|
937
715
|
*/
|
|
938
716
|
required?: CheckoutsessionExpireResponse.Required;
|
|
939
|
-
selectedShippingMethodId?: string;
|
|
940
|
-
shippingAddress?: CheckoutsessionExpireResponse.ShippingAddress;
|
|
941
|
-
shippingMethods?: Array<CheckoutsessionExpireResponse.ShippingMethod>;
|
|
942
717
|
/**
|
|
943
718
|
* The logo of the shop provided as a URL.
|
|
944
719
|
*/
|
|
@@ -987,7 +762,7 @@ export declare namespace CheckoutsessionExpireResponse {
|
|
|
987
762
|
vat?: number;
|
|
988
763
|
}
|
|
989
764
|
/**
|
|
990
|
-
* The billing address of the customer.
|
|
765
|
+
* The billing address of the customer.
|
|
991
766
|
*/
|
|
992
767
|
interface BillingAddress {
|
|
993
768
|
city: string;
|
|
@@ -1006,9 +781,6 @@ export declare namespace CheckoutsessionExpireResponse {
|
|
|
1006
781
|
interface Customer {
|
|
1007
782
|
id: string;
|
|
1008
783
|
}
|
|
1009
|
-
/**
|
|
1010
|
-
* The line items of the Checkout.
|
|
1011
|
-
*/
|
|
1012
784
|
interface LineItem {
|
|
1013
785
|
/**
|
|
1014
786
|
* The total amount of all line items, i.e. single amount \* quantity. Given in
|
|
@@ -1081,96 +853,6 @@ export declare namespace CheckoutsessionExpireResponse {
|
|
|
1081
853
|
*/
|
|
1082
854
|
phone: boolean;
|
|
1083
855
|
}
|
|
1084
|
-
interface ShippingAddress {
|
|
1085
|
-
city: string;
|
|
1086
|
-
/**
|
|
1087
|
-
* The country code in
|
|
1088
|
-
* [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
1089
|
-
*/
|
|
1090
|
-
country: 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK';
|
|
1091
|
-
line1: string;
|
|
1092
|
-
zipCode: string;
|
|
1093
|
-
firstName?: string;
|
|
1094
|
-
lastName?: string;
|
|
1095
|
-
line2?: string;
|
|
1096
|
-
region?: string;
|
|
1097
|
-
}
|
|
1098
|
-
/**
|
|
1099
|
-
* The shipping methods of the Checkout.
|
|
1100
|
-
*/
|
|
1101
|
-
interface ShippingMethod {
|
|
1102
|
-
/**
|
|
1103
|
-
* The customer-facing name of the shipping method.
|
|
1104
|
-
*/
|
|
1105
|
-
name: string;
|
|
1106
|
-
/**
|
|
1107
|
-
* The price of the shipping method in decimals, i.e. 10.23 represents EUR 10.23.
|
|
1108
|
-
*/
|
|
1109
|
-
price: number;
|
|
1110
|
-
/**
|
|
1111
|
-
* The unique identifier of the shipping method within Ivy.
|
|
1112
|
-
*/
|
|
1113
|
-
id?: string;
|
|
1114
|
-
/**
|
|
1115
|
-
* The list of countries where the shipping method is available.
|
|
1116
|
-
*/
|
|
1117
|
-
countries?: Array<'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK'>;
|
|
1118
|
-
/**
|
|
1119
|
-
* The delivery estimate of the shipping method.
|
|
1120
|
-
*/
|
|
1121
|
-
deliveryEstimate?: ShippingMethod.DeliveryEstimate;
|
|
1122
|
-
/**
|
|
1123
|
-
* The unique identifier within your system of the shipping method.
|
|
1124
|
-
*/
|
|
1125
|
-
reference?: string;
|
|
1126
|
-
/**
|
|
1127
|
-
* @deprecated Deprecated in favor of deliveryEstimate
|
|
1128
|
-
*/
|
|
1129
|
-
timeFrame?: string;
|
|
1130
|
-
}
|
|
1131
|
-
namespace ShippingMethod {
|
|
1132
|
-
/**
|
|
1133
|
-
* The delivery estimate of the shipping method.
|
|
1134
|
-
*/
|
|
1135
|
-
interface DeliveryEstimate {
|
|
1136
|
-
/**
|
|
1137
|
-
* The maximum delivery time.
|
|
1138
|
-
*/
|
|
1139
|
-
maximum?: DeliveryEstimate.Maximum;
|
|
1140
|
-
/**
|
|
1141
|
-
* The minimum delivery time.
|
|
1142
|
-
*/
|
|
1143
|
-
minimum?: DeliveryEstimate.Minimum;
|
|
1144
|
-
}
|
|
1145
|
-
namespace DeliveryEstimate {
|
|
1146
|
-
/**
|
|
1147
|
-
* The maximum delivery time.
|
|
1148
|
-
*/
|
|
1149
|
-
interface Maximum {
|
|
1150
|
-
/**
|
|
1151
|
-
* The unit of the time duration.
|
|
1152
|
-
*/
|
|
1153
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1154
|
-
/**
|
|
1155
|
-
* The value of the time duration.
|
|
1156
|
-
*/
|
|
1157
|
-
value: number;
|
|
1158
|
-
}
|
|
1159
|
-
/**
|
|
1160
|
-
* The minimum delivery time.
|
|
1161
|
-
*/
|
|
1162
|
-
interface Minimum {
|
|
1163
|
-
/**
|
|
1164
|
-
* The unit of the time duration.
|
|
1165
|
-
*/
|
|
1166
|
-
unit: 'hour' | 'day' | 'business_day' | 'week' | 'month';
|
|
1167
|
-
/**
|
|
1168
|
-
* The value of the time duration.
|
|
1169
|
-
*/
|
|
1170
|
-
value: number;
|
|
1171
|
-
}
|
|
1172
|
-
}
|
|
1173
|
-
}
|
|
1174
856
|
}
|
|
1175
857
|
export interface CheckoutsessionCreateParams {
|
|
1176
858
|
/**
|
|
@@ -1197,8 +879,8 @@ export interface CheckoutsessionCreateParams {
|
|
|
1197
879
|
*/
|
|
1198
880
|
completeCallbackUrl?: string;
|
|
1199
881
|
/**
|
|
1200
|
-
* The Epoch time in seconds at which the Checkout Session was created.
|
|
1201
|
-
* time of Checkout creation at Ivy.
|
|
882
|
+
* @deprecated The Epoch time in seconds at which the Checkout Session was created.
|
|
883
|
+
* By default, time of Checkout creation at Ivy.
|
|
1202
884
|
*/
|
|
1203
885
|
created?: number;
|
|
1204
886
|
/**
|
|
@@ -1211,9 +893,8 @@ export interface CheckoutsessionCreateParams {
|
|
|
1211
893
|
*/
|
|
1212
894
|
disableBankSelection?: boolean;
|
|
1213
895
|
/**
|
|
1214
|
-
*
|
|
1215
|
-
*
|
|
1216
|
-
* customer-friendly id.
|
|
896
|
+
* @deprecated Currently only visible in the merchant dashboard. This id used to be
|
|
897
|
+
* displayed to the user during the checkout.
|
|
1217
898
|
*/
|
|
1218
899
|
displayId?: string;
|
|
1219
900
|
/**
|
|
@@ -1223,8 +904,8 @@ export interface CheckoutsessionCreateParams {
|
|
|
1223
904
|
errorCallbackUrl?: string;
|
|
1224
905
|
/**
|
|
1225
906
|
* The Epoch time in seconds at which the Checkout Session will expire. It can be
|
|
1226
|
-
* anywhere from
|
|
1227
|
-
*
|
|
907
|
+
* anywhere from 5 minutes to 6 days after Checkout Session creation. By default,
|
|
908
|
+
* this value is 1 hour from creation.
|
|
1228
909
|
*/
|
|
1229
910
|
expiresAt?: number;
|
|
1230
911
|
/**
|
|
@@ -1241,7 +922,7 @@ export interface CheckoutsessionCreateParams {
|
|
|
1241
922
|
* change the language in the checkout. If not provided, the language of the
|
|
1242
923
|
* checkout is determined by the browser's language.
|
|
1243
924
|
*/
|
|
1244
|
-
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk';
|
|
925
|
+
locale?: 'de' | 'nl' | 'en' | 'fr' | 'es' | 'it' | 'pt' | 'sv' | 'pl' | 'sk' | 'lt';
|
|
1245
926
|
/**
|
|
1246
927
|
* The mandate setup for the payment. Relevant for
|
|
1247
928
|
* [Ivy on File](https://docs.getivy.de/docs/beta-ivy-on-file)
|