@wix/auto_sdk_ecom_totals-calculator 1.0.22 → 1.0.24
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/build/{cjs/src/ecom-v1-totals-calculation-totals-calculator.types.d.ts → ecom-v1-totals-calculation-totals-calculator.universal-C6shYu5t.d.mts} +215 -130
- package/build/{internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.types.d.ts → ecom-v1-totals-calculation-totals-calculator.universal-C6shYu5t.d.ts} +215 -130
- package/build/index.d.mts +15 -0
- package/build/index.d.ts +15 -0
- package/build/index.js +426 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +387 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-v1-totals-calculation-totals-calculator.universal.d.ts → ecom-v1-totals-calculation-totals-calculator.universal-DGb3KaYa.d.mts} +120 -147
- package/build/internal/{cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.d.ts → ecom-v1-totals-calculation-totals-calculator.universal-DGb3KaYa.d.ts} +120 -147
- package/build/internal/index.d.mts +15 -0
- package/build/internal/index.d.ts +15 -0
- package/build/internal/index.js +426 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +387 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/ecom-v1-totals-calculation-totals-calculator.types.d.ts → internal/meta.d.mts} +112 -351
- package/build/internal/{es/src/ecom-v1-totals-calculation-totals-calculator.types.d.ts → meta.d.ts} +112 -351
- package/build/internal/meta.js +190 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +163 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1303 -0
- package/build/meta.d.ts +1303 -0
- package/build/meta.js +190 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +163 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.d.ts +0 -5
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.js +0 -23
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.d.ts +0 -3
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.js +0 -144
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.d.ts +0 -13
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.js +0 -47
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.d.ts +0 -13
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.js +0 -28
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.types.js +0 -146
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.d.ts +0 -1654
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.js +0 -279
- package/build/cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.context.d.ts +0 -5
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.context.js +0 -5
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.context.js.map +0 -1
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.http.d.ts +0 -3
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.http.js +0 -140
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.http.js.map +0 -1
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.meta.d.ts +0 -13
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.meta.js +0 -20
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.meta.js.map +0 -1
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.public.d.ts +0 -13
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.public.js +0 -9
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.public.js.map +0 -1
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.types.js +0 -143
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.types.js.map +0 -1
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.universal.d.ts +0 -1654
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.universal.js +0 -252
- package/build/es/src/ecom-v1-totals-calculation-totals-calculator.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.d.ts +0 -5
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.js +0 -23
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.d.ts +0 -3
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.js +0 -144
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.d.ts +0 -13
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.js +0 -47
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.d.ts +0 -13
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.js +0 -28
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.types.js +0 -146
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.js +0 -279
- package/build/internal/cjs/src/ecom-v1-totals-calculation-totals-calculator.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.context.d.ts +0 -5
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.context.js +0 -5
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.http.d.ts +0 -3
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.http.js +0 -140
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.meta.d.ts +0 -13
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.meta.js +0 -20
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.public.d.ts +0 -13
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.public.js +0 -9
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.types.js +0 -143
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.universal.js +0 -252
- package/build/internal/es/src/ecom-v1-totals-calculation-totals-calculator.universal.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
interface TotalsCalculationEntity {
|
|
2
2
|
}
|
|
3
|
-
|
|
3
|
+
interface CalculateTotalsRequest extends CalculateTotalsRequestCouponOneOf, CalculateTotalsRequestGiftCardOneOf {
|
|
4
4
|
/** Coupon ID. */
|
|
5
5
|
couponId?: string | null;
|
|
6
6
|
/** Coupon code. */
|
|
@@ -69,14 +69,14 @@ export interface CalculateTotalsRequest extends CalculateTotalsRequestCouponOneO
|
|
|
69
69
|
externalReferences?: ExternalReference[];
|
|
70
70
|
}
|
|
71
71
|
/** @oneof */
|
|
72
|
-
|
|
72
|
+
interface CalculateTotalsRequestCouponOneOf {
|
|
73
73
|
/** Coupon ID. */
|
|
74
74
|
couponId?: string | null;
|
|
75
75
|
/** Coupon code. */
|
|
76
76
|
couponCode?: string | null;
|
|
77
77
|
}
|
|
78
78
|
/** @oneof */
|
|
79
|
-
|
|
79
|
+
interface CalculateTotalsRequestGiftCardOneOf {
|
|
80
80
|
/**
|
|
81
81
|
* Gift card ID.
|
|
82
82
|
* @format GUID
|
|
@@ -85,13 +85,13 @@ export interface CalculateTotalsRequestGiftCardOneOf {
|
|
|
85
85
|
/** Gift card code. */
|
|
86
86
|
giftCardCode?: string | null;
|
|
87
87
|
}
|
|
88
|
-
|
|
88
|
+
interface LineItem {
|
|
89
89
|
/**
|
|
90
90
|
* Line item ID.
|
|
91
91
|
* @minLength 1
|
|
92
92
|
* @maxLength 100
|
|
93
93
|
*/
|
|
94
|
-
|
|
94
|
+
_id?: string;
|
|
95
95
|
/**
|
|
96
96
|
* Quantity.
|
|
97
97
|
* @max 100000
|
|
@@ -163,7 +163,7 @@ export interface LineItem {
|
|
|
163
163
|
additionalFees?: ApiV1AdditionalFee[];
|
|
164
164
|
}
|
|
165
165
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
166
|
-
|
|
166
|
+
interface CatalogReference {
|
|
167
167
|
/**
|
|
168
168
|
* ID of the item within the catalog it belongs to.
|
|
169
169
|
* @minLength 1
|
|
@@ -189,7 +189,7 @@ export interface CatalogReference {
|
|
|
189
189
|
*/
|
|
190
190
|
options?: Record<string, any> | null;
|
|
191
191
|
}
|
|
192
|
-
|
|
192
|
+
interface PhysicalProperties {
|
|
193
193
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
194
194
|
weight?: number | null;
|
|
195
195
|
/**
|
|
@@ -200,24 +200,24 @@ export interface PhysicalProperties {
|
|
|
200
200
|
/** Whether this line item is shippable. */
|
|
201
201
|
shippable?: boolean;
|
|
202
202
|
}
|
|
203
|
-
|
|
203
|
+
interface Scope {
|
|
204
204
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
205
205
|
namespace?: string;
|
|
206
206
|
/** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
|
|
207
207
|
group?: Group;
|
|
208
208
|
}
|
|
209
|
-
|
|
209
|
+
interface Group {
|
|
210
210
|
/** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
|
|
211
211
|
name?: string;
|
|
212
212
|
/** Item ID (when the coupon scope is limited to just one item). */
|
|
213
213
|
entityId?: string | null;
|
|
214
214
|
}
|
|
215
|
-
|
|
215
|
+
interface SubscriptionSettings {
|
|
216
216
|
/** Frequency of recurring payment. Every day/week/month/year. */
|
|
217
217
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
218
218
|
}
|
|
219
219
|
/** Frequency unit of recurring payment */
|
|
220
|
-
|
|
220
|
+
declare enum SubscriptionFrequency {
|
|
221
221
|
UNDEFINED = "UNDEFINED",
|
|
222
222
|
DAY = "DAY",
|
|
223
223
|
WEEK = "WEEK",
|
|
@@ -225,9 +225,9 @@ export declare enum SubscriptionFrequency {
|
|
|
225
225
|
YEAR = "YEAR"
|
|
226
226
|
}
|
|
227
227
|
/** @enumType */
|
|
228
|
-
|
|
228
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
229
229
|
/** Type of selected payment option for catalog item */
|
|
230
|
-
|
|
230
|
+
declare enum PaymentOptionType {
|
|
231
231
|
/** The entire payment for this item happens as part of the checkout. */
|
|
232
232
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
233
233
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -240,8 +240,8 @@ export declare enum PaymentOptionType {
|
|
|
240
240
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
241
241
|
}
|
|
242
242
|
/** @enumType */
|
|
243
|
-
|
|
244
|
-
|
|
243
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
244
|
+
interface ServiceProperties {
|
|
245
245
|
/**
|
|
246
246
|
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
247
247
|
* For example, the start time of a class.
|
|
@@ -254,20 +254,20 @@ export interface ServiceProperties {
|
|
|
254
254
|
*/
|
|
255
255
|
numberOfParticipants?: number | null;
|
|
256
256
|
}
|
|
257
|
-
|
|
257
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
258
258
|
/** Preset item type. */
|
|
259
259
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
260
260
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
261
261
|
custom?: string;
|
|
262
262
|
}
|
|
263
263
|
/** @oneof */
|
|
264
|
-
|
|
264
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
265
265
|
/** Preset item type. */
|
|
266
266
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
267
267
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
268
268
|
custom?: string;
|
|
269
269
|
}
|
|
270
|
-
|
|
270
|
+
declare enum ItemTypeItemType {
|
|
271
271
|
UNRECOGNISED = "UNRECOGNISED",
|
|
272
272
|
PHYSICAL = "PHYSICAL",
|
|
273
273
|
DIGITAL = "DIGITAL",
|
|
@@ -275,25 +275,25 @@ export declare enum ItemTypeItemType {
|
|
|
275
275
|
SERVICE = "SERVICE"
|
|
276
276
|
}
|
|
277
277
|
/** @enumType */
|
|
278
|
-
|
|
279
|
-
|
|
278
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
279
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
280
280
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
281
281
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
282
282
|
}
|
|
283
283
|
/** @oneof */
|
|
284
|
-
|
|
284
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
285
285
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
286
286
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
287
287
|
}
|
|
288
|
-
|
|
288
|
+
declare enum TaxableAddressType {
|
|
289
289
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
290
290
|
BUSINESS = "BUSINESS",
|
|
291
291
|
BILLING = "BILLING",
|
|
292
292
|
SHIPPING = "SHIPPING"
|
|
293
293
|
}
|
|
294
294
|
/** @enumType */
|
|
295
|
-
|
|
296
|
-
|
|
295
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
296
|
+
interface ApiV1AdditionalFee {
|
|
297
297
|
/**
|
|
298
298
|
* Additional fee's unique code or ID.
|
|
299
299
|
* @minLength 1
|
|
@@ -321,7 +321,7 @@ export interface ApiV1AdditionalFee {
|
|
|
321
321
|
taxDetails?: V1TaxDetails;
|
|
322
322
|
}
|
|
323
323
|
/** Tax details. */
|
|
324
|
-
|
|
324
|
+
interface V1TaxDetails {
|
|
325
325
|
/** Whether additional fee is taxable. */
|
|
326
326
|
taxable?: boolean;
|
|
327
327
|
/**
|
|
@@ -330,23 +330,23 @@ export interface V1TaxDetails {
|
|
|
330
330
|
*/
|
|
331
331
|
taxGroupId?: string | null;
|
|
332
332
|
}
|
|
333
|
-
|
|
333
|
+
interface ModifierGroup {
|
|
334
334
|
/**
|
|
335
335
|
* Modifier group id.
|
|
336
336
|
* @minLength 1
|
|
337
337
|
* @maxLength 36
|
|
338
338
|
*/
|
|
339
|
-
|
|
339
|
+
_id?: string;
|
|
340
340
|
/** Modifier group name. */
|
|
341
341
|
name?: TranslatableString;
|
|
342
342
|
/**
|
|
343
343
|
* List of modifiers in this group.
|
|
344
344
|
* @minSize 1
|
|
345
|
-
* @maxSize
|
|
345
|
+
* @maxSize 25
|
|
346
346
|
*/
|
|
347
347
|
modifiers?: ItemModifier[];
|
|
348
348
|
}
|
|
349
|
-
|
|
349
|
+
interface TranslatableString {
|
|
350
350
|
/**
|
|
351
351
|
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
352
352
|
*
|
|
@@ -367,13 +367,13 @@ export interface TranslatableString {
|
|
|
367
367
|
*/
|
|
368
368
|
translated?: string | null;
|
|
369
369
|
}
|
|
370
|
-
|
|
370
|
+
interface ItemModifier {
|
|
371
371
|
/**
|
|
372
372
|
* Modifier ID.
|
|
373
373
|
* @minLength 1
|
|
374
374
|
* @maxLength 36
|
|
375
375
|
*/
|
|
376
|
-
|
|
376
|
+
_id?: string;
|
|
377
377
|
/**
|
|
378
378
|
* The quantity of this modifier.
|
|
379
379
|
* @min 1
|
|
@@ -391,7 +391,7 @@ export interface ItemModifier {
|
|
|
391
391
|
price?: string | null;
|
|
392
392
|
}
|
|
393
393
|
/** Physical address */
|
|
394
|
-
|
|
394
|
+
interface Address {
|
|
395
395
|
/**
|
|
396
396
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
397
397
|
* @format COUNTRY
|
|
@@ -418,7 +418,7 @@ export interface Address {
|
|
|
418
418
|
* Main address line (usually street name and number).
|
|
419
419
|
* @maxLength 150
|
|
420
420
|
*/
|
|
421
|
-
|
|
421
|
+
addressLine1?: string | null;
|
|
422
422
|
/**
|
|
423
423
|
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
424
424
|
* @maxLength 100
|
|
@@ -435,19 +435,19 @@ export interface Address {
|
|
|
435
435
|
*/
|
|
436
436
|
subdivisionFullname?: string | null;
|
|
437
437
|
}
|
|
438
|
-
|
|
438
|
+
interface StreetAddress {
|
|
439
439
|
/** Street number. */
|
|
440
440
|
number?: string;
|
|
441
441
|
/** Street name. */
|
|
442
442
|
name?: string;
|
|
443
443
|
}
|
|
444
|
-
|
|
444
|
+
interface AddressLocation {
|
|
445
445
|
/** Address latitude. */
|
|
446
446
|
latitude?: number | null;
|
|
447
447
|
/** Address longitude. */
|
|
448
448
|
longitude?: number | null;
|
|
449
449
|
}
|
|
450
|
-
|
|
450
|
+
interface SelectedShippingOption {
|
|
451
451
|
/**
|
|
452
452
|
* Carrier ID.
|
|
453
453
|
* @format GUID
|
|
@@ -460,7 +460,7 @@ export interface SelectedShippingOption {
|
|
|
460
460
|
*/
|
|
461
461
|
code?: string;
|
|
462
462
|
}
|
|
463
|
-
|
|
463
|
+
interface MerchantDiscountInput {
|
|
464
464
|
/**
|
|
465
465
|
* Discount amount.
|
|
466
466
|
* @decimalValue options { gte:0 }
|
|
@@ -473,20 +473,20 @@ export interface MerchantDiscountInput {
|
|
|
473
473
|
*/
|
|
474
474
|
lineItemIds?: string[];
|
|
475
475
|
}
|
|
476
|
-
|
|
476
|
+
interface SelectedMemberships {
|
|
477
477
|
/**
|
|
478
478
|
* Selected memberships.
|
|
479
479
|
* @maxSize 300
|
|
480
480
|
*/
|
|
481
481
|
memberships?: SelectedMembership[];
|
|
482
482
|
}
|
|
483
|
-
|
|
483
|
+
interface SelectedMembership {
|
|
484
484
|
/**
|
|
485
485
|
* Membership ID.
|
|
486
486
|
* @minLength 1
|
|
487
487
|
* @maxLength 100
|
|
488
488
|
*/
|
|
489
|
-
|
|
489
|
+
_id?: string;
|
|
490
490
|
/**
|
|
491
491
|
* ID of the app providing this payment option.
|
|
492
492
|
* @format GUID
|
|
@@ -501,7 +501,7 @@ export interface SelectedMembership {
|
|
|
501
501
|
*/
|
|
502
502
|
lineItemIds?: string[];
|
|
503
503
|
}
|
|
504
|
-
|
|
504
|
+
interface CarrierShippingOption {
|
|
505
505
|
/**
|
|
506
506
|
* This carrier's unique ID
|
|
507
507
|
* @format GUID
|
|
@@ -510,7 +510,7 @@ export interface CarrierShippingOption {
|
|
|
510
510
|
/** Shipping service options offered by this carrier for this request */
|
|
511
511
|
shippingOptions?: ShippingOption;
|
|
512
512
|
}
|
|
513
|
-
|
|
513
|
+
interface ShippingOption {
|
|
514
514
|
/**
|
|
515
515
|
* Unique code of provided shipping option like "usps_std_overnight".
|
|
516
516
|
* For legacy calculators this would be the UUID of the option.
|
|
@@ -535,7 +535,7 @@ export interface ShippingOption {
|
|
|
535
535
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
536
536
|
partial?: boolean | null;
|
|
537
537
|
}
|
|
538
|
-
|
|
538
|
+
interface DeliveryLogistics {
|
|
539
539
|
/**
|
|
540
540
|
* Expected delivery time, in free text. For example, "3-5 business days".
|
|
541
541
|
* @maxLength 500
|
|
@@ -549,7 +549,7 @@ export interface DeliveryLogistics {
|
|
|
549
549
|
/** Pickup details. */
|
|
550
550
|
pickupDetails?: PickupDetails;
|
|
551
551
|
}
|
|
552
|
-
|
|
552
|
+
interface PickupDetails {
|
|
553
553
|
/** Pickup address. */
|
|
554
554
|
address?: Address;
|
|
555
555
|
/**
|
|
@@ -560,26 +560,26 @@ export interface PickupDetails {
|
|
|
560
560
|
/** Pickup method */
|
|
561
561
|
pickupMethod?: PickupMethodWithLiterals;
|
|
562
562
|
}
|
|
563
|
-
|
|
563
|
+
declare enum PickupMethod {
|
|
564
564
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
565
565
|
STORE_PICKUP = "STORE_PICKUP",
|
|
566
566
|
PICKUP_POINT = "PICKUP_POINT"
|
|
567
567
|
}
|
|
568
568
|
/** @enumType */
|
|
569
|
-
|
|
570
|
-
|
|
569
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
570
|
+
interface DeliveryTimeSlot {
|
|
571
571
|
/** starting time of the delivery time slot */
|
|
572
572
|
from?: Date | null;
|
|
573
573
|
/** ending time of the delivery time slot */
|
|
574
574
|
to?: Date | null;
|
|
575
575
|
}
|
|
576
|
-
|
|
576
|
+
interface ShippingPrice {
|
|
577
577
|
/** Shipping price. */
|
|
578
578
|
price?: MultiCurrencyPrice;
|
|
579
579
|
/** Other costs such as insurance, handling & packaging for fragile items, etc. */
|
|
580
580
|
otherCharges?: OtherCharge[];
|
|
581
581
|
}
|
|
582
|
-
|
|
582
|
+
interface MultiCurrencyPrice {
|
|
583
583
|
/**
|
|
584
584
|
* Amount.
|
|
585
585
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -602,7 +602,7 @@ export interface MultiCurrencyPrice {
|
|
|
602
602
|
*/
|
|
603
603
|
formattedConvertedAmount?: string;
|
|
604
604
|
}
|
|
605
|
-
|
|
605
|
+
interface OtherCharge {
|
|
606
606
|
/** Type of additional cost. */
|
|
607
607
|
type?: ChargeTypeWithLiterals;
|
|
608
608
|
/** Price of added cost. */
|
|
@@ -613,13 +613,13 @@ export interface OtherCharge {
|
|
|
613
613
|
*/
|
|
614
614
|
details?: string | null;
|
|
615
615
|
}
|
|
616
|
-
|
|
616
|
+
declare enum ChargeType {
|
|
617
617
|
HANDLING_FEE = "HANDLING_FEE",
|
|
618
618
|
INSURANCE = "INSURANCE"
|
|
619
619
|
}
|
|
620
620
|
/** @enumType */
|
|
621
|
-
|
|
622
|
-
|
|
621
|
+
type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
|
|
622
|
+
interface DeliveryAllocation {
|
|
623
623
|
/** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
|
|
624
624
|
deliveryCarrier?: Carrier;
|
|
625
625
|
/** The delivery region that are relevant for this delivery solution. */
|
|
@@ -627,7 +627,7 @@ export interface DeliveryAllocation {
|
|
|
627
627
|
/** Populated if the delivery solution is a partially supplied by this carrier. */
|
|
628
628
|
applicableLineItems?: ApplicableLineItems;
|
|
629
629
|
}
|
|
630
|
-
|
|
630
|
+
interface Carrier {
|
|
631
631
|
/**
|
|
632
632
|
* The carrier app id
|
|
633
633
|
* @format GUID
|
|
@@ -639,19 +639,19 @@ export interface Carrier {
|
|
|
639
639
|
*/
|
|
640
640
|
code?: string;
|
|
641
641
|
}
|
|
642
|
-
|
|
642
|
+
interface Region {
|
|
643
643
|
/**
|
|
644
644
|
* The delivery region id.
|
|
645
645
|
* @format GUID
|
|
646
646
|
*/
|
|
647
|
-
|
|
647
|
+
_id?: string | null;
|
|
648
648
|
/**
|
|
649
649
|
* The delivery region name.
|
|
650
650
|
* @maxLength 100
|
|
651
651
|
*/
|
|
652
652
|
name?: string | null;
|
|
653
653
|
}
|
|
654
|
-
|
|
654
|
+
interface ApplicableLineItems {
|
|
655
655
|
/**
|
|
656
656
|
* Line items that the delivery solution is for.
|
|
657
657
|
* @maxSize 300
|
|
@@ -660,7 +660,7 @@ export interface ApplicableLineItems {
|
|
|
660
660
|
*/
|
|
661
661
|
lineItemIds?: string[];
|
|
662
662
|
}
|
|
663
|
-
|
|
663
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
664
664
|
/** Coupon details. */
|
|
665
665
|
coupon?: Coupon;
|
|
666
666
|
/** Merchant discount. */
|
|
@@ -679,7 +679,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
679
679
|
lineItemIds?: string[];
|
|
680
680
|
}
|
|
681
681
|
/** @oneof */
|
|
682
|
-
|
|
682
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
683
683
|
/** Coupon details. */
|
|
684
684
|
coupon?: Coupon;
|
|
685
685
|
/** Merchant discount. */
|
|
@@ -687,17 +687,17 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
687
687
|
/** Discount rule */
|
|
688
688
|
discountRule?: DiscountRule;
|
|
689
689
|
}
|
|
690
|
-
|
|
690
|
+
declare enum DiscountType {
|
|
691
691
|
GLOBAL = "GLOBAL",
|
|
692
692
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
693
693
|
SHIPPING = "SHIPPING"
|
|
694
694
|
}
|
|
695
695
|
/** @enumType */
|
|
696
|
-
|
|
696
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
697
697
|
/** Coupon */
|
|
698
|
-
|
|
698
|
+
interface Coupon {
|
|
699
699
|
/** Coupon ID. */
|
|
700
|
-
|
|
700
|
+
_id?: string;
|
|
701
701
|
/** Coupon code. */
|
|
702
702
|
code?: string;
|
|
703
703
|
/** Coupon value. */
|
|
@@ -705,7 +705,7 @@ export interface Coupon {
|
|
|
705
705
|
/** Coupon name. */
|
|
706
706
|
name?: string;
|
|
707
707
|
}
|
|
708
|
-
|
|
708
|
+
interface MerchantDiscount {
|
|
709
709
|
/** Discount value. */
|
|
710
710
|
amount?: MultiCurrencyPrice;
|
|
711
711
|
/**
|
|
@@ -715,18 +715,18 @@ export interface MerchantDiscount {
|
|
|
715
715
|
*/
|
|
716
716
|
percentage?: number | null;
|
|
717
717
|
}
|
|
718
|
-
|
|
718
|
+
interface DiscountRule {
|
|
719
719
|
/**
|
|
720
720
|
* Discount rule ID
|
|
721
721
|
* @format GUID
|
|
722
722
|
*/
|
|
723
|
-
|
|
723
|
+
_id?: string;
|
|
724
724
|
/** Discount rule name */
|
|
725
725
|
name?: DiscountRuleName;
|
|
726
726
|
/** Discount value. */
|
|
727
727
|
amount?: MultiCurrencyPrice;
|
|
728
728
|
}
|
|
729
|
-
|
|
729
|
+
interface DiscountRuleName {
|
|
730
730
|
/**
|
|
731
731
|
* Original discount rule name (in site's default language).
|
|
732
732
|
* @minLength 1
|
|
@@ -740,16 +740,16 @@ export interface DiscountRuleName {
|
|
|
740
740
|
*/
|
|
741
741
|
translated?: string | null;
|
|
742
742
|
}
|
|
743
|
-
|
|
743
|
+
interface LineItemDiscount {
|
|
744
744
|
/**
|
|
745
745
|
* ID of line item the discount applies to.
|
|
746
746
|
* @format GUID
|
|
747
747
|
*/
|
|
748
|
-
|
|
748
|
+
_id?: string;
|
|
749
749
|
/** Discount value. */
|
|
750
750
|
totalDiscountAmount?: MultiCurrencyPrice;
|
|
751
751
|
}
|
|
752
|
-
|
|
752
|
+
interface AdditionalFee {
|
|
753
753
|
/**
|
|
754
754
|
* Additional fee's unique code (or ID) for future processing
|
|
755
755
|
* @minLength 1
|
|
@@ -788,7 +788,7 @@ export interface AdditionalFee {
|
|
|
788
788
|
lineItemIds?: string[];
|
|
789
789
|
}
|
|
790
790
|
/** Tax Details. */
|
|
791
|
-
|
|
791
|
+
interface TaxDetails {
|
|
792
792
|
/** Indication if additional fee is taxable or not */
|
|
793
793
|
taxable?: boolean;
|
|
794
794
|
/**
|
|
@@ -797,15 +797,13 @@ export interface TaxDetails {
|
|
|
797
797
|
*/
|
|
798
798
|
taxGroupId?: string | null;
|
|
799
799
|
}
|
|
800
|
-
|
|
800
|
+
declare enum DataFetchType {
|
|
801
801
|
SHIPPING = "SHIPPING",
|
|
802
802
|
DISCOUNT = "DISCOUNT",
|
|
803
803
|
ADDITIONAL_FEES = "ADDITIONAL_FEES",
|
|
804
804
|
ORDER_VALIDATION = "ORDER_VALIDATION"
|
|
805
805
|
}
|
|
806
|
-
|
|
807
|
-
export type DataFetchTypeWithLiterals = DataFetchType | 'SHIPPING' | 'DISCOUNT' | 'ADDITIONAL_FEES' | 'ORDER_VALIDATION';
|
|
808
|
-
export interface ExternalReference {
|
|
806
|
+
interface ExternalReference {
|
|
809
807
|
/**
|
|
810
808
|
* ID of the app associated with the purchase flow.
|
|
811
809
|
* For example, the Wix Pay Links app ID.
|
|
@@ -822,7 +820,7 @@ export interface ExternalReference {
|
|
|
822
820
|
*/
|
|
823
821
|
resourceId?: string | null;
|
|
824
822
|
}
|
|
825
|
-
|
|
823
|
+
interface CalculateTotalsResponse {
|
|
826
824
|
/** Calculate line items. */
|
|
827
825
|
calculatedLineItems?: CalculatedLineItem[];
|
|
828
826
|
/** Price summary. */
|
|
@@ -900,7 +898,7 @@ export interface CalculateTotalsResponse {
|
|
|
900
898
|
*/
|
|
901
899
|
payAfterFreeTrial?: PriceSummary;
|
|
902
900
|
}
|
|
903
|
-
|
|
901
|
+
interface CalculatedLineItem {
|
|
904
902
|
/** Line item ID. */
|
|
905
903
|
lineItemId?: string;
|
|
906
904
|
/** Price breakdown for this line item. */
|
|
@@ -916,7 +914,7 @@ export interface CalculatedLineItem {
|
|
|
916
914
|
/** tax calculation address. */
|
|
917
915
|
taxableAddress?: TaxableAddress;
|
|
918
916
|
}
|
|
919
|
-
|
|
917
|
+
interface LineItemPricesData {
|
|
920
918
|
/** Total price after discounts, tax, and modifiers. */
|
|
921
919
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
922
920
|
/** Total price after discounts and modifiers, and before tax. */
|
|
@@ -940,7 +938,7 @@ export interface LineItemPricesData {
|
|
|
940
938
|
*/
|
|
941
939
|
fullPrice?: MultiCurrencyPrice;
|
|
942
940
|
}
|
|
943
|
-
|
|
941
|
+
interface ItemTaxFullDetails {
|
|
944
942
|
/** Amount for which tax is calculated. */
|
|
945
943
|
taxableAmount?: MultiCurrencyPrice;
|
|
946
944
|
/**
|
|
@@ -957,7 +955,7 @@ export interface ItemTaxFullDetails {
|
|
|
957
955
|
*/
|
|
958
956
|
rateBreakdown?: TaxRateBreakdown[];
|
|
959
957
|
}
|
|
960
|
-
|
|
958
|
+
interface TaxRateBreakdown {
|
|
961
959
|
/**
|
|
962
960
|
* Name of tax against which the calculation was performed.
|
|
963
961
|
* @maxLength 100
|
|
@@ -975,7 +973,7 @@ export interface TaxRateBreakdown {
|
|
|
975
973
|
* TaxBreakdown represents tax information for a line item.
|
|
976
974
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
977
975
|
*/
|
|
978
|
-
|
|
976
|
+
interface TaxBreakdown {
|
|
979
977
|
/**
|
|
980
978
|
* The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
|
|
981
979
|
* @maxLength 200
|
|
@@ -1007,7 +1005,7 @@ export interface TaxBreakdown {
|
|
|
1007
1005
|
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1008
1006
|
}
|
|
1009
1007
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1010
|
-
|
|
1008
|
+
declare enum JurisdictionType {
|
|
1011
1009
|
UNDEFINED = "UNDEFINED",
|
|
1012
1010
|
COUNTRY = "COUNTRY",
|
|
1013
1011
|
STATE = "STATE",
|
|
@@ -1016,14 +1014,14 @@ export declare enum JurisdictionType {
|
|
|
1016
1014
|
SPECIAL = "SPECIAL"
|
|
1017
1015
|
}
|
|
1018
1016
|
/** @enumType */
|
|
1019
|
-
|
|
1020
|
-
|
|
1017
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
1018
|
+
interface CalculatedItemModifier {
|
|
1021
1019
|
/**
|
|
1022
1020
|
* Modifier ID.
|
|
1023
1021
|
* @minLength 1
|
|
1024
1022
|
* @maxLength 36
|
|
1025
1023
|
*/
|
|
1026
|
-
|
|
1024
|
+
_id?: string;
|
|
1027
1025
|
/**
|
|
1028
1026
|
* ID of the group this modifier belongs to.
|
|
1029
1027
|
* @minLength 1
|
|
@@ -1036,7 +1034,7 @@ export interface CalculatedItemModifier {
|
|
|
1036
1034
|
*/
|
|
1037
1035
|
price?: MultiCurrencyPrice;
|
|
1038
1036
|
}
|
|
1039
|
-
|
|
1037
|
+
interface PriceSummary {
|
|
1040
1038
|
/** Subtotal of all line items, before discounts and before tax. */
|
|
1041
1039
|
subtotal?: MultiCurrencyPrice;
|
|
1042
1040
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -1050,12 +1048,12 @@ export interface PriceSummary {
|
|
|
1050
1048
|
/** Total additional fees price before tax. */
|
|
1051
1049
|
additionalFees?: MultiCurrencyPrice;
|
|
1052
1050
|
}
|
|
1053
|
-
|
|
1051
|
+
interface GiftCard {
|
|
1054
1052
|
/**
|
|
1055
1053
|
* Gift Card ID.
|
|
1056
1054
|
* @deprecated
|
|
1057
1055
|
*/
|
|
1058
|
-
|
|
1056
|
+
_id?: string;
|
|
1059
1057
|
/** Gift card obfuscated code. */
|
|
1060
1058
|
obfuscatedCode?: string;
|
|
1061
1059
|
/** Gift card value. */
|
|
@@ -1073,7 +1071,7 @@ export interface GiftCard {
|
|
|
1073
1071
|
*/
|
|
1074
1072
|
externalId?: string | null;
|
|
1075
1073
|
}
|
|
1076
|
-
|
|
1074
|
+
interface TaxSummary {
|
|
1077
1075
|
/**
|
|
1078
1076
|
* Amount for which tax is calculated, added from line items.
|
|
1079
1077
|
* @readonly
|
|
@@ -1090,7 +1088,7 @@ export interface TaxSummary {
|
|
|
1090
1088
|
*/
|
|
1091
1089
|
calculationDetails?: TaxCalculationDetails;
|
|
1092
1090
|
}
|
|
1093
|
-
|
|
1091
|
+
interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1094
1092
|
/** Reason the manual calculation was used. */
|
|
1095
1093
|
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1096
1094
|
/** Details of the fallback rate calculation. */
|
|
@@ -1099,13 +1097,13 @@ export interface TaxCalculationDetails extends TaxCalculationDetailsCalculationD
|
|
|
1099
1097
|
rateType?: RateTypeWithLiterals;
|
|
1100
1098
|
}
|
|
1101
1099
|
/** @oneof */
|
|
1102
|
-
|
|
1100
|
+
interface TaxCalculationDetailsCalculationDetailsOneOf {
|
|
1103
1101
|
/** Reason the manual calculation was used. */
|
|
1104
1102
|
manualRateReason?: ManualCalculationReasonWithLiterals;
|
|
1105
1103
|
/** Details of the fallback rate calculation. */
|
|
1106
1104
|
autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
|
|
1107
1105
|
}
|
|
1108
|
-
|
|
1106
|
+
declare enum RateType {
|
|
1109
1107
|
/** no tax being collected for this request due to location of purchase */
|
|
1110
1108
|
NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
|
|
1111
1109
|
/** manual rate used for calculation */
|
|
@@ -1116,30 +1114,30 @@ export declare enum RateType {
|
|
|
1116
1114
|
FALLBACK_RATE = "FALLBACK_RATE"
|
|
1117
1115
|
}
|
|
1118
1116
|
/** @enumType */
|
|
1119
|
-
|
|
1120
|
-
|
|
1117
|
+
type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
|
|
1118
|
+
declare enum ManualCalculationReason {
|
|
1121
1119
|
/** user set calculator in Business Manager to be Manual */
|
|
1122
1120
|
GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
|
|
1123
1121
|
/** specific region is on manual even though Global setting is Auto-tax */
|
|
1124
1122
|
REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
|
|
1125
1123
|
}
|
|
1126
1124
|
/** @enumType */
|
|
1127
|
-
|
|
1128
|
-
|
|
1125
|
+
type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
|
|
1126
|
+
interface AutoTaxFallbackCalculationDetails {
|
|
1129
1127
|
/** reason for fallback */
|
|
1130
1128
|
fallbackReason?: FallbackReasonWithLiterals;
|
|
1131
1129
|
/** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
|
|
1132
1130
|
error?: ApplicationError;
|
|
1133
1131
|
}
|
|
1134
|
-
|
|
1132
|
+
declare enum FallbackReason {
|
|
1135
1133
|
/** auto-tax failed to be calculated */
|
|
1136
1134
|
AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
|
|
1137
1135
|
/** auto-tax was temporarily deactivated on a system-level */
|
|
1138
1136
|
AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
|
|
1139
1137
|
}
|
|
1140
1138
|
/** @enumType */
|
|
1141
|
-
|
|
1142
|
-
|
|
1139
|
+
type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
|
|
1140
|
+
interface ApplicationError {
|
|
1143
1141
|
/** Error code. */
|
|
1144
1142
|
code?: string;
|
|
1145
1143
|
/** Description of the error. */
|
|
@@ -1151,7 +1149,7 @@ export interface ApplicationError {
|
|
|
1151
1149
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1152
1150
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1153
1151
|
*/
|
|
1154
|
-
|
|
1152
|
+
interface AggregatedTaxBreakdown {
|
|
1155
1153
|
/**
|
|
1156
1154
|
* The name of the tax against which this tax amount was calculated.
|
|
1157
1155
|
* @maxLength 200
|
|
@@ -1177,7 +1175,7 @@ export interface AggregatedTaxBreakdown {
|
|
|
1177
1175
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1178
1176
|
aggregatedTaxAmount?: MultiCurrencyPrice;
|
|
1179
1177
|
}
|
|
1180
|
-
|
|
1178
|
+
interface ShippingInformation {
|
|
1181
1179
|
/** Shipping region. */
|
|
1182
1180
|
region?: ShippingRegion;
|
|
1183
1181
|
/** Selected shipping option. */
|
|
@@ -1185,20 +1183,20 @@ export interface ShippingInformation {
|
|
|
1185
1183
|
/** All shipping options. */
|
|
1186
1184
|
carrierServiceOptions?: CarrierServiceOption[];
|
|
1187
1185
|
}
|
|
1188
|
-
|
|
1186
|
+
interface ShippingRegion {
|
|
1189
1187
|
/**
|
|
1190
1188
|
* Shipping region ID.
|
|
1191
1189
|
* @format GUID
|
|
1192
1190
|
* @readonly
|
|
1193
1191
|
*/
|
|
1194
|
-
|
|
1192
|
+
_id?: string;
|
|
1195
1193
|
/**
|
|
1196
1194
|
* Shipping region name.
|
|
1197
1195
|
* @maxLength 100
|
|
1198
1196
|
*/
|
|
1199
1197
|
name?: string;
|
|
1200
1198
|
}
|
|
1201
|
-
|
|
1199
|
+
interface SelectedCarrierServiceOption {
|
|
1202
1200
|
/**
|
|
1203
1201
|
* Unique identifier of selected option. For example, "usps_std_overnight".
|
|
1204
1202
|
* @maxLength 100
|
|
@@ -1246,7 +1244,7 @@ export interface SelectedCarrierServiceOption {
|
|
|
1246
1244
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
1247
1245
|
partial?: boolean | null;
|
|
1248
1246
|
}
|
|
1249
|
-
|
|
1247
|
+
interface SelectedCarrierServiceOptionPrices {
|
|
1250
1248
|
/** Total shipping price, after discount and after tax. */
|
|
1251
1249
|
totalPriceAfterTax?: MultiCurrencyPrice;
|
|
1252
1250
|
/** Total price of shipping after discounts (when relevant), and before tax. */
|
|
@@ -1258,7 +1256,7 @@ export interface SelectedCarrierServiceOptionPrices {
|
|
|
1258
1256
|
/** Shipping price before discount and before tax. */
|
|
1259
1257
|
price?: MultiCurrencyPrice;
|
|
1260
1258
|
}
|
|
1261
|
-
|
|
1259
|
+
interface SelectedCarrierServiceOptionOtherCharge {
|
|
1262
1260
|
/** Type of additional cost. */
|
|
1263
1261
|
type?: ChargeTypeWithLiterals;
|
|
1264
1262
|
/**
|
|
@@ -1269,7 +1267,7 @@ export interface SelectedCarrierServiceOptionOtherCharge {
|
|
|
1269
1267
|
/** Price of added charge. */
|
|
1270
1268
|
cost?: SelectedCarrierServiceOptionPrices;
|
|
1271
1269
|
}
|
|
1272
|
-
|
|
1270
|
+
interface CarrierServiceOption {
|
|
1273
1271
|
/**
|
|
1274
1272
|
* Carrier ID.
|
|
1275
1273
|
* @format GUID
|
|
@@ -1278,7 +1276,7 @@ export interface CarrierServiceOption {
|
|
|
1278
1276
|
/** Shipping options offered by this carrier for this request. */
|
|
1279
1277
|
shippingOptions?: ShippingOption[];
|
|
1280
1278
|
}
|
|
1281
|
-
|
|
1279
|
+
interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
|
|
1282
1280
|
/** General shipping calculation error. */
|
|
1283
1281
|
generalShippingCalculationError?: Details;
|
|
1284
1282
|
/** Carrier errors. */
|
|
@@ -1300,13 +1298,13 @@ export interface CalculationErrors extends CalculationErrorsShippingCalculationE
|
|
|
1300
1298
|
discountsCalculationError?: Details;
|
|
1301
1299
|
}
|
|
1302
1300
|
/** @oneof */
|
|
1303
|
-
|
|
1301
|
+
interface CalculationErrorsShippingCalculationErrorOneOf {
|
|
1304
1302
|
/** General shipping calculation error. */
|
|
1305
1303
|
generalShippingCalculationError?: Details;
|
|
1306
1304
|
/** Carrier errors. */
|
|
1307
1305
|
carrierErrors?: CarrierErrors;
|
|
1308
1306
|
}
|
|
1309
|
-
|
|
1307
|
+
interface Details extends DetailsKindOneOf {
|
|
1310
1308
|
applicationError?: ApplicationError;
|
|
1311
1309
|
validationError?: ValidationError;
|
|
1312
1310
|
systemError?: SystemError;
|
|
@@ -1317,7 +1315,7 @@ export interface Details extends DetailsKindOneOf {
|
|
|
1317
1315
|
tracing?: Record<string, string>;
|
|
1318
1316
|
}
|
|
1319
1317
|
/** @oneof */
|
|
1320
|
-
|
|
1318
|
+
interface DetailsKindOneOf {
|
|
1321
1319
|
applicationError?: ApplicationError;
|
|
1322
1320
|
validationError?: ValidationError;
|
|
1323
1321
|
systemError?: SystemError;
|
|
@@ -1354,10 +1352,10 @@ export interface DetailsKindOneOf {
|
|
|
1354
1352
|
* ]
|
|
1355
1353
|
* }
|
|
1356
1354
|
*/
|
|
1357
|
-
|
|
1355
|
+
interface ValidationError {
|
|
1358
1356
|
fieldViolations?: FieldViolation[];
|
|
1359
1357
|
}
|
|
1360
|
-
|
|
1358
|
+
declare enum RuleType {
|
|
1361
1359
|
VALIDATION = "VALIDATION",
|
|
1362
1360
|
OTHER = "OTHER",
|
|
1363
1361
|
MAX = "MAX",
|
|
@@ -1381,8 +1379,8 @@ export declare enum RuleType {
|
|
|
1381
1379
|
REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
|
|
1382
1380
|
}
|
|
1383
1381
|
/** @enumType */
|
|
1384
|
-
|
|
1385
|
-
|
|
1382
|
+
type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
|
|
1383
|
+
interface FieldViolation {
|
|
1386
1384
|
field?: string;
|
|
1387
1385
|
description?: string;
|
|
1388
1386
|
violatedRule?: RuleTypeWithLiterals;
|
|
@@ -1390,21 +1388,21 @@ export interface FieldViolation {
|
|
|
1390
1388
|
ruleName?: string | null;
|
|
1391
1389
|
data?: Record<string, any> | null;
|
|
1392
1390
|
}
|
|
1393
|
-
|
|
1391
|
+
interface SystemError {
|
|
1394
1392
|
/** Error code. */
|
|
1395
1393
|
errorCode?: string | null;
|
|
1396
1394
|
}
|
|
1397
|
-
|
|
1395
|
+
interface CarrierErrors {
|
|
1398
1396
|
/** Carrier errors. */
|
|
1399
1397
|
errors?: CarrierError[];
|
|
1400
1398
|
}
|
|
1401
|
-
|
|
1399
|
+
interface CarrierError {
|
|
1402
1400
|
/** Carrier ID. */
|
|
1403
1401
|
carrierId?: string;
|
|
1404
1402
|
/** Error details. */
|
|
1405
1403
|
error?: Details;
|
|
1406
1404
|
}
|
|
1407
|
-
|
|
1405
|
+
declare enum WeightUnit {
|
|
1408
1406
|
/** Weight unit can't be classified due to an error. */
|
|
1409
1407
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
1410
1408
|
/** Kilograms. */
|
|
@@ -1413,8 +1411,8 @@ export declare enum WeightUnit {
|
|
|
1413
1411
|
LB = "LB"
|
|
1414
1412
|
}
|
|
1415
1413
|
/** @enumType */
|
|
1416
|
-
|
|
1417
|
-
|
|
1414
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
1415
|
+
interface MembershipOptions {
|
|
1418
1416
|
/**
|
|
1419
1417
|
* List of payment options that can be used.
|
|
1420
1418
|
* @maxSize 300
|
|
@@ -1431,13 +1429,13 @@ export interface MembershipOptions {
|
|
|
1431
1429
|
*/
|
|
1432
1430
|
selectedMemberships?: SelectedMembership[];
|
|
1433
1431
|
}
|
|
1434
|
-
|
|
1432
|
+
interface Membership {
|
|
1435
1433
|
/**
|
|
1436
1434
|
* Membership ID.
|
|
1437
1435
|
* @minLength 1
|
|
1438
1436
|
* @maxLength 100
|
|
1439
1437
|
*/
|
|
1440
|
-
|
|
1438
|
+
_id?: string;
|
|
1441
1439
|
/**
|
|
1442
1440
|
* ID of the application providing this payment option.
|
|
1443
1441
|
* @format GUID
|
|
@@ -1460,7 +1458,7 @@ export interface Membership {
|
|
|
1460
1458
|
/** Additional data about this membership. */
|
|
1461
1459
|
additionalData?: Record<string, any> | null;
|
|
1462
1460
|
}
|
|
1463
|
-
|
|
1461
|
+
interface MembershipName {
|
|
1464
1462
|
/**
|
|
1465
1463
|
* Membership name.
|
|
1466
1464
|
* @maxLength 100
|
|
@@ -1472,7 +1470,7 @@ export interface MembershipName {
|
|
|
1472
1470
|
*/
|
|
1473
1471
|
translated?: string | null;
|
|
1474
1472
|
}
|
|
1475
|
-
|
|
1473
|
+
interface MembershipPaymentCredits {
|
|
1476
1474
|
/**
|
|
1477
1475
|
* Membership's total amount of credits.
|
|
1478
1476
|
* @min 1
|
|
@@ -1481,7 +1479,7 @@ export interface MembershipPaymentCredits {
|
|
|
1481
1479
|
/** Membership's remaining amount of credits. */
|
|
1482
1480
|
remaining?: number;
|
|
1483
1481
|
}
|
|
1484
|
-
|
|
1482
|
+
interface InvalidMembership {
|
|
1485
1483
|
/** Membership details. */
|
|
1486
1484
|
membership?: Membership;
|
|
1487
1485
|
/**
|
|
@@ -1491,7 +1489,7 @@ export interface InvalidMembership {
|
|
|
1491
1489
|
*/
|
|
1492
1490
|
reason?: string;
|
|
1493
1491
|
}
|
|
1494
|
-
|
|
1492
|
+
interface V1AdditionalFee {
|
|
1495
1493
|
/**
|
|
1496
1494
|
* Additional fee's unique code (or ID) for future processing.
|
|
1497
1495
|
* @minLength 1
|
|
@@ -1527,7 +1525,7 @@ export interface V1AdditionalFee {
|
|
|
1527
1525
|
/** the source the additional fee was added from */
|
|
1528
1526
|
source?: AdditionalFeeSourceWithLiterals;
|
|
1529
1527
|
}
|
|
1530
|
-
|
|
1528
|
+
declare enum AdditionalFeeSource {
|
|
1531
1529
|
UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
|
|
1532
1530
|
/** The additional fee was added by an additional fee service plugin */
|
|
1533
1531
|
SERVICE_PLUGIN = "SERVICE_PLUGIN",
|
|
@@ -1539,4 +1537,91 @@ export declare enum AdditionalFeeSource {
|
|
|
1539
1537
|
SHIPPING = "SHIPPING"
|
|
1540
1538
|
}
|
|
1541
1539
|
/** @enumType */
|
|
1542
|
-
|
|
1540
|
+
type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
|
|
1541
|
+
interface CalculateTotalsOptions extends CalculateTotalsOptionsCouponOneOf, CalculateTotalsOptionsGiftCardOneOf {
|
|
1542
|
+
/**
|
|
1543
|
+
* Calculation ID. An identifier of the entity that you are calculating totals for, for example, cart ID or checkout ID.
|
|
1544
|
+
* This value will be used in order to optimise calculations by caching.
|
|
1545
|
+
* If not passed, calculation might be slower in some cases.
|
|
1546
|
+
* @minLength 1
|
|
1547
|
+
* @maxLength 100
|
|
1548
|
+
*/
|
|
1549
|
+
calculationId?: string | null;
|
|
1550
|
+
/**
|
|
1551
|
+
* Line items for calculation.
|
|
1552
|
+
* @maxSize 300
|
|
1553
|
+
*/
|
|
1554
|
+
lineItems?: LineItem[];
|
|
1555
|
+
/** Shipping address for tax and shipping calculation (if applicable). */
|
|
1556
|
+
shippingAddress?: Address;
|
|
1557
|
+
/** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
|
|
1558
|
+
billingAddress?: Address;
|
|
1559
|
+
/** Details about selected shipping option. */
|
|
1560
|
+
selectedShippingOption?: SelectedShippingOption;
|
|
1561
|
+
/** Coupon ID. */
|
|
1562
|
+
couponId?: string | null;
|
|
1563
|
+
/** Coupon code. */
|
|
1564
|
+
couponCode?: string | null;
|
|
1565
|
+
/**
|
|
1566
|
+
* Gift card ID.
|
|
1567
|
+
* @format GUID
|
|
1568
|
+
*/
|
|
1569
|
+
giftCardId?: string | null;
|
|
1570
|
+
/** Gift card code. */
|
|
1571
|
+
giftCardCode?: string | null;
|
|
1572
|
+
/**
|
|
1573
|
+
* Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart/checkout.
|
|
1574
|
+
* @maxSize 100
|
|
1575
|
+
* @deprecated
|
|
1576
|
+
*/
|
|
1577
|
+
merchantDiscounts?: MerchantDiscountInput[];
|
|
1578
|
+
/**
|
|
1579
|
+
* Buyer email. Used to enforce coupon [single-use per customer](https://support.wix.com/en/article/wix-stores-limiting-coupon-usage). If not passed, single coupon usage per customer will not be enforced.
|
|
1580
|
+
* @format EMAIL
|
|
1581
|
+
*/
|
|
1582
|
+
buyerEmail?: string | null;
|
|
1583
|
+
/**
|
|
1584
|
+
* Member id to use for this calculation
|
|
1585
|
+
* When not provided, given that the caller is a member, its member id will be used
|
|
1586
|
+
* Providing this require elevated permissions - ECOM.ADMIN_CALCULATE_TOTALS
|
|
1587
|
+
*/
|
|
1588
|
+
memberId?: string | null;
|
|
1589
|
+
/**
|
|
1590
|
+
* The selected memberships and which line items they apply to
|
|
1591
|
+
* When not provided, default selection will be returned
|
|
1592
|
+
* You can also set it to empty selection
|
|
1593
|
+
*/
|
|
1594
|
+
selectedMemberships?: SelectedMemberships;
|
|
1595
|
+
/** Buyer phone number. Used to get shipping rates. */
|
|
1596
|
+
buyerPhone?: string | null;
|
|
1597
|
+
/**
|
|
1598
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
1599
|
+
* @format GUID
|
|
1600
|
+
*/
|
|
1601
|
+
purchaseFlowId?: string | null;
|
|
1602
|
+
/**
|
|
1603
|
+
* Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
|
|
1604
|
+
* For example, a Wix Pay Link ID.
|
|
1605
|
+
* @maxSize 20
|
|
1606
|
+
*/
|
|
1607
|
+
externalReferences?: ExternalReference[];
|
|
1608
|
+
}
|
|
1609
|
+
/** @oneof */
|
|
1610
|
+
interface CalculateTotalsOptionsCouponOneOf {
|
|
1611
|
+
/** Coupon ID. */
|
|
1612
|
+
couponId?: string | null;
|
|
1613
|
+
/** Coupon code. */
|
|
1614
|
+
couponCode?: string | null;
|
|
1615
|
+
}
|
|
1616
|
+
/** @oneof */
|
|
1617
|
+
interface CalculateTotalsOptionsGiftCardOneOf {
|
|
1618
|
+
/**
|
|
1619
|
+
* Gift card ID.
|
|
1620
|
+
* @format GUID
|
|
1621
|
+
*/
|
|
1622
|
+
giftCardId?: string | null;
|
|
1623
|
+
/** Gift card code. */
|
|
1624
|
+
giftCardCode?: string | null;
|
|
1625
|
+
}
|
|
1626
|
+
|
|
1627
|
+
export { type Carrier as $, AdditionalFeeSource as A, type MerchantDiscountInput as B, type CalculateTotalsOptions as C, DiscountType as D, type SelectedMemberships as E, FallbackReason as F, type Group as G, type SelectedMembership as H, ItemTypeItemType as I, JurisdictionType as J, type CarrierShippingOption as K, type LineItem as L, ManualCalculationReason as M, type ShippingOption as N, type DeliveryLogistics as O, PaymentOptionType as P, type PickupDetails as Q, RateType as R, SubscriptionFrequency as S, TaxableAddressType as T, type DeliveryTimeSlot as U, type V1TaxDetails as V, WeightUnit as W, type ShippingPrice as X, type MultiCurrencyPrice as Y, type OtherCharge as Z, type DeliveryAllocation as _, type CalculateTotalsResponse as a, type Region as a0, type ApplicableLineItems as a1, type AppliedDiscount as a2, type AppliedDiscountDiscountSourceOneOf as a3, type Coupon as a4, type MerchantDiscount as a5, type DiscountRule as a6, type DiscountRuleName as a7, type LineItemDiscount as a8, type AdditionalFee as a9, type ValidationError as aA, type FieldViolation as aB, type SystemError as aC, type CarrierErrors as aD, type CarrierError as aE, type MembershipOptions as aF, type Membership as aG, type MembershipName as aH, type MembershipPaymentCredits as aI, type InvalidMembership as aJ, type V1AdditionalFee as aK, type CalculateTotalsOptionsCouponOneOf as aL, type CalculateTotalsOptionsGiftCardOneOf as aM, type TaxDetails as aa, type ExternalReference as ab, type CalculatedLineItem as ac, type LineItemPricesData as ad, type ItemTaxFullDetails as ae, type TaxRateBreakdown as af, type TaxBreakdown as ag, type CalculatedItemModifier as ah, type PriceSummary as ai, type GiftCard as aj, type TaxSummary as ak, type TaxCalculationDetails as al, type TaxCalculationDetailsCalculationDetailsOneOf as am, type AutoTaxFallbackCalculationDetails as an, type ApplicationError as ao, type AggregatedTaxBreakdown as ap, type ShippingInformation as aq, type ShippingRegion as ar, type SelectedCarrierServiceOption as as, type SelectedCarrierServiceOptionPrices as at, type SelectedCarrierServiceOptionOtherCharge as au, type CarrierServiceOption as av, type CalculationErrors as aw, type CalculationErrorsShippingCalculationErrorOneOf as ax, type Details as ay, type DetailsKindOneOf as az, PickupMethod as b, ChargeType as c, DataFetchType as d, RuleType as e, type TotalsCalculationEntity as f, type CalculateTotalsRequest as g, type CalculateTotalsRequestCouponOneOf as h, type CalculateTotalsRequestGiftCardOneOf as i, type CatalogReference as j, type PhysicalProperties as k, type Scope as l, type SubscriptionSettings as m, type ServiceProperties as n, type ItemType as o, type ItemTypeItemTypeDataOneOf as p, type TaxableAddress as q, type TaxableAddressTaxableAddressDataOneOf as r, type ApiV1AdditionalFee as s, type ModifierGroup as t, type TranslatableString as u, type ItemModifier as v, type Address as w, type StreetAddress as x, type AddressLocation as y, type SelectedShippingOption as z };
|