@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
|
|
@@ -117,7 +116,7 @@ export interface SubscriptionContract {
|
|
|
117
116
|
*/
|
|
118
117
|
additionalFees?: AdditionalFee[];
|
|
119
118
|
}
|
|
120
|
-
|
|
119
|
+
interface V1SubscriptionDescription {
|
|
121
120
|
/**
|
|
122
121
|
* Subscription option description.
|
|
123
122
|
* @maxLength 500
|
|
@@ -129,7 +128,7 @@ export interface V1SubscriptionDescription {
|
|
|
129
128
|
*/
|
|
130
129
|
translated?: string | null;
|
|
131
130
|
}
|
|
132
|
-
|
|
131
|
+
interface V1SubscriptionSettings {
|
|
133
132
|
/** Frequency of recurring payment. */
|
|
134
133
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
135
134
|
/**
|
|
@@ -150,7 +149,7 @@ export interface V1SubscriptionSettings {
|
|
|
150
149
|
/** Period until first cycle starts. If None => no free trial */
|
|
151
150
|
freeTrialPeriod?: V1FreeTrialPeriod;
|
|
152
151
|
}
|
|
153
|
-
|
|
152
|
+
declare enum SubscriptionFrequency {
|
|
154
153
|
UNDEFINED = "UNDEFINED",
|
|
155
154
|
DAY = "DAY",
|
|
156
155
|
WEEK = "WEEK",
|
|
@@ -158,8 +157,8 @@ export declare enum SubscriptionFrequency {
|
|
|
158
157
|
YEAR = "YEAR"
|
|
159
158
|
}
|
|
160
159
|
/** @enumType */
|
|
161
|
-
|
|
162
|
-
|
|
160
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
161
|
+
interface V1FreeTrialPeriod {
|
|
163
162
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
164
163
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
165
164
|
/**
|
|
@@ -169,7 +168,7 @@ export interface V1FreeTrialPeriod {
|
|
|
169
168
|
*/
|
|
170
169
|
interval?: number;
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface OrderLineItem {
|
|
173
172
|
/**
|
|
174
173
|
* Line item ID.
|
|
175
174
|
* @immutable
|
|
@@ -288,7 +287,7 @@ export interface OrderLineItem {
|
|
|
288
287
|
*/
|
|
289
288
|
extendedFields?: ExtendedFields;
|
|
290
289
|
}
|
|
291
|
-
|
|
290
|
+
interface ProductName {
|
|
292
291
|
/**
|
|
293
292
|
* __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).
|
|
294
293
|
*
|
|
@@ -310,7 +309,7 @@ export interface ProductName {
|
|
|
310
309
|
translated?: string | null;
|
|
311
310
|
}
|
|
312
311
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
313
|
-
|
|
312
|
+
interface CatalogReference {
|
|
314
313
|
/**
|
|
315
314
|
* ID of the item within the catalog it belongs to.
|
|
316
315
|
* @minLength 1
|
|
@@ -336,7 +335,7 @@ export interface CatalogReference {
|
|
|
336
335
|
*/
|
|
337
336
|
options?: Record<string, any> | null;
|
|
338
337
|
}
|
|
339
|
-
|
|
338
|
+
interface Price {
|
|
340
339
|
/**
|
|
341
340
|
* Amount.
|
|
342
341
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -348,7 +347,7 @@ export interface Price {
|
|
|
348
347
|
*/
|
|
349
348
|
formattedAmount?: string;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
352
351
|
/** Description line plain text value. */
|
|
353
352
|
plainText?: PlainTextValue;
|
|
354
353
|
/** Description line color value. */
|
|
@@ -357,16 +356,16 @@ export interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionL
|
|
|
357
356
|
name?: DescriptionLineName;
|
|
358
357
|
}
|
|
359
358
|
/** @oneof */
|
|
360
|
-
|
|
359
|
+
interface DescriptionLineValueOneOf {
|
|
361
360
|
/** Description line plain text value. */
|
|
362
361
|
plainText?: PlainTextValue;
|
|
363
362
|
/** Description line color value. */
|
|
364
363
|
colorInfo?: Color;
|
|
365
364
|
}
|
|
366
365
|
/** @oneof */
|
|
367
|
-
|
|
366
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
368
367
|
}
|
|
369
|
-
|
|
368
|
+
interface DescriptionLineName {
|
|
370
369
|
/**
|
|
371
370
|
* 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).
|
|
372
371
|
* @maxLength 100
|
|
@@ -380,7 +379,7 @@ export interface DescriptionLineName {
|
|
|
380
379
|
*/
|
|
381
380
|
translated?: string | null;
|
|
382
381
|
}
|
|
383
|
-
|
|
382
|
+
interface PlainTextValue {
|
|
384
383
|
/**
|
|
385
384
|
* 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).
|
|
386
385
|
* @maxLength 600
|
|
@@ -394,7 +393,7 @@ export interface PlainTextValue {
|
|
|
394
393
|
*/
|
|
395
394
|
translated?: string | null;
|
|
396
395
|
}
|
|
397
|
-
|
|
396
|
+
interface Color {
|
|
398
397
|
/**
|
|
399
398
|
* 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).
|
|
400
399
|
* @maxLength 500
|
|
@@ -410,7 +409,7 @@ export interface Color {
|
|
|
410
409
|
/** HEX or RGB color code for display. */
|
|
411
410
|
code?: string | null;
|
|
412
411
|
}
|
|
413
|
-
|
|
412
|
+
declare enum DescriptionLineType {
|
|
414
413
|
/** Unrecognized type. */
|
|
415
414
|
UNRECOGNISED = "UNRECOGNISED",
|
|
416
415
|
/** Plain text type. */
|
|
@@ -418,9 +417,7 @@ export declare enum DescriptionLineType {
|
|
|
418
417
|
/** Color type. */
|
|
419
418
|
COLOR = "COLOR"
|
|
420
419
|
}
|
|
421
|
-
|
|
422
|
-
export type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
|
|
423
|
-
export interface FocalPoint {
|
|
420
|
+
interface FocalPoint {
|
|
424
421
|
/** X-coordinate of the focal point. */
|
|
425
422
|
x?: number;
|
|
426
423
|
/** Y-coordinate of the focal point. */
|
|
@@ -430,7 +427,7 @@ export interface FocalPoint {
|
|
|
430
427
|
/** crop by width */
|
|
431
428
|
width?: number | null;
|
|
432
429
|
}
|
|
433
|
-
|
|
430
|
+
interface PhysicalProperties {
|
|
434
431
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
435
432
|
weight?: number | null;
|
|
436
433
|
/**
|
|
@@ -441,20 +438,20 @@ export interface PhysicalProperties {
|
|
|
441
438
|
/** Whether this line item is shippable. */
|
|
442
439
|
shippable?: boolean;
|
|
443
440
|
}
|
|
444
|
-
|
|
441
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
445
442
|
/** Preset item type. */
|
|
446
443
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
447
444
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
448
445
|
custom?: string;
|
|
449
446
|
}
|
|
450
447
|
/** @oneof */
|
|
451
|
-
|
|
448
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
452
449
|
/** Preset item type. */
|
|
453
450
|
preset?: ItemTypeItemTypeWithLiterals;
|
|
454
451
|
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
455
452
|
custom?: string;
|
|
456
453
|
}
|
|
457
|
-
|
|
454
|
+
declare enum ItemTypeItemType {
|
|
458
455
|
UNRECOGNISED = "UNRECOGNISED",
|
|
459
456
|
PHYSICAL = "PHYSICAL",
|
|
460
457
|
DIGITAL = "DIGITAL",
|
|
@@ -462,9 +459,9 @@ export declare enum ItemTypeItemType {
|
|
|
462
459
|
SERVICE = "SERVICE"
|
|
463
460
|
}
|
|
464
461
|
/** @enumType */
|
|
465
|
-
|
|
462
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
466
463
|
/** Type of selected payment option for catalog item */
|
|
467
|
-
|
|
464
|
+
declare enum PaymentOptionType {
|
|
468
465
|
/** The entire payment for this item happens as part of the checkout. */
|
|
469
466
|
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
470
467
|
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
@@ -477,8 +474,8 @@ export declare enum PaymentOptionType {
|
|
|
477
474
|
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
478
475
|
}
|
|
479
476
|
/** @enumType */
|
|
480
|
-
|
|
481
|
-
|
|
477
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
478
|
+
interface ItemTaxFullDetails {
|
|
482
479
|
/** Taxable amount of this line item. */
|
|
483
480
|
taxableAmount?: Price;
|
|
484
481
|
/**
|
|
@@ -489,7 +486,7 @@ export interface ItemTaxFullDetails {
|
|
|
489
486
|
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
490
487
|
totalTax?: Price;
|
|
491
488
|
}
|
|
492
|
-
|
|
489
|
+
interface LineItemTaxInfo {
|
|
493
490
|
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
494
491
|
taxAmount?: Price;
|
|
495
492
|
/** Amount for which tax is calculated. */
|
|
@@ -517,7 +514,7 @@ export interface LineItemTaxInfo {
|
|
|
517
514
|
* TaxBreakdown represents tax information for a line item.
|
|
518
515
|
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
519
516
|
*/
|
|
520
|
-
|
|
517
|
+
interface LineItemTaxBreakdown {
|
|
521
518
|
/**
|
|
522
519
|
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
523
520
|
* @maxLength 200
|
|
@@ -550,7 +547,7 @@ export interface LineItemTaxBreakdown {
|
|
|
550
547
|
taxableAmount?: Price;
|
|
551
548
|
}
|
|
552
549
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
553
|
-
|
|
550
|
+
declare enum JurisdictionType {
|
|
554
551
|
UNDEFINED = "UNDEFINED",
|
|
555
552
|
COUNTRY = "COUNTRY",
|
|
556
553
|
STATE = "STATE",
|
|
@@ -559,8 +556,8 @@ export declare enum JurisdictionType {
|
|
|
559
556
|
SPECIAL = "SPECIAL"
|
|
560
557
|
}
|
|
561
558
|
/** @enumType */
|
|
562
|
-
|
|
563
|
-
|
|
559
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
560
|
+
interface DigitalFile {
|
|
564
561
|
/**
|
|
565
562
|
* ID of the secure file in media.
|
|
566
563
|
* @minLength 1
|
|
@@ -580,7 +577,7 @@ export interface DigitalFile {
|
|
|
580
577
|
*/
|
|
581
578
|
expirationDate?: Date | null;
|
|
582
579
|
}
|
|
583
|
-
|
|
580
|
+
interface SubscriptionInfo {
|
|
584
581
|
/**
|
|
585
582
|
* Subscription ID.
|
|
586
583
|
* @format GUID
|
|
@@ -618,7 +615,7 @@ export interface SubscriptionInfo {
|
|
|
618
615
|
*/
|
|
619
616
|
chargesDescription?: string | null;
|
|
620
617
|
}
|
|
621
|
-
|
|
618
|
+
interface SubscriptionTitle {
|
|
622
619
|
/**
|
|
623
620
|
* 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).
|
|
624
621
|
* @minLength 1
|
|
@@ -634,7 +631,7 @@ export interface SubscriptionTitle {
|
|
|
634
631
|
*/
|
|
635
632
|
translated?: string | null;
|
|
636
633
|
}
|
|
637
|
-
|
|
634
|
+
interface SubscriptionDescription {
|
|
638
635
|
/**
|
|
639
636
|
* Subscription option description.
|
|
640
637
|
* @maxLength 500
|
|
@@ -646,7 +643,7 @@ export interface SubscriptionDescription {
|
|
|
646
643
|
*/
|
|
647
644
|
translated?: string | null;
|
|
648
645
|
}
|
|
649
|
-
|
|
646
|
+
interface SubscriptionSettings {
|
|
650
647
|
/** Frequency of recurring payment. */
|
|
651
648
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
652
649
|
/**
|
|
@@ -668,7 +665,7 @@ export interface SubscriptionSettings {
|
|
|
668
665
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
669
666
|
}
|
|
670
667
|
/** Frequency unit of recurring payment */
|
|
671
|
-
|
|
668
|
+
declare enum V2SubscriptionFrequency {
|
|
672
669
|
UNDEFINED = "UNDEFINED",
|
|
673
670
|
DAY = "DAY",
|
|
674
671
|
WEEK = "WEEK",
|
|
@@ -676,8 +673,8 @@ export declare enum V2SubscriptionFrequency {
|
|
|
676
673
|
YEAR = "YEAR"
|
|
677
674
|
}
|
|
678
675
|
/** @enumType */
|
|
679
|
-
|
|
680
|
-
|
|
676
|
+
type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
677
|
+
interface FreeTrialPeriod {
|
|
681
678
|
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
682
679
|
frequency?: V2SubscriptionFrequencyWithLiterals;
|
|
683
680
|
/**
|
|
@@ -687,13 +684,13 @@ export interface FreeTrialPeriod {
|
|
|
687
684
|
*/
|
|
688
685
|
interval?: number;
|
|
689
686
|
}
|
|
690
|
-
|
|
687
|
+
interface BillingAdjustment {
|
|
691
688
|
/** The type of adjustment. */
|
|
692
689
|
type?: AdjustmentTypeWithLiterals;
|
|
693
690
|
/** Summary of the prorated adjustment amount. */
|
|
694
691
|
priceSummary?: BillingAdjustmentPriceSummary;
|
|
695
692
|
}
|
|
696
|
-
|
|
693
|
+
declare enum AdjustmentType {
|
|
697
694
|
UNKNOWN_ADJUSTMENT_TYPE = "UNKNOWN_ADJUSTMENT_TYPE",
|
|
698
695
|
/** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
|
|
699
696
|
EXTRA_CHARGE = "EXTRA_CHARGE",
|
|
@@ -701,8 +698,8 @@ export declare enum AdjustmentType {
|
|
|
701
698
|
CREDIT = "CREDIT"
|
|
702
699
|
}
|
|
703
700
|
/** @enumType */
|
|
704
|
-
|
|
705
|
-
|
|
701
|
+
type AdjustmentTypeWithLiterals = AdjustmentType | 'UNKNOWN_ADJUSTMENT_TYPE' | 'EXTRA_CHARGE' | 'CREDIT';
|
|
702
|
+
interface BillingAdjustmentPriceSummary {
|
|
706
703
|
/** Subtotal of adjustment, before tax. */
|
|
707
704
|
subtotal?: Price;
|
|
708
705
|
/** Tax on adjustment. */
|
|
@@ -710,7 +707,7 @@ export interface BillingAdjustmentPriceSummary {
|
|
|
710
707
|
/** Total price after tax. */
|
|
711
708
|
total?: Price;
|
|
712
709
|
}
|
|
713
|
-
|
|
710
|
+
interface PriceDescription {
|
|
714
711
|
/**
|
|
715
712
|
* __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).
|
|
716
713
|
* @minLength 1
|
|
@@ -726,7 +723,7 @@ export interface PriceDescription {
|
|
|
726
723
|
*/
|
|
727
724
|
translated?: string | null;
|
|
728
725
|
}
|
|
729
|
-
|
|
726
|
+
interface LocationAndQuantity {
|
|
730
727
|
/**
|
|
731
728
|
* Location id in the associated owner app.
|
|
732
729
|
* @format GUID
|
|
@@ -752,24 +749,24 @@ export interface LocationAndQuantity {
|
|
|
752
749
|
*/
|
|
753
750
|
name?: string | null;
|
|
754
751
|
}
|
|
755
|
-
|
|
752
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
756
753
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
757
754
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
758
755
|
}
|
|
759
756
|
/** @oneof */
|
|
760
|
-
|
|
757
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
761
758
|
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
762
759
|
addressType?: TaxableAddressTypeWithLiterals;
|
|
763
760
|
}
|
|
764
|
-
|
|
761
|
+
declare enum TaxableAddressType {
|
|
765
762
|
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
766
763
|
BUSINESS = "BUSINESS",
|
|
767
764
|
BILLING = "BILLING",
|
|
768
765
|
SHIPPING = "SHIPPING"
|
|
769
766
|
}
|
|
770
767
|
/** @enumType */
|
|
771
|
-
|
|
772
|
-
|
|
768
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
769
|
+
interface ExtendedFields {
|
|
773
770
|
/**
|
|
774
771
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
775
772
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -780,7 +777,7 @@ export interface ExtendedFields {
|
|
|
780
777
|
*/
|
|
781
778
|
namespaces?: Record<string, Record<string, any>>;
|
|
782
779
|
}
|
|
783
|
-
|
|
780
|
+
interface ModifierGroup {
|
|
784
781
|
/**
|
|
785
782
|
* Modifier group id.
|
|
786
783
|
* @minLength 1
|
|
@@ -796,7 +793,7 @@ export interface ModifierGroup {
|
|
|
796
793
|
*/
|
|
797
794
|
modifiers?: ItemModifier[];
|
|
798
795
|
}
|
|
799
|
-
|
|
796
|
+
interface TranslatableString {
|
|
800
797
|
/**
|
|
801
798
|
* __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).
|
|
802
799
|
*
|
|
@@ -817,7 +814,7 @@ export interface TranslatableString {
|
|
|
817
814
|
*/
|
|
818
815
|
translated?: string | null;
|
|
819
816
|
}
|
|
820
|
-
|
|
817
|
+
interface ItemModifier {
|
|
821
818
|
/**
|
|
822
819
|
* Modifier ID.
|
|
823
820
|
* @minLength 1
|
|
@@ -838,7 +835,7 @@ export interface ItemModifier {
|
|
|
838
835
|
price?: Price;
|
|
839
836
|
}
|
|
840
837
|
/** Buyer Info */
|
|
841
|
-
|
|
838
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
842
839
|
/**
|
|
843
840
|
* Visitor ID (if site visitor is not a member).
|
|
844
841
|
* @format GUID
|
|
@@ -861,7 +858,7 @@ export interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
|
861
858
|
email?: string | null;
|
|
862
859
|
}
|
|
863
860
|
/** @oneof */
|
|
864
|
-
|
|
861
|
+
interface BuyerInfoIdOneOf {
|
|
865
862
|
/**
|
|
866
863
|
* Visitor ID (if site visitor is not a member).
|
|
867
864
|
* @format GUID
|
|
@@ -873,7 +870,7 @@ export interface BuyerInfoIdOneOf {
|
|
|
873
870
|
*/
|
|
874
871
|
memberId?: string;
|
|
875
872
|
}
|
|
876
|
-
|
|
873
|
+
declare enum WeightUnit {
|
|
877
874
|
/** Weight unit can't be classified due to an error. */
|
|
878
875
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
879
876
|
/** Kilograms. */
|
|
@@ -882,8 +879,8 @@ export declare enum WeightUnit {
|
|
|
882
879
|
LB = "LB"
|
|
883
880
|
}
|
|
884
881
|
/** @enumType */
|
|
885
|
-
|
|
886
|
-
|
|
882
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
883
|
+
interface CurrencyConversionDetails {
|
|
887
884
|
/**
|
|
888
885
|
* 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.
|
|
889
886
|
*
|
|
@@ -901,7 +898,7 @@ export interface CurrencyConversionDetails {
|
|
|
901
898
|
*/
|
|
902
899
|
conversionRate?: string | null;
|
|
903
900
|
}
|
|
904
|
-
|
|
901
|
+
interface PriceSummary {
|
|
905
902
|
/** Subtotal of all the line items, before discounts and before tax. */
|
|
906
903
|
subtotal?: Price;
|
|
907
904
|
/** Total shipping price, before discounts and before tax. */
|
|
@@ -916,14 +913,14 @@ export interface PriceSummary {
|
|
|
916
913
|
totalAdditionalFees?: Price;
|
|
917
914
|
}
|
|
918
915
|
/** Billing Info and shipping details */
|
|
919
|
-
|
|
916
|
+
interface AddressWithContact {
|
|
920
917
|
/** Address. */
|
|
921
918
|
address?: Address;
|
|
922
919
|
/** Contact details. */
|
|
923
920
|
contactDetails?: FullAddressContactDetails;
|
|
924
921
|
}
|
|
925
922
|
/** Physical address */
|
|
926
|
-
|
|
923
|
+
interface Address {
|
|
927
924
|
/**
|
|
928
925
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
929
926
|
* @format COUNTRY
|
|
@@ -967,20 +964,20 @@ export interface Address {
|
|
|
967
964
|
*/
|
|
968
965
|
subdivisionFullname?: string | null;
|
|
969
966
|
}
|
|
970
|
-
|
|
967
|
+
interface StreetAddress {
|
|
971
968
|
/** Street number. */
|
|
972
969
|
number?: string;
|
|
973
970
|
/** Street name. */
|
|
974
971
|
name?: string;
|
|
975
972
|
}
|
|
976
|
-
|
|
973
|
+
interface AddressLocation {
|
|
977
974
|
/** Address latitude. */
|
|
978
975
|
latitude?: number | null;
|
|
979
976
|
/** Address longitude. */
|
|
980
977
|
longitude?: number | null;
|
|
981
978
|
}
|
|
982
979
|
/** Full contact details for an address */
|
|
983
|
-
|
|
980
|
+
interface FullAddressContactDetails {
|
|
984
981
|
/**
|
|
985
982
|
* First name.
|
|
986
983
|
* @maxLength 100
|
|
@@ -1004,7 +1001,7 @@ export interface FullAddressContactDetails {
|
|
|
1004
1001
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
1005
1002
|
vatId?: VatId;
|
|
1006
1003
|
}
|
|
1007
|
-
|
|
1004
|
+
interface VatId {
|
|
1008
1005
|
/** Customer's tax ID. */
|
|
1009
1006
|
_id?: string;
|
|
1010
1007
|
/**
|
|
@@ -1017,7 +1014,7 @@ export interface VatId {
|
|
|
1017
1014
|
type?: VatTypeWithLiterals;
|
|
1018
1015
|
}
|
|
1019
1016
|
/** tax info types */
|
|
1020
|
-
|
|
1017
|
+
declare enum VatType {
|
|
1021
1018
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1022
1019
|
/** CPF - for individual tax payers. */
|
|
1023
1020
|
CPF = "CPF",
|
|
@@ -1025,8 +1022,8 @@ export declare enum VatType {
|
|
|
1025
1022
|
CNPJ = "CNPJ"
|
|
1026
1023
|
}
|
|
1027
1024
|
/** @enumType */
|
|
1028
|
-
|
|
1029
|
-
|
|
1025
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
1026
|
+
interface ShippingInformation {
|
|
1030
1027
|
/**
|
|
1031
1028
|
* App Def Id of external provider which was a source of shipping info
|
|
1032
1029
|
* @minLength 1
|
|
@@ -1052,7 +1049,7 @@ export interface ShippingInformation {
|
|
|
1052
1049
|
/** Shipping region. */
|
|
1053
1050
|
region?: ShippingRegion;
|
|
1054
1051
|
}
|
|
1055
|
-
|
|
1052
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1056
1053
|
/** Shipping address and contact details. */
|
|
1057
1054
|
shippingDestination?: AddressWithContact;
|
|
1058
1055
|
/** Pickup details. */
|
|
@@ -1076,20 +1073,20 @@ export interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
|
1076
1073
|
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1077
1074
|
}
|
|
1078
1075
|
/** @oneof */
|
|
1079
|
-
|
|
1076
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1080
1077
|
/** Shipping address and contact details. */
|
|
1081
1078
|
shippingDestination?: AddressWithContact;
|
|
1082
1079
|
/** Pickup details. */
|
|
1083
1080
|
pickupDetails?: PickupDetails;
|
|
1084
1081
|
}
|
|
1085
|
-
|
|
1082
|
+
interface PickupDetails {
|
|
1086
1083
|
/** Pickup address. */
|
|
1087
1084
|
address?: PickupAddress;
|
|
1088
1085
|
/** Pickup method */
|
|
1089
1086
|
pickupMethod?: PickupMethodWithLiterals;
|
|
1090
1087
|
}
|
|
1091
1088
|
/** Physical address */
|
|
1092
|
-
|
|
1089
|
+
interface PickupAddress {
|
|
1093
1090
|
/**
|
|
1094
1091
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1095
1092
|
* @format COUNTRY
|
|
@@ -1133,20 +1130,20 @@ export interface PickupAddress {
|
|
|
1133
1130
|
*/
|
|
1134
1131
|
subdivisionFullname?: string | null;
|
|
1135
1132
|
}
|
|
1136
|
-
|
|
1133
|
+
declare enum PickupMethod {
|
|
1137
1134
|
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1138
1135
|
STORE_PICKUP = "STORE_PICKUP",
|
|
1139
1136
|
PICKUP_POINT = "PICKUP_POINT"
|
|
1140
1137
|
}
|
|
1141
1138
|
/** @enumType */
|
|
1142
|
-
|
|
1143
|
-
|
|
1139
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1140
|
+
interface DeliveryTimeSlot {
|
|
1144
1141
|
/** Delivery slot starting time. */
|
|
1145
1142
|
from?: Date | null;
|
|
1146
1143
|
/** Delivery slot ending time. */
|
|
1147
1144
|
to?: Date | null;
|
|
1148
1145
|
}
|
|
1149
|
-
|
|
1146
|
+
interface ShippingPrice {
|
|
1150
1147
|
/** Shipping price for display purposes. */
|
|
1151
1148
|
price?: Price;
|
|
1152
1149
|
/**
|
|
@@ -1167,14 +1164,14 @@ export interface ShippingPrice {
|
|
|
1167
1164
|
*/
|
|
1168
1165
|
discount?: Price;
|
|
1169
1166
|
}
|
|
1170
|
-
|
|
1167
|
+
interface ShippingRegion {
|
|
1171
1168
|
/**
|
|
1172
1169
|
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1173
1170
|
* @maxLength 100
|
|
1174
1171
|
*/
|
|
1175
1172
|
name?: string | null;
|
|
1176
1173
|
}
|
|
1177
|
-
|
|
1174
|
+
interface OrderTaxInfo {
|
|
1178
1175
|
/** Calculated tax, added from line items. */
|
|
1179
1176
|
totalTax?: Price;
|
|
1180
1177
|
/**
|
|
@@ -1194,7 +1191,7 @@ export interface OrderTaxInfo {
|
|
|
1194
1191
|
* 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.
|
|
1195
1192
|
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1196
1193
|
*/
|
|
1197
|
-
|
|
1194
|
+
interface OrderTaxBreakdown {
|
|
1198
1195
|
/**
|
|
1199
1196
|
* The name of the tax against which this tax amount was calculated.
|
|
1200
1197
|
* @maxLength 200
|
|
@@ -1221,7 +1218,7 @@ export interface OrderTaxBreakdown {
|
|
|
1221
1218
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1222
1219
|
aggregatedTaxAmount?: Price;
|
|
1223
1220
|
}
|
|
1224
|
-
|
|
1221
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1225
1222
|
/** Applied coupon info. */
|
|
1226
1223
|
coupon?: Coupon;
|
|
1227
1224
|
/** Merchant discount. */
|
|
@@ -1254,7 +1251,7 @@ export interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1254
1251
|
_id?: string | null;
|
|
1255
1252
|
}
|
|
1256
1253
|
/** @oneof */
|
|
1257
|
-
|
|
1254
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1258
1255
|
/** Applied coupon info. */
|
|
1259
1256
|
coupon?: Coupon;
|
|
1260
1257
|
/** Merchant discount. */
|
|
@@ -1262,15 +1259,15 @@ export interface AppliedDiscountDiscountSourceOneOf {
|
|
|
1262
1259
|
/** Automatic Discount */
|
|
1263
1260
|
discountRule?: DiscountRule;
|
|
1264
1261
|
}
|
|
1265
|
-
|
|
1262
|
+
declare enum DiscountType {
|
|
1266
1263
|
GLOBAL = "GLOBAL",
|
|
1267
1264
|
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1268
1265
|
SHIPPING = "SHIPPING"
|
|
1269
1266
|
}
|
|
1270
1267
|
/** @enumType */
|
|
1271
|
-
|
|
1268
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1272
1269
|
/** Coupon */
|
|
1273
|
-
|
|
1270
|
+
interface Coupon {
|
|
1274
1271
|
/** Coupon ID. */
|
|
1275
1272
|
_id?: string;
|
|
1276
1273
|
/** Coupon code. */
|
|
@@ -1280,7 +1277,7 @@ export interface Coupon {
|
|
|
1280
1277
|
/** Coupon value. */
|
|
1281
1278
|
amount?: Price;
|
|
1282
1279
|
}
|
|
1283
|
-
|
|
1280
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1284
1281
|
/**
|
|
1285
1282
|
* Pre-defined discount reason (optional).
|
|
1286
1283
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1295,7 +1292,7 @@ export interface MerchantDiscount extends MerchantDiscountMerchantDiscountReason
|
|
|
1295
1292
|
amount?: Price;
|
|
1296
1293
|
}
|
|
1297
1294
|
/** @oneof */
|
|
1298
|
-
|
|
1295
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1299
1296
|
/**
|
|
1300
1297
|
* Pre-defined discount reason (optional).
|
|
1301
1298
|
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
@@ -1307,14 +1304,14 @@ export interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
|
1307
1304
|
*/
|
|
1308
1305
|
description?: string | null;
|
|
1309
1306
|
}
|
|
1310
|
-
|
|
1307
|
+
declare enum DiscountReason {
|
|
1311
1308
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1312
1309
|
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1313
1310
|
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1314
1311
|
}
|
|
1315
1312
|
/** @enumType */
|
|
1316
|
-
|
|
1317
|
-
|
|
1313
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1314
|
+
interface DiscountRule {
|
|
1318
1315
|
/**
|
|
1319
1316
|
* Discount rule ID
|
|
1320
1317
|
* @format GUID
|
|
@@ -1325,7 +1322,7 @@ export interface DiscountRule {
|
|
|
1325
1322
|
/** Discount value. */
|
|
1326
1323
|
amount?: Price;
|
|
1327
1324
|
}
|
|
1328
|
-
|
|
1325
|
+
interface DiscountRuleName {
|
|
1329
1326
|
/**
|
|
1330
1327
|
* Original discount rule name (in site's default language).
|
|
1331
1328
|
* @minLength 1
|
|
@@ -1339,7 +1336,7 @@ export interface DiscountRuleName {
|
|
|
1339
1336
|
*/
|
|
1340
1337
|
translated?: string | null;
|
|
1341
1338
|
}
|
|
1342
|
-
|
|
1339
|
+
interface LineItemDiscount {
|
|
1343
1340
|
/**
|
|
1344
1341
|
* ID of line item the discount applies to.
|
|
1345
1342
|
* @format GUID
|
|
@@ -1348,7 +1345,7 @@ export interface LineItemDiscount {
|
|
|
1348
1345
|
/** Total discount for this line item. */
|
|
1349
1346
|
totalDiscount?: Price;
|
|
1350
1347
|
}
|
|
1351
|
-
|
|
1348
|
+
interface ChannelInfo {
|
|
1352
1349
|
/** Sales channel that submitted the order. */
|
|
1353
1350
|
type?: ChannelTypeWithLiterals;
|
|
1354
1351
|
/**
|
|
@@ -1362,7 +1359,7 @@ export interface ChannelInfo {
|
|
|
1362
1359
|
*/
|
|
1363
1360
|
externalOrderUrl?: string | null;
|
|
1364
1361
|
}
|
|
1365
|
-
|
|
1362
|
+
declare enum ChannelType {
|
|
1366
1363
|
/** Unspecified sales channel. This value is not supported. */
|
|
1367
1364
|
UNSPECIFIED = "UNSPECIFIED",
|
|
1368
1365
|
/** A web client. */
|
|
@@ -1397,8 +1394,8 @@ export declare enum ChannelType {
|
|
|
1397
1394
|
FAIRE_COM = "FAIRE_COM"
|
|
1398
1395
|
}
|
|
1399
1396
|
/** @enumType */
|
|
1400
|
-
|
|
1401
|
-
|
|
1397
|
+
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';
|
|
1398
|
+
interface CustomField {
|
|
1402
1399
|
/** Custom field value. */
|
|
1403
1400
|
value?: any;
|
|
1404
1401
|
/**
|
|
@@ -1414,7 +1411,7 @@ export interface CustomField {
|
|
|
1414
1411
|
*/
|
|
1415
1412
|
translatedTitle?: string | null;
|
|
1416
1413
|
}
|
|
1417
|
-
|
|
1414
|
+
interface V1SubscriptionTitle {
|
|
1418
1415
|
/**
|
|
1419
1416
|
* 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).
|
|
1420
1417
|
* @minLength 1
|
|
@@ -1430,7 +1427,7 @@ export interface V1SubscriptionTitle {
|
|
|
1430
1427
|
*/
|
|
1431
1428
|
translated?: string | null;
|
|
1432
1429
|
}
|
|
1433
|
-
|
|
1430
|
+
interface AdditionalFee {
|
|
1434
1431
|
/**
|
|
1435
1432
|
* Additional fee's unique code for future processing.
|
|
1436
1433
|
* @minLength 1
|
|
@@ -1469,7 +1466,7 @@ export interface AdditionalFee {
|
|
|
1469
1466
|
*/
|
|
1470
1467
|
lineItemIds?: string[];
|
|
1471
1468
|
}
|
|
1472
|
-
|
|
1469
|
+
interface Location {
|
|
1473
1470
|
/**
|
|
1474
1471
|
* Location ID.
|
|
1475
1472
|
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
@@ -1484,38 +1481,38 @@ export interface Location {
|
|
|
1484
1481
|
*/
|
|
1485
1482
|
name?: string;
|
|
1486
1483
|
}
|
|
1487
|
-
|
|
1484
|
+
interface CreateSubscriptionContractRequest {
|
|
1488
1485
|
/** SubscriptionContract to be created. */
|
|
1489
1486
|
subscriptionContract?: SubscriptionContract;
|
|
1490
1487
|
}
|
|
1491
|
-
|
|
1488
|
+
interface CreateSubscriptionContractResponse {
|
|
1492
1489
|
/** The created SubscriptionContract. */
|
|
1493
1490
|
subscriptionContract?: SubscriptionContract;
|
|
1494
1491
|
}
|
|
1495
|
-
|
|
1492
|
+
interface GetSubscriptionContractRequest {
|
|
1496
1493
|
/**
|
|
1497
1494
|
* ID of the SubscriptionContract to retrieve.
|
|
1498
1495
|
* @format GUID
|
|
1499
1496
|
*/
|
|
1500
1497
|
subscriptionContractId: string;
|
|
1501
1498
|
}
|
|
1502
|
-
|
|
1499
|
+
interface GetSubscriptionContractResponse {
|
|
1503
1500
|
/** The requested SubscriptionContract. */
|
|
1504
1501
|
subscriptionContract?: SubscriptionContract;
|
|
1505
1502
|
}
|
|
1506
|
-
|
|
1503
|
+
interface UpdateSubscriptionContractRequest {
|
|
1507
1504
|
/** SubscriptionContract to be updated, may be partial. */
|
|
1508
1505
|
subscriptionContract?: SubscriptionContract;
|
|
1509
1506
|
}
|
|
1510
|
-
|
|
1507
|
+
interface UpdateSubscriptionContractResponse {
|
|
1511
1508
|
/** Updated SubscriptionContract. */
|
|
1512
1509
|
subscriptionContract?: SubscriptionContract;
|
|
1513
1510
|
}
|
|
1514
|
-
|
|
1511
|
+
interface QuerySubscriptionContractsRequest {
|
|
1515
1512
|
/** WQL expression. */
|
|
1516
1513
|
query?: CursorQuery;
|
|
1517
1514
|
}
|
|
1518
|
-
|
|
1515
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1519
1516
|
/** 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`. */
|
|
1520
1517
|
cursorPaging?: CursorPaging;
|
|
1521
1518
|
/**
|
|
@@ -1537,11 +1534,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1537
1534
|
sort?: Sorting[];
|
|
1538
1535
|
}
|
|
1539
1536
|
/** @oneof */
|
|
1540
|
-
|
|
1537
|
+
interface CursorQueryPagingMethodOneOf {
|
|
1541
1538
|
/** 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`. */
|
|
1542
1539
|
cursorPaging?: CursorPaging;
|
|
1543
1540
|
}
|
|
1544
|
-
|
|
1541
|
+
interface Sorting {
|
|
1545
1542
|
/**
|
|
1546
1543
|
* Name of the field to sort by.
|
|
1547
1544
|
* @maxLength 512
|
|
@@ -1550,13 +1547,13 @@ export interface Sorting {
|
|
|
1550
1547
|
/** Sort order. */
|
|
1551
1548
|
order?: SortOrderWithLiterals;
|
|
1552
1549
|
}
|
|
1553
|
-
|
|
1550
|
+
declare enum SortOrder {
|
|
1554
1551
|
ASC = "ASC",
|
|
1555
1552
|
DESC = "DESC"
|
|
1556
1553
|
}
|
|
1557
1554
|
/** @enumType */
|
|
1558
|
-
|
|
1559
|
-
|
|
1555
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1556
|
+
interface CursorPaging {
|
|
1560
1557
|
/**
|
|
1561
1558
|
* Maximum number of items to return in the results.
|
|
1562
1559
|
* @max 100
|
|
@@ -1571,13 +1568,13 @@ export interface CursorPaging {
|
|
|
1571
1568
|
*/
|
|
1572
1569
|
cursor?: string | null;
|
|
1573
1570
|
}
|
|
1574
|
-
|
|
1571
|
+
interface QuerySubscriptionContractsResponse {
|
|
1575
1572
|
/** List of SubscriptionContracts. */
|
|
1576
1573
|
subscriptionContracts?: SubscriptionContract[];
|
|
1577
1574
|
/** Paging metadata */
|
|
1578
1575
|
pagingMetadata?: CursorPagingMetadata;
|
|
1579
1576
|
}
|
|
1580
|
-
|
|
1577
|
+
interface CursorPagingMetadata {
|
|
1581
1578
|
/** Number of items returned in the response. */
|
|
1582
1579
|
count?: number | null;
|
|
1583
1580
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1590,7 +1587,7 @@ export interface CursorPagingMetadata {
|
|
|
1590
1587
|
*/
|
|
1591
1588
|
hasNext?: boolean | null;
|
|
1592
1589
|
}
|
|
1593
|
-
|
|
1590
|
+
interface Cursors {
|
|
1594
1591
|
/**
|
|
1595
1592
|
* Cursor string pointing to the next page in the list of results.
|
|
1596
1593
|
* @maxLength 16000
|
|
@@ -1602,7 +1599,7 @@ export interface Cursors {
|
|
|
1602
1599
|
*/
|
|
1603
1600
|
prev?: string | null;
|
|
1604
1601
|
}
|
|
1605
|
-
|
|
1602
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1606
1603
|
createdEvent?: EntityCreatedEvent;
|
|
1607
1604
|
updatedEvent?: EntityUpdatedEvent;
|
|
1608
1605
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1637,19 +1634,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1637
1634
|
entityEventSequence?: string | null;
|
|
1638
1635
|
}
|
|
1639
1636
|
/** @oneof */
|
|
1640
|
-
|
|
1637
|
+
interface DomainEventBodyOneOf {
|
|
1641
1638
|
createdEvent?: EntityCreatedEvent;
|
|
1642
1639
|
updatedEvent?: EntityUpdatedEvent;
|
|
1643
1640
|
deletedEvent?: EntityDeletedEvent;
|
|
1644
1641
|
actionEvent?: ActionEvent;
|
|
1645
1642
|
}
|
|
1646
|
-
|
|
1643
|
+
interface EntityCreatedEvent {
|
|
1647
1644
|
entity?: string;
|
|
1648
1645
|
}
|
|
1649
|
-
|
|
1646
|
+
interface RestoreInfo {
|
|
1650
1647
|
deletedDate?: Date | null;
|
|
1651
1648
|
}
|
|
1652
|
-
|
|
1649
|
+
interface EntityUpdatedEvent {
|
|
1653
1650
|
/**
|
|
1654
1651
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1655
1652
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1657,16 +1654,16 @@ export interface EntityUpdatedEvent {
|
|
|
1657
1654
|
*/
|
|
1658
1655
|
currentEntity?: string;
|
|
1659
1656
|
}
|
|
1660
|
-
|
|
1657
|
+
interface EntityDeletedEvent {
|
|
1661
1658
|
/** Entity that was deleted. */
|
|
1662
1659
|
deletedEntity?: string | null;
|
|
1663
1660
|
}
|
|
1664
|
-
|
|
1661
|
+
interface ActionEvent {
|
|
1665
1662
|
body?: string;
|
|
1666
1663
|
}
|
|
1667
|
-
|
|
1664
|
+
interface Empty {
|
|
1668
1665
|
}
|
|
1669
|
-
|
|
1666
|
+
interface MessageEnvelope {
|
|
1670
1667
|
/**
|
|
1671
1668
|
* App instance ID.
|
|
1672
1669
|
* @format GUID
|
|
@@ -1682,7 +1679,7 @@ export interface MessageEnvelope {
|
|
|
1682
1679
|
/** Stringify payload. */
|
|
1683
1680
|
data?: string;
|
|
1684
1681
|
}
|
|
1685
|
-
|
|
1682
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1686
1683
|
/**
|
|
1687
1684
|
* ID of a site visitor that has not logged in to the site.
|
|
1688
1685
|
* @format GUID
|
|
@@ -1707,7 +1704,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1707
1704
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1708
1705
|
}
|
|
1709
1706
|
/** @oneof */
|
|
1710
|
-
|
|
1707
|
+
interface IdentificationDataIdOneOf {
|
|
1711
1708
|
/**
|
|
1712
1709
|
* ID of a site visitor that has not logged in to the site.
|
|
1713
1710
|
* @format GUID
|
|
@@ -1729,7 +1726,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1729
1726
|
*/
|
|
1730
1727
|
appId?: string;
|
|
1731
1728
|
}
|
|
1732
|
-
|
|
1729
|
+
declare enum WebhookIdentityType {
|
|
1733
1730
|
UNKNOWN = "UNKNOWN",
|
|
1734
1731
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1735
1732
|
MEMBER = "MEMBER",
|
|
@@ -1737,8 +1734,8 @@ export declare enum WebhookIdentityType {
|
|
|
1737
1734
|
APP = "APP"
|
|
1738
1735
|
}
|
|
1739
1736
|
/** @enumType */
|
|
1740
|
-
|
|
1741
|
-
|
|
1737
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1738
|
+
interface BaseEventMetadata {
|
|
1742
1739
|
/**
|
|
1743
1740
|
* App instance ID.
|
|
1744
1741
|
* @format GUID
|
|
@@ -1752,7 +1749,7 @@ export interface BaseEventMetadata {
|
|
|
1752
1749
|
/** The identification type and identity data. */
|
|
1753
1750
|
identity?: IdentificationData;
|
|
1754
1751
|
}
|
|
1755
|
-
|
|
1752
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1756
1753
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1757
1754
|
_id?: string;
|
|
1758
1755
|
/**
|
|
@@ -1782,107 +1779,17 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1782
1779
|
*/
|
|
1783
1780
|
entityEventSequence?: string | null;
|
|
1784
1781
|
}
|
|
1785
|
-
|
|
1782
|
+
interface SubscriptionContractCreatedEnvelope {
|
|
1786
1783
|
entity: SubscriptionContract;
|
|
1787
1784
|
metadata: EventMetadata;
|
|
1788
1785
|
}
|
|
1789
|
-
|
|
1790
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1791
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1792
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1793
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1794
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1795
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1796
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1797
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1798
|
-
* @webhook
|
|
1799
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_created
|
|
1800
|
-
* @slug created
|
|
1801
|
-
* @documentationMaturity preview
|
|
1802
|
-
*/
|
|
1803
|
-
export declare function onSubscriptionContractCreated(handler: (event: SubscriptionContractCreatedEnvelope) => void | Promise<void>): void;
|
|
1804
|
-
export interface SubscriptionContractDeletedEnvelope {
|
|
1786
|
+
interface SubscriptionContractDeletedEnvelope {
|
|
1805
1787
|
metadata: EventMetadata;
|
|
1806
1788
|
}
|
|
1807
|
-
|
|
1808
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1809
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1810
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1811
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1812
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1813
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1814
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1815
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1816
|
-
* @webhook
|
|
1817
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_deleted
|
|
1818
|
-
* @slug deleted
|
|
1819
|
-
* @documentationMaturity preview
|
|
1820
|
-
*/
|
|
1821
|
-
export declare function onSubscriptionContractDeleted(handler: (event: SubscriptionContractDeletedEnvelope) => void | Promise<void>): void;
|
|
1822
|
-
export interface SubscriptionContractUpdatedEnvelope {
|
|
1789
|
+
interface SubscriptionContractUpdatedEnvelope {
|
|
1823
1790
|
entity: SubscriptionContract;
|
|
1824
1791
|
metadata: EventMetadata;
|
|
1825
1792
|
}
|
|
1826
|
-
/** @permissionScope Manage Stores - all permissions
|
|
1827
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1828
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1829
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1830
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1831
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1832
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1833
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1834
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1835
|
-
* @webhook
|
|
1836
|
-
* @eventType wix.ecom.subscription_contracts.v1.subscription_contract_updated
|
|
1837
|
-
* @slug updated
|
|
1838
|
-
* @documentationMaturity preview
|
|
1839
|
-
*/
|
|
1840
|
-
export declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
|
|
1841
|
-
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`;
|
|
1842
|
-
/**
|
|
1843
|
-
* Retrieves a SubscriptionContract.
|
|
1844
|
-
* @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
|
|
1845
|
-
* @public
|
|
1846
|
-
* @documentationMaturity preview
|
|
1847
|
-
* @requiredField subscriptionContractId
|
|
1848
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1849
|
-
* @permissionScope Manage Stores - all permissions
|
|
1850
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1851
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1852
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1853
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1854
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1855
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1856
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1857
|
-
* @applicableIdentity APP
|
|
1858
|
-
* @returns The requested SubscriptionContract.
|
|
1859
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
|
|
1860
|
-
*/
|
|
1861
|
-
export declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, SubscriptionContractNonNullablePaths>>;
|
|
1862
|
-
/**
|
|
1863
|
-
* Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
|
|
1864
|
-
*
|
|
1865
|
-
* Up to 300 SubscriptionContracts can be returned per request.
|
|
1866
|
-
*
|
|
1867
|
-
* To learn how to query SubscriptionContracts, see [API Query Language][2].
|
|
1868
|
-
*
|
|
1869
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
1870
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
1871
|
-
* @public
|
|
1872
|
-
* @documentationMaturity preview
|
|
1873
|
-
* @permissionScope Manage Stores - all permissions
|
|
1874
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1875
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1876
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1877
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1878
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1879
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1880
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1881
|
-
* @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
|
|
1882
|
-
* @applicableIdentity APP
|
|
1883
|
-
* @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
|
|
1884
|
-
*/
|
|
1885
|
-
export declare function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;
|
|
1886
1793
|
interface QueryCursorResult {
|
|
1887
1794
|
cursors: Cursors;
|
|
1888
1795
|
hasNext: () => boolean;
|
|
@@ -1890,13 +1797,13 @@ interface QueryCursorResult {
|
|
|
1890
1797
|
length: number;
|
|
1891
1798
|
pageSize: number;
|
|
1892
1799
|
}
|
|
1893
|
-
|
|
1800
|
+
interface SubscriptionContractsQueryResult extends QueryCursorResult {
|
|
1894
1801
|
items: SubscriptionContract[];
|
|
1895
1802
|
query: SubscriptionContractsQueryBuilder;
|
|
1896
1803
|
next: () => Promise<SubscriptionContractsQueryResult>;
|
|
1897
1804
|
prev: () => Promise<SubscriptionContractsQueryResult>;
|
|
1898
1805
|
}
|
|
1899
|
-
|
|
1806
|
+
interface SubscriptionContractsQueryBuilder {
|
|
1900
1807
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1901
1808
|
* @param value - Value to compare against.
|
|
1902
1809
|
* @documentationMaturity preview
|
|
@@ -1960,4 +1867,5 @@ export interface SubscriptionContractsQueryBuilder {
|
|
|
1960
1867
|
/** @documentationMaturity preview */
|
|
1961
1868
|
find: () => Promise<SubscriptionContractsQueryResult>;
|
|
1962
1869
|
}
|
|
1963
|
-
|
|
1870
|
+
|
|
1871
|
+
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 };
|