@wix/auto_sdk_ecom_subscription-contracts 1.0.33 → 1.0.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-BwexlKIz.d.mts} +135 -227
- package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-BwexlKIz.d.ts} +135 -227
- package/build/index.d.mts +41 -0
- package/build/index.d.ts +41 -0
- package/build/index.js +659 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +615 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-DaM0yN7N.d.mts} +135 -227
- package/build/internal/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.d.ts → ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal-DaM0yN7N.d.ts} +135 -227
- package/build/internal/index.d.mts +41 -0
- package/build/internal/index.d.ts +41 -0
- package/build/internal/index.js +659 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +615 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → internal/meta.d.mts} +111 -479
- package/build/{es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → internal/meta.d.ts} +111 -479
- package/build/internal/meta.js +257 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +229 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.mts} +111 -479
- package/build/{internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.d.ts → meta.d.ts} +111 -479
- package/build/meta.js +257 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +229 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -338
- package/build/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -310
- package/build/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -35
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -198
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -66
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -153
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -161
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -338
- package/build/internal/cjs/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.d.ts +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.context.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.d.ts +0 -14
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js +0 -193
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.http.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.d.ts +0 -16
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js +0 -38
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.meta.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.d.ts +0 -32
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js +0 -132
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.public.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js +0 -158
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.types.js.map +0 -1
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js +0 -310
- package/build/internal/es/src/ecom-subscription-contracts-v1-subscription-contract-subscription-contracts.universal.js.map +0 -1
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A SubscriptionContract is a ...
|
|
4
3
|
* You can ...
|
|
5
4
|
* Read more about SubscriptionContracts
|
|
6
5
|
* in this [article](<LINK_TO_KB_ARTICLE>).
|
|
7
6
|
*/
|
|
8
|
-
|
|
7
|
+
interface SubscriptionContract {
|
|
9
8
|
/**
|
|
10
9
|
* SubscriptionContract ID.
|
|
11
10
|
* @format GUID
|
|
@@ -127,7 +126,7 @@ export interface SubscriptionContract {
|
|
|
127
126
|
*/
|
|
128
127
|
additionalFees?: AdditionalFee[];
|
|
129
128
|
}
|
|
130
|
-
|
|
129
|
+
interface V1SubscriptionDescription {
|
|
131
130
|
/**
|
|
132
131
|
* Subscription option description.
|
|
133
132
|
* @maxLength 500
|
|
@@ -139,7 +138,7 @@ export interface V1SubscriptionDescription {
|
|
|
139
138
|
*/
|
|
140
139
|
translated?: string | null;
|
|
141
140
|
}
|
|
142
|
-
|
|
141
|
+
interface V1SubscriptionSettings {
|
|
143
142
|
/** Frequency of recurring payment. */
|
|
144
143
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
145
144
|
/**
|
|
@@ -165,7 +164,7 @@ export interface V1SubscriptionSettings {
|
|
|
165
164
|
*/
|
|
166
165
|
startDate?: Date | null;
|
|
167
166
|
}
|
|
168
|
-
|
|
167
|
+
declare enum SubscriptionFrequency {
|
|
169
168
|
UNDEFINED = "UNDEFINED",
|
|
170
169
|
DAY = "DAY",
|
|
171
170
|
WEEK = "WEEK",
|
|
@@ -173,8 +172,8 @@ export declare enum SubscriptionFrequency {
|
|
|
173
172
|
YEAR = "YEAR"
|
|
174
173
|
}
|
|
175
174
|
/** @enumType */
|
|
176
|
-
|
|
177
|
-
|
|
175
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
176
|
+
interface V1FreeTrialPeriod {
|
|
178
177
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
179
178
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
180
179
|
/**
|
|
@@ -184,7 +183,7 @@ export interface V1FreeTrialPeriod {
|
|
|
184
183
|
*/
|
|
185
184
|
interval?: number;
|
|
186
185
|
}
|
|
187
|
-
|
|
186
|
+
interface OrderLineItem {
|
|
188
187
|
/**
|
|
189
188
|
* Line item ID.
|
|
190
189
|
* @immutable
|
|
@@ -316,7 +315,7 @@ export interface OrderLineItem {
|
|
|
316
315
|
*/
|
|
317
316
|
modifierGroups?: ModifierGroup[];
|
|
318
317
|
}
|
|
319
|
-
|
|
318
|
+
interface ProductName {
|
|
320
319
|
/**
|
|
321
320
|
* __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).
|
|
322
321
|
*
|
|
@@ -338,7 +337,7 @@ export interface ProductName {
|
|
|
338
337
|
translated?: string | null;
|
|
339
338
|
}
|
|
340
339
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
341
|
-
|
|
340
|
+
interface CatalogReference {
|
|
342
341
|
/**
|
|
343
342
|
* ID of the item within the catalog it belongs to.
|
|
344
343
|
* @minLength 1
|
|
@@ -364,7 +363,7 @@ export interface CatalogReference {
|
|
|
364
363
|
*/
|
|
365
364
|
options?: Record<string, any> | null;
|
|
366
365
|
}
|
|
367
|
-
|
|
366
|
+
interface Price {
|
|
368
367
|
/**
|
|
369
368
|
* Amount.
|
|
370
369
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -376,7 +375,7 @@ export interface Price {
|
|
|
376
375
|
*/
|
|
377
376
|
formattedAmount?: string;
|
|
378
377
|
}
|
|
379
|
-
|
|
378
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
380
379
|
/** Description line plain text value. */
|
|
381
380
|
plainText?: PlainTextValue;
|
|
382
381
|
/** Description line color value. */
|
|
@@ -390,16 +389,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
390
389
|
modifierDescriptionLine?: boolean;
|
|
391
390
|
}
|
|
392
391
|
/** @oneof */
|
|
393
|
-
|
|
392
|
+
interface DescriptionLineValueOneOf {
|
|
394
393
|
/** Description line plain text value. */
|
|
395
394
|
plainText?: PlainTextValue;
|
|
396
395
|
/** Description line color value. */
|
|
397
396
|
colorInfo?: Color;
|
|
398
397
|
}
|
|
399
398
|
/** @oneof */
|
|
400
|
-
|
|
399
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface DescriptionLineName {
|
|
403
402
|
/**
|
|
404
403
|
* 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).
|
|
405
404
|
* @maxLength 100
|
|
@@ -413,7 +412,7 @@ export interface DescriptionLineName {
|
|
|
413
412
|
*/
|
|
414
413
|
translated?: string | null;
|
|
415
414
|
}
|
|
416
|
-
|
|
415
|
+
interface PlainTextValue {
|
|
417
416
|
/**
|
|
418
417
|
* 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).
|
|
419
418
|
* @maxLength 600
|
|
@@ -427,7 +426,7 @@ export interface PlainTextValue {
|
|
|
427
426
|
*/
|
|
428
427
|
translated?: string | null;
|
|
429
428
|
}
|
|
430
|
-
|
|
429
|
+
interface Color {
|
|
431
430
|
/**
|
|
432
431
|
* 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).
|
|
433
432
|
* @maxLength 500
|
|
@@ -443,7 +442,7 @@ export interface Color {
|
|
|
443
442
|
/** HEX or RGB color code for display. */
|
|
444
443
|
code?: string | null;
|
|
445
444
|
}
|
|
446
|
-
|
|
445
|
+
declare enum DescriptionLineType {
|
|
447
446
|
/** Unrecognized type. */
|
|
448
447
|
UNRECOGNISED = "UNRECOGNISED",
|
|
449
448
|
/** Plain text type. */
|
|
@@ -451,9 +450,7 @@ export declare enum DescriptionLineType {
|
|
|
451
450
|
/** Color type. */
|
|
452
451
|
COLOR = "COLOR"
|
|
453
452
|
}
|
|
454
|
-
|
|
455
|
-
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
456
|
-
export interface FocalPoint {
|
|
453
|
+
interface FocalPoint {
|
|
457
454
|
/** X-coordinate of the focal point. */
|
|
458
455
|
x?: number;
|
|
459
456
|
/** Y-coordinate of the focal point. */
|
|
@@ -463,7 +460,7 @@ export interface FocalPoint {
|
|
|
463
460
|
/** crop by width */
|
|
464
461
|
width?: number | null;
|
|
465
462
|
}
|
|
466
|
-
|
|
463
|
+
interface PhysicalProperties {
|
|
467
464
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
468
465
|
weight?: number | null;
|
|
469
466
|
/**
|
|
@@ -474,20 +471,20 @@ export interface PhysicalProperties {
|
|
|
474
471
|
/** Whether this line item is shippable. */
|
|
475
472
|
shippable?: boolean;
|
|
476
473
|
}
|
|
477
|
-
|
|
474
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
478
475
|
/** Preset item type. */
|
|
479
476
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
480
477
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
481
478
|
custom?: string;
|
|
482
479
|
}
|
|
483
480
|
/** @oneof */
|
|
484
|
-
|
|
481
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
485
482
|
/** Preset item type. */
|
|
486
483
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
487
484
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
488
485
|
custom?: string;
|
|
489
486
|
}
|
|
490
|
-
|
|
487
|
+
declare enum ItemTypeItemType {
|
|
491
488
|
UNRECOGNISED = "UNRECOGNISED",
|
|
492
489
|
PHYSICAL = "PHYSICAL",
|
|
493
490
|
DIGITAL = "DIGITAL",
|
|
@@ -495,9 +492,9 @@ export declare enum ItemTypeItemType {
|
|
|
495
492
|
SERVICE = "SERVICE"
|
|
496
493
|
}
|
|
497
494
|
/** @enumType */
|
|
498
|
-
|
|
495
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
499
496
|
/** Type of selected payment option for catalog item */
|
|
500
|
-
|
|
497
|
+
declare enum PaymentOptionType {
|
|
501
498
|
/** The entire payment for this item happens as part of the checkout. */
|
|
502
499
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
503
500
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -510,8 +507,8 @@ export declare enum PaymentOptionType {
|
|
|
510
507
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
511
508
|
}
|
|
512
509
|
/** @enumType */
|
|
513
|
-
|
|
514
|
-
|
|
510
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
511
|
+
interface ItemTaxFullDetails {
|
|
515
512
|
/** Taxable amount of this line item. */
|
|
516
513
|
taxableAmount?: Price;
|
|
517
514
|
/**
|
|
@@ -522,7 +519,7 @@ export interface ItemTaxFullDetails {
|
|
|
522
519
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
523
520
|
totalTax?: Price;
|
|
524
521
|
}
|
|
525
|
-
|
|
522
|
+
interface LineItemTaxInfo {
|
|
526
523
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
527
524
|
taxAmount?: Price;
|
|
528
525
|
/** Amount for which tax is calculated. */
|
|
@@ -550,7 +547,7 @@ export interface LineItemTaxInfo {
|
|
|
550
547
|
* TaxBreakdown represents tax information for a line item.
|
|
551
548
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
552
549
|
*/
|
|
553
|
-
|
|
550
|
+
interface LineItemTaxBreakdown {
|
|
554
551
|
/**
|
|
555
552
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
556
553
|
* @maxLength 200
|
|
@@ -583,7 +580,7 @@ export interface LineItemTaxBreakdown {
|
|
|
583
580
|
taxableAmount?: Price;
|
|
584
581
|
}
|
|
585
582
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
586
|
-
|
|
583
|
+
declare enum JurisdictionType {
|
|
587
584
|
UNDEFINED = "UNDEFINED",
|
|
588
585
|
COUNTRY = "COUNTRY",
|
|
589
586
|
STATE = "STATE",
|
|
@@ -592,8 +589,8 @@ export declare enum JurisdictionType {
|
|
|
592
589
|
SPECIAL = "SPECIAL"
|
|
593
590
|
}
|
|
594
591
|
/** @enumType */
|
|
595
|
-
|
|
596
|
-
|
|
592
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
593
|
+
interface DigitalFile {
|
|
597
594
|
/**
|
|
598
595
|
* ID of the secure file in media.
|
|
599
596
|
* @minLength 1
|
|
@@ -613,7 +610,7 @@ export interface DigitalFile {
|
|
|
613
610
|
*/
|
|
614
611
|
expirationDate?: Date | null;
|
|
615
612
|
}
|
|
616
|
-
|
|
613
|
+
interface SubscriptionInfo {
|
|
617
614
|
/**
|
|
618
615
|
* Subscription ID.
|
|
619
616
|
* @format GUID
|
|
@@ -666,7 +663,7 @@ export interface SubscriptionInfo {
|
|
|
666
663
|
*/
|
|
667
664
|
billingAdjustment?: BillingAdjustment;
|
|
668
665
|
}
|
|
669
|
-
|
|
666
|
+
interface SubscriptionTitle {
|
|
670
667
|
/**
|
|
671
668
|
* 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).
|
|
672
669
|
* @minLength 1
|
|
@@ -682,7 +679,7 @@ export interface SubscriptionTitle {
|
|
|
682
679
|
*/
|
|
683
680
|
translated?: string | null;
|
|
684
681
|
}
|
|
685
|
-
|
|
682
|
+
interface SubscriptionDescription {
|
|
686
683
|
/**
|
|
687
684
|
* Subscription option description.
|
|
688
685
|
* @maxLength 500
|
|
@@ -694,7 +691,7 @@ export interface SubscriptionDescription {
|
|
|
694
691
|
*/
|
|
695
692
|
translated?: string | null;
|
|
696
693
|
}
|
|
697
|
-
|
|
694
|
+
interface SubscriptionSettings {
|
|
698
695
|
/** Frequency of recurring payment. */
|
|
699
696
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
700
697
|
/**
|
|
@@ -721,7 +718,7 @@ export interface SubscriptionSettings {
|
|
|
721
718
|
startDate?: Date | null;
|
|
722
719
|
}
|
|
723
720
|
/** Frequency unit of recurring payment */
|
|
724
|
-
|
|
721
|
+
declare enum V2SubscriptionFrequency {
|
|
725
722
|
UNDEFINED = "UNDEFINED",
|
|
726
723
|
DAY = "DAY",
|
|
727
724
|
WEEK = "WEEK",
|
|
@@ -729,8 +726,8 @@ export declare enum V2SubscriptionFrequency {
|
|
|
729
726
|
YEAR = "YEAR"
|
|
730
727
|
}
|
|
731
728
|
/** @enumType */
|
|
732
|
-
|
|
733
|
-
|
|
729
|
+
type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
730
|
+
interface FreeTrialPeriod {
|
|
734
731
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
735
732
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
736
733
|
/**
|
|
@@ -740,13 +737,13 @@ export interface FreeTrialPeriod {
|
|
|
740
737
|
*/
|
|
741
738
|
interval?: number;
|
|
742
739
|
}
|
|
743
|
-
|
|
740
|
+
interface BillingAdjustment {
|
|
744
741
|
/** The type of adjustment. */
|
|
745
742
|
type?: AdjustmentTypeWithLiterals;
|
|
746
743
|
/** Summary of the prorated adjustment amount. */
|
|
747
744
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
748
745
|
}
|
|
749
|
-
|
|
746
|
+
declare enum AdjustmentType {
|
|
750
747
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
751
748
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
752
749
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
@@ -754,8 +751,8 @@ export declare enum AdjustmentType {
|
|
|
754
751
|
CREDIT = "CREDIT"
|
|
755
752
|
}
|
|
756
753
|
/** @enumType */
|
|
757
|
-
|
|
758
|
-
|
|
754
|
+
type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
755
|
+
interface BillingAdjustmentPriceSummary {
|
|
759
756
|
/** Subtotal of adjustment, before tax. */
|
|
760
757
|
subtotal?: Price;
|
|
761
758
|
/** Tax on adjustment. */
|
|
@@ -763,7 +760,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
763
760
|
/** Total price after tax. */
|
|
764
761
|
total?: Price;
|
|
765
762
|
}
|
|
766
|
-
|
|
763
|
+
interface PriceDescription {
|
|
767
764
|
/**
|
|
768
765
|
* __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).
|
|
769
766
|
* @minLength 1
|
|
@@ -779,7 +776,7 @@ export interface PriceDescription {
|
|
|
779
776
|
*/
|
|
780
777
|
translated?: string | null;
|
|
781
778
|
}
|
|
782
|
-
|
|
779
|
+
interface LocationAndQuantity {
|
|
783
780
|
/**
|
|
784
781
|
* Location id in the associated owner app.
|
|
785
782
|
* @format GUID
|
|
@@ -805,24 +802,24 @@ export interface LocationAndQuantity {
|
|
|
805
802
|
*/
|
|
806
803
|
name?: string | null;
|
|
807
804
|
}
|
|
808
|
-
|
|
805
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
809
806
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
810
807
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
811
808
|
}
|
|
812
809
|
/** @oneof */
|
|
813
|
-
|
|
810
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
814
811
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
815
812
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
816
813
|
}
|
|
817
|
-
|
|
814
|
+
declare enum TaxableAddressType {
|
|
818
815
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
819
816
|
BUSINESS = "BUSINESS",
|
|
820
817
|
BILLING = "BILLING",
|
|
821
818
|
SHIPPING = "SHIPPING"
|
|
822
819
|
}
|
|
823
820
|
/** @enumType */
|
|
824
|
-
|
|
825
|
-
|
|
821
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
822
|
+
interface ExtendedFields {
|
|
826
823
|
/**
|
|
827
824
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
828
825
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -833,7 +830,7 @@ export interface ExtendedFields {
|
|
|
833
830
|
*/
|
|
834
831
|
namespaces?: Record<string, Record<string, any>>;
|
|
835
832
|
}
|
|
836
|
-
|
|
833
|
+
interface ModifierGroup {
|
|
837
834
|
/**
|
|
838
835
|
* Modifier group id.
|
|
839
836
|
* @minLength 1
|
|
@@ -849,7 +846,7 @@ export interface ModifierGroup {
|
|
|
849
846
|
*/
|
|
850
847
|
modifiers?: ItemModifier[];
|
|
851
848
|
}
|
|
852
|
-
|
|
849
|
+
interface TranslatableString {
|
|
853
850
|
/**
|
|
854
851
|
* __Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
855
852
|
*
|
|
@@ -870,7 +867,7 @@ export interface TranslatableString {
|
|
|
870
867
|
*/
|
|
871
868
|
translated?: string | null;
|
|
872
869
|
}
|
|
873
|
-
|
|
870
|
+
interface ItemModifier {
|
|
874
871
|
/**
|
|
875
872
|
* Modifier ID.
|
|
876
873
|
* @minLength 1
|
|
@@ -891,7 +888,7 @@ export interface ItemModifier {
|
|
|
891
888
|
price?: Price;
|
|
892
889
|
}
|
|
893
890
|
/** Buyer Info */
|
|
894
|
-
|
|
891
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
895
892
|
/**
|
|
896
893
|
* Visitor ID (if site visitor is not a member).
|
|
897
894
|
* @format GUID
|
|
@@ -914,7 +911,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
914
911
|
email?: string | null;
|
|
915
912
|
}
|
|
916
913
|
/** @oneof */
|
|
917
|
-
|
|
914
|
+
interface BuyerInfoIdOneOf {
|
|
918
915
|
/**
|
|
919
916
|
* Visitor ID (if site visitor is not a member).
|
|
920
917
|
* @format GUID
|
|
@@ -926,7 +923,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
926
923
|
*/
|
|
927
924
|
memberId?: string;
|
|
928
925
|
}
|
|
929
|
-
|
|
926
|
+
declare enum WeightUnit {
|
|
930
927
|
/** Weight unit can't be classified due to an error. */
|
|
931
928
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
932
929
|
/** Kilograms. */
|
|
@@ -935,8 +932,8 @@ export declare enum WeightUnit {
|
|
|
935
932
|
LB = "LB"
|
|
936
933
|
}
|
|
937
934
|
/** @enumType */
|
|
938
|
-
|
|
939
|
-
|
|
935
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
936
|
+
interface CurrencyConversionDetails {
|
|
940
937
|
/**
|
|
941
938
|
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
942
939
|
*
|
|
@@ -954,7 +951,7 @@ export interface CurrencyConversionDetails {
|
|
|
954
951
|
*/
|
|
955
952
|
conversionRate?: string | null;
|
|
956
953
|
}
|
|
957
|
-
|
|
954
|
+
interface PriceSummary {
|
|
958
955
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
959
956
|
subtotal?: Price;
|
|
960
957
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -969,14 +966,14 @@ export interface PriceSummary {
|
|
|
969
966
|
totalAdditionalFees?: Price;
|
|
970
967
|
}
|
|
971
968
|
/** Billing Info and shipping details */
|
|
972
|
-
|
|
969
|
+
interface AddressWithContact {
|
|
973
970
|
/** Address. */
|
|
974
971
|
address?: Address;
|
|
975
972
|
/** Contact details. */
|
|
976
973
|
contactDetails?: FullAddressContactDetails;
|
|
977
974
|
}
|
|
978
975
|
/** Physical address */
|
|
979
|
-
|
|
976
|
+
interface Address {
|
|
980
977
|
/**
|
|
981
978
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
982
979
|
* @format COUNTRY
|
|
@@ -1020,20 +1017,20 @@ export interface Address {
|
|
|
1020
1017
|
*/
|
|
1021
1018
|
subdivisionFullname?: string | null;
|
|
1022
1019
|
}
|
|
1023
|
-
|
|
1020
|
+
interface StreetAddress {
|
|
1024
1021
|
/** Street number. */
|
|
1025
1022
|
number?: string;
|
|
1026
1023
|
/** Street name. */
|
|
1027
1024
|
name?: string;
|
|
1028
1025
|
}
|
|
1029
|
-
|
|
1026
|
+
interface AddressLocation {
|
|
1030
1027
|
/** Address latitude. */
|
|
1031
1028
|
latitude?: number | null;
|
|
1032
1029
|
/** Address longitude. */
|
|
1033
1030
|
longitude?: number | null;
|
|
1034
1031
|
}
|
|
1035
1032
|
/** Full contact details for an address */
|
|
1036
|
-
|
|
1033
|
+
interface FullAddressContactDetails {
|
|
1037
1034
|
/**
|
|
1038
1035
|
* First name.
|
|
1039
1036
|
* @maxLength 100
|
|
@@ -1057,7 +1054,7 @@ export interface FullAddressContactDetails {
|
|
|
1057
1054
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1058
1055
|
vatId?: VatId;
|
|
1059
1056
|
}
|
|
1060
|
-
|
|
1057
|
+
interface VatId {
|
|
1061
1058
|
/** Customer's tax ID. */
|
|
1062
1059
|
_id?: string;
|
|
1063
1060
|
/**
|
|
@@ -1070,7 +1067,7 @@ export interface VatId {
|
|
|
1070
1067
|
type?: VatTypeWithLiterals;
|
|
1071
1068
|
}
|
|
1072
1069
|
/** tax info types */
|
|
1073
|
-
|
|
1070
|
+
declare enum VatType {
|
|
1074
1071
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1075
1072
|
/** CPF - for individual tax payers. */
|
|
1076
1073
|
CPF = "CPF",
|
|
@@ -1078,8 +1075,8 @@ export declare enum VatType {
|
|
|
1078
1075
|
CNPJ = "CNPJ"
|
|
1079
1076
|
}
|
|
1080
1077
|
/** @enumType */
|
|
1081
|
-
|
|
1082
|
-
|
|
1078
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1079
|
+
interface ShippingInformation {
|
|
1083
1080
|
/**
|
|
1084
1081
|
* App Def Id of external provider which was a source of shipping info
|
|
1085
1082
|
* @minLength 1
|
|
@@ -1105,7 +1102,7 @@ export interface ShippingInformation {
|
|
|
1105
1102
|
/** Shipping region. */
|
|
1106
1103
|
region?: ShippingRegion;
|
|
1107
1104
|
}
|
|
1108
|
-
|
|
1105
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1109
1106
|
/** Shipping address and contact details. */
|
|
1110
1107
|
shippingDestination?: AddressWithContact;
|
|
1111
1108
|
/** Pickup details. */
|
|
@@ -1129,20 +1126,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1129
1126
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1130
1127
|
}
|
|
1131
1128
|
/** @oneof */
|
|
1132
|
-
|
|
1129
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1133
1130
|
/** Shipping address and contact details. */
|
|
1134
1131
|
shippingDestination?: AddressWithContact;
|
|
1135
1132
|
/** Pickup details. */
|
|
1136
1133
|
pickupDetails?: PickupDetails;
|
|
1137
1134
|
}
|
|
1138
|
-
|
|
1135
|
+
interface PickupDetails {
|
|
1139
1136
|
/** Pickup address. */
|
|
1140
1137
|
address?: PickupAddress;
|
|
1141
1138
|
/** Pickup method */
|
|
1142
1139
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1143
1140
|
}
|
|
1144
1141
|
/** Physical address */
|
|
1145
|
-
|
|
1142
|
+
interface PickupAddress {
|
|
1146
1143
|
/**
|
|
1147
1144
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1148
1145
|
* @format COUNTRY
|
|
@@ -1186,20 +1183,20 @@ export interface PickupAddress {
|
|
|
1186
1183
|
*/
|
|
1187
1184
|
subdivisionFullname?: string | null;
|
|
1188
1185
|
}
|
|
1189
|
-
|
|
1186
|
+
declare enum PickupMethod {
|
|
1190
1187
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1191
1188
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1192
1189
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1193
1190
|
}
|
|
1194
1191
|
/** @enumType */
|
|
1195
|
-
|
|
1196
|
-
|
|
1192
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1193
|
+
interface DeliveryTimeSlot {
|
|
1197
1194
|
/** Delivery slot starting time. */
|
|
1198
1195
|
from?: Date | null;
|
|
1199
1196
|
/** Delivery slot ending time. */
|
|
1200
1197
|
to?: Date | null;
|
|
1201
1198
|
}
|
|
1202
|
-
|
|
1199
|
+
interface ShippingPrice {
|
|
1203
1200
|
/** Shipping price for display purposes. */
|
|
1204
1201
|
price?: Price;
|
|
1205
1202
|
/**
|
|
@@ -1220,14 +1217,14 @@ export interface ShippingPrice {
|
|
|
1220
1217
|
*/
|
|
1221
1218
|
discount?: Price;
|
|
1222
1219
|
}
|
|
1223
|
-
|
|
1220
|
+
interface ShippingRegion {
|
|
1224
1221
|
/**
|
|
1225
1222
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1226
1223
|
* @maxLength 100
|
|
1227
1224
|
*/
|
|
1228
1225
|
name?: string | null;
|
|
1229
1226
|
}
|
|
1230
|
-
|
|
1227
|
+
interface OrderTaxInfo {
|
|
1231
1228
|
/** Calculated tax, added from line items. */
|
|
1232
1229
|
totalTax?: Price;
|
|
1233
1230
|
/**
|
|
@@ -1247,7 +1244,7 @@ export interface OrderTaxInfo {
|
|
|
1247
1244
|
* 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.
|
|
1248
1245
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1249
1246
|
*/
|
|
1250
|
-
|
|
1247
|
+
interface OrderTaxBreakdown {
|
|
1251
1248
|
/**
|
|
1252
1249
|
* The name of the tax against which this tax amount was calculated.
|
|
1253
1250
|
* @maxLength 200
|
|
@@ -1274,7 +1271,7 @@ export interface OrderTaxBreakdown {
|
|
|
1274
1271
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1275
1272
|
aggregatedTaxAmount?: Price;
|
|
1276
1273
|
}
|
|
1277
|
-
|
|
1274
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1278
1275
|
/** Applied coupon info. */
|
|
1279
1276
|
coupon?: Coupon;
|
|
1280
1277
|
/** Merchant discount. */
|
|
@@ -1315,7 +1312,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1315
1312
|
subscriptionCycles?: number | null;
|
|
1316
1313
|
}
|
|
1317
1314
|
/** @oneof */
|
|
1318
|
-
|
|
1315
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1319
1316
|
/** Applied coupon info. */
|
|
1320
1317
|
coupon?: Coupon;
|
|
1321
1318
|
/** Merchant discount. */
|
|
@@ -1323,15 +1320,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1323
1320
|
/** Automatic Discount */
|
|
1324
1321
|
discountRule?: DiscountRule;
|
|
1325
1322
|
}
|
|
1326
|
-
|
|
1323
|
+
declare enum DiscountType {
|
|
1327
1324
|
GLOBAL = "GLOBAL",
|
|
1328
1325
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1329
1326
|
SHIPPING = "SHIPPING"
|
|
1330
1327
|
}
|
|
1331
1328
|
/** @enumType */
|
|
1332
|
-
|
|
1329
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1333
1330
|
/** Coupon */
|
|
1334
|
-
|
|
1331
|
+
interface Coupon {
|
|
1335
1332
|
/** Coupon ID. */
|
|
1336
1333
|
_id?: string;
|
|
1337
1334
|
/** Coupon code. */
|
|
@@ -1341,7 +1338,7 @@ export interface Coupon {
|
|
|
1341
1338
|
/** Coupon value. */
|
|
1342
1339
|
amount?: Price;
|
|
1343
1340
|
}
|
|
1344
|
-
|
|
1341
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1345
1342
|
/**
|
|
1346
1343
|
* Pre-defined discount reason (optional).
|
|
1347
1344
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1363,7 +1360,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1363
1360
|
percentage?: string | null;
|
|
1364
1361
|
}
|
|
1365
1362
|
/** @oneof */
|
|
1366
|
-
|
|
1363
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1367
1364
|
/**
|
|
1368
1365
|
* Pre-defined discount reason (optional).
|
|
1369
1366
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1375,14 +1372,14 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1375
1372
|
*/
|
|
1376
1373
|
description?: string | null;
|
|
1377
1374
|
}
|
|
1378
|
-
|
|
1375
|
+
declare enum DiscountReason {
|
|
1379
1376
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1380
1377
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1381
1378
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1382
1379
|
}
|
|
1383
1380
|
/** @enumType */
|
|
1384
|
-
|
|
1385
|
-
|
|
1381
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1382
|
+
interface DiscountRule {
|
|
1386
1383
|
/**
|
|
1387
1384
|
* Discount rule ID
|
|
1388
1385
|
* @format GUID
|
|
@@ -1393,7 +1390,7 @@ export interface DiscountRule {
|
|
|
1393
1390
|
/** Discount value. */
|
|
1394
1391
|
amount?: Price;
|
|
1395
1392
|
}
|
|
1396
|
-
|
|
1393
|
+
interface DiscountRuleName {
|
|
1397
1394
|
/**
|
|
1398
1395
|
* Original discount rule name (in site's default language).
|
|
1399
1396
|
* @minLength 1
|
|
@@ -1407,7 +1404,7 @@ export interface DiscountRuleName {
|
|
|
1407
1404
|
*/
|
|
1408
1405
|
translated?: string | null;
|
|
1409
1406
|
}
|
|
1410
|
-
|
|
1407
|
+
interface LineItemDiscount {
|
|
1411
1408
|
/**
|
|
1412
1409
|
* ID of line item the discount applies to.
|
|
1413
1410
|
* @format GUID
|
|
@@ -1416,7 +1413,7 @@ export interface LineItemDiscount {
|
|
|
1416
1413
|
/** Total discount for this line item. */
|
|
1417
1414
|
totalDiscount?: Price;
|
|
1418
1415
|
}
|
|
1419
|
-
|
|
1416
|
+
interface ChannelInfo {
|
|
1420
1417
|
/** Sales channel that submitted the order. */
|
|
1421
1418
|
type?: ChannelTypeWithLiterals;
|
|
1422
1419
|
/**
|
|
@@ -1430,7 +1427,7 @@ export interface ChannelInfo {
|
|
|
1430
1427
|
*/
|
|
1431
1428
|
externalOrderUrl?: string | null;
|
|
1432
1429
|
}
|
|
1433
|
-
|
|
1430
|
+
declare enum ChannelType {
|
|
1434
1431
|
/** Unspecified sales channel. This value is not supported. */
|
|
1435
1432
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1436
1433
|
/** A web client. */
|
|
@@ -1465,8 +1462,8 @@ export declare enum ChannelType {
|
|
|
1465
1462
|
FAIRE_COM = "FAIRE_COM"
|
|
1466
1463
|
}
|
|
1467
1464
|
/** @enumType */
|
|
1468
|
-
|
|
1469
|
-
|
|
1465
|
+
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
1466
|
+
interface CustomField {
|
|
1470
1467
|
/** Custom field value. */
|
|
1471
1468
|
value?: any;
|
|
1472
1469
|
/**
|
|
@@ -1482,7 +1479,7 @@ export interface CustomField {
|
|
|
1482
1479
|
*/
|
|
1483
1480
|
translatedTitle?: string | null;
|
|
1484
1481
|
}
|
|
1485
|
-
|
|
1482
|
+
interface V1SubscriptionTitle {
|
|
1486
1483
|
/**
|
|
1487
1484
|
* 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).
|
|
1488
1485
|
* @minLength 1
|
|
@@ -1498,7 +1495,7 @@ export interface V1SubscriptionTitle {
|
|
|
1498
1495
|
*/
|
|
1499
1496
|
translated?: string | null;
|
|
1500
1497
|
}
|
|
1501
|
-
|
|
1498
|
+
interface AdditionalFee {
|
|
1502
1499
|
/**
|
|
1503
1500
|
* Additional fee's unique code for future processing.
|
|
1504
1501
|
* @minLength 1
|
|
@@ -1545,7 +1542,7 @@ export interface AdditionalFee {
|
|
|
1545
1542
|
*/
|
|
1546
1543
|
subscriptionCycles?: number | null;
|
|
1547
1544
|
}
|
|
1548
|
-
|
|
1545
|
+
interface Location {
|
|
1549
1546
|
/**
|
|
1550
1547
|
* Location ID.
|
|
1551
1548
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -1560,38 +1557,38 @@ export interface Location {
|
|
|
1560
1557
|
*/
|
|
1561
1558
|
name?: string;
|
|
1562
1559
|
}
|
|
1563
|
-
|
|
1560
|
+
interface CreateSubscriptionContractRequest {
|
|
1564
1561
|
/** SubscriptionContract to be created. */
|
|
1565
1562
|
subscriptionContract?: SubscriptionContract;
|
|
1566
1563
|
}
|
|
1567
|
-
|
|
1564
|
+
interface CreateSubscriptionContractResponse {
|
|
1568
1565
|
/** The created SubscriptionContract. */
|
|
1569
1566
|
subscriptionContract?: SubscriptionContract;
|
|
1570
1567
|
}
|
|
1571
|
-
|
|
1568
|
+
interface GetSubscriptionContractRequest {
|
|
1572
1569
|
/**
|
|
1573
1570
|
* ID of the SubscriptionContract to retrieve.
|
|
1574
1571
|
* @format GUID
|
|
1575
1572
|
*/
|
|
1576
1573
|
subscriptionContractId: string;
|
|
1577
1574
|
}
|
|
1578
|
-
|
|
1575
|
+
interface GetSubscriptionContractResponse {
|
|
1579
1576
|
/** The requested SubscriptionContract. */
|
|
1580
1577
|
subscriptionContract?: SubscriptionContract;
|
|
1581
1578
|
}
|
|
1582
|
-
|
|
1579
|
+
interface UpdateSubscriptionContractRequest {
|
|
1583
1580
|
/** SubscriptionContract to be updated, may be partial. */
|
|
1584
1581
|
subscriptionContract?: SubscriptionContract;
|
|
1585
1582
|
}
|
|
1586
|
-
|
|
1583
|
+
interface UpdateSubscriptionContractResponse {
|
|
1587
1584
|
/** Updated SubscriptionContract. */
|
|
1588
1585
|
subscriptionContract?: SubscriptionContract;
|
|
1589
1586
|
}
|
|
1590
|
-
|
|
1587
|
+
interface QuerySubscriptionContractsRequest {
|
|
1591
1588
|
/** WQL expression. */
|
|
1592
1589
|
query?: CursorQuery;
|
|
1593
1590
|
}
|
|
1594
|
-
|
|
1591
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1595
1592
|
/** 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`. */
|
|
1596
1593
|
cursorPaging?: CursorPaging;
|
|
1597
1594
|
/**
|
|
@@ -1613,11 +1610,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1613
1610
|
sort?: Sorting[];
|
|
1614
1611
|
}
|
|
1615
1612
|
/** @oneof */
|
|
1616
|
-
|
|
1613
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1617
1614
|
/** 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`. */
|
|
1618
1615
|
cursorPaging?: CursorPaging;
|
|
1619
1616
|
}
|
|
1620
|
-
|
|
1617
|
+
interface Sorting {
|
|
1621
1618
|
/**
|
|
1622
1619
|
* Name of the field to sort by.
|
|
1623
1620
|
* @maxLength 512
|
|
@@ -1626,13 +1623,13 @@ export interface Sorting {
|
|
|
1626
1623
|
/** Sort order. */
|
|
1627
1624
|
order?: SortOrderWithLiterals;
|
|
1628
1625
|
}
|
|
1629
|
-
|
|
1626
|
+
declare enum SortOrder {
|
|
1630
1627
|
ASC = "ASC",
|
|
1631
1628
|
DESC = "DESC"
|
|
1632
1629
|
}
|
|
1633
1630
|
/** @enumType */
|
|
1634
|
-
|
|
1635
|
-
|
|
1631
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1632
|
+
interface CursorPaging {
|
|
1636
1633
|
/**
|
|
1637
1634
|
* Maximum number of items to return in the results.
|
|
1638
1635
|
* @max 100
|
|
@@ -1647,13 +1644,13 @@ export interface CursorPaging {
|
|
|
1647
1644
|
*/
|
|
1648
1645
|
cursor?: string | null;
|
|
1649
1646
|
}
|
|
1650
|
-
|
|
1647
|
+
interface QuerySubscriptionContractsResponse {
|
|
1651
1648
|
/** List of SubscriptionContracts. */
|
|
1652
1649
|
subscriptionContracts?: SubscriptionContract[];
|
|
1653
1650
|
/** Paging metadata */
|
|
1654
1651
|
pagingMetadata?: CursorPagingMetadata;
|
|
1655
1652
|
}
|
|
1656
|
-
|
|
1653
|
+
interface CursorPagingMetadata {
|
|
1657
1654
|
/** Number of items returned in the response. */
|
|
1658
1655
|
count?: number | null;
|
|
1659
1656
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1666,7 +1663,7 @@ export interface CursorPagingMetadata {
|
|
|
1666
1663
|
*/
|
|
1667
1664
|
hasNext?: boolean | null;
|
|
1668
1665
|
}
|
|
1669
|
-
|
|
1666
|
+
interface Cursors {
|
|
1670
1667
|
/**
|
|
1671
1668
|
* Cursor string pointing to the next page in the list of results.
|
|
1672
1669
|
* @maxLength 16000
|
|
@@ -1678,7 +1675,7 @@ export interface Cursors {
|
|
|
1678
1675
|
*/
|
|
1679
1676
|
prev?: string | null;
|
|
1680
1677
|
}
|
|
1681
|
-
|
|
1678
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1682
1679
|
createdEvent?: EntityCreatedEvent;
|
|
1683
1680
|
updatedEvent?: EntityUpdatedEvent;
|
|
1684
1681
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1713,19 +1710,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1713
1710
|
entityEventSequence?: string | null;
|
|
1714
1711
|
}
|
|
1715
1712
|
/** @oneof */
|
|
1716
|
-
|
|
1713
|
+
interface DomainEventBodyOneOf {
|
|
1717
1714
|
createdEvent?: EntityCreatedEvent;
|
|
1718
1715
|
updatedEvent?: EntityUpdatedEvent;
|
|
1719
1716
|
deletedEvent?: EntityDeletedEvent;
|
|
1720
1717
|
actionEvent?: ActionEvent;
|
|
1721
1718
|
}
|
|
1722
|
-
|
|
1719
|
+
interface EntityCreatedEvent {
|
|
1723
1720
|
entity?: string;
|
|
1724
1721
|
}
|
|
1725
|
-
|
|
1722
|
+
interface RestoreInfo {
|
|
1726
1723
|
deletedDate?: Date | null;
|
|
1727
1724
|
}
|
|
1728
|
-
|
|
1725
|
+
interface EntityUpdatedEvent {
|
|
1729
1726
|
/**
|
|
1730
1727
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1731
1728
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1733,16 +1730,16 @@ export interface EntityUpdatedEvent {
|
|
|
1733
1730
|
*/
|
|
1734
1731
|
currentEntity?: string;
|
|
1735
1732
|
}
|
|
1736
|
-
|
|
1733
|
+
interface EntityDeletedEvent {
|
|
1737
1734
|
/** Entity that was deleted. */
|
|
1738
1735
|
deletedEntity?: string | null;
|
|
1739
1736
|
}
|
|
1740
|
-
|
|
1737
|
+
interface ActionEvent {
|
|
1741
1738
|
body?: string;
|
|
1742
1739
|
}
|
|
1743
|
-
|
|
1740
|
+
interface Empty {
|
|
1744
1741
|
}
|
|
1745
|
-
|
|
1742
|
+
interface MessageEnvelope {
|
|
1746
1743
|
/**
|
|
1747
1744
|
* App instance ID.
|
|
1748
1745
|
* @format GUID
|
|
@@ -1758,7 +1755,7 @@ export interface MessageEnvelope {
|
|
|
1758
1755
|
/** Stringify payload. */
|
|
1759
1756
|
data?: string;
|
|
1760
1757
|
}
|
|
1761
|
-
|
|
1758
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1762
1759
|
/**
|
|
1763
1760
|
* ID of a site visitor that has not logged in to the site.
|
|
1764
1761
|
* @format GUID
|
|
@@ -1783,7 +1780,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1783
1780
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1784
1781
|
}
|
|
1785
1782
|
/** @oneof */
|
|
1786
|
-
|
|
1783
|
+
interface IdentificationDataIdOneOf {
|
|
1787
1784
|
/**
|
|
1788
1785
|
* ID of a site visitor that has not logged in to the site.
|
|
1789
1786
|
* @format GUID
|
|
@@ -1805,7 +1802,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1805
1802
|
*/
|
|
1806
1803
|
appId?: string;
|
|
1807
1804
|
}
|
|
1808
|
-
|
|
1805
|
+
declare enum WebhookIdentityType {
|
|
1809
1806
|
UNKNOWN = "UNKNOWN",
|
|
1810
1807
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1811
1808
|
MEMBER = "MEMBER",
|
|
@@ -1813,8 +1810,8 @@ export declare enum WebhookIdentityType {
|
|
|
1813
1810
|
APP = "APP"
|
|
1814
1811
|
}
|
|
1815
1812
|
/** @enumType */
|
|
1816
|
-
|
|
1817
|
-
|
|
1813
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1814
|
+
interface BaseEventMetadata {
|
|
1818
1815
|
/**
|
|
1819
1816
|
* App instance ID.
|
|
1820
1817
|
* @format GUID
|
|
@@ -1828,7 +1825,7 @@ export interface BaseEventMetadata {
|
|
|
1828
1825
|
/** The identification type and identity data. */
|
|
1829
1826
|
identity?: IdentificationData;
|
|
1830
1827
|
}
|
|
1831
|
-
|
|
1828
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1832
1829
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1833
1830
|
_id?: string;
|
|
1834
1831
|
/**
|
|
@@ -1858,107 +1855,17 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1858
1855
|
*/
|
|
1859
1856
|
entityEventSequence?: string | null;
|
|
1860
1857
|
}
|
|
1861
|
-
|
|
1858
|
+
interface SubscriptionContractCreatedEnvelope {
|
|
1862
1859
|
entity: SubscriptionContract;
|
|
1863
1860
|
metadata: EventMetadata;
|
|
1864
1861
|
}
|
|
1865
|
-
|
|
1866
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1867
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1868
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1869
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1870
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1871
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1872
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1873
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1874
|
-
* @webhook
|
|
1875
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
|
|
1876
|
-
* @slug created
|
|
1877
|
-
* @documentationMaturity preview
|
|
1878
|
-
*/
|
|
1879
|
-
export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
|
|
1880
|
-
export interface SubscriptionContractDeletedEnvelope {
|
|
1862
|
+
interface SubscriptionContractDeletedEnvelope {
|
|
1881
1863
|
metadata: EventMetadata;
|
|
1882
1864
|
}
|
|
1883
|
-
|
|
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
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1892
|
-
* @webhook
|
|
1893
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
|
|
1894
|
-
* @slug deleted
|
|
1895
|
-
* @documentationMaturity preview
|
|
1896
|
-
*/
|
|
1897
|
-
export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
|
|
1898
|
-
export interface SubscriptionContractUpdatedEnvelope {
|
|
1865
|
+
interface SubscriptionContractUpdatedEnvelope {
|
|
1899
1866
|
entity: SubscriptionContract;
|
|
1900
1867
|
metadata: EventMetadata;
|
|
1901
1868
|
}
|
|
1902
|
-
/** @permissionScope Manage Stores - all permissions
|
|
1903
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1904
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1905
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1906
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1907
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1908
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1909
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1910
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1911
|
-
* @webhook
|
|
1912
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
|
|
1913
|
-
* @slug updated
|
|
1914
|
-
* @documentationMaturity preview
|
|
1915
|
-
*/
|
|
1916
|
-
export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
|
|
1917
|
-
type SubscriptionContractNonNullablePaths = `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `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}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `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` | `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`;
|
|
1918
|
-
/**
|
|
1919
|
-
* Retrieves a SubscriptionContract.
|
|
1920
|
-
* @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
|
|
1921
|
-
* @public
|
|
1922
|
-
* @documentationMaturity preview
|
|
1923
|
-
* @requiredField subscriptionContractId
|
|
1924
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1925
|
-
* @permissionScope Manage Stores - all permissions
|
|
1926
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1927
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1928
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1929
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1930
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1931
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1932
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1933
|
-
* @applicableIdentity APP
|
|
1934
|
-
* @returns The requested SubscriptionContract.
|
|
1935
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
1936
|
-
*/
|
|
1937
|
-
export declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, SubscriptionContractNonNullablePaths>>;
|
|
1938
|
-
/**
|
|
1939
|
-
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
1940
|
-
*
|
|
1941
|
-
* Up to 300 SubscriptionContracts can be returned per request.
|
|
1942
|
-
*
|
|
1943
|
-
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
1944
|
-
*
|
|
1945
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
1946
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
1947
|
-
* @public
|
|
1948
|
-
* @documentationMaturity preview
|
|
1949
|
-
* @permissionScope Manage Stores - all permissions
|
|
1950
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1951
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1952
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1953
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1954
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1955
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1956
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1957
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1958
|
-
* @applicableIdentity APP
|
|
1959
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
|
|
1960
|
-
*/
|
|
1961
|
-
export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
|
|
1962
1869
|
interface QueryCursorResult {
|
|
1963
1870
|
cursors: Cursors;
|
|
1964
1871
|
hasNext: () => boolean;
|
|
@@ -1966,13 +1873,13 @@ interface QueryCursorResult {
|
|
|
1966
1873
|
length: number;
|
|
1967
1874
|
pageSize: number;
|
|
1968
1875
|
}
|
|
1969
|
-
|
|
1876
|
+
interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1970
1877
|
items: SubscriptionContract[];
|
|
1971
1878
|
query: SubscriptionContractsQueryBuilder;
|
|
1972
1879
|
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
1973
1880
|
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
1974
1881
|
}
|
|
1975
|
-
|
|
1882
|
+
interface SubscriptionContractsQueryBuilder {
|
|
1976
1883
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1977
1884
|
* @param value - Value to compare against.
|
|
1978
1885
|
* @documentationMaturity preview
|
|
@@ -2036,4 +1943,5 @@ export interface SubscriptionContractsQueryBuilder {
|
|
|
2036
1943
|
/** @documentationMaturity preview */
|
|
2037
1944
|
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
2038
1945
|
}
|
|
2039
|
-
|
|
1946
|
+
|
|
1947
|
+
export { type ExtendedFields as $, AdjustmentType as A, type ItemTaxFullDetails as B, ChannelType as C, DescriptionLineType as D, type LineItemTaxBreakdown as E, type FocalPoint as F, type DigitalFile as G, type SubscriptionInfo as H, ItemTypeItemType as I, JurisdictionType as J, type SubscriptionTitle as K, type LineItemTaxInfo as L, type SubscriptionDescription as M, type SubscriptionSettings as N, type OrderLineItem as O, PaymentOptionType as P, type FreeTrialPeriod as Q, type BillingAdjustment as R, type SubscriptionContract as S, TaxableAddressType as T, type BillingAdjustmentPriceSummary as U, V2SubscriptionFrequency as V, WeightUnit as W, type PriceDescription as X, type LocationAndQuantity as Y, type TaxableAddress as Z, type TaxableAddressTaxableAddressDataOneOf as _, type SubscriptionContractsQueryBuilder as a, type SubscriptionContractsQueryResult as a$, type ModifierGroup as a0, type TranslatableString as a1, type ItemModifier as a2, type BuyerInfo as a3, type BuyerInfoIdOneOf as a4, type CurrencyConversionDetails as a5, type PriceSummary as a6, type AddressWithContact as a7, type Address as a8, type StreetAddress as a9, type CreateSubscriptionContractRequest as aA, type CreateSubscriptionContractResponse as aB, type GetSubscriptionContractRequest as aC, type GetSubscriptionContractResponse as aD, type UpdateSubscriptionContractRequest as aE, type UpdateSubscriptionContractResponse as aF, type QuerySubscriptionContractsRequest as aG, type CursorQuery as aH, type CursorQueryPagingMethodOneOf as aI, type Sorting as aJ, type CursorPaging as aK, type QuerySubscriptionContractsResponse as aL, type CursorPagingMetadata as aM, type Cursors as aN, type DomainEvent as aO, type DomainEventBodyOneOf as aP, type EntityCreatedEvent as aQ, type RestoreInfo as aR, type EntityUpdatedEvent as aS, type EntityDeletedEvent as aT, type ActionEvent as aU, type Empty as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type AddressLocation as aa, type FullAddressContactDetails as ab, type VatId as ac, type ShippingInformation as ad, type DeliveryLogistics as ae, type DeliveryLogisticsAddressOneOf as af, type PickupDetails as ag, type PickupAddress as ah, type DeliveryTimeSlot as ai, type ShippingPrice as aj, type ShippingRegion as ak, type OrderTaxInfo as al, type OrderTaxBreakdown as am, type AppliedDiscount as an, type AppliedDiscountDiscountSourceOneOf as ao, type Coupon as ap, type MerchantDiscount as aq, type MerchantDiscountMerchantDiscountReasonOneOf as ar, type DiscountRule as as, type DiscountRuleName as at, type LineItemDiscount as au, type ChannelInfo as av, type CustomField as aw, type V1SubscriptionTitle as ax, type AdditionalFee as ay, type Location as az, type SubscriptionContractCreatedEnvelope as b, type SubscriptionContractDeletedEnvelope as c, type SubscriptionContractUpdatedEnvelope as d, SubscriptionFrequency as e, VatType as f, PickupMethod as g, DiscountType as h, DiscountReason as i, SortOrder as j, WebhookIdentityType as k, type V1SubscriptionDescription as l, type V1SubscriptionSettings as m, type V1FreeTrialPeriod as n, type ProductName as o, type CatalogReference as p, type Price as q, type DescriptionLine as r, type DescriptionLineValueOneOf as s, type DescriptionLineDescriptionLineValueOneOf as t, type DescriptionLineName as u, type PlainTextValue as v, type Color as w, type PhysicalProperties as x, type ItemType as y, type ItemTypeItemTypeDataOneOf as z };
|