@wix/auto_sdk_ecom_subscription-contracts 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.mts} +251 -398
- package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.ts} +251 -398
- package/build/index.d.mts +39 -0
- package/build/index.d.ts +39 -0
- package/build/index.js +659 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +615 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → internal/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.mts} +207 -447
- package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → internal/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.ts} +207 -447
- package/build/internal/index.d.mts +39 -0
- package/build/internal/index.d.ts +39 -0
- package/build/internal/index.js +659 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +615 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.mts} +93 -751
- package/build/internal/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.ts} +93 -751
- package/build/internal/meta.js +257 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +229 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +1320 -0
- package/build/meta.d.ts +1320 -0
- package/build/meta.js +257 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +229 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- 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-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -342
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.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-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -314
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.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-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +0 -2251
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -342
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.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-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts +0 -2251
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -314
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Read more about SubscriptionContracts
|
|
5
5
|
* in this [article](<LINK_TO_KB_ARTICLE>).
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
interface SubscriptionContract {
|
|
8
8
|
/**
|
|
9
9
|
* SubscriptionContract ID.
|
|
10
10
|
* @format GUID
|
|
@@ -37,6 +37,11 @@ export interface SubscriptionContract {
|
|
|
37
37
|
* @targetRemovalDate 2025-10-01
|
|
38
38
|
*/
|
|
39
39
|
description?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
42
|
+
* @internal
|
|
43
|
+
*/
|
|
44
|
+
subscriptionDescription?: V1SubscriptionDescription;
|
|
40
45
|
/**
|
|
41
46
|
* Subscription detailed information.
|
|
42
47
|
* @immutable
|
|
@@ -110,13 +115,18 @@ export interface SubscriptionContract {
|
|
|
110
115
|
* @targetRemovalDate 2025-10-01
|
|
111
116
|
*/
|
|
112
117
|
title?: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
subscriptionTitle?: V1SubscriptionTitle;
|
|
113
123
|
/**
|
|
114
124
|
* Additional fees applied to subscription contract.
|
|
115
125
|
* @maxSize 100
|
|
116
126
|
*/
|
|
117
127
|
additionalFees?: AdditionalFee[];
|
|
118
128
|
}
|
|
119
|
-
|
|
129
|
+
interface V1SubscriptionDescription {
|
|
120
130
|
/**
|
|
121
131
|
* Subscription option description.
|
|
122
132
|
* @maxLength 500
|
|
@@ -128,7 +138,7 @@ export interface V1SubscriptionDescription {
|
|
|
128
138
|
*/
|
|
129
139
|
translated?: string | null;
|
|
130
140
|
}
|
|
131
|
-
|
|
141
|
+
interface V1SubscriptionSettings {
|
|
132
142
|
/** Frequency of recurring payment. */
|
|
133
143
|
frequency?: SubscriptionFrequency;
|
|
134
144
|
/**
|
|
@@ -146,15 +156,25 @@ export interface V1SubscriptionSettings {
|
|
|
146
156
|
billingCycles?: number | null;
|
|
147
157
|
/** Whether to allow the customer to cancel the subscription. */
|
|
148
158
|
enableCustomerCancellation?: boolean;
|
|
159
|
+
/**
|
|
160
|
+
* Period until first cycle starts. If None => no free trial
|
|
161
|
+
* @internal
|
|
162
|
+
*/
|
|
163
|
+
freeTrialPeriod?: V1FreeTrialPeriod;
|
|
164
|
+
/**
|
|
165
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
166
|
+
* @internal
|
|
167
|
+
*/
|
|
168
|
+
startDate?: Date | null;
|
|
149
169
|
}
|
|
150
|
-
|
|
170
|
+
declare enum SubscriptionFrequency {
|
|
151
171
|
UNDEFINED = "UNDEFINED",
|
|
152
172
|
DAY = "DAY",
|
|
153
173
|
WEEK = "WEEK",
|
|
154
174
|
MONTH = "MONTH",
|
|
155
175
|
YEAR = "YEAR"
|
|
156
176
|
}
|
|
157
|
-
|
|
177
|
+
interface V1FreeTrialPeriod {
|
|
158
178
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
159
179
|
frequency?: SubscriptionFrequency;
|
|
160
180
|
/**
|
|
@@ -164,7 +184,7 @@ export interface V1FreeTrialPeriod {
|
|
|
164
184
|
*/
|
|
165
185
|
interval?: number;
|
|
166
186
|
}
|
|
167
|
-
|
|
187
|
+
interface OrderLineItem {
|
|
168
188
|
/**
|
|
169
189
|
* Line item ID.
|
|
170
190
|
* @immutable
|
|
@@ -274,6 +294,17 @@ export interface OrderLineItem {
|
|
|
274
294
|
* @maxSize 5
|
|
275
295
|
*/
|
|
276
296
|
locations?: LocationAndQuantity[];
|
|
297
|
+
/**
|
|
298
|
+
* Address used for tax calculation.
|
|
299
|
+
* @internal
|
|
300
|
+
*/
|
|
301
|
+
taxableAddress?: TaxableAddress;
|
|
302
|
+
/**
|
|
303
|
+
* ID of the app managing the inventory.
|
|
304
|
+
* @internal
|
|
305
|
+
* @format GUID
|
|
306
|
+
*/
|
|
307
|
+
inventoryAppId?: string | null;
|
|
277
308
|
/**
|
|
278
309
|
* Custom extended fields for the line item object.
|
|
279
310
|
*
|
|
@@ -281,7 +312,7 @@ export interface OrderLineItem {
|
|
|
281
312
|
*/
|
|
282
313
|
extendedFields?: ExtendedFields;
|
|
283
314
|
}
|
|
284
|
-
|
|
315
|
+
interface ProductName {
|
|
285
316
|
/**
|
|
286
317
|
* __Required.__ Item name 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).
|
|
287
318
|
*
|
|
@@ -303,7 +334,7 @@ export interface ProductName {
|
|
|
303
334
|
translated?: string | null;
|
|
304
335
|
}
|
|
305
336
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
306
|
-
|
|
337
|
+
interface CatalogReference {
|
|
307
338
|
/**
|
|
308
339
|
* ID of the item within the catalog it belongs to.
|
|
309
340
|
* @minLength 1
|
|
@@ -329,7 +360,7 @@ export interface CatalogReference {
|
|
|
329
360
|
*/
|
|
330
361
|
options?: Record<string, any> | null;
|
|
331
362
|
}
|
|
332
|
-
|
|
363
|
+
interface Price {
|
|
333
364
|
/**
|
|
334
365
|
* Amount.
|
|
335
366
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -341,7 +372,7 @@ export interface Price {
|
|
|
341
372
|
*/
|
|
342
373
|
formattedAmount?: string;
|
|
343
374
|
}
|
|
344
|
-
|
|
375
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
345
376
|
/** Description line plain text value. */
|
|
346
377
|
plainText?: PlainTextValue;
|
|
347
378
|
/** Description line color value. */
|
|
@@ -350,16 +381,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
350
381
|
name?: DescriptionLineName;
|
|
351
382
|
}
|
|
352
383
|
/** @oneof */
|
|
353
|
-
|
|
384
|
+
interface DescriptionLineValueOneOf {
|
|
354
385
|
/** Description line plain text value. */
|
|
355
386
|
plainText?: PlainTextValue;
|
|
356
387
|
/** Description line color value. */
|
|
357
388
|
colorInfo?: Color;
|
|
358
389
|
}
|
|
359
390
|
/** @oneof */
|
|
360
|
-
|
|
391
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
361
392
|
}
|
|
362
|
-
|
|
393
|
+
interface DescriptionLineName {
|
|
363
394
|
/**
|
|
364
395
|
* Description line name 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).
|
|
365
396
|
* @maxLength 100
|
|
@@ -373,7 +404,7 @@ export interface DescriptionLineName {
|
|
|
373
404
|
*/
|
|
374
405
|
translated?: string | null;
|
|
375
406
|
}
|
|
376
|
-
|
|
407
|
+
interface PlainTextValue {
|
|
377
408
|
/**
|
|
378
409
|
* Description line plain text value 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).
|
|
379
410
|
* @maxLength 600
|
|
@@ -387,7 +418,7 @@ export interface PlainTextValue {
|
|
|
387
418
|
*/
|
|
388
419
|
translated?: string | null;
|
|
389
420
|
}
|
|
390
|
-
|
|
421
|
+
interface Color {
|
|
391
422
|
/**
|
|
392
423
|
* Description line color name 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).
|
|
393
424
|
* @maxLength 500
|
|
@@ -403,7 +434,7 @@ export interface Color {
|
|
|
403
434
|
/** HEX or RGB color code for display. */
|
|
404
435
|
code?: string | null;
|
|
405
436
|
}
|
|
406
|
-
|
|
437
|
+
declare enum DescriptionLineType {
|
|
407
438
|
/** Unrecognized type. */
|
|
408
439
|
UNRECOGNISED = "UNRECOGNISED",
|
|
409
440
|
/** Plain text type. */
|
|
@@ -411,7 +442,7 @@ export declare enum DescriptionLineType {
|
|
|
411
442
|
/** Color type. */
|
|
412
443
|
COLOR = "COLOR"
|
|
413
444
|
}
|
|
414
|
-
|
|
445
|
+
interface FocalPoint {
|
|
415
446
|
/** X-coordinate of the focal point. */
|
|
416
447
|
x?: number;
|
|
417
448
|
/** Y-coordinate of the focal point. */
|
|
@@ -421,7 +452,7 @@ export interface FocalPoint {
|
|
|
421
452
|
/** crop by width */
|
|
422
453
|
width?: number | null;
|
|
423
454
|
}
|
|
424
|
-
|
|
455
|
+
interface PhysicalProperties {
|
|
425
456
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
426
457
|
weight?: number | null;
|
|
427
458
|
/**
|
|
@@ -432,20 +463,20 @@ export interface PhysicalProperties {
|
|
|
432
463
|
/** Whether this line item is shippable. */
|
|
433
464
|
shippable?: boolean;
|
|
434
465
|
}
|
|
435
|
-
|
|
466
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
436
467
|
/** Preset item type. */
|
|
437
468
|
preset?: ItemTypeItemType;
|
|
438
469
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
439
470
|
custom?: string;
|
|
440
471
|
}
|
|
441
472
|
/** @oneof */
|
|
442
|
-
|
|
473
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
443
474
|
/** Preset item type. */
|
|
444
475
|
preset?: ItemTypeItemType;
|
|
445
476
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
446
477
|
custom?: string;
|
|
447
478
|
}
|
|
448
|
-
|
|
479
|
+
declare enum ItemTypeItemType {
|
|
449
480
|
UNRECOGNISED = "UNRECOGNISED",
|
|
450
481
|
PHYSICAL = "PHYSICAL",
|
|
451
482
|
DIGITAL = "DIGITAL",
|
|
@@ -453,7 +484,7 @@ export declare enum ItemTypeItemType {
|
|
|
453
484
|
SERVICE = "SERVICE"
|
|
454
485
|
}
|
|
455
486
|
/** Type of selected payment option for catalog item */
|
|
456
|
-
|
|
487
|
+
declare enum PaymentOptionType {
|
|
457
488
|
/** The entire payment for this item happens as part of the checkout. */
|
|
458
489
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
459
490
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -465,7 +496,7 @@ export declare enum PaymentOptionType {
|
|
|
465
496
|
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
466
497
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
467
498
|
}
|
|
468
|
-
|
|
499
|
+
interface ItemTaxFullDetails {
|
|
469
500
|
/** Taxable amount of this line item. */
|
|
470
501
|
taxableAmount?: Price;
|
|
471
502
|
/**
|
|
@@ -476,7 +507,7 @@ export interface ItemTaxFullDetails {
|
|
|
476
507
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
477
508
|
totalTax?: Price;
|
|
478
509
|
}
|
|
479
|
-
|
|
510
|
+
interface LineItemTaxInfo {
|
|
480
511
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
481
512
|
taxAmount?: Price;
|
|
482
513
|
/** Amount for which tax is calculated. */
|
|
@@ -504,7 +535,7 @@ export interface LineItemTaxInfo {
|
|
|
504
535
|
* TaxBreakdown represents tax information for a line item.
|
|
505
536
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
506
537
|
*/
|
|
507
|
-
|
|
538
|
+
interface LineItemTaxBreakdown {
|
|
508
539
|
/**
|
|
509
540
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
510
541
|
* @maxLength 200
|
|
@@ -537,7 +568,7 @@ export interface LineItemTaxBreakdown {
|
|
|
537
568
|
taxableAmount?: Price;
|
|
538
569
|
}
|
|
539
570
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
540
|
-
|
|
571
|
+
declare enum JurisdictionType {
|
|
541
572
|
UNDEFINED = "UNDEFINED",
|
|
542
573
|
COUNTRY = "COUNTRY",
|
|
543
574
|
STATE = "STATE",
|
|
@@ -545,7 +576,7 @@ export declare enum JurisdictionType {
|
|
|
545
576
|
CITY = "CITY",
|
|
546
577
|
SPECIAL = "SPECIAL"
|
|
547
578
|
}
|
|
548
|
-
|
|
579
|
+
interface DigitalFile {
|
|
549
580
|
/**
|
|
550
581
|
* ID of the secure file in media.
|
|
551
582
|
* @minLength 1
|
|
@@ -565,7 +596,7 @@ export interface DigitalFile {
|
|
|
565
596
|
*/
|
|
566
597
|
expirationDate?: Date | null;
|
|
567
598
|
}
|
|
568
|
-
|
|
599
|
+
interface SubscriptionInfo {
|
|
569
600
|
/**
|
|
570
601
|
* Subscription ID.
|
|
571
602
|
* @format GUID
|
|
@@ -584,6 +615,11 @@ export interface SubscriptionInfo {
|
|
|
584
615
|
* @targetRemovalDate 2025-10-01
|
|
585
616
|
*/
|
|
586
617
|
subscriptionOptionTitle?: string;
|
|
618
|
+
/**
|
|
619
|
+
* Subscription title. For example, `"Monthly coffee Subscription"`.
|
|
620
|
+
* @internal
|
|
621
|
+
*/
|
|
622
|
+
title?: SubscriptionTitle;
|
|
587
623
|
/**
|
|
588
624
|
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
589
625
|
* @maxLength 60
|
|
@@ -592,13 +628,29 @@ export interface SubscriptionInfo {
|
|
|
592
628
|
* @targetRemovalDate 2025-10-01
|
|
593
629
|
*/
|
|
594
630
|
subscriptionOptionDescription?: string | null;
|
|
631
|
+
/**
|
|
632
|
+
* Subscription description. For example, `"1kg of selected coffee, once a month"`.
|
|
633
|
+
* @internal
|
|
634
|
+
*/
|
|
635
|
+
description?: SubscriptionDescription;
|
|
595
636
|
/**
|
|
596
637
|
* Subscription detailed information.
|
|
597
638
|
* @immutable
|
|
598
639
|
*/
|
|
599
640
|
subscriptionSettings?: SubscriptionSettings;
|
|
641
|
+
/**
|
|
642
|
+
* Description of the charges that will be applied for subscription.
|
|
643
|
+
* @internal
|
|
644
|
+
* @maxLength 1000
|
|
645
|
+
*/
|
|
646
|
+
chargesDescription?: string | null;
|
|
647
|
+
/**
|
|
648
|
+
* Details of the billing adjustment applied to the current subscription cycle due to a shift in the subscription’s billing date.
|
|
649
|
+
* @internal
|
|
650
|
+
*/
|
|
651
|
+
billingAdjustment?: BillingAdjustment;
|
|
600
652
|
}
|
|
601
|
-
|
|
653
|
+
interface SubscriptionTitle {
|
|
602
654
|
/**
|
|
603
655
|
* Subscription option name 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).
|
|
604
656
|
* @minLength 1
|
|
@@ -614,7 +666,7 @@ export interface SubscriptionTitle {
|
|
|
614
666
|
*/
|
|
615
667
|
translated?: string | null;
|
|
616
668
|
}
|
|
617
|
-
|
|
669
|
+
interface SubscriptionDescription {
|
|
618
670
|
/**
|
|
619
671
|
* Subscription option description.
|
|
620
672
|
* @maxLength 500
|
|
@@ -626,7 +678,7 @@ export interface SubscriptionDescription {
|
|
|
626
678
|
*/
|
|
627
679
|
translated?: string | null;
|
|
628
680
|
}
|
|
629
|
-
|
|
681
|
+
interface SubscriptionSettings {
|
|
630
682
|
/** Frequency of recurring payment. */
|
|
631
683
|
frequency?: V2SubscriptionFrequency;
|
|
632
684
|
/**
|
|
@@ -642,16 +694,31 @@ export interface SubscriptionSettings {
|
|
|
642
694
|
* @min 1
|
|
643
695
|
*/
|
|
644
696
|
billingCycles?: number | null;
|
|
697
|
+
/**
|
|
698
|
+
* Whether to allow the customer to cancel the subscription.
|
|
699
|
+
* @internal
|
|
700
|
+
*/
|
|
701
|
+
enableCustomerCancellation?: boolean;
|
|
702
|
+
/**
|
|
703
|
+
* Period until first cycle starts. If None => no free trial
|
|
704
|
+
* @internal
|
|
705
|
+
*/
|
|
706
|
+
freeTrialPeriod?: FreeTrialPeriod;
|
|
707
|
+
/**
|
|
708
|
+
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
709
|
+
* @internal
|
|
710
|
+
*/
|
|
711
|
+
startDate?: Date | null;
|
|
645
712
|
}
|
|
646
713
|
/** Frequency unit of recurring payment */
|
|
647
|
-
|
|
714
|
+
declare enum V2SubscriptionFrequency {
|
|
648
715
|
UNDEFINED = "UNDEFINED",
|
|
649
716
|
DAY = "DAY",
|
|
650
717
|
WEEK = "WEEK",
|
|
651
718
|
MONTH = "MONTH",
|
|
652
719
|
YEAR = "YEAR"
|
|
653
720
|
}
|
|
654
|
-
|
|
721
|
+
interface FreeTrialPeriod {
|
|
655
722
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
656
723
|
frequency?: V2SubscriptionFrequency;
|
|
657
724
|
/**
|
|
@@ -661,20 +728,20 @@ export interface FreeTrialPeriod {
|
|
|
661
728
|
*/
|
|
662
729
|
interval?: number;
|
|
663
730
|
}
|
|
664
|
-
|
|
731
|
+
interface BillingAdjustment {
|
|
665
732
|
/** The type of adjustment. */
|
|
666
733
|
type?: AdjustmentType;
|
|
667
734
|
/** Summary of the prorated adjustment amount. */
|
|
668
735
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
669
736
|
}
|
|
670
|
-
|
|
737
|
+
declare enum AdjustmentType {
|
|
671
738
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
672
739
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
673
740
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
674
741
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
675
742
|
CREDIT = "CREDIT"
|
|
676
743
|
}
|
|
677
|
-
|
|
744
|
+
interface BillingAdjustmentPriceSummary {
|
|
678
745
|
/** Subtotal of adjustment, before tax. */
|
|
679
746
|
subtotal?: Price;
|
|
680
747
|
/** Tax on adjustment. */
|
|
@@ -682,7 +749,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
682
749
|
/** Total price after tax. */
|
|
683
750
|
total?: Price;
|
|
684
751
|
}
|
|
685
|
-
|
|
752
|
+
interface PriceDescription {
|
|
686
753
|
/**
|
|
687
754
|
* __Required.__ Price description 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).
|
|
688
755
|
* @minLength 1
|
|
@@ -698,7 +765,7 @@ export interface PriceDescription {
|
|
|
698
765
|
*/
|
|
699
766
|
translated?: string | null;
|
|
700
767
|
}
|
|
701
|
-
|
|
768
|
+
interface LocationAndQuantity {
|
|
702
769
|
/**
|
|
703
770
|
* Location id in the associated owner app.
|
|
704
771
|
* @format GUID
|
|
@@ -724,22 +791,22 @@ export interface LocationAndQuantity {
|
|
|
724
791
|
*/
|
|
725
792
|
name?: string | null;
|
|
726
793
|
}
|
|
727
|
-
|
|
794
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
728
795
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
729
796
|
addressType?: TaxableAddressType;
|
|
730
797
|
}
|
|
731
798
|
/** @oneof */
|
|
732
|
-
|
|
799
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
733
800
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
734
801
|
addressType?: TaxableAddressType;
|
|
735
802
|
}
|
|
736
|
-
|
|
803
|
+
declare enum TaxableAddressType {
|
|
737
804
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
738
805
|
BUSINESS = "BUSINESS",
|
|
739
806
|
BILLING = "BILLING",
|
|
740
807
|
SHIPPING = "SHIPPING"
|
|
741
808
|
}
|
|
742
|
-
|
|
809
|
+
interface ExtendedFields {
|
|
743
810
|
/**
|
|
744
811
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
745
812
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -751,7 +818,7 @@ export interface ExtendedFields {
|
|
|
751
818
|
namespaces?: Record<string, Record<string, any>>;
|
|
752
819
|
}
|
|
753
820
|
/** Buyer Info */
|
|
754
|
-
|
|
821
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
755
822
|
/**
|
|
756
823
|
* Visitor ID (if site visitor is not a member).
|
|
757
824
|
* @format GUID
|
|
@@ -774,7 +841,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
774
841
|
email?: string | null;
|
|
775
842
|
}
|
|
776
843
|
/** @oneof */
|
|
777
|
-
|
|
844
|
+
interface BuyerInfoIdOneOf {
|
|
778
845
|
/**
|
|
779
846
|
* Visitor ID (if site visitor is not a member).
|
|
780
847
|
* @format GUID
|
|
@@ -786,7 +853,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
786
853
|
*/
|
|
787
854
|
memberId?: string;
|
|
788
855
|
}
|
|
789
|
-
|
|
856
|
+
declare enum WeightUnit {
|
|
790
857
|
/** Weight unit can't be classified due to an error. */
|
|
791
858
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
792
859
|
/** Kilograms. */
|
|
@@ -794,7 +861,7 @@ export declare enum WeightUnit {
|
|
|
794
861
|
/** Pounds. */
|
|
795
862
|
LB = "LB"
|
|
796
863
|
}
|
|
797
|
-
|
|
864
|
+
interface CurrencyConversionDetails {
|
|
798
865
|
/**
|
|
799
866
|
* Original currency used to calculate the pricing before conversion to payment currency set on the order [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
800
867
|
* @readonly
|
|
@@ -810,7 +877,7 @@ export interface CurrencyConversionDetails {
|
|
|
810
877
|
*/
|
|
811
878
|
conversionRate?: string | null;
|
|
812
879
|
}
|
|
813
|
-
|
|
880
|
+
interface PriceSummary {
|
|
814
881
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
815
882
|
subtotal?: Price;
|
|
816
883
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -825,14 +892,14 @@ export interface PriceSummary {
|
|
|
825
892
|
totalAdditionalFees?: Price;
|
|
826
893
|
}
|
|
827
894
|
/** Billing Info and shipping details */
|
|
828
|
-
|
|
895
|
+
interface AddressWithContact {
|
|
829
896
|
/** Address. */
|
|
830
897
|
address?: Address;
|
|
831
898
|
/** Contact details. */
|
|
832
899
|
contactDetails?: FullAddressContactDetails;
|
|
833
900
|
}
|
|
834
901
|
/** Physical address */
|
|
835
|
-
|
|
902
|
+
interface Address {
|
|
836
903
|
/**
|
|
837
904
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
838
905
|
* @format COUNTRY
|
|
@@ -876,20 +943,20 @@ export interface Address {
|
|
|
876
943
|
*/
|
|
877
944
|
subdivisionFullname?: string | null;
|
|
878
945
|
}
|
|
879
|
-
|
|
946
|
+
interface StreetAddress {
|
|
880
947
|
/** Street number. */
|
|
881
948
|
number?: string;
|
|
882
949
|
/** Street name. */
|
|
883
950
|
name?: string;
|
|
884
951
|
}
|
|
885
|
-
|
|
952
|
+
interface AddressLocation {
|
|
886
953
|
/** Address latitude. */
|
|
887
954
|
latitude?: number | null;
|
|
888
955
|
/** Address longitude. */
|
|
889
956
|
longitude?: number | null;
|
|
890
957
|
}
|
|
891
958
|
/** Full contact details for an address */
|
|
892
|
-
|
|
959
|
+
interface FullAddressContactDetails {
|
|
893
960
|
/**
|
|
894
961
|
* First name.
|
|
895
962
|
* @maxLength 100
|
|
@@ -913,7 +980,7 @@ export interface FullAddressContactDetails {
|
|
|
913
980
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
914
981
|
vatId?: VatId;
|
|
915
982
|
}
|
|
916
|
-
|
|
983
|
+
interface VatId {
|
|
917
984
|
/** Customer's tax ID. */
|
|
918
985
|
_id?: string;
|
|
919
986
|
/**
|
|
@@ -926,14 +993,14 @@ export interface VatId {
|
|
|
926
993
|
type?: VatType;
|
|
927
994
|
}
|
|
928
995
|
/** tax info types */
|
|
929
|
-
|
|
996
|
+
declare enum VatType {
|
|
930
997
|
UNSPECIFIED = "UNSPECIFIED",
|
|
931
998
|
/** CPF - for individual tax payers. */
|
|
932
999
|
CPF = "CPF",
|
|
933
1000
|
/** CNPJ - for corporations */
|
|
934
1001
|
CNPJ = "CNPJ"
|
|
935
1002
|
}
|
|
936
|
-
|
|
1003
|
+
interface ShippingInformation {
|
|
937
1004
|
/**
|
|
938
1005
|
* App Def Id of external provider which was a source of shipping info
|
|
939
1006
|
* @minLength 1
|
|
@@ -959,7 +1026,7 @@ export interface ShippingInformation {
|
|
|
959
1026
|
/** Shipping region. */
|
|
960
1027
|
region?: ShippingRegion;
|
|
961
1028
|
}
|
|
962
|
-
|
|
1029
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
963
1030
|
/** Shipping address and contact details. */
|
|
964
1031
|
shippingDestination?: AddressWithContact;
|
|
965
1032
|
/** Pickup details. */
|
|
@@ -983,20 +1050,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
983
1050
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
984
1051
|
}
|
|
985
1052
|
/** @oneof */
|
|
986
|
-
|
|
1053
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
987
1054
|
/** Shipping address and contact details. */
|
|
988
1055
|
shippingDestination?: AddressWithContact;
|
|
989
1056
|
/** Pickup details. */
|
|
990
1057
|
pickupDetails?: PickupDetails;
|
|
991
1058
|
}
|
|
992
|
-
|
|
1059
|
+
interface PickupDetails {
|
|
993
1060
|
/** Pickup address. */
|
|
994
1061
|
address?: PickupAddress;
|
|
995
1062
|
/** Pickup method */
|
|
996
1063
|
pickupMethod?: PickupMethod;
|
|
997
1064
|
}
|
|
998
1065
|
/** Physical address */
|
|
999
|
-
|
|
1066
|
+
interface PickupAddress {
|
|
1000
1067
|
/**
|
|
1001
1068
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1002
1069
|
* @format COUNTRY
|
|
@@ -1040,18 +1107,18 @@ export interface PickupAddress {
|
|
|
1040
1107
|
*/
|
|
1041
1108
|
subdivisionFullname?: string | null;
|
|
1042
1109
|
}
|
|
1043
|
-
|
|
1110
|
+
declare enum PickupMethod {
|
|
1044
1111
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1045
1112
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1046
1113
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1047
1114
|
}
|
|
1048
|
-
|
|
1115
|
+
interface DeliveryTimeSlot {
|
|
1049
1116
|
/** Delivery slot starting time. */
|
|
1050
1117
|
from?: Date | null;
|
|
1051
1118
|
/** Delivery slot ending time. */
|
|
1052
1119
|
to?: Date | null;
|
|
1053
1120
|
}
|
|
1054
|
-
|
|
1121
|
+
interface ShippingPrice {
|
|
1055
1122
|
/** Shipping price for display purposes. */
|
|
1056
1123
|
price?: Price;
|
|
1057
1124
|
/**
|
|
@@ -1072,14 +1139,14 @@ export interface ShippingPrice {
|
|
|
1072
1139
|
*/
|
|
1073
1140
|
discount?: Price;
|
|
1074
1141
|
}
|
|
1075
|
-
|
|
1142
|
+
interface ShippingRegion {
|
|
1076
1143
|
/**
|
|
1077
1144
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1078
1145
|
* @maxLength 100
|
|
1079
1146
|
*/
|
|
1080
1147
|
name?: string | null;
|
|
1081
1148
|
}
|
|
1082
|
-
|
|
1149
|
+
interface OrderTaxInfo {
|
|
1083
1150
|
/** Calculated tax, added from line items. */
|
|
1084
1151
|
totalTax?: Price;
|
|
1085
1152
|
/**
|
|
@@ -1099,7 +1166,7 @@ export interface OrderTaxInfo {
|
|
|
1099
1166
|
* 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.
|
|
1100
1167
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1101
1168
|
*/
|
|
1102
|
-
|
|
1169
|
+
interface OrderTaxBreakdown {
|
|
1103
1170
|
/**
|
|
1104
1171
|
* The name of the tax against which this tax amount was calculated.
|
|
1105
1172
|
* @maxLength 200
|
|
@@ -1126,7 +1193,7 @@ export interface OrderTaxBreakdown {
|
|
|
1126
1193
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1127
1194
|
aggregatedTaxAmount?: Price;
|
|
1128
1195
|
}
|
|
1129
|
-
|
|
1196
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1130
1197
|
/** Applied coupon info. */
|
|
1131
1198
|
coupon?: Coupon;
|
|
1132
1199
|
/** Merchant discount. */
|
|
@@ -1157,9 +1224,17 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1157
1224
|
* @immutable
|
|
1158
1225
|
*/
|
|
1159
1226
|
_id?: string | null;
|
|
1227
|
+
/**
|
|
1228
|
+
* Number of subscription billing cycles the discount applies to.
|
|
1229
|
+
* If None and discount is linked to subscription line item, it applies to all cycles.
|
|
1230
|
+
* @internal
|
|
1231
|
+
* @min 1
|
|
1232
|
+
* @max 999
|
|
1233
|
+
*/
|
|
1234
|
+
subscriptionCycles?: number | null;
|
|
1160
1235
|
}
|
|
1161
1236
|
/** @oneof */
|
|
1162
|
-
|
|
1237
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1163
1238
|
/** Applied coupon info. */
|
|
1164
1239
|
coupon?: Coupon;
|
|
1165
1240
|
/** Merchant discount. */
|
|
@@ -1167,13 +1242,13 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1167
1242
|
/** Automatic Discount */
|
|
1168
1243
|
discountRule?: DiscountRule;
|
|
1169
1244
|
}
|
|
1170
|
-
|
|
1245
|
+
declare enum DiscountType {
|
|
1171
1246
|
GLOBAL = "GLOBAL",
|
|
1172
1247
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1173
1248
|
SHIPPING = "SHIPPING"
|
|
1174
1249
|
}
|
|
1175
1250
|
/** Coupon */
|
|
1176
|
-
|
|
1251
|
+
interface Coupon {
|
|
1177
1252
|
/** Coupon ID. */
|
|
1178
1253
|
_id?: string;
|
|
1179
1254
|
/** Coupon code. */
|
|
@@ -1183,7 +1258,7 @@ export interface Coupon {
|
|
|
1183
1258
|
/** Coupon value. */
|
|
1184
1259
|
amount?: Price;
|
|
1185
1260
|
}
|
|
1186
|
-
|
|
1261
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1187
1262
|
/**
|
|
1188
1263
|
* Pre-defined discount reason (optional).
|
|
1189
1264
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1196,9 +1271,16 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1196
1271
|
description?: string | null;
|
|
1197
1272
|
/** Discount amount. */
|
|
1198
1273
|
amount?: Price;
|
|
1274
|
+
/**
|
|
1275
|
+
* Discount percentage.
|
|
1276
|
+
* @internal
|
|
1277
|
+
* @format DECIMAL_VALUE
|
|
1278
|
+
* @decimalValue options { gte:0, lte:100, maxScale:2 }
|
|
1279
|
+
*/
|
|
1280
|
+
percentage?: string | null;
|
|
1199
1281
|
}
|
|
1200
1282
|
/** @oneof */
|
|
1201
|
-
|
|
1283
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1202
1284
|
/**
|
|
1203
1285
|
* Pre-defined discount reason (optional).
|
|
1204
1286
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1210,12 +1292,12 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1210
1292
|
*/
|
|
1211
1293
|
description?: string | null;
|
|
1212
1294
|
}
|
|
1213
|
-
|
|
1295
|
+
declare enum DiscountReason {
|
|
1214
1296
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1215
1297
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1216
1298
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1217
1299
|
}
|
|
1218
|
-
|
|
1300
|
+
interface DiscountRule {
|
|
1219
1301
|
/**
|
|
1220
1302
|
* Discount rule ID
|
|
1221
1303
|
* @format GUID
|
|
@@ -1226,7 +1308,7 @@ export interface DiscountRule {
|
|
|
1226
1308
|
/** Discount value. */
|
|
1227
1309
|
amount?: Price;
|
|
1228
1310
|
}
|
|
1229
|
-
|
|
1311
|
+
interface DiscountRuleName {
|
|
1230
1312
|
/**
|
|
1231
1313
|
* Original discount rule name (in site's default language).
|
|
1232
1314
|
* @minLength 1
|
|
@@ -1240,7 +1322,7 @@ export interface DiscountRuleName {
|
|
|
1240
1322
|
*/
|
|
1241
1323
|
translated?: string | null;
|
|
1242
1324
|
}
|
|
1243
|
-
|
|
1325
|
+
interface LineItemDiscount {
|
|
1244
1326
|
/**
|
|
1245
1327
|
* ID of line item the discount applies to.
|
|
1246
1328
|
* @format GUID
|
|
@@ -1249,7 +1331,7 @@ export interface LineItemDiscount {
|
|
|
1249
1331
|
/** Total discount for this line item. */
|
|
1250
1332
|
totalDiscount?: Price;
|
|
1251
1333
|
}
|
|
1252
|
-
|
|
1334
|
+
interface ChannelInfo {
|
|
1253
1335
|
/** Sales channel that submitted the order. */
|
|
1254
1336
|
type?: ChannelType;
|
|
1255
1337
|
/**
|
|
@@ -1263,7 +1345,7 @@ export interface ChannelInfo {
|
|
|
1263
1345
|
*/
|
|
1264
1346
|
externalOrderUrl?: string | null;
|
|
1265
1347
|
}
|
|
1266
|
-
|
|
1348
|
+
declare enum ChannelType {
|
|
1267
1349
|
/** Unspecified sales channel. This value is not supported. */
|
|
1268
1350
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1269
1351
|
/** A web client. */
|
|
@@ -1297,7 +1379,7 @@ export declare enum ChannelType {
|
|
|
1297
1379
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1298
1380
|
FAIRE_COM = "FAIRE_COM"
|
|
1299
1381
|
}
|
|
1300
|
-
|
|
1382
|
+
interface CustomField {
|
|
1301
1383
|
/** Custom field value. */
|
|
1302
1384
|
value?: any;
|
|
1303
1385
|
/**
|
|
@@ -1313,7 +1395,7 @@ export interface CustomField {
|
|
|
1313
1395
|
*/
|
|
1314
1396
|
translatedTitle?: string | null;
|
|
1315
1397
|
}
|
|
1316
|
-
|
|
1398
|
+
interface V1SubscriptionTitle {
|
|
1317
1399
|
/**
|
|
1318
1400
|
* Subscription option name 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).
|
|
1319
1401
|
* @minLength 1
|
|
@@ -1329,7 +1411,7 @@ export interface V1SubscriptionTitle {
|
|
|
1329
1411
|
*/
|
|
1330
1412
|
translated?: string | null;
|
|
1331
1413
|
}
|
|
1332
|
-
|
|
1414
|
+
interface AdditionalFee {
|
|
1333
1415
|
/**
|
|
1334
1416
|
* Additional fee's unique code for future processing.
|
|
1335
1417
|
* @minLength 1
|
|
@@ -1367,8 +1449,16 @@ export interface AdditionalFee {
|
|
|
1367
1449
|
* @format GUID
|
|
1368
1450
|
*/
|
|
1369
1451
|
lineItemIds?: string[];
|
|
1452
|
+
/**
|
|
1453
|
+
* Number of subscription billing cycles the additional fee applies to.
|
|
1454
|
+
* If None and additional fee is linked to subscription line item, it applies to all cycles.
|
|
1455
|
+
* @internal
|
|
1456
|
+
* @min 1
|
|
1457
|
+
* @max 999
|
|
1458
|
+
*/
|
|
1459
|
+
subscriptionCycles?: number | null;
|
|
1370
1460
|
}
|
|
1371
|
-
|
|
1461
|
+
interface Location {
|
|
1372
1462
|
/**
|
|
1373
1463
|
* Location ID.
|
|
1374
1464
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -1383,38 +1473,38 @@ export interface Location {
|
|
|
1383
1473
|
*/
|
|
1384
1474
|
name?: string;
|
|
1385
1475
|
}
|
|
1386
|
-
|
|
1476
|
+
interface CreateSubscriptionContractRequest {
|
|
1387
1477
|
/** SubscriptionContract to be created. */
|
|
1388
1478
|
subscriptionContract?: SubscriptionContract;
|
|
1389
1479
|
}
|
|
1390
|
-
|
|
1480
|
+
interface CreateSubscriptionContractResponse {
|
|
1391
1481
|
/** The created SubscriptionContract. */
|
|
1392
1482
|
subscriptionContract?: SubscriptionContract;
|
|
1393
1483
|
}
|
|
1394
|
-
|
|
1484
|
+
interface GetSubscriptionContractRequest {
|
|
1395
1485
|
/**
|
|
1396
1486
|
* ID of the SubscriptionContract to retrieve.
|
|
1397
1487
|
* @format GUID
|
|
1398
1488
|
*/
|
|
1399
1489
|
subscriptionContractId: string;
|
|
1400
1490
|
}
|
|
1401
|
-
|
|
1491
|
+
interface GetSubscriptionContractResponse {
|
|
1402
1492
|
/** The requested SubscriptionContract. */
|
|
1403
1493
|
subscriptionContract?: SubscriptionContract;
|
|
1404
1494
|
}
|
|
1405
|
-
|
|
1495
|
+
interface UpdateSubscriptionContractRequest {
|
|
1406
1496
|
/** SubscriptionContract to be updated, may be partial. */
|
|
1407
1497
|
subscriptionContract?: SubscriptionContract;
|
|
1408
1498
|
}
|
|
1409
|
-
|
|
1499
|
+
interface UpdateSubscriptionContractResponse {
|
|
1410
1500
|
/** Updated SubscriptionContract. */
|
|
1411
1501
|
subscriptionContract?: SubscriptionContract;
|
|
1412
1502
|
}
|
|
1413
|
-
|
|
1503
|
+
interface QuerySubscriptionContractsRequest {
|
|
1414
1504
|
/** WQL expression. */
|
|
1415
1505
|
query?: CursorQuery;
|
|
1416
1506
|
}
|
|
1417
|
-
|
|
1507
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1418
1508
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1419
1509
|
cursorPaging?: CursorPaging;
|
|
1420
1510
|
/**
|
|
@@ -1436,11 +1526,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1436
1526
|
sort?: Sorting[];
|
|
1437
1527
|
}
|
|
1438
1528
|
/** @oneof */
|
|
1439
|
-
|
|
1529
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1440
1530
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1441
1531
|
cursorPaging?: CursorPaging;
|
|
1442
1532
|
}
|
|
1443
|
-
|
|
1533
|
+
interface Sorting {
|
|
1444
1534
|
/**
|
|
1445
1535
|
* Name of the field to sort by.
|
|
1446
1536
|
* @maxLength 512
|
|
@@ -1449,11 +1539,11 @@ export interface Sorting {
|
|
|
1449
1539
|
/** Sort order. */
|
|
1450
1540
|
order?: SortOrder;
|
|
1451
1541
|
}
|
|
1452
|
-
|
|
1542
|
+
declare enum SortOrder {
|
|
1453
1543
|
ASC = "ASC",
|
|
1454
1544
|
DESC = "DESC"
|
|
1455
1545
|
}
|
|
1456
|
-
|
|
1546
|
+
interface CursorPaging {
|
|
1457
1547
|
/**
|
|
1458
1548
|
* Maximum number of items to return in the results.
|
|
1459
1549
|
* @max 100
|
|
@@ -1468,13 +1558,13 @@ export interface CursorPaging {
|
|
|
1468
1558
|
*/
|
|
1469
1559
|
cursor?: string | null;
|
|
1470
1560
|
}
|
|
1471
|
-
|
|
1561
|
+
interface QuerySubscriptionContractsResponse {
|
|
1472
1562
|
/** List of SubscriptionContracts. */
|
|
1473
1563
|
subscriptionContracts?: SubscriptionContract[];
|
|
1474
1564
|
/** Paging metadata */
|
|
1475
1565
|
pagingMetadata?: CursorPagingMetadata;
|
|
1476
1566
|
}
|
|
1477
|
-
|
|
1567
|
+
interface CursorPagingMetadata {
|
|
1478
1568
|
/** Number of items returned in the response. */
|
|
1479
1569
|
count?: number | null;
|
|
1480
1570
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1487,7 +1577,7 @@ export interface CursorPagingMetadata {
|
|
|
1487
1577
|
*/
|
|
1488
1578
|
hasNext?: boolean | null;
|
|
1489
1579
|
}
|
|
1490
|
-
|
|
1580
|
+
interface Cursors {
|
|
1491
1581
|
/**
|
|
1492
1582
|
* Cursor string pointing to the next page in the list of results.
|
|
1493
1583
|
* @maxLength 16000
|
|
@@ -1499,7 +1589,7 @@ export interface Cursors {
|
|
|
1499
1589
|
*/
|
|
1500
1590
|
prev?: string | null;
|
|
1501
1591
|
}
|
|
1502
|
-
|
|
1592
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1503
1593
|
createdEvent?: EntityCreatedEvent;
|
|
1504
1594
|
updatedEvent?: EntityUpdatedEvent;
|
|
1505
1595
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1542,19 +1632,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1542
1632
|
entityEventSequence?: string | null;
|
|
1543
1633
|
}
|
|
1544
1634
|
/** @oneof */
|
|
1545
|
-
|
|
1635
|
+
interface DomainEventBodyOneOf {
|
|
1546
1636
|
createdEvent?: EntityCreatedEvent;
|
|
1547
1637
|
updatedEvent?: EntityUpdatedEvent;
|
|
1548
1638
|
deletedEvent?: EntityDeletedEvent;
|
|
1549
1639
|
actionEvent?: ActionEvent;
|
|
1550
1640
|
}
|
|
1551
|
-
|
|
1641
|
+
interface EntityCreatedEvent {
|
|
1552
1642
|
entity?: string;
|
|
1553
1643
|
}
|
|
1554
|
-
|
|
1644
|
+
interface RestoreInfo {
|
|
1555
1645
|
deletedDate?: Date | null;
|
|
1556
1646
|
}
|
|
1557
|
-
|
|
1647
|
+
interface EntityUpdatedEvent {
|
|
1558
1648
|
/**
|
|
1559
1649
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1560
1650
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1562,16 +1652,16 @@ export interface EntityUpdatedEvent {
|
|
|
1562
1652
|
*/
|
|
1563
1653
|
currentEntity?: string;
|
|
1564
1654
|
}
|
|
1565
|
-
|
|
1655
|
+
interface EntityDeletedEvent {
|
|
1566
1656
|
/** Entity that was deleted */
|
|
1567
1657
|
deletedEntity?: string | null;
|
|
1568
1658
|
}
|
|
1569
|
-
|
|
1659
|
+
interface ActionEvent {
|
|
1570
1660
|
body?: string;
|
|
1571
1661
|
}
|
|
1572
|
-
|
|
1662
|
+
interface Empty {
|
|
1573
1663
|
}
|
|
1574
|
-
|
|
1664
|
+
interface MessageEnvelope {
|
|
1575
1665
|
/**
|
|
1576
1666
|
* App instance ID.
|
|
1577
1667
|
* @format GUID
|
|
@@ -1587,7 +1677,7 @@ export interface MessageEnvelope {
|
|
|
1587
1677
|
/** Stringify payload. */
|
|
1588
1678
|
data?: string;
|
|
1589
1679
|
}
|
|
1590
|
-
|
|
1680
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1591
1681
|
/**
|
|
1592
1682
|
* ID of a site visitor that has not logged in to the site.
|
|
1593
1683
|
* @format GUID
|
|
@@ -1612,7 +1702,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1612
1702
|
identityType?: WebhookIdentityType;
|
|
1613
1703
|
}
|
|
1614
1704
|
/** @oneof */
|
|
1615
|
-
|
|
1705
|
+
interface IdentificationDataIdOneOf {
|
|
1616
1706
|
/**
|
|
1617
1707
|
* ID of a site visitor that has not logged in to the site.
|
|
1618
1708
|
* @format GUID
|
|
@@ -1634,246 +1724,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
1634
1724
|
*/
|
|
1635
1725
|
appId?: string;
|
|
1636
1726
|
}
|
|
1637
|
-
|
|
1727
|
+
declare enum WebhookIdentityType {
|
|
1638
1728
|
UNKNOWN = "UNKNOWN",
|
|
1639
1729
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1640
1730
|
MEMBER = "MEMBER",
|
|
1641
1731
|
WIX_USER = "WIX_USER",
|
|
1642
1732
|
APP = "APP"
|
|
1643
1733
|
}
|
|
1644
|
-
interface
|
|
1645
|
-
frequency: SubscriptionFrequency;
|
|
1646
|
-
autoRenewal: boolean;
|
|
1647
|
-
enableCustomerCancellation: boolean;
|
|
1648
|
-
}
|
|
1649
|
-
interface ProductNameNonNullableFields {
|
|
1650
|
-
original: string;
|
|
1651
|
-
}
|
|
1652
|
-
interface CatalogReferenceNonNullableFields {
|
|
1653
|
-
catalogItemId: string;
|
|
1654
|
-
appId: string;
|
|
1655
|
-
}
|
|
1656
|
-
interface PriceNonNullableFields {
|
|
1657
|
-
amount: string;
|
|
1658
|
-
formattedAmount: string;
|
|
1659
|
-
}
|
|
1660
|
-
interface PlainTextValueNonNullableFields {
|
|
1661
|
-
original: string;
|
|
1662
|
-
}
|
|
1663
|
-
interface ColorNonNullableFields {
|
|
1664
|
-
original: string;
|
|
1665
|
-
}
|
|
1666
|
-
interface DescriptionLineNameNonNullableFields {
|
|
1667
|
-
original: string;
|
|
1668
|
-
}
|
|
1669
|
-
interface DescriptionLineNonNullableFields {
|
|
1670
|
-
plainText?: PlainTextValueNonNullableFields;
|
|
1671
|
-
colorInfo?: ColorNonNullableFields;
|
|
1672
|
-
plainTextValue?: PlainTextValueNonNullableFields;
|
|
1673
|
-
color: string;
|
|
1674
|
-
name?: DescriptionLineNameNonNullableFields;
|
|
1675
|
-
lineType: DescriptionLineType;
|
|
1676
|
-
}
|
|
1677
|
-
interface PhysicalPropertiesNonNullableFields {
|
|
1678
|
-
shippable: boolean;
|
|
1679
|
-
}
|
|
1680
|
-
interface ItemTypeNonNullableFields {
|
|
1681
|
-
preset: ItemTypeItemType;
|
|
1682
|
-
custom: string;
|
|
1683
|
-
}
|
|
1684
|
-
interface ItemTaxFullDetailsNonNullableFields {
|
|
1685
|
-
taxableAmount?: PriceNonNullableFields;
|
|
1686
|
-
taxRate: string;
|
|
1687
|
-
totalTax?: PriceNonNullableFields;
|
|
1688
|
-
}
|
|
1689
|
-
interface LineItemTaxBreakdownNonNullableFields {
|
|
1690
|
-
taxAmount?: PriceNonNullableFields;
|
|
1691
|
-
jurisdictionType: JurisdictionType;
|
|
1692
|
-
nonTaxableAmount?: PriceNonNullableFields;
|
|
1693
|
-
taxableAmount?: PriceNonNullableFields;
|
|
1694
|
-
}
|
|
1695
|
-
interface LineItemTaxInfoNonNullableFields {
|
|
1696
|
-
taxAmount?: PriceNonNullableFields;
|
|
1697
|
-
taxableAmount?: PriceNonNullableFields;
|
|
1698
|
-
taxIncludedInPrice: boolean;
|
|
1699
|
-
taxBreakdown: LineItemTaxBreakdownNonNullableFields[];
|
|
1700
|
-
}
|
|
1701
|
-
interface DigitalFileNonNullableFields {
|
|
1702
|
-
fileId: string;
|
|
1703
|
-
}
|
|
1704
|
-
interface SubscriptionSettingsNonNullableFields {
|
|
1705
|
-
frequency: V2SubscriptionFrequency;
|
|
1706
|
-
autoRenewal: boolean;
|
|
1707
|
-
}
|
|
1708
|
-
interface SubscriptionInfoNonNullableFields {
|
|
1709
|
-
cycleNumber: number;
|
|
1710
|
-
subscriptionOptionTitle: string;
|
|
1711
|
-
subscriptionSettings?: SubscriptionSettingsNonNullableFields;
|
|
1712
|
-
}
|
|
1713
|
-
interface PriceDescriptionNonNullableFields {
|
|
1714
|
-
original: string;
|
|
1715
|
-
}
|
|
1716
|
-
interface LocationAndQuantityNonNullableFields {
|
|
1717
|
-
_id: string;
|
|
1718
|
-
quantity: number;
|
|
1719
|
-
}
|
|
1720
|
-
interface OrderLineItemNonNullableFields {
|
|
1721
|
-
_id: string;
|
|
1722
|
-
productName?: ProductNameNonNullableFields;
|
|
1723
|
-
catalogReference?: CatalogReferenceNonNullableFields;
|
|
1724
|
-
quantity: number;
|
|
1725
|
-
totalDiscount?: PriceNonNullableFields;
|
|
1726
|
-
descriptionLines: DescriptionLineNonNullableFields[];
|
|
1727
|
-
image: string;
|
|
1728
|
-
physicalProperties?: PhysicalPropertiesNonNullableFields;
|
|
1729
|
-
itemType?: ItemTypeNonNullableFields;
|
|
1730
|
-
price?: PriceNonNullableFields;
|
|
1731
|
-
priceBeforeDiscounts?: PriceNonNullableFields;
|
|
1732
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
1733
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
1734
|
-
paymentOption: PaymentOptionType;
|
|
1735
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
1736
|
-
taxInfo?: LineItemTaxInfoNonNullableFields;
|
|
1737
|
-
digitalFile?: DigitalFileNonNullableFields;
|
|
1738
|
-
subscriptionInfo?: SubscriptionInfoNonNullableFields;
|
|
1739
|
-
priceDescription?: PriceDescriptionNonNullableFields;
|
|
1740
|
-
depositAmount?: PriceNonNullableFields;
|
|
1741
|
-
locations: LocationAndQuantityNonNullableFields[];
|
|
1742
|
-
lineItemPrice?: PriceNonNullableFields;
|
|
1743
|
-
}
|
|
1744
|
-
interface BuyerInfoNonNullableFields {
|
|
1745
|
-
visitorId: string;
|
|
1746
|
-
memberId: string;
|
|
1747
|
-
}
|
|
1748
|
-
interface PriceSummaryNonNullableFields {
|
|
1749
|
-
subtotal?: PriceNonNullableFields;
|
|
1750
|
-
shipping?: PriceNonNullableFields;
|
|
1751
|
-
tax?: PriceNonNullableFields;
|
|
1752
|
-
discount?: PriceNonNullableFields;
|
|
1753
|
-
totalPrice?: PriceNonNullableFields;
|
|
1754
|
-
total?: PriceNonNullableFields;
|
|
1755
|
-
totalWithGiftCard?: PriceNonNullableFields;
|
|
1756
|
-
totalWithoutGiftCard?: PriceNonNullableFields;
|
|
1757
|
-
totalAdditionalFees?: PriceNonNullableFields;
|
|
1758
|
-
}
|
|
1759
|
-
interface StreetAddressNonNullableFields {
|
|
1760
|
-
number: string;
|
|
1761
|
-
name: string;
|
|
1762
|
-
apt: string;
|
|
1763
|
-
}
|
|
1764
|
-
interface AddressNonNullableFields {
|
|
1765
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
1766
|
-
}
|
|
1767
|
-
interface VatIdNonNullableFields {
|
|
1768
|
-
_id: string;
|
|
1769
|
-
type: VatType;
|
|
1770
|
-
}
|
|
1771
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
1772
|
-
vatId?: VatIdNonNullableFields;
|
|
1773
|
-
}
|
|
1774
|
-
interface AddressWithContactNonNullableFields {
|
|
1775
|
-
address?: AddressNonNullableFields;
|
|
1776
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
1777
|
-
}
|
|
1778
|
-
interface PickupAddressNonNullableFields {
|
|
1779
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
1780
|
-
}
|
|
1781
|
-
interface PickupDetailsNonNullableFields {
|
|
1782
|
-
address?: PickupAddressNonNullableFields;
|
|
1783
|
-
pickupMethod: PickupMethod;
|
|
1784
|
-
}
|
|
1785
|
-
interface DeliveryLogisticsNonNullableFields {
|
|
1786
|
-
shippingDestination?: AddressWithContactNonNullableFields;
|
|
1787
|
-
pickupDetails?: PickupDetailsNonNullableFields;
|
|
1788
|
-
}
|
|
1789
|
-
interface ShippingPriceNonNullableFields {
|
|
1790
|
-
price?: PriceNonNullableFields;
|
|
1791
|
-
totalPriceBeforeTax?: PriceNonNullableFields;
|
|
1792
|
-
totalPriceAfterTax?: PriceNonNullableFields;
|
|
1793
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
1794
|
-
discount?: PriceNonNullableFields;
|
|
1795
|
-
}
|
|
1796
|
-
interface ShippingInformationNonNullableFields {
|
|
1797
|
-
title: string;
|
|
1798
|
-
logistics?: DeliveryLogisticsNonNullableFields;
|
|
1799
|
-
cost?: ShippingPriceNonNullableFields;
|
|
1800
|
-
}
|
|
1801
|
-
interface OrderTaxBreakdownNonNullableFields {
|
|
1802
|
-
taxName: string;
|
|
1803
|
-
taxType: string;
|
|
1804
|
-
jurisdiction: string;
|
|
1805
|
-
jurisdictionType: JurisdictionType;
|
|
1806
|
-
rate: string;
|
|
1807
|
-
aggregatedTaxAmount?: PriceNonNullableFields;
|
|
1808
|
-
aggregatedTaxableAmount?: PriceNonNullableFields;
|
|
1809
|
-
}
|
|
1810
|
-
interface OrderTaxInfoNonNullableFields {
|
|
1811
|
-
totalTax?: PriceNonNullableFields;
|
|
1812
|
-
taxBreakdown: OrderTaxBreakdownNonNullableFields[];
|
|
1813
|
-
}
|
|
1814
|
-
interface CouponNonNullableFields {
|
|
1815
|
-
_id: string;
|
|
1816
|
-
code: string;
|
|
1817
|
-
name: string;
|
|
1818
|
-
amount?: PriceNonNullableFields;
|
|
1819
|
-
}
|
|
1820
|
-
interface MerchantDiscountNonNullableFields {
|
|
1821
|
-
discountReason: DiscountReason;
|
|
1822
|
-
amount?: PriceNonNullableFields;
|
|
1823
|
-
}
|
|
1824
|
-
interface DiscountRuleNameNonNullableFields {
|
|
1825
|
-
original: string;
|
|
1826
|
-
}
|
|
1827
|
-
interface DiscountRuleNonNullableFields {
|
|
1828
|
-
_id: string;
|
|
1829
|
-
name?: DiscountRuleNameNonNullableFields;
|
|
1830
|
-
amount?: PriceNonNullableFields;
|
|
1831
|
-
}
|
|
1832
|
-
interface AppliedDiscountNonNullableFields {
|
|
1833
|
-
coupon?: CouponNonNullableFields;
|
|
1834
|
-
merchantDiscount?: MerchantDiscountNonNullableFields;
|
|
1835
|
-
discountRule?: DiscountRuleNonNullableFields;
|
|
1836
|
-
discountType: DiscountType;
|
|
1837
|
-
lineItemIds: string[];
|
|
1838
|
-
}
|
|
1839
|
-
interface ChannelInfoNonNullableFields {
|
|
1840
|
-
type: ChannelType;
|
|
1841
|
-
}
|
|
1842
|
-
interface CustomFieldNonNullableFields {
|
|
1843
|
-
title: string;
|
|
1844
|
-
}
|
|
1845
|
-
interface AdditionalFeeNonNullableFields {
|
|
1846
|
-
name: string;
|
|
1847
|
-
price?: PriceNonNullableFields;
|
|
1848
|
-
taxDetails?: ItemTaxFullDetailsNonNullableFields;
|
|
1849
|
-
priceBeforeTax?: PriceNonNullableFields;
|
|
1850
|
-
priceAfterTax?: PriceNonNullableFields;
|
|
1851
|
-
_id: string;
|
|
1852
|
-
lineItemIds: string[];
|
|
1853
|
-
}
|
|
1854
|
-
export interface SubscriptionContractNonNullableFields {
|
|
1855
|
-
subscriptionSettings?: V1SubscriptionSettingsNonNullableFields;
|
|
1856
|
-
lineItems: OrderLineItemNonNullableFields[];
|
|
1857
|
-
buyerInfo?: BuyerInfoNonNullableFields;
|
|
1858
|
-
weightUnit: WeightUnit;
|
|
1859
|
-
taxIncludedInPrices: boolean;
|
|
1860
|
-
priceSummary?: PriceSummaryNonNullableFields;
|
|
1861
|
-
billingInfo?: AddressWithContactNonNullableFields;
|
|
1862
|
-
shippingInfo?: ShippingInformationNonNullableFields;
|
|
1863
|
-
taxInfo?: OrderTaxInfoNonNullableFields;
|
|
1864
|
-
appliedDiscounts: AppliedDiscountNonNullableFields[];
|
|
1865
|
-
channelInfo?: ChannelInfoNonNullableFields;
|
|
1866
|
-
customFields: CustomFieldNonNullableFields[];
|
|
1867
|
-
recipientInfo?: AddressWithContactNonNullableFields;
|
|
1868
|
-
additionalFees: AdditionalFeeNonNullableFields[];
|
|
1869
|
-
}
|
|
1870
|
-
export interface GetSubscriptionContractResponseNonNullableFields {
|
|
1871
|
-
subscriptionContract?: SubscriptionContractNonNullableFields;
|
|
1872
|
-
}
|
|
1873
|
-
export interface QuerySubscriptionContractsResponseNonNullableFields {
|
|
1874
|
-
subscriptionContracts: SubscriptionContractNonNullableFields[];
|
|
1875
|
-
}
|
|
1876
|
-
export interface BaseEventMetadata {
|
|
1734
|
+
interface BaseEventMetadata {
|
|
1877
1735
|
/**
|
|
1878
1736
|
* App instance ID.
|
|
1879
1737
|
* @format GUID
|
|
@@ -1887,7 +1745,7 @@ export interface BaseEventMetadata {
|
|
|
1887
1745
|
/** The identification type and identity data. */
|
|
1888
1746
|
identity?: IdentificationData;
|
|
1889
1747
|
}
|
|
1890
|
-
|
|
1748
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1891
1749
|
/**
|
|
1892
1750
|
* Unique event ID.
|
|
1893
1751
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1925,116 +1783,17 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1925
1783
|
*/
|
|
1926
1784
|
entityEventSequence?: string | null;
|
|
1927
1785
|
}
|
|
1928
|
-
|
|
1786
|
+
interface SubscriptionContractCreatedEnvelope {
|
|
1929
1787
|
entity: SubscriptionContract;
|
|
1930
1788
|
metadata: EventMetadata;
|
|
1931
1789
|
}
|
|
1932
|
-
|
|
1933
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1934
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1935
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1936
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1937
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1938
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1939
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1940
|
-
* @permissionScope Picasso private app mega scope
|
|
1941
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1942
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1943
|
-
* @webhook
|
|
1944
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
|
|
1945
|
-
* @slug created
|
|
1946
|
-
* @documentationMaturity preview
|
|
1947
|
-
*/
|
|
1948
|
-
export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
|
|
1949
|
-
export interface SubscriptionContractDeletedEnvelope {
|
|
1790
|
+
interface SubscriptionContractDeletedEnvelope {
|
|
1950
1791
|
metadata: EventMetadata;
|
|
1951
1792
|
}
|
|
1952
|
-
|
|
1953
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1954
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1955
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1956
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1957
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1958
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1959
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1960
|
-
* @permissionScope Picasso private app mega scope
|
|
1961
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1962
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1963
|
-
* @webhook
|
|
1964
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
|
|
1965
|
-
* @slug deleted
|
|
1966
|
-
* @documentationMaturity preview
|
|
1967
|
-
*/
|
|
1968
|
-
export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
|
|
1969
|
-
export interface SubscriptionContractUpdatedEnvelope {
|
|
1793
|
+
interface SubscriptionContractUpdatedEnvelope {
|
|
1970
1794
|
entity: SubscriptionContract;
|
|
1971
1795
|
metadata: EventMetadata;
|
|
1972
1796
|
}
|
|
1973
|
-
/** @permissionScope Manage Stores - all permissions
|
|
1974
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1975
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1976
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1977
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1978
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1979
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1980
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1981
|
-
* @permissionScope Picasso private app mega scope
|
|
1982
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1983
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1984
|
-
* @webhook
|
|
1985
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
|
|
1986
|
-
* @slug updated
|
|
1987
|
-
* @documentationMaturity preview
|
|
1988
|
-
*/
|
|
1989
|
-
export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
|
|
1990
|
-
/**
|
|
1991
|
-
* Retrieves a SubscriptionContract.
|
|
1992
|
-
* @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
|
|
1993
|
-
* @public
|
|
1994
|
-
* @documentationMaturity preview
|
|
1995
|
-
* @requiredField subscriptionContractId
|
|
1996
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1997
|
-
* @permissionScope Manage Stores - all permissions
|
|
1998
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1999
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
2000
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
2001
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2002
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2003
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
2004
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2005
|
-
* @permissionScope Picasso private app mega scope
|
|
2006
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
2007
|
-
* @applicableIdentity APP
|
|
2008
|
-
* @returns The requested SubscriptionContract.
|
|
2009
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
2010
|
-
*/
|
|
2011
|
-
export declare function getSubscriptionContract(subscriptionContractId: string): Promise<SubscriptionContract & SubscriptionContractNonNullableFields>;
|
|
2012
|
-
/**
|
|
2013
|
-
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
2014
|
-
*
|
|
2015
|
-
* Up to 300 SubscriptionContracts can be returned per request.
|
|
2016
|
-
*
|
|
2017
|
-
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
2018
|
-
*
|
|
2019
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
2020
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
2021
|
-
* @public
|
|
2022
|
-
* @documentationMaturity preview
|
|
2023
|
-
* @permissionScope Manage Stores - all permissions
|
|
2024
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
2025
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
2026
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
2027
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
2028
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
2029
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
2030
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
2031
|
-
* @permissionScope Picasso private app mega scope
|
|
2032
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
2033
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
2034
|
-
* @applicableIdentity APP
|
|
2035
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
|
|
2036
|
-
*/
|
|
2037
|
-
export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
|
|
2038
1797
|
interface QueryCursorResult {
|
|
2039
1798
|
cursors: Cursors;
|
|
2040
1799
|
hasNext: () => boolean;
|
|
@@ -2042,13 +1801,13 @@ interface QueryCursorResult {
|
|
|
2042
1801
|
length: number;
|
|
2043
1802
|
pageSize: number;
|
|
2044
1803
|
}
|
|
2045
|
-
|
|
1804
|
+
interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
2046
1805
|
items: SubscriptionContract[];
|
|
2047
1806
|
query: SubscriptionContractsQueryBuilder;
|
|
2048
1807
|
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
2049
1808
|
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
2050
1809
|
}
|
|
2051
|
-
|
|
1810
|
+
interface SubscriptionContractsQueryBuilder {
|
|
2052
1811
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2053
1812
|
* @param value - Value to compare against.
|
|
2054
1813
|
* @documentationMaturity preview
|
|
@@ -2092,4 +1851,5 @@ export interface SubscriptionContractsQueryBuilder {
|
|
|
2092
1851
|
/** @documentationMaturity preview */
|
|
2093
1852
|
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
2094
1853
|
}
|
|
2095
|
-
|
|
1854
|
+
|
|
1855
|
+
export { type CurrencyConversionDetails as $, AdjustmentType as A, type SubscriptionInfo as B, ChannelType as C, DescriptionLineType as D, type SubscriptionTitle as E, type FocalPoint as F, type SubscriptionDescription as G, type SubscriptionSettings as H, ItemTypeItemType as I, JurisdictionType as J, type FreeTrialPeriod as K, type LineItemTaxInfo as L, type BillingAdjustment as M, type BillingAdjustmentPriceSummary as N, type OrderLineItem as O, PaymentOptionType as P, type PriceDescription as Q, type LocationAndQuantity as R, type SubscriptionContract as S, TaxableAddressType as T, type TaxableAddress as U, V2SubscriptionFrequency as V, WeightUnit as W, type TaxableAddressTaxableAddressDataOneOf as X, type ExtendedFields as Y, type BuyerInfo as Z, type BuyerInfoIdOneOf as _, type SubscriptionContractsQueryBuilder as a, type PriceSummary as a0, type AddressWithContact as a1, type Address as a2, type StreetAddress as a3, type AddressLocation as a4, type FullAddressContactDetails as a5, type VatId as a6, type ShippingInformation as a7, type DeliveryLogistics as a8, type DeliveryLogisticsAddressOneOf as a9, type QuerySubscriptionContractsRequest as aA, type CursorQuery as aB, type CursorQueryPagingMethodOneOf as aC, type Sorting as aD, type CursorPaging as aE, type QuerySubscriptionContractsResponse as aF, type CursorPagingMetadata as aG, type Cursors as aH, type DomainEvent as aI, type DomainEventBodyOneOf as aJ, type EntityCreatedEvent as aK, type RestoreInfo as aL, type EntityUpdatedEvent as aM, type EntityDeletedEvent as aN, type ActionEvent as aO, type Empty as aP, type MessageEnvelope as aQ, type IdentificationData as aR, type IdentificationDataIdOneOf as aS, type BaseEventMetadata as aT, type EventMetadata as aU, type SubscriptionContractCreatedEnvelope as aV, type SubscriptionContractDeletedEnvelope as aW, type SubscriptionContractUpdatedEnvelope as aX, type SubscriptionContractsQueryResult as aY, type PickupDetails as aa, type PickupAddress as ab, type DeliveryTimeSlot as ac, type ShippingPrice as ad, type ShippingRegion as ae, type OrderTaxInfo as af, type OrderTaxBreakdown as ag, type AppliedDiscount as ah, type AppliedDiscountDiscountSourceOneOf as ai, type Coupon as aj, type MerchantDiscount as ak, type MerchantDiscountMerchantDiscountReasonOneOf as al, type DiscountRule as am, type DiscountRuleName as an, type LineItemDiscount as ao, type ChannelInfo as ap, type CustomField as aq, type V1SubscriptionTitle as ar, type AdditionalFee as as, type Location as at, type CreateSubscriptionContractRequest as au, type CreateSubscriptionContractResponse as av, type GetSubscriptionContractRequest as aw, type GetSubscriptionContractResponse as ax, type UpdateSubscriptionContractRequest as ay, type UpdateSubscriptionContractResponse as az, SubscriptionFrequency as b, VatType as c, PickupMethod as d, DiscountType as e, DiscountReason as f, SortOrder as g, WebhookIdentityType as h, type V1SubscriptionDescription as i, type V1SubscriptionSettings as j, type V1FreeTrialPeriod as k, type ProductName as l, type CatalogReference as m, type Price as n, type DescriptionLine as o, type DescriptionLineValueOneOf as p, type DescriptionLineDescriptionLineValueOneOf as q, type DescriptionLineName as r, type PlainTextValue as s, type Color as t, type PhysicalProperties as u, type ItemType as v, type ItemTypeItemTypeDataOneOf as w, type ItemTaxFullDetails as x, type LineItemTaxBreakdown as y, type DigitalFile as z };
|