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