@wix/auto_sdk_ecom_subscription-contracts 1.0.20 → 1.0.21
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/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +35 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +198 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +66 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +153 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +161 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
- package/build/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.mts → cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +342 -0
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +16 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +193 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +38 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +132 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +158 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
- package/build/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-C1mp-xS2.d.ts → es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +314 -0
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +35 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +198 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +66 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +153 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +161 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
- package/build/internal/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.mts → cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +342 -0
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +16 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +16 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +1 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +14 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +193 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +1 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +16 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +38 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +1 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +32 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +132 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +1 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts +1668 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +158 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +1 -0
- package/build/internal/{ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-WYe0iZSk.d.ts → es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts} +217 -117
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +314 -0
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -39
- package/build/index.d.ts +0 -39
- package/build/index.js +0 -659
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -615
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -39
- package/build/internal/index.d.ts +0 -39
- package/build/internal/index.js +0 -659
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -615
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -1320
- package/build/internal/meta.d.ts +0 -1320
- package/build/internal/meta.js +0 -257
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -229
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -1320
- package/build/meta.d.ts +0 -1320
- package/build/meta.js +0 -257
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -229
- package/build/meta.mjs.map +0 -1
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/**
|
|
2
3
|
* A SubscriptionContract is a ...
|
|
3
4
|
* You can ...
|
|
4
5
|
* Read more about SubscriptionContracts
|
|
5
6
|
* in this [article](<LINK_TO_KB_ARTICLE>).
|
|
6
7
|
*/
|
|
7
|
-
interface SubscriptionContract {
|
|
8
|
+
export interface SubscriptionContract {
|
|
8
9
|
/**
|
|
9
10
|
* SubscriptionContract ID.
|
|
10
11
|
* @format GUID
|
|
@@ -116,7 +117,7 @@ interface SubscriptionContract {
|
|
|
116
117
|
*/
|
|
117
118
|
additionalFees?: AdditionalFee[];
|
|
118
119
|
}
|
|
119
|
-
interface V1SubscriptionDescription {
|
|
120
|
+
export interface V1SubscriptionDescription {
|
|
120
121
|
/**
|
|
121
122
|
* Subscription option description.
|
|
122
123
|
* @maxLength 500
|
|
@@ -128,7 +129,7 @@ interface V1SubscriptionDescription {
|
|
|
128
129
|
*/
|
|
129
130
|
translated?: string | null;
|
|
130
131
|
}
|
|
131
|
-
interface V1SubscriptionSettings {
|
|
132
|
+
export interface V1SubscriptionSettings {
|
|
132
133
|
/** Frequency of recurring payment. */
|
|
133
134
|
frequency?: SubscriptionFrequency;
|
|
134
135
|
/**
|
|
@@ -147,14 +148,14 @@ interface V1SubscriptionSettings {
|
|
|
147
148
|
/** Whether to allow the customer to cancel the subscription. */
|
|
148
149
|
enableCustomerCancellation?: boolean;
|
|
149
150
|
}
|
|
150
|
-
declare enum SubscriptionFrequency {
|
|
151
|
+
export declare enum SubscriptionFrequency {
|
|
151
152
|
UNDEFINED = "UNDEFINED",
|
|
152
153
|
DAY = "DAY",
|
|
153
154
|
WEEK = "WEEK",
|
|
154
155
|
MONTH = "MONTH",
|
|
155
156
|
YEAR = "YEAR"
|
|
156
157
|
}
|
|
157
|
-
interface V1FreeTrialPeriod {
|
|
158
|
+
export interface V1FreeTrialPeriod {
|
|
158
159
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
159
160
|
frequency?: SubscriptionFrequency;
|
|
160
161
|
/**
|
|
@@ -164,7 +165,7 @@ interface V1FreeTrialPeriod {
|
|
|
164
165
|
*/
|
|
165
166
|
interval?: number;
|
|
166
167
|
}
|
|
167
|
-
interface OrderLineItem {
|
|
168
|
+
export interface OrderLineItem {
|
|
168
169
|
/**
|
|
169
170
|
* Line item ID.
|
|
170
171
|
* @immutable
|
|
@@ -281,7 +282,7 @@ interface OrderLineItem {
|
|
|
281
282
|
*/
|
|
282
283
|
extendedFields?: ExtendedFields;
|
|
283
284
|
}
|
|
284
|
-
interface ProductName {
|
|
285
|
+
export interface ProductName {
|
|
285
286
|
/**
|
|
286
287
|
* __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
288
|
*
|
|
@@ -303,7 +304,7 @@ interface ProductName {
|
|
|
303
304
|
translated?: string | null;
|
|
304
305
|
}
|
|
305
306
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
306
|
-
interface CatalogReference {
|
|
307
|
+
export interface CatalogReference {
|
|
307
308
|
/**
|
|
308
309
|
* ID of the item within the catalog it belongs to.
|
|
309
310
|
* @minLength 1
|
|
@@ -329,7 +330,7 @@ interface CatalogReference {
|
|
|
329
330
|
*/
|
|
330
331
|
options?: Record<string, any> | null;
|
|
331
332
|
}
|
|
332
|
-
interface Price {
|
|
333
|
+
export interface Price {
|
|
333
334
|
/**
|
|
334
335
|
* Amount.
|
|
335
336
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -341,7 +342,7 @@ interface Price {
|
|
|
341
342
|
*/
|
|
342
343
|
formattedAmount?: string;
|
|
343
344
|
}
|
|
344
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
345
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
345
346
|
/** Description line plain text value. */
|
|
346
347
|
plainText?: PlainTextValue;
|
|
347
348
|
/** Description line color value. */
|
|
@@ -350,16 +351,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
350
351
|
name?: DescriptionLineName;
|
|
351
352
|
}
|
|
352
353
|
/** @oneof */
|
|
353
|
-
interface DescriptionLineValueOneOf {
|
|
354
|
+
export interface DescriptionLineValueOneOf {
|
|
354
355
|
/** Description line plain text value. */
|
|
355
356
|
plainText?: PlainTextValue;
|
|
356
357
|
/** Description line color value. */
|
|
357
358
|
colorInfo?: Color;
|
|
358
359
|
}
|
|
359
360
|
/** @oneof */
|
|
360
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
361
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
361
362
|
}
|
|
362
|
-
interface DescriptionLineName {
|
|
363
|
+
export interface DescriptionLineName {
|
|
363
364
|
/**
|
|
364
365
|
* 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
366
|
* @maxLength 100
|
|
@@ -373,7 +374,7 @@ interface DescriptionLineName {
|
|
|
373
374
|
*/
|
|
374
375
|
translated?: string | null;
|
|
375
376
|
}
|
|
376
|
-
interface PlainTextValue {
|
|
377
|
+
export interface PlainTextValue {
|
|
377
378
|
/**
|
|
378
379
|
* 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
380
|
* @maxLength 600
|
|
@@ -387,7 +388,7 @@ interface PlainTextValue {
|
|
|
387
388
|
*/
|
|
388
389
|
translated?: string | null;
|
|
389
390
|
}
|
|
390
|
-
interface Color {
|
|
391
|
+
export interface Color {
|
|
391
392
|
/**
|
|
392
393
|
* 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
394
|
* @maxLength 500
|
|
@@ -403,7 +404,7 @@ interface Color {
|
|
|
403
404
|
/** HEX or RGB color code for display. */
|
|
404
405
|
code?: string | null;
|
|
405
406
|
}
|
|
406
|
-
declare enum DescriptionLineType {
|
|
407
|
+
export declare enum DescriptionLineType {
|
|
407
408
|
/** Unrecognized type. */
|
|
408
409
|
UNRECOGNISED = "UNRECOGNISED",
|
|
409
410
|
/** Plain text type. */
|
|
@@ -411,7 +412,7 @@ declare enum DescriptionLineType {
|
|
|
411
412
|
/** Color type. */
|
|
412
413
|
COLOR = "COLOR"
|
|
413
414
|
}
|
|
414
|
-
interface FocalPoint {
|
|
415
|
+
export interface FocalPoint {
|
|
415
416
|
/** X-coordinate of the focal point. */
|
|
416
417
|
x?: number;
|
|
417
418
|
/** Y-coordinate of the focal point. */
|
|
@@ -421,7 +422,7 @@ interface FocalPoint {
|
|
|
421
422
|
/** crop by width */
|
|
422
423
|
width?: number | null;
|
|
423
424
|
}
|
|
424
|
-
interface PhysicalProperties {
|
|
425
|
+
export interface PhysicalProperties {
|
|
425
426
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
426
427
|
weight?: number | null;
|
|
427
428
|
/**
|
|
@@ -432,20 +433,20 @@ interface PhysicalProperties {
|
|
|
432
433
|
/** Whether this line item is shippable. */
|
|
433
434
|
shippable?: boolean;
|
|
434
435
|
}
|
|
435
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
436
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
436
437
|
/** Preset item type. */
|
|
437
438
|
preset?: ItemTypeItemType;
|
|
438
439
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
439
440
|
custom?: string;
|
|
440
441
|
}
|
|
441
442
|
/** @oneof */
|
|
442
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
443
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
443
444
|
/** Preset item type. */
|
|
444
445
|
preset?: ItemTypeItemType;
|
|
445
446
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
446
447
|
custom?: string;
|
|
447
448
|
}
|
|
448
|
-
declare enum ItemTypeItemType {
|
|
449
|
+
export declare enum ItemTypeItemType {
|
|
449
450
|
UNRECOGNISED = "UNRECOGNISED",
|
|
450
451
|
PHYSICAL = "PHYSICAL",
|
|
451
452
|
DIGITAL = "DIGITAL",
|
|
@@ -453,7 +454,7 @@ declare enum ItemTypeItemType {
|
|
|
453
454
|
SERVICE = "SERVICE"
|
|
454
455
|
}
|
|
455
456
|
/** Type of selected payment option for catalog item */
|
|
456
|
-
declare enum PaymentOptionType {
|
|
457
|
+
export declare enum PaymentOptionType {
|
|
457
458
|
/** The entire payment for this item happens as part of the checkout. */
|
|
458
459
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
459
460
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -465,7 +466,7 @@ declare enum PaymentOptionType {
|
|
|
465
466
|
/** 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
467
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
467
468
|
}
|
|
468
|
-
interface ItemTaxFullDetails {
|
|
469
|
+
export interface ItemTaxFullDetails {
|
|
469
470
|
/** Taxable amount of this line item. */
|
|
470
471
|
taxableAmount?: Price;
|
|
471
472
|
/**
|
|
@@ -476,7 +477,7 @@ interface ItemTaxFullDetails {
|
|
|
476
477
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
477
478
|
totalTax?: Price;
|
|
478
479
|
}
|
|
479
|
-
interface LineItemTaxInfo {
|
|
480
|
+
export interface LineItemTaxInfo {
|
|
480
481
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
481
482
|
taxAmount?: Price;
|
|
482
483
|
/** Amount for which tax is calculated. */
|
|
@@ -504,7 +505,7 @@ interface LineItemTaxInfo {
|
|
|
504
505
|
* TaxBreakdown represents tax information for a line item.
|
|
505
506
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
506
507
|
*/
|
|
507
|
-
interface LineItemTaxBreakdown {
|
|
508
|
+
export interface LineItemTaxBreakdown {
|
|
508
509
|
/**
|
|
509
510
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
510
511
|
* @maxLength 200
|
|
@@ -537,7 +538,7 @@ interface LineItemTaxBreakdown {
|
|
|
537
538
|
taxableAmount?: Price;
|
|
538
539
|
}
|
|
539
540
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
540
|
-
declare enum JurisdictionType {
|
|
541
|
+
export declare enum JurisdictionType {
|
|
541
542
|
UNDEFINED = "UNDEFINED",
|
|
542
543
|
COUNTRY = "COUNTRY",
|
|
543
544
|
STATE = "STATE",
|
|
@@ -545,7 +546,7 @@ declare enum JurisdictionType {
|
|
|
545
546
|
CITY = "CITY",
|
|
546
547
|
SPECIAL = "SPECIAL"
|
|
547
548
|
}
|
|
548
|
-
interface DigitalFile {
|
|
549
|
+
export interface DigitalFile {
|
|
549
550
|
/**
|
|
550
551
|
* ID of the secure file in media.
|
|
551
552
|
* @minLength 1
|
|
@@ -565,7 +566,7 @@ interface DigitalFile {
|
|
|
565
566
|
*/
|
|
566
567
|
expirationDate?: Date | null;
|
|
567
568
|
}
|
|
568
|
-
interface SubscriptionInfo {
|
|
569
|
+
export interface SubscriptionInfo {
|
|
569
570
|
/**
|
|
570
571
|
* Subscription ID.
|
|
571
572
|
* @format GUID
|
|
@@ -598,7 +599,7 @@ interface SubscriptionInfo {
|
|
|
598
599
|
*/
|
|
599
600
|
subscriptionSettings?: SubscriptionSettings;
|
|
600
601
|
}
|
|
601
|
-
interface SubscriptionTitle {
|
|
602
|
+
export interface SubscriptionTitle {
|
|
602
603
|
/**
|
|
603
604
|
* 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
605
|
* @minLength 1
|
|
@@ -614,7 +615,7 @@ interface SubscriptionTitle {
|
|
|
614
615
|
*/
|
|
615
616
|
translated?: string | null;
|
|
616
617
|
}
|
|
617
|
-
interface SubscriptionDescription {
|
|
618
|
+
export interface SubscriptionDescription {
|
|
618
619
|
/**
|
|
619
620
|
* Subscription option description.
|
|
620
621
|
* @maxLength 500
|
|
@@ -626,7 +627,7 @@ interface SubscriptionDescription {
|
|
|
626
627
|
*/
|
|
627
628
|
translated?: string | null;
|
|
628
629
|
}
|
|
629
|
-
interface SubscriptionSettings {
|
|
630
|
+
export interface SubscriptionSettings {
|
|
630
631
|
/** Frequency of recurring payment. */
|
|
631
632
|
frequency?: V2SubscriptionFrequency;
|
|
632
633
|
/**
|
|
@@ -644,14 +645,14 @@ interface SubscriptionSettings {
|
|
|
644
645
|
billingCycles?: number | null;
|
|
645
646
|
}
|
|
646
647
|
/** Frequency unit of recurring payment */
|
|
647
|
-
declare enum V2SubscriptionFrequency {
|
|
648
|
+
export declare enum V2SubscriptionFrequency {
|
|
648
649
|
UNDEFINED = "UNDEFINED",
|
|
649
650
|
DAY = "DAY",
|
|
650
651
|
WEEK = "WEEK",
|
|
651
652
|
MONTH = "MONTH",
|
|
652
653
|
YEAR = "YEAR"
|
|
653
654
|
}
|
|
654
|
-
interface FreeTrialPeriod {
|
|
655
|
+
export interface FreeTrialPeriod {
|
|
655
656
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
656
657
|
frequency?: V2SubscriptionFrequency;
|
|
657
658
|
/**
|
|
@@ -661,20 +662,20 @@ interface FreeTrialPeriod {
|
|
|
661
662
|
*/
|
|
662
663
|
interval?: number;
|
|
663
664
|
}
|
|
664
|
-
interface BillingAdjustment {
|
|
665
|
+
export interface BillingAdjustment {
|
|
665
666
|
/** The type of adjustment. */
|
|
666
667
|
type?: AdjustmentType;
|
|
667
668
|
/** Summary of the prorated adjustment amount. */
|
|
668
669
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
669
670
|
}
|
|
670
|
-
declare enum AdjustmentType {
|
|
671
|
+
export declare enum AdjustmentType {
|
|
671
672
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
672
673
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
673
674
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
674
675
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
675
676
|
CREDIT = "CREDIT"
|
|
676
677
|
}
|
|
677
|
-
interface BillingAdjustmentPriceSummary {
|
|
678
|
+
export interface BillingAdjustmentPriceSummary {
|
|
678
679
|
/** Subtotal of adjustment, before tax. */
|
|
679
680
|
subtotal?: Price;
|
|
680
681
|
/** Tax on adjustment. */
|
|
@@ -682,7 +683,7 @@ interface BillingAdjustmentPriceSummary {
|
|
|
682
683
|
/** Total price after tax. */
|
|
683
684
|
total?: Price;
|
|
684
685
|
}
|
|
685
|
-
interface PriceDescription {
|
|
686
|
+
export interface PriceDescription {
|
|
686
687
|
/**
|
|
687
688
|
* __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
689
|
* @minLength 1
|
|
@@ -698,7 +699,7 @@ interface PriceDescription {
|
|
|
698
699
|
*/
|
|
699
700
|
translated?: string | null;
|
|
700
701
|
}
|
|
701
|
-
interface LocationAndQuantity {
|
|
702
|
+
export interface LocationAndQuantity {
|
|
702
703
|
/**
|
|
703
704
|
* Location id in the associated owner app.
|
|
704
705
|
* @format GUID
|
|
@@ -724,22 +725,22 @@ interface LocationAndQuantity {
|
|
|
724
725
|
*/
|
|
725
726
|
name?: string | null;
|
|
726
727
|
}
|
|
727
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
728
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
728
729
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
729
730
|
addressType?: TaxableAddressType;
|
|
730
731
|
}
|
|
731
732
|
/** @oneof */
|
|
732
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
733
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
733
734
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
734
735
|
addressType?: TaxableAddressType;
|
|
735
736
|
}
|
|
736
|
-
declare enum TaxableAddressType {
|
|
737
|
+
export declare enum TaxableAddressType {
|
|
737
738
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
738
739
|
BUSINESS = "BUSINESS",
|
|
739
740
|
BILLING = "BILLING",
|
|
740
741
|
SHIPPING = "SHIPPING"
|
|
741
742
|
}
|
|
742
|
-
interface ExtendedFields {
|
|
743
|
+
export interface ExtendedFields {
|
|
743
744
|
/**
|
|
744
745
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
745
746
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -751,7 +752,7 @@ interface ExtendedFields {
|
|
|
751
752
|
namespaces?: Record<string, Record<string, any>>;
|
|
752
753
|
}
|
|
753
754
|
/** Buyer Info */
|
|
754
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
755
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
755
756
|
/**
|
|
756
757
|
* Visitor ID (if site visitor is not a member).
|
|
757
758
|
* @format GUID
|
|
@@ -774,7 +775,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
774
775
|
email?: string | null;
|
|
775
776
|
}
|
|
776
777
|
/** @oneof */
|
|
777
|
-
interface BuyerInfoIdOneOf {
|
|
778
|
+
export interface BuyerInfoIdOneOf {
|
|
778
779
|
/**
|
|
779
780
|
* Visitor ID (if site visitor is not a member).
|
|
780
781
|
* @format GUID
|
|
@@ -786,7 +787,7 @@ interface BuyerInfoIdOneOf {
|
|
|
786
787
|
*/
|
|
787
788
|
memberId?: string;
|
|
788
789
|
}
|
|
789
|
-
declare enum WeightUnit {
|
|
790
|
+
export declare enum WeightUnit {
|
|
790
791
|
/** Weight unit can't be classified due to an error. */
|
|
791
792
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
792
793
|
/** Kilograms. */
|
|
@@ -794,7 +795,7 @@ declare enum WeightUnit {
|
|
|
794
795
|
/** Pounds. */
|
|
795
796
|
LB = "LB"
|
|
796
797
|
}
|
|
797
|
-
interface CurrencyConversionDetails {
|
|
798
|
+
export interface CurrencyConversionDetails {
|
|
798
799
|
/**
|
|
799
800
|
* 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
801
|
* @readonly
|
|
@@ -810,7 +811,7 @@ interface CurrencyConversionDetails {
|
|
|
810
811
|
*/
|
|
811
812
|
conversionRate?: string | null;
|
|
812
813
|
}
|
|
813
|
-
interface PriceSummary {
|
|
814
|
+
export interface PriceSummary {
|
|
814
815
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
815
816
|
subtotal?: Price;
|
|
816
817
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -825,14 +826,14 @@ interface PriceSummary {
|
|
|
825
826
|
totalAdditionalFees?: Price;
|
|
826
827
|
}
|
|
827
828
|
/** Billing Info and shipping details */
|
|
828
|
-
interface AddressWithContact {
|
|
829
|
+
export interface AddressWithContact {
|
|
829
830
|
/** Address. */
|
|
830
831
|
address?: Address;
|
|
831
832
|
/** Contact details. */
|
|
832
833
|
contactDetails?: FullAddressContactDetails;
|
|
833
834
|
}
|
|
834
835
|
/** Physical address */
|
|
835
|
-
interface Address {
|
|
836
|
+
export interface Address {
|
|
836
837
|
/**
|
|
837
838
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
838
839
|
* @format COUNTRY
|
|
@@ -876,20 +877,20 @@ interface Address {
|
|
|
876
877
|
*/
|
|
877
878
|
subdivisionFullname?: string | null;
|
|
878
879
|
}
|
|
879
|
-
interface StreetAddress {
|
|
880
|
+
export interface StreetAddress {
|
|
880
881
|
/** Street number. */
|
|
881
882
|
number?: string;
|
|
882
883
|
/** Street name. */
|
|
883
884
|
name?: string;
|
|
884
885
|
}
|
|
885
|
-
interface AddressLocation {
|
|
886
|
+
export interface AddressLocation {
|
|
886
887
|
/** Address latitude. */
|
|
887
888
|
latitude?: number | null;
|
|
888
889
|
/** Address longitude. */
|
|
889
890
|
longitude?: number | null;
|
|
890
891
|
}
|
|
891
892
|
/** Full contact details for an address */
|
|
892
|
-
interface FullAddressContactDetails {
|
|
893
|
+
export interface FullAddressContactDetails {
|
|
893
894
|
/**
|
|
894
895
|
* First name.
|
|
895
896
|
* @maxLength 100
|
|
@@ -913,7 +914,7 @@ interface FullAddressContactDetails {
|
|
|
913
914
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
914
915
|
vatId?: VatId;
|
|
915
916
|
}
|
|
916
|
-
interface VatId {
|
|
917
|
+
export interface VatId {
|
|
917
918
|
/** Customer's tax ID. */
|
|
918
919
|
_id?: string;
|
|
919
920
|
/**
|
|
@@ -926,14 +927,14 @@ interface VatId {
|
|
|
926
927
|
type?: VatType;
|
|
927
928
|
}
|
|
928
929
|
/** tax info types */
|
|
929
|
-
declare enum VatType {
|
|
930
|
+
export declare enum VatType {
|
|
930
931
|
UNSPECIFIED = "UNSPECIFIED",
|
|
931
932
|
/** CPF - for individual tax payers. */
|
|
932
933
|
CPF = "CPF",
|
|
933
934
|
/** CNPJ - for corporations */
|
|
934
935
|
CNPJ = "CNPJ"
|
|
935
936
|
}
|
|
936
|
-
interface ShippingInformation {
|
|
937
|
+
export interface ShippingInformation {
|
|
937
938
|
/**
|
|
938
939
|
* App Def Id of external provider which was a source of shipping info
|
|
939
940
|
* @minLength 1
|
|
@@ -959,7 +960,7 @@ interface ShippingInformation {
|
|
|
959
960
|
/** Shipping region. */
|
|
960
961
|
region?: ShippingRegion;
|
|
961
962
|
}
|
|
962
|
-
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
963
|
+
export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
963
964
|
/** Shipping address and contact details. */
|
|
964
965
|
shippingDestination?: AddressWithContact;
|
|
965
966
|
/** Pickup details. */
|
|
@@ -983,20 +984,20 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
983
984
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
984
985
|
}
|
|
985
986
|
/** @oneof */
|
|
986
|
-
interface DeliveryLogisticsAddressOneOf {
|
|
987
|
+
export interface DeliveryLogisticsAddressOneOf {
|
|
987
988
|
/** Shipping address and contact details. */
|
|
988
989
|
shippingDestination?: AddressWithContact;
|
|
989
990
|
/** Pickup details. */
|
|
990
991
|
pickupDetails?: PickupDetails;
|
|
991
992
|
}
|
|
992
|
-
interface PickupDetails {
|
|
993
|
+
export interface PickupDetails {
|
|
993
994
|
/** Pickup address. */
|
|
994
995
|
address?: PickupAddress;
|
|
995
996
|
/** Pickup method */
|
|
996
997
|
pickupMethod?: PickupMethod;
|
|
997
998
|
}
|
|
998
999
|
/** Physical address */
|
|
999
|
-
interface PickupAddress {
|
|
1000
|
+
export interface PickupAddress {
|
|
1000
1001
|
/**
|
|
1001
1002
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1002
1003
|
* @format COUNTRY
|
|
@@ -1040,18 +1041,18 @@ interface PickupAddress {
|
|
|
1040
1041
|
*/
|
|
1041
1042
|
subdivisionFullname?: string | null;
|
|
1042
1043
|
}
|
|
1043
|
-
declare enum PickupMethod {
|
|
1044
|
+
export declare enum PickupMethod {
|
|
1044
1045
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1045
1046
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1046
1047
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1047
1048
|
}
|
|
1048
|
-
interface DeliveryTimeSlot {
|
|
1049
|
+
export interface DeliveryTimeSlot {
|
|
1049
1050
|
/** Delivery slot starting time. */
|
|
1050
1051
|
from?: Date | null;
|
|
1051
1052
|
/** Delivery slot ending time. */
|
|
1052
1053
|
to?: Date | null;
|
|
1053
1054
|
}
|
|
1054
|
-
interface ShippingPrice {
|
|
1055
|
+
export interface ShippingPrice {
|
|
1055
1056
|
/** Shipping price for display purposes. */
|
|
1056
1057
|
price?: Price;
|
|
1057
1058
|
/**
|
|
@@ -1072,14 +1073,14 @@ interface ShippingPrice {
|
|
|
1072
1073
|
*/
|
|
1073
1074
|
discount?: Price;
|
|
1074
1075
|
}
|
|
1075
|
-
interface ShippingRegion {
|
|
1076
|
+
export interface ShippingRegion {
|
|
1076
1077
|
/**
|
|
1077
1078
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1078
1079
|
* @maxLength 100
|
|
1079
1080
|
*/
|
|
1080
1081
|
name?: string | null;
|
|
1081
1082
|
}
|
|
1082
|
-
interface OrderTaxInfo {
|
|
1083
|
+
export interface OrderTaxInfo {
|
|
1083
1084
|
/** Calculated tax, added from line items. */
|
|
1084
1085
|
totalTax?: Price;
|
|
1085
1086
|
/**
|
|
@@ -1099,7 +1100,7 @@ interface OrderTaxInfo {
|
|
|
1099
1100
|
* 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
1101
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1101
1102
|
*/
|
|
1102
|
-
interface OrderTaxBreakdown {
|
|
1103
|
+
export interface OrderTaxBreakdown {
|
|
1103
1104
|
/**
|
|
1104
1105
|
* The name of the tax against which this tax amount was calculated.
|
|
1105
1106
|
* @maxLength 200
|
|
@@ -1126,7 +1127,7 @@ interface OrderTaxBreakdown {
|
|
|
1126
1127
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1127
1128
|
aggregatedTaxAmount?: Price;
|
|
1128
1129
|
}
|
|
1129
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1130
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1130
1131
|
/** Applied coupon info. */
|
|
1131
1132
|
coupon?: Coupon;
|
|
1132
1133
|
/** Merchant discount. */
|
|
@@ -1159,7 +1160,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1159
1160
|
_id?: string | null;
|
|
1160
1161
|
}
|
|
1161
1162
|
/** @oneof */
|
|
1162
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1163
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1163
1164
|
/** Applied coupon info. */
|
|
1164
1165
|
coupon?: Coupon;
|
|
1165
1166
|
/** Merchant discount. */
|
|
@@ -1167,13 +1168,13 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1167
1168
|
/** Automatic Discount */
|
|
1168
1169
|
discountRule?: DiscountRule;
|
|
1169
1170
|
}
|
|
1170
|
-
declare enum DiscountType {
|
|
1171
|
+
export declare enum DiscountType {
|
|
1171
1172
|
GLOBAL = "GLOBAL",
|
|
1172
1173
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1173
1174
|
SHIPPING = "SHIPPING"
|
|
1174
1175
|
}
|
|
1175
1176
|
/** Coupon */
|
|
1176
|
-
interface Coupon {
|
|
1177
|
+
export interface Coupon {
|
|
1177
1178
|
/** Coupon ID. */
|
|
1178
1179
|
_id?: string;
|
|
1179
1180
|
/** Coupon code. */
|
|
@@ -1183,7 +1184,7 @@ interface Coupon {
|
|
|
1183
1184
|
/** Coupon value. */
|
|
1184
1185
|
amount?: Price;
|
|
1185
1186
|
}
|
|
1186
|
-
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1187
|
+
export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1187
1188
|
/**
|
|
1188
1189
|
* Pre-defined discount reason (optional).
|
|
1189
1190
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1198,7 +1199,7 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1198
1199
|
amount?: Price;
|
|
1199
1200
|
}
|
|
1200
1201
|
/** @oneof */
|
|
1201
|
-
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1202
|
+
export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1202
1203
|
/**
|
|
1203
1204
|
* Pre-defined discount reason (optional).
|
|
1204
1205
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1210,12 +1211,12 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1210
1211
|
*/
|
|
1211
1212
|
description?: string | null;
|
|
1212
1213
|
}
|
|
1213
|
-
declare enum DiscountReason {
|
|
1214
|
+
export declare enum DiscountReason {
|
|
1214
1215
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1215
1216
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1216
1217
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1217
1218
|
}
|
|
1218
|
-
interface DiscountRule {
|
|
1219
|
+
export interface DiscountRule {
|
|
1219
1220
|
/**
|
|
1220
1221
|
* Discount rule ID
|
|
1221
1222
|
* @format GUID
|
|
@@ -1226,7 +1227,7 @@ interface DiscountRule {
|
|
|
1226
1227
|
/** Discount value. */
|
|
1227
1228
|
amount?: Price;
|
|
1228
1229
|
}
|
|
1229
|
-
interface DiscountRuleName {
|
|
1230
|
+
export interface DiscountRuleName {
|
|
1230
1231
|
/**
|
|
1231
1232
|
* Original discount rule name (in site's default language).
|
|
1232
1233
|
* @minLength 1
|
|
@@ -1240,7 +1241,7 @@ interface DiscountRuleName {
|
|
|
1240
1241
|
*/
|
|
1241
1242
|
translated?: string | null;
|
|
1242
1243
|
}
|
|
1243
|
-
interface LineItemDiscount {
|
|
1244
|
+
export interface LineItemDiscount {
|
|
1244
1245
|
/**
|
|
1245
1246
|
* ID of line item the discount applies to.
|
|
1246
1247
|
* @format GUID
|
|
@@ -1249,7 +1250,7 @@ interface LineItemDiscount {
|
|
|
1249
1250
|
/** Total discount for this line item. */
|
|
1250
1251
|
totalDiscount?: Price;
|
|
1251
1252
|
}
|
|
1252
|
-
interface ChannelInfo {
|
|
1253
|
+
export interface ChannelInfo {
|
|
1253
1254
|
/** Sales channel that submitted the order. */
|
|
1254
1255
|
type?: ChannelType;
|
|
1255
1256
|
/**
|
|
@@ -1263,7 +1264,7 @@ interface ChannelInfo {
|
|
|
1263
1264
|
*/
|
|
1264
1265
|
externalOrderUrl?: string | null;
|
|
1265
1266
|
}
|
|
1266
|
-
declare enum ChannelType {
|
|
1267
|
+
export declare enum ChannelType {
|
|
1267
1268
|
/** Unspecified sales channel. This value is not supported. */
|
|
1268
1269
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1269
1270
|
/** A web client. */
|
|
@@ -1297,7 +1298,7 @@ declare enum ChannelType {
|
|
|
1297
1298
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1298
1299
|
FAIRE_COM = "FAIRE_COM"
|
|
1299
1300
|
}
|
|
1300
|
-
interface CustomField {
|
|
1301
|
+
export interface CustomField {
|
|
1301
1302
|
/** Custom field value. */
|
|
1302
1303
|
value?: any;
|
|
1303
1304
|
/**
|
|
@@ -1313,7 +1314,7 @@ interface CustomField {
|
|
|
1313
1314
|
*/
|
|
1314
1315
|
translatedTitle?: string | null;
|
|
1315
1316
|
}
|
|
1316
|
-
interface V1SubscriptionTitle {
|
|
1317
|
+
export interface V1SubscriptionTitle {
|
|
1317
1318
|
/**
|
|
1318
1319
|
* 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
1320
|
* @minLength 1
|
|
@@ -1329,7 +1330,7 @@ interface V1SubscriptionTitle {
|
|
|
1329
1330
|
*/
|
|
1330
1331
|
translated?: string | null;
|
|
1331
1332
|
}
|
|
1332
|
-
interface AdditionalFee {
|
|
1333
|
+
export interface AdditionalFee {
|
|
1333
1334
|
/**
|
|
1334
1335
|
* Additional fee's unique code for future processing.
|
|
1335
1336
|
* @minLength 1
|
|
@@ -1368,7 +1369,7 @@ interface AdditionalFee {
|
|
|
1368
1369
|
*/
|
|
1369
1370
|
lineItemIds?: string[];
|
|
1370
1371
|
}
|
|
1371
|
-
interface Location {
|
|
1372
|
+
export interface Location {
|
|
1372
1373
|
/**
|
|
1373
1374
|
* Location ID.
|
|
1374
1375
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -1383,38 +1384,38 @@ interface Location {
|
|
|
1383
1384
|
*/
|
|
1384
1385
|
name?: string;
|
|
1385
1386
|
}
|
|
1386
|
-
interface CreateSubscriptionContractRequest {
|
|
1387
|
+
export interface CreateSubscriptionContractRequest {
|
|
1387
1388
|
/** SubscriptionContract to be created. */
|
|
1388
1389
|
subscriptionContract?: SubscriptionContract;
|
|
1389
1390
|
}
|
|
1390
|
-
interface CreateSubscriptionContractResponse {
|
|
1391
|
+
export interface CreateSubscriptionContractResponse {
|
|
1391
1392
|
/** The created SubscriptionContract. */
|
|
1392
1393
|
subscriptionContract?: SubscriptionContract;
|
|
1393
1394
|
}
|
|
1394
|
-
interface GetSubscriptionContractRequest {
|
|
1395
|
+
export interface GetSubscriptionContractRequest {
|
|
1395
1396
|
/**
|
|
1396
1397
|
* ID of the SubscriptionContract to retrieve.
|
|
1397
1398
|
* @format GUID
|
|
1398
1399
|
*/
|
|
1399
1400
|
subscriptionContractId: string;
|
|
1400
1401
|
}
|
|
1401
|
-
interface GetSubscriptionContractResponse {
|
|
1402
|
+
export interface GetSubscriptionContractResponse {
|
|
1402
1403
|
/** The requested SubscriptionContract. */
|
|
1403
1404
|
subscriptionContract?: SubscriptionContract;
|
|
1404
1405
|
}
|
|
1405
|
-
interface UpdateSubscriptionContractRequest {
|
|
1406
|
+
export interface UpdateSubscriptionContractRequest {
|
|
1406
1407
|
/** SubscriptionContract to be updated, may be partial. */
|
|
1407
1408
|
subscriptionContract?: SubscriptionContract;
|
|
1408
1409
|
}
|
|
1409
|
-
interface UpdateSubscriptionContractResponse {
|
|
1410
|
+
export interface UpdateSubscriptionContractResponse {
|
|
1410
1411
|
/** Updated SubscriptionContract. */
|
|
1411
1412
|
subscriptionContract?: SubscriptionContract;
|
|
1412
1413
|
}
|
|
1413
|
-
interface QuerySubscriptionContractsRequest {
|
|
1414
|
+
export interface QuerySubscriptionContractsRequest {
|
|
1414
1415
|
/** WQL expression. */
|
|
1415
1416
|
query?: CursorQuery;
|
|
1416
1417
|
}
|
|
1417
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1418
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1418
1419
|
/** 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
1420
|
cursorPaging?: CursorPaging;
|
|
1420
1421
|
/**
|
|
@@ -1436,11 +1437,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1436
1437
|
sort?: Sorting[];
|
|
1437
1438
|
}
|
|
1438
1439
|
/** @oneof */
|
|
1439
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1440
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1440
1441
|
/** 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
1442
|
cursorPaging?: CursorPaging;
|
|
1442
1443
|
}
|
|
1443
|
-
interface Sorting {
|
|
1444
|
+
export interface Sorting {
|
|
1444
1445
|
/**
|
|
1445
1446
|
* Name of the field to sort by.
|
|
1446
1447
|
* @maxLength 512
|
|
@@ -1449,11 +1450,11 @@ interface Sorting {
|
|
|
1449
1450
|
/** Sort order. */
|
|
1450
1451
|
order?: SortOrder;
|
|
1451
1452
|
}
|
|
1452
|
-
declare enum SortOrder {
|
|
1453
|
+
export declare enum SortOrder {
|
|
1453
1454
|
ASC = "ASC",
|
|
1454
1455
|
DESC = "DESC"
|
|
1455
1456
|
}
|
|
1456
|
-
interface CursorPaging {
|
|
1457
|
+
export interface CursorPaging {
|
|
1457
1458
|
/**
|
|
1458
1459
|
* Maximum number of items to return in the results.
|
|
1459
1460
|
* @max 100
|
|
@@ -1468,13 +1469,13 @@ interface CursorPaging {
|
|
|
1468
1469
|
*/
|
|
1469
1470
|
cursor?: string | null;
|
|
1470
1471
|
}
|
|
1471
|
-
interface QuerySubscriptionContractsResponse {
|
|
1472
|
+
export interface QuerySubscriptionContractsResponse {
|
|
1472
1473
|
/** List of SubscriptionContracts. */
|
|
1473
1474
|
subscriptionContracts?: SubscriptionContract[];
|
|
1474
1475
|
/** Paging metadata */
|
|
1475
1476
|
pagingMetadata?: CursorPagingMetadata;
|
|
1476
1477
|
}
|
|
1477
|
-
interface CursorPagingMetadata {
|
|
1478
|
+
export interface CursorPagingMetadata {
|
|
1478
1479
|
/** Number of items returned in the response. */
|
|
1479
1480
|
count?: number | null;
|
|
1480
1481
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1487,7 +1488,7 @@ interface CursorPagingMetadata {
|
|
|
1487
1488
|
*/
|
|
1488
1489
|
hasNext?: boolean | null;
|
|
1489
1490
|
}
|
|
1490
|
-
interface Cursors {
|
|
1491
|
+
export interface Cursors {
|
|
1491
1492
|
/**
|
|
1492
1493
|
* Cursor string pointing to the next page in the list of results.
|
|
1493
1494
|
* @maxLength 16000
|
|
@@ -1499,7 +1500,7 @@ interface Cursors {
|
|
|
1499
1500
|
*/
|
|
1500
1501
|
prev?: string | null;
|
|
1501
1502
|
}
|
|
1502
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1503
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1503
1504
|
createdEvent?: EntityCreatedEvent;
|
|
1504
1505
|
updatedEvent?: EntityUpdatedEvent;
|
|
1505
1506
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1542,19 +1543,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1542
1543
|
entityEventSequence?: string | null;
|
|
1543
1544
|
}
|
|
1544
1545
|
/** @oneof */
|
|
1545
|
-
interface DomainEventBodyOneOf {
|
|
1546
|
+
export interface DomainEventBodyOneOf {
|
|
1546
1547
|
createdEvent?: EntityCreatedEvent;
|
|
1547
1548
|
updatedEvent?: EntityUpdatedEvent;
|
|
1548
1549
|
deletedEvent?: EntityDeletedEvent;
|
|
1549
1550
|
actionEvent?: ActionEvent;
|
|
1550
1551
|
}
|
|
1551
|
-
interface EntityCreatedEvent {
|
|
1552
|
+
export interface EntityCreatedEvent {
|
|
1552
1553
|
entity?: string;
|
|
1553
1554
|
}
|
|
1554
|
-
interface RestoreInfo {
|
|
1555
|
+
export interface RestoreInfo {
|
|
1555
1556
|
deletedDate?: Date | null;
|
|
1556
1557
|
}
|
|
1557
|
-
interface EntityUpdatedEvent {
|
|
1558
|
+
export interface EntityUpdatedEvent {
|
|
1558
1559
|
/**
|
|
1559
1560
|
* 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
1561
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1562,16 +1563,16 @@ interface EntityUpdatedEvent {
|
|
|
1562
1563
|
*/
|
|
1563
1564
|
currentEntity?: string;
|
|
1564
1565
|
}
|
|
1565
|
-
interface EntityDeletedEvent {
|
|
1566
|
+
export interface EntityDeletedEvent {
|
|
1566
1567
|
/** Entity that was deleted */
|
|
1567
1568
|
deletedEntity?: string | null;
|
|
1568
1569
|
}
|
|
1569
|
-
interface ActionEvent {
|
|
1570
|
+
export interface ActionEvent {
|
|
1570
1571
|
body?: string;
|
|
1571
1572
|
}
|
|
1572
|
-
interface Empty {
|
|
1573
|
+
export interface Empty {
|
|
1573
1574
|
}
|
|
1574
|
-
interface MessageEnvelope {
|
|
1575
|
+
export interface MessageEnvelope {
|
|
1575
1576
|
/**
|
|
1576
1577
|
* App instance ID.
|
|
1577
1578
|
* @format GUID
|
|
@@ -1587,7 +1588,7 @@ interface MessageEnvelope {
|
|
|
1587
1588
|
/** Stringify payload. */
|
|
1588
1589
|
data?: string;
|
|
1589
1590
|
}
|
|
1590
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1591
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1591
1592
|
/**
|
|
1592
1593
|
* ID of a site visitor that has not logged in to the site.
|
|
1593
1594
|
* @format GUID
|
|
@@ -1612,7 +1613,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1612
1613
|
identityType?: WebhookIdentityType;
|
|
1613
1614
|
}
|
|
1614
1615
|
/** @oneof */
|
|
1615
|
-
interface IdentificationDataIdOneOf {
|
|
1616
|
+
export interface IdentificationDataIdOneOf {
|
|
1616
1617
|
/**
|
|
1617
1618
|
* ID of a site visitor that has not logged in to the site.
|
|
1618
1619
|
* @format GUID
|
|
@@ -1634,14 +1635,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1634
1635
|
*/
|
|
1635
1636
|
appId?: string;
|
|
1636
1637
|
}
|
|
1637
|
-
declare enum WebhookIdentityType {
|
|
1638
|
+
export declare enum WebhookIdentityType {
|
|
1638
1639
|
UNKNOWN = "UNKNOWN",
|
|
1639
1640
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1640
1641
|
MEMBER = "MEMBER",
|
|
1641
1642
|
WIX_USER = "WIX_USER",
|
|
1642
1643
|
APP = "APP"
|
|
1643
1644
|
}
|
|
1644
|
-
interface BaseEventMetadata {
|
|
1645
|
+
export interface BaseEventMetadata {
|
|
1645
1646
|
/**
|
|
1646
1647
|
* App instance ID.
|
|
1647
1648
|
* @format GUID
|
|
@@ -1655,7 +1656,7 @@ interface BaseEventMetadata {
|
|
|
1655
1656
|
/** The identification type and identity data. */
|
|
1656
1657
|
identity?: IdentificationData;
|
|
1657
1658
|
}
|
|
1658
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1659
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1659
1660
|
/**
|
|
1660
1661
|
* Unique event ID.
|
|
1661
1662
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1693,17 +1694,117 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1693
1694
|
*/
|
|
1694
1695
|
entityEventSequence?: string | null;
|
|
1695
1696
|
}
|
|
1696
|
-
interface SubscriptionContractCreatedEnvelope {
|
|
1697
|
+
export interface SubscriptionContractCreatedEnvelope {
|
|
1697
1698
|
entity: SubscriptionContract;
|
|
1698
1699
|
metadata: EventMetadata;
|
|
1699
1700
|
}
|
|
1700
|
-
|
|
1701
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1702
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1703
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1704
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1705
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1706
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1707
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1708
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1709
|
+
* @permissionScope Picasso private app mega scope
|
|
1710
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1711
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1712
|
+
* @webhook
|
|
1713
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
|
|
1714
|
+
* @slug created
|
|
1715
|
+
* @documentationMaturity preview
|
|
1716
|
+
*/
|
|
1717
|
+
export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
|
|
1718
|
+
export interface SubscriptionContractDeletedEnvelope {
|
|
1701
1719
|
metadata: EventMetadata;
|
|
1702
1720
|
}
|
|
1703
|
-
|
|
1721
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1722
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1723
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1724
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1725
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1726
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1727
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1728
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1729
|
+
* @permissionScope Picasso private app mega scope
|
|
1730
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1731
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1732
|
+
* @webhook
|
|
1733
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
|
|
1734
|
+
* @slug deleted
|
|
1735
|
+
* @documentationMaturity preview
|
|
1736
|
+
*/
|
|
1737
|
+
export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
|
|
1738
|
+
export interface SubscriptionContractUpdatedEnvelope {
|
|
1704
1739
|
entity: SubscriptionContract;
|
|
1705
1740
|
metadata: EventMetadata;
|
|
1706
1741
|
}
|
|
1742
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1743
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1744
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1745
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1746
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1747
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1748
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1749
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1750
|
+
* @permissionScope Picasso private app mega scope
|
|
1751
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1752
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1753
|
+
* @webhook
|
|
1754
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
|
|
1755
|
+
* @slug updated
|
|
1756
|
+
* @documentationMaturity preview
|
|
1757
|
+
*/
|
|
1758
|
+
export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
|
|
1759
|
+
type SubscriptionContractNonNullablePaths = `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.descriptionLines` | `lineItems.${number}.descriptionLines.${number}.plainText.original` | `lineItems.${number}.descriptionLines.${number}.colorInfo.original` | `lineItems.${number}.descriptionLines.${number}.name.original` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.taxInfo.taxBreakdown` | `lineItems.${number}.taxInfo.taxBreakdown.${number}.jurisdictionType` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.locations` | `lineItems.${number}.locations.${number}._id` | `lineItems.${number}.locations.${number}.quantity` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `appliedDiscounts.${number}.lineItemIds` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `additionalFees.${number}.lineItemIds`;
|
|
1760
|
+
/**
|
|
1761
|
+
* Retrieves a SubscriptionContract.
|
|
1762
|
+
* @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
|
|
1763
|
+
* @public
|
|
1764
|
+
* @documentationMaturity preview
|
|
1765
|
+
* @requiredField subscriptionContractId
|
|
1766
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1767
|
+
* @permissionScope Manage Stores - all permissions
|
|
1768
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1769
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1770
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1771
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1772
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1773
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1774
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1775
|
+
* @permissionScope Picasso private app mega scope
|
|
1776
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1777
|
+
* @applicableIdentity APP
|
|
1778
|
+
* @returns The requested SubscriptionContract.
|
|
1779
|
+
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
1780
|
+
*/
|
|
1781
|
+
export declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, SubscriptionContractNonNullablePaths>>;
|
|
1782
|
+
/**
|
|
1783
|
+
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
1784
|
+
*
|
|
1785
|
+
* Up to 300 SubscriptionContracts can be returned per request.
|
|
1786
|
+
*
|
|
1787
|
+
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
1788
|
+
*
|
|
1789
|
+
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
1790
|
+
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
1791
|
+
* @public
|
|
1792
|
+
* @documentationMaturity preview
|
|
1793
|
+
* @permissionScope Manage Stores - all permissions
|
|
1794
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1795
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1796
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1797
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1798
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1799
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1800
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1801
|
+
* @permissionScope Picasso private app mega scope
|
|
1802
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1803
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1804
|
+
* @applicableIdentity APP
|
|
1805
|
+
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
|
|
1806
|
+
*/
|
|
1807
|
+
export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
|
|
1707
1808
|
interface QueryCursorResult {
|
|
1708
1809
|
cursors: Cursors;
|
|
1709
1810
|
hasNext: () => boolean;
|
|
@@ -1711,13 +1812,13 @@ interface QueryCursorResult {
|
|
|
1711
1812
|
length: number;
|
|
1712
1813
|
pageSize: number;
|
|
1713
1814
|
}
|
|
1714
|
-
interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1815
|
+
export interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1715
1816
|
items: SubscriptionContract[];
|
|
1716
1817
|
query: SubscriptionContractsQueryBuilder;
|
|
1717
1818
|
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
1718
1819
|
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
1719
1820
|
}
|
|
1720
|
-
interface SubscriptionContractsQueryBuilder {
|
|
1821
|
+
export interface SubscriptionContractsQueryBuilder {
|
|
1721
1822
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1722
1823
|
* @param value - Value to compare against.
|
|
1723
1824
|
* @documentationMaturity preview
|
|
@@ -1761,5 +1862,4 @@ interface SubscriptionContractsQueryBuilder {
|
|
|
1761
1862
|
/** @documentationMaturity preview */
|
|
1762
1863
|
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
1763
1864
|
}
|
|
1764
|
-
|
|
1765
|
-
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 };
|
|
1865
|
+
export {};
|