@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
|
|
@@ -126,7 +127,7 @@ interface SubscriptionContract {
|
|
|
126
127
|
*/
|
|
127
128
|
additionalFees?: AdditionalFee[];
|
|
128
129
|
}
|
|
129
|
-
interface V1SubscriptionDescription {
|
|
130
|
+
export interface V1SubscriptionDescription {
|
|
130
131
|
/**
|
|
131
132
|
* Subscription option description.
|
|
132
133
|
* @maxLength 500
|
|
@@ -138,7 +139,7 @@ interface V1SubscriptionDescription {
|
|
|
138
139
|
*/
|
|
139
140
|
translated?: string | null;
|
|
140
141
|
}
|
|
141
|
-
interface V1SubscriptionSettings {
|
|
142
|
+
export interface V1SubscriptionSettings {
|
|
142
143
|
/** Frequency of recurring payment. */
|
|
143
144
|
frequency?: SubscriptionFrequency;
|
|
144
145
|
/**
|
|
@@ -167,14 +168,14 @@ interface V1SubscriptionSettings {
|
|
|
167
168
|
*/
|
|
168
169
|
startDate?: Date | null;
|
|
169
170
|
}
|
|
170
|
-
declare enum SubscriptionFrequency {
|
|
171
|
+
export declare enum SubscriptionFrequency {
|
|
171
172
|
UNDEFINED = "UNDEFINED",
|
|
172
173
|
DAY = "DAY",
|
|
173
174
|
WEEK = "WEEK",
|
|
174
175
|
MONTH = "MONTH",
|
|
175
176
|
YEAR = "YEAR"
|
|
176
177
|
}
|
|
177
|
-
interface V1FreeTrialPeriod {
|
|
178
|
+
export interface V1FreeTrialPeriod {
|
|
178
179
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
179
180
|
frequency?: SubscriptionFrequency;
|
|
180
181
|
/**
|
|
@@ -184,7 +185,7 @@ interface V1FreeTrialPeriod {
|
|
|
184
185
|
*/
|
|
185
186
|
interval?: number;
|
|
186
187
|
}
|
|
187
|
-
interface OrderLineItem {
|
|
188
|
+
export interface OrderLineItem {
|
|
188
189
|
/**
|
|
189
190
|
* Line item ID.
|
|
190
191
|
* @immutable
|
|
@@ -312,7 +313,7 @@ interface OrderLineItem {
|
|
|
312
313
|
*/
|
|
313
314
|
extendedFields?: ExtendedFields;
|
|
314
315
|
}
|
|
315
|
-
interface ProductName {
|
|
316
|
+
export interface ProductName {
|
|
316
317
|
/**
|
|
317
318
|
* __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).
|
|
318
319
|
*
|
|
@@ -334,7 +335,7 @@ interface ProductName {
|
|
|
334
335
|
translated?: string | null;
|
|
335
336
|
}
|
|
336
337
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
337
|
-
interface CatalogReference {
|
|
338
|
+
export interface CatalogReference {
|
|
338
339
|
/**
|
|
339
340
|
* ID of the item within the catalog it belongs to.
|
|
340
341
|
* @minLength 1
|
|
@@ -360,7 +361,7 @@ interface CatalogReference {
|
|
|
360
361
|
*/
|
|
361
362
|
options?: Record<string, any> | null;
|
|
362
363
|
}
|
|
363
|
-
interface Price {
|
|
364
|
+
export interface Price {
|
|
364
365
|
/**
|
|
365
366
|
* Amount.
|
|
366
367
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -372,7 +373,7 @@ interface Price {
|
|
|
372
373
|
*/
|
|
373
374
|
formattedAmount?: string;
|
|
374
375
|
}
|
|
375
|
-
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
376
|
+
export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
376
377
|
/** Description line plain text value. */
|
|
377
378
|
plainText?: PlainTextValue;
|
|
378
379
|
/** Description line color value. */
|
|
@@ -381,16 +382,16 @@ interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDesc
|
|
|
381
382
|
name?: DescriptionLineName;
|
|
382
383
|
}
|
|
383
384
|
/** @oneof */
|
|
384
|
-
interface DescriptionLineValueOneOf {
|
|
385
|
+
export interface DescriptionLineValueOneOf {
|
|
385
386
|
/** Description line plain text value. */
|
|
386
387
|
plainText?: PlainTextValue;
|
|
387
388
|
/** Description line color value. */
|
|
388
389
|
colorInfo?: Color;
|
|
389
390
|
}
|
|
390
391
|
/** @oneof */
|
|
391
|
-
interface DescriptionLineDescriptionLineValueOneOf {
|
|
392
|
+
export interface DescriptionLineDescriptionLineValueOneOf {
|
|
392
393
|
}
|
|
393
|
-
interface DescriptionLineName {
|
|
394
|
+
export interface DescriptionLineName {
|
|
394
395
|
/**
|
|
395
396
|
* 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).
|
|
396
397
|
* @maxLength 100
|
|
@@ -404,7 +405,7 @@ interface DescriptionLineName {
|
|
|
404
405
|
*/
|
|
405
406
|
translated?: string | null;
|
|
406
407
|
}
|
|
407
|
-
interface PlainTextValue {
|
|
408
|
+
export interface PlainTextValue {
|
|
408
409
|
/**
|
|
409
410
|
* 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).
|
|
410
411
|
* @maxLength 600
|
|
@@ -418,7 +419,7 @@ interface PlainTextValue {
|
|
|
418
419
|
*/
|
|
419
420
|
translated?: string | null;
|
|
420
421
|
}
|
|
421
|
-
interface Color {
|
|
422
|
+
export interface Color {
|
|
422
423
|
/**
|
|
423
424
|
* 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).
|
|
424
425
|
* @maxLength 500
|
|
@@ -434,7 +435,7 @@ interface Color {
|
|
|
434
435
|
/** HEX or RGB color code for display. */
|
|
435
436
|
code?: string | null;
|
|
436
437
|
}
|
|
437
|
-
declare enum DescriptionLineType {
|
|
438
|
+
export declare enum DescriptionLineType {
|
|
438
439
|
/** Unrecognized type. */
|
|
439
440
|
UNRECOGNISED = "UNRECOGNISED",
|
|
440
441
|
/** Plain text type. */
|
|
@@ -442,7 +443,7 @@ declare enum DescriptionLineType {
|
|
|
442
443
|
/** Color type. */
|
|
443
444
|
COLOR = "COLOR"
|
|
444
445
|
}
|
|
445
|
-
interface FocalPoint {
|
|
446
|
+
export interface FocalPoint {
|
|
446
447
|
/** X-coordinate of the focal point. */
|
|
447
448
|
x?: number;
|
|
448
449
|
/** Y-coordinate of the focal point. */
|
|
@@ -452,7 +453,7 @@ interface FocalPoint {
|
|
|
452
453
|
/** crop by width */
|
|
453
454
|
width?: number | null;
|
|
454
455
|
}
|
|
455
|
-
interface PhysicalProperties {
|
|
456
|
+
export interface PhysicalProperties {
|
|
456
457
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
457
458
|
weight?: number | null;
|
|
458
459
|
/**
|
|
@@ -463,20 +464,20 @@ interface PhysicalProperties {
|
|
|
463
464
|
/** Whether this line item is shippable. */
|
|
464
465
|
shippable?: boolean;
|
|
465
466
|
}
|
|
466
|
-
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
467
|
+
export interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
467
468
|
/** Preset item type. */
|
|
468
469
|
preset?: ItemTypeItemType;
|
|
469
470
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
470
471
|
custom?: string;
|
|
471
472
|
}
|
|
472
473
|
/** @oneof */
|
|
473
|
-
interface ItemTypeItemTypeDataOneOf {
|
|
474
|
+
export interface ItemTypeItemTypeDataOneOf {
|
|
474
475
|
/** Preset item type. */
|
|
475
476
|
preset?: ItemTypeItemType;
|
|
476
477
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
477
478
|
custom?: string;
|
|
478
479
|
}
|
|
479
|
-
declare enum ItemTypeItemType {
|
|
480
|
+
export declare enum ItemTypeItemType {
|
|
480
481
|
UNRECOGNISED = "UNRECOGNISED",
|
|
481
482
|
PHYSICAL = "PHYSICAL",
|
|
482
483
|
DIGITAL = "DIGITAL",
|
|
@@ -484,7 +485,7 @@ declare enum ItemTypeItemType {
|
|
|
484
485
|
SERVICE = "SERVICE"
|
|
485
486
|
}
|
|
486
487
|
/** Type of selected payment option for catalog item */
|
|
487
|
-
declare enum PaymentOptionType {
|
|
488
|
+
export declare enum PaymentOptionType {
|
|
488
489
|
/** The entire payment for this item happens as part of the checkout. */
|
|
489
490
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
490
491
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -496,7 +497,7 @@ declare enum PaymentOptionType {
|
|
|
496
497
|
/** 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`. */
|
|
497
498
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
498
499
|
}
|
|
499
|
-
interface ItemTaxFullDetails {
|
|
500
|
+
export interface ItemTaxFullDetails {
|
|
500
501
|
/** Taxable amount of this line item. */
|
|
501
502
|
taxableAmount?: Price;
|
|
502
503
|
/**
|
|
@@ -507,7 +508,7 @@ interface ItemTaxFullDetails {
|
|
|
507
508
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
508
509
|
totalTax?: Price;
|
|
509
510
|
}
|
|
510
|
-
interface LineItemTaxInfo {
|
|
511
|
+
export interface LineItemTaxInfo {
|
|
511
512
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
512
513
|
taxAmount?: Price;
|
|
513
514
|
/** Amount for which tax is calculated. */
|
|
@@ -535,7 +536,7 @@ interface LineItemTaxInfo {
|
|
|
535
536
|
* TaxBreakdown represents tax information for a line item.
|
|
536
537
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
537
538
|
*/
|
|
538
|
-
interface LineItemTaxBreakdown {
|
|
539
|
+
export interface LineItemTaxBreakdown {
|
|
539
540
|
/**
|
|
540
541
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
541
542
|
* @maxLength 200
|
|
@@ -568,7 +569,7 @@ interface LineItemTaxBreakdown {
|
|
|
568
569
|
taxableAmount?: Price;
|
|
569
570
|
}
|
|
570
571
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
571
|
-
declare enum JurisdictionType {
|
|
572
|
+
export declare enum JurisdictionType {
|
|
572
573
|
UNDEFINED = "UNDEFINED",
|
|
573
574
|
COUNTRY = "COUNTRY",
|
|
574
575
|
STATE = "STATE",
|
|
@@ -576,7 +577,7 @@ declare enum JurisdictionType {
|
|
|
576
577
|
CITY = "CITY",
|
|
577
578
|
SPECIAL = "SPECIAL"
|
|
578
579
|
}
|
|
579
|
-
interface DigitalFile {
|
|
580
|
+
export interface DigitalFile {
|
|
580
581
|
/**
|
|
581
582
|
* ID of the secure file in media.
|
|
582
583
|
* @minLength 1
|
|
@@ -596,7 +597,7 @@ interface DigitalFile {
|
|
|
596
597
|
*/
|
|
597
598
|
expirationDate?: Date | null;
|
|
598
599
|
}
|
|
599
|
-
interface SubscriptionInfo {
|
|
600
|
+
export interface SubscriptionInfo {
|
|
600
601
|
/**
|
|
601
602
|
* Subscription ID.
|
|
602
603
|
* @format GUID
|
|
@@ -650,7 +651,7 @@ interface SubscriptionInfo {
|
|
|
650
651
|
*/
|
|
651
652
|
billingAdjustment?: BillingAdjustment;
|
|
652
653
|
}
|
|
653
|
-
interface SubscriptionTitle {
|
|
654
|
+
export interface SubscriptionTitle {
|
|
654
655
|
/**
|
|
655
656
|
* 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).
|
|
656
657
|
* @minLength 1
|
|
@@ -666,7 +667,7 @@ interface SubscriptionTitle {
|
|
|
666
667
|
*/
|
|
667
668
|
translated?: string | null;
|
|
668
669
|
}
|
|
669
|
-
interface SubscriptionDescription {
|
|
670
|
+
export interface SubscriptionDescription {
|
|
670
671
|
/**
|
|
671
672
|
* Subscription option description.
|
|
672
673
|
* @maxLength 500
|
|
@@ -678,7 +679,7 @@ interface SubscriptionDescription {
|
|
|
678
679
|
*/
|
|
679
680
|
translated?: string | null;
|
|
680
681
|
}
|
|
681
|
-
interface SubscriptionSettings {
|
|
682
|
+
export interface SubscriptionSettings {
|
|
682
683
|
/** Frequency of recurring payment. */
|
|
683
684
|
frequency?: V2SubscriptionFrequency;
|
|
684
685
|
/**
|
|
@@ -711,14 +712,14 @@ interface SubscriptionSettings {
|
|
|
711
712
|
startDate?: Date | null;
|
|
712
713
|
}
|
|
713
714
|
/** Frequency unit of recurring payment */
|
|
714
|
-
declare enum V2SubscriptionFrequency {
|
|
715
|
+
export declare enum V2SubscriptionFrequency {
|
|
715
716
|
UNDEFINED = "UNDEFINED",
|
|
716
717
|
DAY = "DAY",
|
|
717
718
|
WEEK = "WEEK",
|
|
718
719
|
MONTH = "MONTH",
|
|
719
720
|
YEAR = "YEAR"
|
|
720
721
|
}
|
|
721
|
-
interface FreeTrialPeriod {
|
|
722
|
+
export interface FreeTrialPeriod {
|
|
722
723
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
723
724
|
frequency?: V2SubscriptionFrequency;
|
|
724
725
|
/**
|
|
@@ -728,20 +729,20 @@ interface FreeTrialPeriod {
|
|
|
728
729
|
*/
|
|
729
730
|
interval?: number;
|
|
730
731
|
}
|
|
731
|
-
interface BillingAdjustment {
|
|
732
|
+
export interface BillingAdjustment {
|
|
732
733
|
/** The type of adjustment. */
|
|
733
734
|
type?: AdjustmentType;
|
|
734
735
|
/** Summary of the prorated adjustment amount. */
|
|
735
736
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
736
737
|
}
|
|
737
|
-
declare enum AdjustmentType {
|
|
738
|
+
export declare enum AdjustmentType {
|
|
738
739
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
739
740
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
740
741
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
741
742
|
/** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
|
|
742
743
|
CREDIT = "CREDIT"
|
|
743
744
|
}
|
|
744
|
-
interface BillingAdjustmentPriceSummary {
|
|
745
|
+
export interface BillingAdjustmentPriceSummary {
|
|
745
746
|
/** Subtotal of adjustment, before tax. */
|
|
746
747
|
subtotal?: Price;
|
|
747
748
|
/** Tax on adjustment. */
|
|
@@ -749,7 +750,7 @@ interface BillingAdjustmentPriceSummary {
|
|
|
749
750
|
/** Total price after tax. */
|
|
750
751
|
total?: Price;
|
|
751
752
|
}
|
|
752
|
-
interface PriceDescription {
|
|
753
|
+
export interface PriceDescription {
|
|
753
754
|
/**
|
|
754
755
|
* __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).
|
|
755
756
|
* @minLength 1
|
|
@@ -765,7 +766,7 @@ interface PriceDescription {
|
|
|
765
766
|
*/
|
|
766
767
|
translated?: string | null;
|
|
767
768
|
}
|
|
768
|
-
interface LocationAndQuantity {
|
|
769
|
+
export interface LocationAndQuantity {
|
|
769
770
|
/**
|
|
770
771
|
* Location id in the associated owner app.
|
|
771
772
|
* @format GUID
|
|
@@ -791,22 +792,22 @@ interface LocationAndQuantity {
|
|
|
791
792
|
*/
|
|
792
793
|
name?: string | null;
|
|
793
794
|
}
|
|
794
|
-
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
795
|
+
export interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
795
796
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
796
797
|
addressType?: TaxableAddressType;
|
|
797
798
|
}
|
|
798
799
|
/** @oneof */
|
|
799
|
-
interface TaxableAddressTaxableAddressDataOneOf {
|
|
800
|
+
export interface TaxableAddressTaxableAddressDataOneOf {
|
|
800
801
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
801
802
|
addressType?: TaxableAddressType;
|
|
802
803
|
}
|
|
803
|
-
declare enum TaxableAddressType {
|
|
804
|
+
export declare enum TaxableAddressType {
|
|
804
805
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
805
806
|
BUSINESS = "BUSINESS",
|
|
806
807
|
BILLING = "BILLING",
|
|
807
808
|
SHIPPING = "SHIPPING"
|
|
808
809
|
}
|
|
809
|
-
interface ExtendedFields {
|
|
810
|
+
export interface ExtendedFields {
|
|
810
811
|
/**
|
|
811
812
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
812
813
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -818,7 +819,7 @@ interface ExtendedFields {
|
|
|
818
819
|
namespaces?: Record<string, Record<string, any>>;
|
|
819
820
|
}
|
|
820
821
|
/** Buyer Info */
|
|
821
|
-
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
822
|
+
export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
822
823
|
/**
|
|
823
824
|
* Visitor ID (if site visitor is not a member).
|
|
824
825
|
* @format GUID
|
|
@@ -841,7 +842,7 @@ interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
841
842
|
email?: string | null;
|
|
842
843
|
}
|
|
843
844
|
/** @oneof */
|
|
844
|
-
interface BuyerInfoIdOneOf {
|
|
845
|
+
export interface BuyerInfoIdOneOf {
|
|
845
846
|
/**
|
|
846
847
|
* Visitor ID (if site visitor is not a member).
|
|
847
848
|
* @format GUID
|
|
@@ -853,7 +854,7 @@ interface BuyerInfoIdOneOf {
|
|
|
853
854
|
*/
|
|
854
855
|
memberId?: string;
|
|
855
856
|
}
|
|
856
|
-
declare enum WeightUnit {
|
|
857
|
+
export declare enum WeightUnit {
|
|
857
858
|
/** Weight unit can't be classified due to an error. */
|
|
858
859
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
859
860
|
/** Kilograms. */
|
|
@@ -861,7 +862,7 @@ declare enum WeightUnit {
|
|
|
861
862
|
/** Pounds. */
|
|
862
863
|
LB = "LB"
|
|
863
864
|
}
|
|
864
|
-
interface CurrencyConversionDetails {
|
|
865
|
+
export interface CurrencyConversionDetails {
|
|
865
866
|
/**
|
|
866
867
|
* 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.
|
|
867
868
|
* @readonly
|
|
@@ -877,7 +878,7 @@ interface CurrencyConversionDetails {
|
|
|
877
878
|
*/
|
|
878
879
|
conversionRate?: string | null;
|
|
879
880
|
}
|
|
880
|
-
interface PriceSummary {
|
|
881
|
+
export interface PriceSummary {
|
|
881
882
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
882
883
|
subtotal?: Price;
|
|
883
884
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -892,14 +893,14 @@ interface PriceSummary {
|
|
|
892
893
|
totalAdditionalFees?: Price;
|
|
893
894
|
}
|
|
894
895
|
/** Billing Info and shipping details */
|
|
895
|
-
interface AddressWithContact {
|
|
896
|
+
export interface AddressWithContact {
|
|
896
897
|
/** Address. */
|
|
897
898
|
address?: Address;
|
|
898
899
|
/** Contact details. */
|
|
899
900
|
contactDetails?: FullAddressContactDetails;
|
|
900
901
|
}
|
|
901
902
|
/** Physical address */
|
|
902
|
-
interface Address {
|
|
903
|
+
export interface Address {
|
|
903
904
|
/**
|
|
904
905
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
905
906
|
* @format COUNTRY
|
|
@@ -943,20 +944,20 @@ interface Address {
|
|
|
943
944
|
*/
|
|
944
945
|
subdivisionFullname?: string | null;
|
|
945
946
|
}
|
|
946
|
-
interface StreetAddress {
|
|
947
|
+
export interface StreetAddress {
|
|
947
948
|
/** Street number. */
|
|
948
949
|
number?: string;
|
|
949
950
|
/** Street name. */
|
|
950
951
|
name?: string;
|
|
951
952
|
}
|
|
952
|
-
interface AddressLocation {
|
|
953
|
+
export interface AddressLocation {
|
|
953
954
|
/** Address latitude. */
|
|
954
955
|
latitude?: number | null;
|
|
955
956
|
/** Address longitude. */
|
|
956
957
|
longitude?: number | null;
|
|
957
958
|
}
|
|
958
959
|
/** Full contact details for an address */
|
|
959
|
-
interface FullAddressContactDetails {
|
|
960
|
+
export interface FullAddressContactDetails {
|
|
960
961
|
/**
|
|
961
962
|
* First name.
|
|
962
963
|
* @maxLength 100
|
|
@@ -980,7 +981,7 @@ interface FullAddressContactDetails {
|
|
|
980
981
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
981
982
|
vatId?: VatId;
|
|
982
983
|
}
|
|
983
|
-
interface VatId {
|
|
984
|
+
export interface VatId {
|
|
984
985
|
/** Customer's tax ID. */
|
|
985
986
|
_id?: string;
|
|
986
987
|
/**
|
|
@@ -993,14 +994,14 @@ interface VatId {
|
|
|
993
994
|
type?: VatType;
|
|
994
995
|
}
|
|
995
996
|
/** tax info types */
|
|
996
|
-
declare enum VatType {
|
|
997
|
+
export declare enum VatType {
|
|
997
998
|
UNSPECIFIED = "UNSPECIFIED",
|
|
998
999
|
/** CPF - for individual tax payers. */
|
|
999
1000
|
CPF = "CPF",
|
|
1000
1001
|
/** CNPJ - for corporations */
|
|
1001
1002
|
CNPJ = "CNPJ"
|
|
1002
1003
|
}
|
|
1003
|
-
interface ShippingInformation {
|
|
1004
|
+
export interface ShippingInformation {
|
|
1004
1005
|
/**
|
|
1005
1006
|
* App Def Id of external provider which was a source of shipping info
|
|
1006
1007
|
* @minLength 1
|
|
@@ -1026,7 +1027,7 @@ interface ShippingInformation {
|
|
|
1026
1027
|
/** Shipping region. */
|
|
1027
1028
|
region?: ShippingRegion;
|
|
1028
1029
|
}
|
|
1029
|
-
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1030
|
+
export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1030
1031
|
/** Shipping address and contact details. */
|
|
1031
1032
|
shippingDestination?: AddressWithContact;
|
|
1032
1033
|
/** Pickup details. */
|
|
@@ -1050,20 +1051,20 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1050
1051
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1051
1052
|
}
|
|
1052
1053
|
/** @oneof */
|
|
1053
|
-
interface DeliveryLogisticsAddressOneOf {
|
|
1054
|
+
export interface DeliveryLogisticsAddressOneOf {
|
|
1054
1055
|
/** Shipping address and contact details. */
|
|
1055
1056
|
shippingDestination?: AddressWithContact;
|
|
1056
1057
|
/** Pickup details. */
|
|
1057
1058
|
pickupDetails?: PickupDetails;
|
|
1058
1059
|
}
|
|
1059
|
-
interface PickupDetails {
|
|
1060
|
+
export interface PickupDetails {
|
|
1060
1061
|
/** Pickup address. */
|
|
1061
1062
|
address?: PickupAddress;
|
|
1062
1063
|
/** Pickup method */
|
|
1063
1064
|
pickupMethod?: PickupMethod;
|
|
1064
1065
|
}
|
|
1065
1066
|
/** Physical address */
|
|
1066
|
-
interface PickupAddress {
|
|
1067
|
+
export interface PickupAddress {
|
|
1067
1068
|
/**
|
|
1068
1069
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1069
1070
|
* @format COUNTRY
|
|
@@ -1107,18 +1108,18 @@ interface PickupAddress {
|
|
|
1107
1108
|
*/
|
|
1108
1109
|
subdivisionFullname?: string | null;
|
|
1109
1110
|
}
|
|
1110
|
-
declare enum PickupMethod {
|
|
1111
|
+
export declare enum PickupMethod {
|
|
1111
1112
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1112
1113
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1113
1114
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1114
1115
|
}
|
|
1115
|
-
interface DeliveryTimeSlot {
|
|
1116
|
+
export interface DeliveryTimeSlot {
|
|
1116
1117
|
/** Delivery slot starting time. */
|
|
1117
1118
|
from?: Date | null;
|
|
1118
1119
|
/** Delivery slot ending time. */
|
|
1119
1120
|
to?: Date | null;
|
|
1120
1121
|
}
|
|
1121
|
-
interface ShippingPrice {
|
|
1122
|
+
export interface ShippingPrice {
|
|
1122
1123
|
/** Shipping price for display purposes. */
|
|
1123
1124
|
price?: Price;
|
|
1124
1125
|
/**
|
|
@@ -1139,14 +1140,14 @@ interface ShippingPrice {
|
|
|
1139
1140
|
*/
|
|
1140
1141
|
discount?: Price;
|
|
1141
1142
|
}
|
|
1142
|
-
interface ShippingRegion {
|
|
1143
|
+
export interface ShippingRegion {
|
|
1143
1144
|
/**
|
|
1144
1145
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1145
1146
|
* @maxLength 100
|
|
1146
1147
|
*/
|
|
1147
1148
|
name?: string | null;
|
|
1148
1149
|
}
|
|
1149
|
-
interface OrderTaxInfo {
|
|
1150
|
+
export interface OrderTaxInfo {
|
|
1150
1151
|
/** Calculated tax, added from line items. */
|
|
1151
1152
|
totalTax?: Price;
|
|
1152
1153
|
/**
|
|
@@ -1166,7 +1167,7 @@ interface OrderTaxInfo {
|
|
|
1166
1167
|
* 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.
|
|
1167
1168
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1168
1169
|
*/
|
|
1169
|
-
interface OrderTaxBreakdown {
|
|
1170
|
+
export interface OrderTaxBreakdown {
|
|
1170
1171
|
/**
|
|
1171
1172
|
* The name of the tax against which this tax amount was calculated.
|
|
1172
1173
|
* @maxLength 200
|
|
@@ -1193,7 +1194,7 @@ interface OrderTaxBreakdown {
|
|
|
1193
1194
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1194
1195
|
aggregatedTaxAmount?: Price;
|
|
1195
1196
|
}
|
|
1196
|
-
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1197
|
+
export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1197
1198
|
/** Applied coupon info. */
|
|
1198
1199
|
coupon?: Coupon;
|
|
1199
1200
|
/** Merchant discount. */
|
|
@@ -1234,7 +1235,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1234
1235
|
subscriptionCycles?: number | null;
|
|
1235
1236
|
}
|
|
1236
1237
|
/** @oneof */
|
|
1237
|
-
interface AppliedDiscountDiscountSourceOneOf {
|
|
1238
|
+
export interface AppliedDiscountDiscountSourceOneOf {
|
|
1238
1239
|
/** Applied coupon info. */
|
|
1239
1240
|
coupon?: Coupon;
|
|
1240
1241
|
/** Merchant discount. */
|
|
@@ -1242,13 +1243,13 @@ interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1242
1243
|
/** Automatic Discount */
|
|
1243
1244
|
discountRule?: DiscountRule;
|
|
1244
1245
|
}
|
|
1245
|
-
declare enum DiscountType {
|
|
1246
|
+
export declare enum DiscountType {
|
|
1246
1247
|
GLOBAL = "GLOBAL",
|
|
1247
1248
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1248
1249
|
SHIPPING = "SHIPPING"
|
|
1249
1250
|
}
|
|
1250
1251
|
/** Coupon */
|
|
1251
|
-
interface Coupon {
|
|
1252
|
+
export interface Coupon {
|
|
1252
1253
|
/** Coupon ID. */
|
|
1253
1254
|
_id?: string;
|
|
1254
1255
|
/** Coupon code. */
|
|
@@ -1258,7 +1259,7 @@ interface Coupon {
|
|
|
1258
1259
|
/** Coupon value. */
|
|
1259
1260
|
amount?: Price;
|
|
1260
1261
|
}
|
|
1261
|
-
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1262
|
+
export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1262
1263
|
/**
|
|
1263
1264
|
* Pre-defined discount reason (optional).
|
|
1264
1265
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1280,7 +1281,7 @@ interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1280
1281
|
percentage?: string | null;
|
|
1281
1282
|
}
|
|
1282
1283
|
/** @oneof */
|
|
1283
|
-
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1284
|
+
export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1284
1285
|
/**
|
|
1285
1286
|
* Pre-defined discount reason (optional).
|
|
1286
1287
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1292,12 +1293,12 @@ interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1292
1293
|
*/
|
|
1293
1294
|
description?: string | null;
|
|
1294
1295
|
}
|
|
1295
|
-
declare enum DiscountReason {
|
|
1296
|
+
export declare enum DiscountReason {
|
|
1296
1297
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1297
1298
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1298
1299
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1299
1300
|
}
|
|
1300
|
-
interface DiscountRule {
|
|
1301
|
+
export interface DiscountRule {
|
|
1301
1302
|
/**
|
|
1302
1303
|
* Discount rule ID
|
|
1303
1304
|
* @format GUID
|
|
@@ -1308,7 +1309,7 @@ interface DiscountRule {
|
|
|
1308
1309
|
/** Discount value. */
|
|
1309
1310
|
amount?: Price;
|
|
1310
1311
|
}
|
|
1311
|
-
interface DiscountRuleName {
|
|
1312
|
+
export interface DiscountRuleName {
|
|
1312
1313
|
/**
|
|
1313
1314
|
* Original discount rule name (in site's default language).
|
|
1314
1315
|
* @minLength 1
|
|
@@ -1322,7 +1323,7 @@ interface DiscountRuleName {
|
|
|
1322
1323
|
*/
|
|
1323
1324
|
translated?: string | null;
|
|
1324
1325
|
}
|
|
1325
|
-
interface LineItemDiscount {
|
|
1326
|
+
export interface LineItemDiscount {
|
|
1326
1327
|
/**
|
|
1327
1328
|
* ID of line item the discount applies to.
|
|
1328
1329
|
* @format GUID
|
|
@@ -1331,7 +1332,7 @@ interface LineItemDiscount {
|
|
|
1331
1332
|
/** Total discount for this line item. */
|
|
1332
1333
|
totalDiscount?: Price;
|
|
1333
1334
|
}
|
|
1334
|
-
interface ChannelInfo {
|
|
1335
|
+
export interface ChannelInfo {
|
|
1335
1336
|
/** Sales channel that submitted the order. */
|
|
1336
1337
|
type?: ChannelType;
|
|
1337
1338
|
/**
|
|
@@ -1345,7 +1346,7 @@ interface ChannelInfo {
|
|
|
1345
1346
|
*/
|
|
1346
1347
|
externalOrderUrl?: string | null;
|
|
1347
1348
|
}
|
|
1348
|
-
declare enum ChannelType {
|
|
1349
|
+
export declare enum ChannelType {
|
|
1349
1350
|
/** Unspecified sales channel. This value is not supported. */
|
|
1350
1351
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1351
1352
|
/** A web client. */
|
|
@@ -1379,7 +1380,7 @@ declare enum ChannelType {
|
|
|
1379
1380
|
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1380
1381
|
FAIRE_COM = "FAIRE_COM"
|
|
1381
1382
|
}
|
|
1382
|
-
interface CustomField {
|
|
1383
|
+
export interface CustomField {
|
|
1383
1384
|
/** Custom field value. */
|
|
1384
1385
|
value?: any;
|
|
1385
1386
|
/**
|
|
@@ -1395,7 +1396,7 @@ interface CustomField {
|
|
|
1395
1396
|
*/
|
|
1396
1397
|
translatedTitle?: string | null;
|
|
1397
1398
|
}
|
|
1398
|
-
interface V1SubscriptionTitle {
|
|
1399
|
+
export interface V1SubscriptionTitle {
|
|
1399
1400
|
/**
|
|
1400
1401
|
* 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).
|
|
1401
1402
|
* @minLength 1
|
|
@@ -1411,7 +1412,7 @@ interface V1SubscriptionTitle {
|
|
|
1411
1412
|
*/
|
|
1412
1413
|
translated?: string | null;
|
|
1413
1414
|
}
|
|
1414
|
-
interface AdditionalFee {
|
|
1415
|
+
export interface AdditionalFee {
|
|
1415
1416
|
/**
|
|
1416
1417
|
* Additional fee's unique code for future processing.
|
|
1417
1418
|
* @minLength 1
|
|
@@ -1458,7 +1459,7 @@ interface AdditionalFee {
|
|
|
1458
1459
|
*/
|
|
1459
1460
|
subscriptionCycles?: number | null;
|
|
1460
1461
|
}
|
|
1461
|
-
interface Location {
|
|
1462
|
+
export interface Location {
|
|
1462
1463
|
/**
|
|
1463
1464
|
* Location ID.
|
|
1464
1465
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -1473,38 +1474,38 @@ interface Location {
|
|
|
1473
1474
|
*/
|
|
1474
1475
|
name?: string;
|
|
1475
1476
|
}
|
|
1476
|
-
interface CreateSubscriptionContractRequest {
|
|
1477
|
+
export interface CreateSubscriptionContractRequest {
|
|
1477
1478
|
/** SubscriptionContract to be created. */
|
|
1478
1479
|
subscriptionContract?: SubscriptionContract;
|
|
1479
1480
|
}
|
|
1480
|
-
interface CreateSubscriptionContractResponse {
|
|
1481
|
+
export interface CreateSubscriptionContractResponse {
|
|
1481
1482
|
/** The created SubscriptionContract. */
|
|
1482
1483
|
subscriptionContract?: SubscriptionContract;
|
|
1483
1484
|
}
|
|
1484
|
-
interface GetSubscriptionContractRequest {
|
|
1485
|
+
export interface GetSubscriptionContractRequest {
|
|
1485
1486
|
/**
|
|
1486
1487
|
* ID of the SubscriptionContract to retrieve.
|
|
1487
1488
|
* @format GUID
|
|
1488
1489
|
*/
|
|
1489
1490
|
subscriptionContractId: string;
|
|
1490
1491
|
}
|
|
1491
|
-
interface GetSubscriptionContractResponse {
|
|
1492
|
+
export interface GetSubscriptionContractResponse {
|
|
1492
1493
|
/** The requested SubscriptionContract. */
|
|
1493
1494
|
subscriptionContract?: SubscriptionContract;
|
|
1494
1495
|
}
|
|
1495
|
-
interface UpdateSubscriptionContractRequest {
|
|
1496
|
+
export interface UpdateSubscriptionContractRequest {
|
|
1496
1497
|
/** SubscriptionContract to be updated, may be partial. */
|
|
1497
1498
|
subscriptionContract?: SubscriptionContract;
|
|
1498
1499
|
}
|
|
1499
|
-
interface UpdateSubscriptionContractResponse {
|
|
1500
|
+
export interface UpdateSubscriptionContractResponse {
|
|
1500
1501
|
/** Updated SubscriptionContract. */
|
|
1501
1502
|
subscriptionContract?: SubscriptionContract;
|
|
1502
1503
|
}
|
|
1503
|
-
interface QuerySubscriptionContractsRequest {
|
|
1504
|
+
export interface QuerySubscriptionContractsRequest {
|
|
1504
1505
|
/** WQL expression. */
|
|
1505
1506
|
query?: CursorQuery;
|
|
1506
1507
|
}
|
|
1507
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1508
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1508
1509
|
/** 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`. */
|
|
1509
1510
|
cursorPaging?: CursorPaging;
|
|
1510
1511
|
/**
|
|
@@ -1526,11 +1527,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1526
1527
|
sort?: Sorting[];
|
|
1527
1528
|
}
|
|
1528
1529
|
/** @oneof */
|
|
1529
|
-
interface CursorQueryPagingMethodOneOf {
|
|
1530
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
1530
1531
|
/** 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`. */
|
|
1531
1532
|
cursorPaging?: CursorPaging;
|
|
1532
1533
|
}
|
|
1533
|
-
interface Sorting {
|
|
1534
|
+
export interface Sorting {
|
|
1534
1535
|
/**
|
|
1535
1536
|
* Name of the field to sort by.
|
|
1536
1537
|
* @maxLength 512
|
|
@@ -1539,11 +1540,11 @@ interface Sorting {
|
|
|
1539
1540
|
/** Sort order. */
|
|
1540
1541
|
order?: SortOrder;
|
|
1541
1542
|
}
|
|
1542
|
-
declare enum SortOrder {
|
|
1543
|
+
export declare enum SortOrder {
|
|
1543
1544
|
ASC = "ASC",
|
|
1544
1545
|
DESC = "DESC"
|
|
1545
1546
|
}
|
|
1546
|
-
interface CursorPaging {
|
|
1547
|
+
export interface CursorPaging {
|
|
1547
1548
|
/**
|
|
1548
1549
|
* Maximum number of items to return in the results.
|
|
1549
1550
|
* @max 100
|
|
@@ -1558,13 +1559,13 @@ interface CursorPaging {
|
|
|
1558
1559
|
*/
|
|
1559
1560
|
cursor?: string | null;
|
|
1560
1561
|
}
|
|
1561
|
-
interface QuerySubscriptionContractsResponse {
|
|
1562
|
+
export interface QuerySubscriptionContractsResponse {
|
|
1562
1563
|
/** List of SubscriptionContracts. */
|
|
1563
1564
|
subscriptionContracts?: SubscriptionContract[];
|
|
1564
1565
|
/** Paging metadata */
|
|
1565
1566
|
pagingMetadata?: CursorPagingMetadata;
|
|
1566
1567
|
}
|
|
1567
|
-
interface CursorPagingMetadata {
|
|
1568
|
+
export interface CursorPagingMetadata {
|
|
1568
1569
|
/** Number of items returned in the response. */
|
|
1569
1570
|
count?: number | null;
|
|
1570
1571
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1577,7 +1578,7 @@ interface CursorPagingMetadata {
|
|
|
1577
1578
|
*/
|
|
1578
1579
|
hasNext?: boolean | null;
|
|
1579
1580
|
}
|
|
1580
|
-
interface Cursors {
|
|
1581
|
+
export interface Cursors {
|
|
1581
1582
|
/**
|
|
1582
1583
|
* Cursor string pointing to the next page in the list of results.
|
|
1583
1584
|
* @maxLength 16000
|
|
@@ -1589,7 +1590,7 @@ interface Cursors {
|
|
|
1589
1590
|
*/
|
|
1590
1591
|
prev?: string | null;
|
|
1591
1592
|
}
|
|
1592
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1593
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1593
1594
|
createdEvent?: EntityCreatedEvent;
|
|
1594
1595
|
updatedEvent?: EntityUpdatedEvent;
|
|
1595
1596
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1632,19 +1633,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1632
1633
|
entityEventSequence?: string | null;
|
|
1633
1634
|
}
|
|
1634
1635
|
/** @oneof */
|
|
1635
|
-
interface DomainEventBodyOneOf {
|
|
1636
|
+
export interface DomainEventBodyOneOf {
|
|
1636
1637
|
createdEvent?: EntityCreatedEvent;
|
|
1637
1638
|
updatedEvent?: EntityUpdatedEvent;
|
|
1638
1639
|
deletedEvent?: EntityDeletedEvent;
|
|
1639
1640
|
actionEvent?: ActionEvent;
|
|
1640
1641
|
}
|
|
1641
|
-
interface EntityCreatedEvent {
|
|
1642
|
+
export interface EntityCreatedEvent {
|
|
1642
1643
|
entity?: string;
|
|
1643
1644
|
}
|
|
1644
|
-
interface RestoreInfo {
|
|
1645
|
+
export interface RestoreInfo {
|
|
1645
1646
|
deletedDate?: Date | null;
|
|
1646
1647
|
}
|
|
1647
|
-
interface EntityUpdatedEvent {
|
|
1648
|
+
export interface EntityUpdatedEvent {
|
|
1648
1649
|
/**
|
|
1649
1650
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1650
1651
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1652,16 +1653,16 @@ interface EntityUpdatedEvent {
|
|
|
1652
1653
|
*/
|
|
1653
1654
|
currentEntity?: string;
|
|
1654
1655
|
}
|
|
1655
|
-
interface EntityDeletedEvent {
|
|
1656
|
+
export interface EntityDeletedEvent {
|
|
1656
1657
|
/** Entity that was deleted */
|
|
1657
1658
|
deletedEntity?: string | null;
|
|
1658
1659
|
}
|
|
1659
|
-
interface ActionEvent {
|
|
1660
|
+
export interface ActionEvent {
|
|
1660
1661
|
body?: string;
|
|
1661
1662
|
}
|
|
1662
|
-
interface Empty {
|
|
1663
|
+
export interface Empty {
|
|
1663
1664
|
}
|
|
1664
|
-
interface MessageEnvelope {
|
|
1665
|
+
export interface MessageEnvelope {
|
|
1665
1666
|
/**
|
|
1666
1667
|
* App instance ID.
|
|
1667
1668
|
* @format GUID
|
|
@@ -1677,7 +1678,7 @@ interface MessageEnvelope {
|
|
|
1677
1678
|
/** Stringify payload. */
|
|
1678
1679
|
data?: string;
|
|
1679
1680
|
}
|
|
1680
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1681
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1681
1682
|
/**
|
|
1682
1683
|
* ID of a site visitor that has not logged in to the site.
|
|
1683
1684
|
* @format GUID
|
|
@@ -1702,7 +1703,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1702
1703
|
identityType?: WebhookIdentityType;
|
|
1703
1704
|
}
|
|
1704
1705
|
/** @oneof */
|
|
1705
|
-
interface IdentificationDataIdOneOf {
|
|
1706
|
+
export interface IdentificationDataIdOneOf {
|
|
1706
1707
|
/**
|
|
1707
1708
|
* ID of a site visitor that has not logged in to the site.
|
|
1708
1709
|
* @format GUID
|
|
@@ -1724,14 +1725,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1724
1725
|
*/
|
|
1725
1726
|
appId?: string;
|
|
1726
1727
|
}
|
|
1727
|
-
declare enum WebhookIdentityType {
|
|
1728
|
+
export declare enum WebhookIdentityType {
|
|
1728
1729
|
UNKNOWN = "UNKNOWN",
|
|
1729
1730
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1730
1731
|
MEMBER = "MEMBER",
|
|
1731
1732
|
WIX_USER = "WIX_USER",
|
|
1732
1733
|
APP = "APP"
|
|
1733
1734
|
}
|
|
1734
|
-
interface BaseEventMetadata {
|
|
1735
|
+
export interface BaseEventMetadata {
|
|
1735
1736
|
/**
|
|
1736
1737
|
* App instance ID.
|
|
1737
1738
|
* @format GUID
|
|
@@ -1745,7 +1746,7 @@ interface BaseEventMetadata {
|
|
|
1745
1746
|
/** The identification type and identity data. */
|
|
1746
1747
|
identity?: IdentificationData;
|
|
1747
1748
|
}
|
|
1748
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1749
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1749
1750
|
/**
|
|
1750
1751
|
* Unique event ID.
|
|
1751
1752
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1783,17 +1784,117 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1783
1784
|
*/
|
|
1784
1785
|
entityEventSequence?: string | null;
|
|
1785
1786
|
}
|
|
1786
|
-
interface SubscriptionContractCreatedEnvelope {
|
|
1787
|
+
export interface SubscriptionContractCreatedEnvelope {
|
|
1787
1788
|
entity: SubscriptionContract;
|
|
1788
1789
|
metadata: EventMetadata;
|
|
1789
1790
|
}
|
|
1790
|
-
|
|
1791
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1792
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1793
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1794
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1795
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1796
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1797
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1798
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1799
|
+
* @permissionScope Picasso private app mega scope
|
|
1800
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1801
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1802
|
+
* @webhook
|
|
1803
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
|
|
1804
|
+
* @slug created
|
|
1805
|
+
* @documentationMaturity preview
|
|
1806
|
+
*/
|
|
1807
|
+
export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
|
|
1808
|
+
export interface SubscriptionContractDeletedEnvelope {
|
|
1791
1809
|
metadata: EventMetadata;
|
|
1792
1810
|
}
|
|
1793
|
-
|
|
1811
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1812
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1813
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1814
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1815
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1816
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1817
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1818
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1819
|
+
* @permissionScope Picasso private app mega scope
|
|
1820
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1821
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1822
|
+
* @webhook
|
|
1823
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
|
|
1824
|
+
* @slug deleted
|
|
1825
|
+
* @documentationMaturity preview
|
|
1826
|
+
*/
|
|
1827
|
+
export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
|
|
1828
|
+
export interface SubscriptionContractUpdatedEnvelope {
|
|
1794
1829
|
entity: SubscriptionContract;
|
|
1795
1830
|
metadata: EventMetadata;
|
|
1796
1831
|
}
|
|
1832
|
+
/** @permissionScope Manage Stores - all permissions
|
|
1833
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1834
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1835
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1836
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1837
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1838
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1839
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1840
|
+
* @permissionScope Picasso private app mega scope
|
|
1841
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1842
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1843
|
+
* @webhook
|
|
1844
|
+
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
|
|
1845
|
+
* @slug updated
|
|
1846
|
+
* @documentationMaturity preview
|
|
1847
|
+
*/
|
|
1848
|
+
export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
|
|
1849
|
+
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`;
|
|
1850
|
+
/**
|
|
1851
|
+
* Retrieves a SubscriptionContract.
|
|
1852
|
+
* @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
|
|
1853
|
+
* @public
|
|
1854
|
+
* @documentationMaturity preview
|
|
1855
|
+
* @requiredField subscriptionContractId
|
|
1856
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1857
|
+
* @permissionScope Manage Stores - all permissions
|
|
1858
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1859
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1860
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1861
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1862
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1863
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1864
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1865
|
+
* @permissionScope Picasso private app mega scope
|
|
1866
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1867
|
+
* @applicableIdentity APP
|
|
1868
|
+
* @returns The requested SubscriptionContract.
|
|
1869
|
+
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
1870
|
+
*/
|
|
1871
|
+
export declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, SubscriptionContractNonNullablePaths>>;
|
|
1872
|
+
/**
|
|
1873
|
+
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
1874
|
+
*
|
|
1875
|
+
* Up to 300 SubscriptionContracts can be returned per request.
|
|
1876
|
+
*
|
|
1877
|
+
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
1878
|
+
*
|
|
1879
|
+
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
1880
|
+
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
1881
|
+
* @public
|
|
1882
|
+
* @documentationMaturity preview
|
|
1883
|
+
* @permissionScope Manage Stores - all permissions
|
|
1884
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1885
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
1886
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1887
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
1888
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1889
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
1890
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1891
|
+
* @permissionScope Picasso private app mega scope
|
|
1892
|
+
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1893
|
+
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1894
|
+
* @applicableIdentity APP
|
|
1895
|
+
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
|
|
1896
|
+
*/
|
|
1897
|
+
export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
|
|
1797
1898
|
interface QueryCursorResult {
|
|
1798
1899
|
cursors: Cursors;
|
|
1799
1900
|
hasNext: () => boolean;
|
|
@@ -1801,13 +1902,13 @@ interface QueryCursorResult {
|
|
|
1801
1902
|
length: number;
|
|
1802
1903
|
pageSize: number;
|
|
1803
1904
|
}
|
|
1804
|
-
interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1905
|
+
export interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1805
1906
|
items: SubscriptionContract[];
|
|
1806
1907
|
query: SubscriptionContractsQueryBuilder;
|
|
1807
1908
|
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
1808
1909
|
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
1809
1910
|
}
|
|
1810
|
-
interface SubscriptionContractsQueryBuilder {
|
|
1911
|
+
export interface SubscriptionContractsQueryBuilder {
|
|
1811
1912
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1812
1913
|
* @param value - Value to compare against.
|
|
1813
1914
|
* @documentationMaturity preview
|
|
@@ -1851,5 +1952,4 @@ interface SubscriptionContractsQueryBuilder {
|
|
|
1851
1952
|
/** @documentationMaturity preview */
|
|
1852
1953
|
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
1853
1954
|
}
|
|
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 };
|
|
1955
|
+
export {};
|