@wix/auto_sdk_pricing-plans_orders 1.0.57 → 1.0.59
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/index.d.mts +343 -0
- package/build/index.d.ts +343 -0
- package/build/index.js +1870 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1807 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +343 -0
- package/build/internal/index.d.ts +343 -0
- package/build/internal/index.js +1870 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1807 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +982 -0
- package/build/internal/meta.d.ts +982 -0
- package/build/internal/meta.js +1057 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1016 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{es/src/pricing-plans-v2-order-orders.types.d.ts → internal/pricing-plans-v2-order-orders.universal-CxIXSY94.d.mts} +424 -157
- package/build/{cjs/src/pricing-plans-v2-order-orders.types.d.ts → internal/pricing-plans-v2-order-orders.universal-CxIXSY94.d.ts} +424 -157
- package/build/meta.d.mts +982 -0
- package/build/meta.d.ts +982 -0
- package/build/meta.js +1057 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1016 -0
- package/build/meta.mjs.map +1 -0
- package/build/{internal/cjs/src/pricing-plans-v2-order-orders.types.d.ts → pricing-plans-v2-order-orders.universal-Bwx6oqbS.d.mts} +420 -170
- package/build/{internal/es/src/pricing-plans-v2-order-orders.types.d.ts → pricing-plans-v2-order-orders.universal-Bwx6oqbS.d.ts} +420 -170
- 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/pricing-plans-v2-order-orders.context.d.ts +0 -111
- package/build/cjs/src/pricing-plans-v2-order-orders.context.js +0 -126
- package/build/cjs/src/pricing-plans-v2-order-orders.context.js.map +0 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.http.d.ts +0 -149
- package/build/cjs/src/pricing-plans-v2-order-orders.http.js +0 -877
- package/build/cjs/src/pricing-plans-v2-order-orders.http.js.map +0 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.d.ts +0 -43
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.js +0 -313
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.js.map +0 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.public.d.ts +0 -249
- package/build/cjs/src/pricing-plans-v2-order-orders.public.js +0 -373
- package/build/cjs/src/pricing-plans-v2-order-orders.public.js.map +0 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.types.js +0 -145
- package/build/cjs/src/pricing-plans-v2-order-orders.types.js.map +0 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.d.ts +0 -2317
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.js +0 -930
- package/build/cjs/src/pricing-plans-v2-order-orders.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/pricing-plans-v2-order-orders.context.d.ts +0 -111
- package/build/es/src/pricing-plans-v2-order-orders.context.js +0 -111
- package/build/es/src/pricing-plans-v2-order-orders.context.js.map +0 -1
- package/build/es/src/pricing-plans-v2-order-orders.http.d.ts +0 -149
- package/build/es/src/pricing-plans-v2-order-orders.http.js +0 -859
- package/build/es/src/pricing-plans-v2-order-orders.http.js.map +0 -1
- package/build/es/src/pricing-plans-v2-order-orders.meta.d.ts +0 -43
- package/build/es/src/pricing-plans-v2-order-orders.meta.js +0 -272
- package/build/es/src/pricing-plans-v2-order-orders.meta.js.map +0 -1
- package/build/es/src/pricing-plans-v2-order-orders.public.d.ts +0 -249
- package/build/es/src/pricing-plans-v2-order-orders.public.js +0 -343
- package/build/es/src/pricing-plans-v2-order-orders.public.js.map +0 -1
- package/build/es/src/pricing-plans-v2-order-orders.types.js +0 -142
- package/build/es/src/pricing-plans-v2-order-orders.types.js.map +0 -1
- package/build/es/src/pricing-plans-v2-order-orders.universal.d.ts +0 -2317
- package/build/es/src/pricing-plans-v2-order-orders.universal.js +0 -889
- package/build/es/src/pricing-plans-v2-order-orders.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/pricing-plans-v2-order-orders.context.d.ts +0 -111
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.context.js +0 -126
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.context.js.map +0 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.d.ts +0 -149
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.js +0 -877
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.js.map +0 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.d.ts +0 -43
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.js +0 -313
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.d.ts +0 -249
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.js +0 -373
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.js.map +0 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.types.js +0 -145
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.types.js.map +0 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.d.ts +0 -2334
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.js +0 -930
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.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/pricing-plans-v2-order-orders.context.d.ts +0 -111
- package/build/internal/es/src/pricing-plans-v2-order-orders.context.js +0 -111
- package/build/internal/es/src/pricing-plans-v2-order-orders.context.js.map +0 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.d.ts +0 -149
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.js +0 -859
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.js.map +0 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.d.ts +0 -43
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.js +0 -272
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.js.map +0 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.d.ts +0 -249
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.js +0 -343
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.js.map +0 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.types.js +0 -142
- package/build/internal/es/src/pricing-plans-v2-order-orders.types.js.map +0 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.d.ts +0 -2334
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.js +0 -889
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.js.map +0 -1
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
* Orders are based on pricing models based on the payment and duration cycles for each plan.
|
|
6
6
|
* Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).
|
|
7
7
|
*/
|
|
8
|
-
|
|
8
|
+
interface Order {
|
|
9
9
|
/**
|
|
10
10
|
* Order ID.
|
|
11
11
|
* @format GUID
|
|
12
12
|
* @readonly
|
|
13
13
|
*/
|
|
14
|
-
|
|
14
|
+
_id?: string;
|
|
15
15
|
/**
|
|
16
16
|
* ID of the plan purchased with the order, from the Plans API.
|
|
17
17
|
* @format GUID
|
|
@@ -44,7 +44,8 @@ export interface Order {
|
|
|
44
44
|
*/
|
|
45
45
|
buyer?: Buyer;
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
47
|
+
* @internal
|
|
48
|
+
* @internal
|
|
48
49
|
* @readonly
|
|
49
50
|
* @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
|
|
50
51
|
* @replacedBy pricing
|
|
@@ -152,19 +153,19 @@ export interface Order {
|
|
|
152
153
|
* Date and time the order was created.
|
|
153
154
|
* @readonly
|
|
154
155
|
*/
|
|
155
|
-
|
|
156
|
+
_createdDate?: Date | null;
|
|
156
157
|
/**
|
|
157
158
|
* Date and time the order was updated.
|
|
158
159
|
* @readonly
|
|
159
160
|
*/
|
|
160
|
-
|
|
161
|
+
_updatedDate?: Date | null;
|
|
161
162
|
/**
|
|
162
163
|
* Information about the form submitted during the plan's checkout.
|
|
163
164
|
* @readonly
|
|
164
165
|
*/
|
|
165
166
|
formData?: FormData;
|
|
166
167
|
}
|
|
167
|
-
|
|
168
|
+
interface Buyer {
|
|
168
169
|
/**
|
|
169
170
|
* Member ID for a Wix site member, from the Members API.
|
|
170
171
|
* @format GUID
|
|
@@ -178,7 +179,7 @@ export interface Buyer {
|
|
|
178
179
|
*/
|
|
179
180
|
contactId?: string;
|
|
180
181
|
}
|
|
181
|
-
|
|
182
|
+
interface PriceDetails extends PriceDetailsPricingModelOneOf {
|
|
182
183
|
/** Order has recurring payments. */
|
|
183
184
|
subscription?: Recurrence;
|
|
184
185
|
/** One-time payment. Order is valid for a specified duration. */
|
|
@@ -224,7 +225,7 @@ export interface PriceDetails extends PriceDetailsPricingModelOneOf {
|
|
|
224
225
|
coupon?: Coupon;
|
|
225
226
|
}
|
|
226
227
|
/** @oneof */
|
|
227
|
-
|
|
228
|
+
interface PriceDetailsPricingModelOneOf {
|
|
228
229
|
/** Order has recurring payments. */
|
|
229
230
|
subscription?: Recurrence;
|
|
230
231
|
/** One-time payment. Order is valid for a specified duration. */
|
|
@@ -232,7 +233,7 @@ export interface PriceDetailsPricingModelOneOf {
|
|
|
232
233
|
/** One-time payment. Order is valid until it is canceled. */
|
|
233
234
|
singlePaymentUnlimited?: boolean | null;
|
|
234
235
|
}
|
|
235
|
-
|
|
236
|
+
interface Tax {
|
|
236
237
|
/** Name of the tax. For example, VAT. */
|
|
237
238
|
name?: string;
|
|
238
239
|
/** Whether tax is included in the original price. When `false`, tax is added at checkout. */
|
|
@@ -249,7 +250,7 @@ export interface Tax {
|
|
|
249
250
|
amount?: string;
|
|
250
251
|
}
|
|
251
252
|
/** An object specifying how often and for how long payments recur (may be forever). */
|
|
252
|
-
|
|
253
|
+
interface Recurrence {
|
|
253
254
|
/**
|
|
254
255
|
* Number of payment cycles the subscription is valid for.
|
|
255
256
|
* `0` for unlimited plans or for plans that are valid until canceled.
|
|
@@ -264,7 +265,7 @@ export interface Recurrence {
|
|
|
264
265
|
cycleCount?: number | null;
|
|
265
266
|
}
|
|
266
267
|
/** A duration expressed in number of time units. */
|
|
267
|
-
|
|
268
|
+
interface Duration {
|
|
268
269
|
/**
|
|
269
270
|
* Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
|
|
270
271
|
* @min 1
|
|
@@ -273,7 +274,7 @@ export interface Duration {
|
|
|
273
274
|
/** Unit of time for the cycle duration. */
|
|
274
275
|
unit?: PeriodUnitWithLiterals;
|
|
275
276
|
}
|
|
276
|
-
|
|
277
|
+
declare enum PeriodUnit {
|
|
277
278
|
/** Not defined. */
|
|
278
279
|
UNDEFINED = "UNDEFINED",
|
|
279
280
|
/** Time unit is a day. */
|
|
@@ -286,8 +287,8 @@ export declare enum PeriodUnit {
|
|
|
286
287
|
YEAR = "YEAR"
|
|
287
288
|
}
|
|
288
289
|
/** @enumType */
|
|
289
|
-
|
|
290
|
-
|
|
290
|
+
type PeriodUnitWithLiterals = PeriodUnit | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
291
|
+
interface Coupon {
|
|
291
292
|
/**
|
|
292
293
|
* Code of the applied coupon.
|
|
293
294
|
* @minLength 1
|
|
@@ -304,9 +305,9 @@ export interface Coupon {
|
|
|
304
305
|
* @format GUID
|
|
305
306
|
* @readonly
|
|
306
307
|
*/
|
|
307
|
-
|
|
308
|
+
_id?: string;
|
|
308
309
|
}
|
|
309
|
-
|
|
310
|
+
interface PricingDetails extends PricingDetailsPricingModelOneOf {
|
|
310
311
|
/** Pricing model for an order with recurring payment cycles. */
|
|
311
312
|
subscription?: Recurrence;
|
|
312
313
|
/** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
|
|
@@ -320,7 +321,7 @@ export interface PricingDetails extends PricingDetailsPricingModelOneOf {
|
|
|
320
321
|
prices?: SpannedPrice[];
|
|
321
322
|
}
|
|
322
323
|
/** @oneof */
|
|
323
|
-
|
|
324
|
+
interface PricingDetailsPricingModelOneOf {
|
|
324
325
|
/** Pricing model for an order with recurring payment cycles. */
|
|
325
326
|
subscription?: Recurrence;
|
|
326
327
|
/** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
|
|
@@ -328,7 +329,7 @@ export interface PricingDetailsPricingModelOneOf {
|
|
|
328
329
|
/** Pricing model for an order with a one-time payment and the order is valid until canceled. */
|
|
329
330
|
singlePaymentUnlimited?: boolean | null;
|
|
330
331
|
}
|
|
331
|
-
|
|
332
|
+
interface SpannedPrice {
|
|
332
333
|
/**
|
|
333
334
|
* Cycle duration to apply `price` for.
|
|
334
335
|
*
|
|
@@ -339,7 +340,7 @@ export interface SpannedPrice {
|
|
|
339
340
|
/** Order price. */
|
|
340
341
|
price?: Price;
|
|
341
342
|
}
|
|
342
|
-
|
|
343
|
+
interface PriceDuration {
|
|
343
344
|
/**
|
|
344
345
|
* Price starts to apply with this cycle.
|
|
345
346
|
*
|
|
@@ -357,7 +358,7 @@ export interface PriceDuration {
|
|
|
357
358
|
*/
|
|
358
359
|
numberOfCycles?: number | null;
|
|
359
360
|
}
|
|
360
|
-
|
|
361
|
+
interface Price {
|
|
361
362
|
/**
|
|
362
363
|
* Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`.
|
|
363
364
|
* @format DECIMAL_VALUE
|
|
@@ -395,7 +396,7 @@ export interface Price {
|
|
|
395
396
|
*/
|
|
396
397
|
proration?: string;
|
|
397
398
|
}
|
|
398
|
-
|
|
399
|
+
interface Fee {
|
|
399
400
|
/**
|
|
400
401
|
* Fee name
|
|
401
402
|
* @minLength 1
|
|
@@ -408,7 +409,7 @@ export interface Fee {
|
|
|
408
409
|
*/
|
|
409
410
|
amount?: string;
|
|
410
411
|
}
|
|
411
|
-
|
|
412
|
+
declare enum OrderType {
|
|
412
413
|
/** Undefined order type. */
|
|
413
414
|
UNDEFINED = "UNDEFINED",
|
|
414
415
|
/** The buyer purchased the plan using the site. */
|
|
@@ -419,8 +420,8 @@ export declare enum OrderType {
|
|
|
419
420
|
EXTERNAL = "EXTERNAL"
|
|
420
421
|
}
|
|
421
422
|
/** @enumType */
|
|
422
|
-
|
|
423
|
-
|
|
423
|
+
type OrderTypeWithLiterals = OrderType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE' | 'EXTERNAL';
|
|
424
|
+
declare enum OrderMethod {
|
|
424
425
|
/** Unknown order method. */
|
|
425
426
|
UNKNOWN = "UNKNOWN",
|
|
426
427
|
/** Mail Order / Telephone Order transaction. */
|
|
@@ -429,8 +430,8 @@ export declare enum OrderMethod {
|
|
|
429
430
|
POS = "POS"
|
|
430
431
|
}
|
|
431
432
|
/** @enumType */
|
|
432
|
-
|
|
433
|
-
|
|
433
|
+
type OrderMethodWithLiterals = OrderMethod | 'UNKNOWN' | 'MOTO' | 'POS';
|
|
434
|
+
declare enum OrderStatus {
|
|
434
435
|
/** Undefined order status. */
|
|
435
436
|
UNDEFINED = "UNDEFINED",
|
|
436
437
|
/** Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer. */
|
|
@@ -447,8 +448,8 @@ export declare enum OrderStatus {
|
|
|
447
448
|
CANCELED = "CANCELED"
|
|
448
449
|
}
|
|
449
450
|
/** @enumType */
|
|
450
|
-
|
|
451
|
-
|
|
451
|
+
type OrderStatusWithLiterals = OrderStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'CANCELED';
|
|
452
|
+
interface Cancellation {
|
|
452
453
|
/** Date and time the cancellation was requested. */
|
|
453
454
|
requestedDate?: Date | null;
|
|
454
455
|
/** Reason for the cancellation. */
|
|
@@ -456,7 +457,7 @@ export interface Cancellation {
|
|
|
456
457
|
/** When the cancellation takes effect. Set when cancelling the order. */
|
|
457
458
|
effectiveAt?: CancellationEffectiveAtWithLiterals;
|
|
458
459
|
}
|
|
459
|
-
|
|
460
|
+
declare enum CancellationCause {
|
|
460
461
|
/** Undefined cancellation cause. */
|
|
461
462
|
UNDEFINED = "UNDEFINED",
|
|
462
463
|
/** Wix user canceled the order. */
|
|
@@ -471,8 +472,8 @@ export declare enum CancellationCause {
|
|
|
471
472
|
UNKNOWN = "UNKNOWN"
|
|
472
473
|
}
|
|
473
474
|
/** @enumType */
|
|
474
|
-
|
|
475
|
-
|
|
475
|
+
type CancellationCauseWithLiterals = CancellationCause | 'UNDEFINED' | 'OWNER_ACTION' | 'MEMBER_ACTION' | 'PAYMENT_FAILURE' | 'PAYMENT_SETUP_FAILURE' | 'UNKNOWN';
|
|
476
|
+
declare enum CancellationEffectiveAt {
|
|
476
477
|
/** Undefined cancellation time. */
|
|
477
478
|
UNDEFINED = "UNDEFINED",
|
|
478
479
|
/** Cancellation occurs immediately and the buyer can no longer use the plan. */
|
|
@@ -481,8 +482,8 @@ export declare enum CancellationEffectiveAt {
|
|
|
481
482
|
NEXT_PAYMENT_DATE = "NEXT_PAYMENT_DATE"
|
|
482
483
|
}
|
|
483
484
|
/** @enumType */
|
|
484
|
-
|
|
485
|
-
|
|
485
|
+
type CancellationEffectiveAtWithLiterals = CancellationEffectiveAt | 'UNDEFINED' | 'IMMEDIATELY' | 'NEXT_PAYMENT_DATE';
|
|
486
|
+
declare enum PaymentStatus {
|
|
486
487
|
/** Undefined payment status. */
|
|
487
488
|
UNDEFINED = "UNDEFINED",
|
|
488
489
|
/** Payment has been paid. */
|
|
@@ -499,8 +500,8 @@ export declare enum PaymentStatus {
|
|
|
499
500
|
NOT_APPLICABLE = "NOT_APPLICABLE"
|
|
500
501
|
}
|
|
501
502
|
/** @enumType */
|
|
502
|
-
|
|
503
|
-
|
|
503
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | 'PENDING' | 'NOT_APPLICABLE';
|
|
504
|
+
interface PausePeriod {
|
|
504
505
|
/** Status of the pause period. */
|
|
505
506
|
status?: StatusWithLiterals;
|
|
506
507
|
/** Start date and time of the pause period. */
|
|
@@ -512,7 +513,7 @@ export interface PausePeriod {
|
|
|
512
513
|
*/
|
|
513
514
|
resumeDate?: Date | null;
|
|
514
515
|
}
|
|
515
|
-
|
|
516
|
+
declare enum Status {
|
|
516
517
|
/** Undefined status. */
|
|
517
518
|
UNDEFINED = "UNDEFINED",
|
|
518
519
|
/** Status while the order is paused. */
|
|
@@ -521,12 +522,12 @@ export declare enum Status {
|
|
|
521
522
|
ENDED = "ENDED"
|
|
522
523
|
}
|
|
523
524
|
/** @enumType */
|
|
524
|
-
|
|
525
|
+
type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | 'ENDED';
|
|
525
526
|
/**
|
|
526
527
|
* Current cycle will be empty when order is cancelled, expired or order start date is in the future
|
|
527
528
|
* Current cycle start and end dates take into account free trial days and suspensions
|
|
528
529
|
*/
|
|
529
|
-
|
|
530
|
+
interface CurrentCycle {
|
|
530
531
|
/**
|
|
531
532
|
* Index of the current payment cycle in the order.
|
|
532
533
|
*
|
|
@@ -539,7 +540,7 @@ export interface CurrentCycle {
|
|
|
539
540
|
endedDate?: Date | null;
|
|
540
541
|
}
|
|
541
542
|
/** Order cycle start and end dates take into account free trial days and suspensions */
|
|
542
|
-
|
|
543
|
+
interface OrderCycle {
|
|
543
544
|
/**
|
|
544
545
|
* Index of this cycle in the order.
|
|
545
546
|
*
|
|
@@ -551,7 +552,7 @@ export interface OrderCycle {
|
|
|
551
552
|
/** End date and time for this order cycle. */
|
|
552
553
|
endedDate?: Date | null;
|
|
553
554
|
}
|
|
554
|
-
|
|
555
|
+
interface FormData {
|
|
555
556
|
/**
|
|
556
557
|
* ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout.
|
|
557
558
|
* @format GUID
|
|
@@ -568,13 +569,13 @@ export interface FormData {
|
|
|
568
569
|
*/
|
|
569
570
|
submissionData?: Record<string, any>;
|
|
570
571
|
}
|
|
571
|
-
|
|
572
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
572
573
|
createdEvent?: EntityCreatedEvent;
|
|
573
574
|
updatedEvent?: EntityUpdatedEvent;
|
|
574
575
|
deletedEvent?: EntityDeletedEvent;
|
|
575
576
|
actionEvent?: ActionEvent;
|
|
576
577
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
577
|
-
|
|
578
|
+
_id?: string;
|
|
578
579
|
/**
|
|
579
580
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
580
581
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -603,42 +604,40 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
603
604
|
entityEventSequence?: string | null;
|
|
604
605
|
}
|
|
605
606
|
/** @oneof */
|
|
606
|
-
|
|
607
|
+
interface DomainEventBodyOneOf {
|
|
607
608
|
createdEvent?: EntityCreatedEvent;
|
|
608
609
|
updatedEvent?: EntityUpdatedEvent;
|
|
609
610
|
deletedEvent?: EntityDeletedEvent;
|
|
610
611
|
actionEvent?: ActionEvent;
|
|
611
612
|
}
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
615
|
-
restoreInfo?: RestoreInfo;
|
|
613
|
+
interface EntityCreatedEvent {
|
|
614
|
+
entity?: string;
|
|
616
615
|
}
|
|
617
|
-
|
|
616
|
+
interface RestoreInfo {
|
|
618
617
|
deletedDate?: Date | null;
|
|
619
618
|
}
|
|
620
|
-
|
|
619
|
+
interface EntityUpdatedEvent {
|
|
621
620
|
/**
|
|
622
621
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
623
622
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
624
623
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
625
624
|
*/
|
|
626
|
-
|
|
625
|
+
currentEntity?: string;
|
|
627
626
|
}
|
|
628
|
-
|
|
627
|
+
interface EntityDeletedEvent {
|
|
629
628
|
/** Entity that was deleted. */
|
|
630
|
-
|
|
629
|
+
deletedEntity?: string | null;
|
|
631
630
|
}
|
|
632
|
-
|
|
633
|
-
|
|
631
|
+
interface ActionEvent {
|
|
632
|
+
body?: string;
|
|
634
633
|
}
|
|
635
|
-
|
|
634
|
+
interface Empty {
|
|
636
635
|
}
|
|
637
|
-
|
|
636
|
+
interface OrderPurchased {
|
|
638
637
|
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
639
638
|
order?: Order;
|
|
640
639
|
}
|
|
641
|
-
|
|
640
|
+
interface OrderStarted {
|
|
642
641
|
/** Order that reached its `startDate`. */
|
|
643
642
|
order?: Order;
|
|
644
643
|
}
|
|
@@ -647,27 +646,27 @@ export interface OrderStarted {
|
|
|
647
646
|
*
|
|
648
647
|
* This webhook does not trigger at the initial start of an offline order.
|
|
649
648
|
*/
|
|
650
|
-
|
|
649
|
+
interface OrderCycleStarted {
|
|
651
650
|
/** Order whose new cycle started. */
|
|
652
651
|
order?: Order;
|
|
653
652
|
/** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
|
|
654
653
|
cycleNumber?: number;
|
|
655
654
|
}
|
|
656
655
|
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
657
|
-
|
|
656
|
+
interface OrderAutoRenewCanceled {
|
|
658
657
|
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
659
658
|
order?: Order;
|
|
660
659
|
}
|
|
661
|
-
|
|
660
|
+
interface OrderEnded {
|
|
662
661
|
/** Order that ended. */
|
|
663
662
|
order?: Order;
|
|
664
663
|
}
|
|
665
|
-
|
|
664
|
+
interface GetOrderRequest {
|
|
666
665
|
/**
|
|
667
666
|
* Order ID.
|
|
668
667
|
* @format GUID
|
|
669
668
|
*/
|
|
670
|
-
|
|
669
|
+
_id: string;
|
|
671
670
|
/**
|
|
672
671
|
* Predefined set of fields to return.
|
|
673
672
|
*
|
|
@@ -675,7 +674,7 @@ export interface GetOrderRequest {
|
|
|
675
674
|
*/
|
|
676
675
|
fieldSet?: SetWithLiterals;
|
|
677
676
|
}
|
|
678
|
-
|
|
677
|
+
declare enum Set {
|
|
679
678
|
/** Same behavior as `BASIC`.` */
|
|
680
679
|
UNKNOWN_SET = "UNKNOWN_SET",
|
|
681
680
|
/** Doesn't return any order form submission data. */
|
|
@@ -684,12 +683,12 @@ export declare enum Set {
|
|
|
684
683
|
FULL = "FULL"
|
|
685
684
|
}
|
|
686
685
|
/** @enumType */
|
|
687
|
-
|
|
688
|
-
|
|
686
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
687
|
+
interface GetOrderResponse {
|
|
689
688
|
/** Order. */
|
|
690
689
|
order?: Order;
|
|
691
690
|
}
|
|
692
|
-
|
|
691
|
+
interface ListOrdersRequest {
|
|
693
692
|
/**
|
|
694
693
|
* Filter by a buyer's member ID, from the Members API.
|
|
695
694
|
* @format GUID
|
|
@@ -731,7 +730,7 @@ export interface ListOrdersRequest {
|
|
|
731
730
|
*/
|
|
732
731
|
fieldSet?: SetWithLiterals;
|
|
733
732
|
}
|
|
734
|
-
|
|
733
|
+
interface Sorting {
|
|
735
734
|
/**
|
|
736
735
|
* Name of the field to sort by.
|
|
737
736
|
* @maxLength 512
|
|
@@ -740,19 +739,19 @@ export interface Sorting {
|
|
|
740
739
|
/** Sort order. */
|
|
741
740
|
order?: SortOrderWithLiterals;
|
|
742
741
|
}
|
|
743
|
-
|
|
742
|
+
declare enum SortOrder {
|
|
744
743
|
ASC = "ASC",
|
|
745
744
|
DESC = "DESC"
|
|
746
745
|
}
|
|
747
746
|
/** @enumType */
|
|
748
|
-
|
|
749
|
-
|
|
747
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
748
|
+
interface ListOrdersResponse {
|
|
750
749
|
/** List of orders. */
|
|
751
750
|
orders?: Order[];
|
|
752
751
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
753
752
|
pagingMetadata?: PagingMetadataV2;
|
|
754
753
|
}
|
|
755
|
-
|
|
754
|
+
interface PagingMetadataV2 {
|
|
756
755
|
/** Number of items returned in the response. */
|
|
757
756
|
count?: number | null;
|
|
758
757
|
/** Offset that was requested. */
|
|
@@ -764,7 +763,7 @@ export interface PagingMetadataV2 {
|
|
|
764
763
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
765
764
|
cursors?: Cursors;
|
|
766
765
|
}
|
|
767
|
-
|
|
766
|
+
interface Cursors {
|
|
768
767
|
/**
|
|
769
768
|
* Cursor string pointing to the next page in the list of results.
|
|
770
769
|
* @maxLength 16000
|
|
@@ -776,11 +775,11 @@ export interface Cursors {
|
|
|
776
775
|
*/
|
|
777
776
|
prev?: string | null;
|
|
778
777
|
}
|
|
779
|
-
|
|
778
|
+
interface OrdersQueryOrdersRequest {
|
|
780
779
|
/** Query filter. */
|
|
781
780
|
query?: QueryV2;
|
|
782
781
|
}
|
|
783
|
-
|
|
782
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
784
783
|
/** Paging options to limit and skip the number of items. */
|
|
785
784
|
paging?: Paging;
|
|
786
785
|
/** 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`. */
|
|
@@ -803,19 +802,19 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
803
802
|
fieldsets?: string[];
|
|
804
803
|
}
|
|
805
804
|
/** @oneof */
|
|
806
|
-
|
|
805
|
+
interface QueryV2PagingMethodOneOf {
|
|
807
806
|
/** Paging options to limit and skip the number of items. */
|
|
808
807
|
paging?: Paging;
|
|
809
808
|
/** 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`. */
|
|
810
809
|
cursorPaging?: CursorPaging;
|
|
811
810
|
}
|
|
812
|
-
|
|
811
|
+
interface Paging {
|
|
813
812
|
/** Number of items to load. */
|
|
814
813
|
limit?: number | null;
|
|
815
814
|
/** Number of items to skip in the current sort order. */
|
|
816
815
|
offset?: number | null;
|
|
817
816
|
}
|
|
818
|
-
|
|
817
|
+
interface CursorPaging {
|
|
819
818
|
/**
|
|
820
819
|
* Maximum number of items to return in the results.
|
|
821
820
|
* @max 100
|
|
@@ -830,28 +829,28 @@ export interface CursorPaging {
|
|
|
830
829
|
*/
|
|
831
830
|
cursor?: string | null;
|
|
832
831
|
}
|
|
833
|
-
|
|
832
|
+
interface OrdersQueryOrdersResponse {
|
|
834
833
|
/** Retrieved orders. */
|
|
835
834
|
plans?: Order[];
|
|
836
835
|
/** Paging-related data (number of orders returned, offset). */
|
|
837
836
|
pagingMetadata?: PagingMetadataV2;
|
|
838
837
|
}
|
|
839
|
-
|
|
838
|
+
interface GetOrdersStatsRequest {
|
|
840
839
|
}
|
|
841
|
-
|
|
840
|
+
interface GetOrdersStatsResponse {
|
|
842
841
|
/** Total number of orders. */
|
|
843
842
|
totalOrderCount?: number;
|
|
844
843
|
/** Number of active orders. */
|
|
845
844
|
activeOrderCount?: number;
|
|
846
845
|
}
|
|
847
|
-
|
|
846
|
+
interface GetAvailableOrderActionsRequest {
|
|
848
847
|
/**
|
|
849
848
|
* Order ID.
|
|
850
849
|
* @format GUID
|
|
851
850
|
*/
|
|
852
|
-
|
|
851
|
+
_id?: string;
|
|
853
852
|
}
|
|
854
|
-
|
|
853
|
+
interface GetAvailableOrderActionsResponse {
|
|
855
854
|
/** Whether the order can be suspended. */
|
|
856
855
|
suspendable?: boolean;
|
|
857
856
|
/** If the order cannot be suspended, a reason is returned here. */
|
|
@@ -859,7 +858,7 @@ export interface GetAvailableOrderActionsResponse {
|
|
|
859
858
|
/** Whether the order can be canceled by the buyer. */
|
|
860
859
|
cancelableByBuyer?: boolean;
|
|
861
860
|
}
|
|
862
|
-
|
|
861
|
+
declare enum ReasonNotSuspendable {
|
|
863
862
|
/** Undefined reason. */
|
|
864
863
|
UNDEFINED = "UNDEFINED",
|
|
865
864
|
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
@@ -878,13 +877,13 @@ export declare enum ReasonNotSuspendable {
|
|
|
878
877
|
OLD_STRIPE = "OLD_STRIPE"
|
|
879
878
|
}
|
|
880
879
|
/** @enumType */
|
|
881
|
-
|
|
882
|
-
|
|
880
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
881
|
+
interface PostponeEndDateRequest {
|
|
883
882
|
/**
|
|
884
883
|
* Order ID.
|
|
885
884
|
* @format GUID
|
|
886
885
|
*/
|
|
887
|
-
|
|
886
|
+
_id: string;
|
|
888
887
|
/**
|
|
889
888
|
* New end date and time.
|
|
890
889
|
*
|
|
@@ -892,59 +891,59 @@ export interface PostponeEndDateRequest {
|
|
|
892
891
|
*/
|
|
893
892
|
endDate: Date | null;
|
|
894
893
|
}
|
|
895
|
-
|
|
894
|
+
interface PostponeEndDateResponse {
|
|
896
895
|
}
|
|
897
|
-
|
|
896
|
+
interface OrderEndDatePostponed {
|
|
898
897
|
/** Order whose `endDate` was postponed. */
|
|
899
898
|
order?: Order;
|
|
900
899
|
}
|
|
901
|
-
|
|
900
|
+
interface CancelOrderRequest {
|
|
902
901
|
/**
|
|
903
902
|
* Order ID.
|
|
904
903
|
* @format GUID
|
|
905
904
|
*/
|
|
906
|
-
|
|
905
|
+
_id: string;
|
|
907
906
|
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
908
907
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
909
908
|
}
|
|
910
|
-
|
|
909
|
+
interface CancelOrderResponse {
|
|
911
910
|
}
|
|
912
911
|
/**
|
|
913
912
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
914
913
|
*
|
|
915
914
|
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
916
915
|
*/
|
|
917
|
-
|
|
916
|
+
interface OrderCanceled {
|
|
918
917
|
/** Canceled order. */
|
|
919
918
|
order?: Order;
|
|
920
919
|
}
|
|
921
|
-
|
|
920
|
+
interface MarkAsPaidRequest {
|
|
922
921
|
/**
|
|
923
922
|
* Order ID.
|
|
924
923
|
* @format GUID
|
|
925
924
|
*/
|
|
926
|
-
|
|
925
|
+
_id: string;
|
|
927
926
|
}
|
|
928
|
-
|
|
927
|
+
interface MarkAsPaidResponse {
|
|
929
928
|
}
|
|
930
|
-
|
|
929
|
+
interface OrderMarkedAsPaid {
|
|
931
930
|
/** Order that was marked as paid. */
|
|
932
931
|
order?: Order;
|
|
933
932
|
}
|
|
934
|
-
|
|
933
|
+
interface PauseOrderRequest {
|
|
935
934
|
/**
|
|
936
935
|
* Order ID.
|
|
937
936
|
* @format GUID
|
|
938
937
|
*/
|
|
939
|
-
|
|
938
|
+
_id: string;
|
|
940
939
|
}
|
|
941
|
-
|
|
940
|
+
interface PauseOrderResponse {
|
|
942
941
|
}
|
|
943
|
-
|
|
942
|
+
interface OrderPaused {
|
|
944
943
|
/** Paused order. */
|
|
945
944
|
order?: Order;
|
|
946
945
|
}
|
|
947
|
-
|
|
946
|
+
interface BulkPauseOrderRequest {
|
|
948
947
|
/**
|
|
949
948
|
* List of Order IDs.
|
|
950
949
|
* @format GUID
|
|
@@ -955,21 +954,21 @@ export interface BulkPauseOrderRequest {
|
|
|
955
954
|
/** Set to true to return Order entity in response. */
|
|
956
955
|
returnFullEntity?: boolean;
|
|
957
956
|
}
|
|
958
|
-
|
|
957
|
+
interface BulkPauseOrderResponse {
|
|
959
958
|
/** Orders that were paused. */
|
|
960
959
|
results?: BulkOrderResult[];
|
|
961
960
|
/** Bulk action metadata. */
|
|
962
961
|
bulkActionMetadata?: BulkActionMetadata;
|
|
963
962
|
}
|
|
964
|
-
|
|
963
|
+
interface BulkOrderResult {
|
|
965
964
|
/** Item metadata */
|
|
966
965
|
itemMetadata?: ItemMetadata;
|
|
967
966
|
/** The order. */
|
|
968
967
|
order?: Order;
|
|
969
968
|
}
|
|
970
|
-
|
|
969
|
+
interface ItemMetadata {
|
|
971
970
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
972
|
-
|
|
971
|
+
_id?: string | null;
|
|
973
972
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
974
973
|
originalIndex?: number;
|
|
975
974
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -977,7 +976,7 @@ export interface ItemMetadata {
|
|
|
977
976
|
/** Details about the error in case of failure. */
|
|
978
977
|
error?: ApplicationError;
|
|
979
978
|
}
|
|
980
|
-
|
|
979
|
+
interface ApplicationError {
|
|
981
980
|
/** Error code. */
|
|
982
981
|
code?: string;
|
|
983
982
|
/** Description of the error. */
|
|
@@ -985,7 +984,7 @@ export interface ApplicationError {
|
|
|
985
984
|
/** Data related to the error. */
|
|
986
985
|
data?: Record<string, any> | null;
|
|
987
986
|
}
|
|
988
|
-
|
|
987
|
+
interface BulkActionMetadata {
|
|
989
988
|
/** Number of items that were successfully processed. */
|
|
990
989
|
totalSuccesses?: number;
|
|
991
990
|
/** Number of items that couldn't be processed. */
|
|
@@ -993,20 +992,20 @@ export interface BulkActionMetadata {
|
|
|
993
992
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
994
993
|
undetailedFailures?: number;
|
|
995
994
|
}
|
|
996
|
-
|
|
995
|
+
interface ResumeOrderRequest {
|
|
997
996
|
/**
|
|
998
997
|
* Order ID.
|
|
999
998
|
* @format GUID
|
|
1000
999
|
*/
|
|
1001
|
-
|
|
1000
|
+
_id: string;
|
|
1002
1001
|
}
|
|
1003
|
-
|
|
1002
|
+
interface ResumeOrderResponse {
|
|
1004
1003
|
}
|
|
1005
|
-
|
|
1004
|
+
interface OrderResumed {
|
|
1006
1005
|
/** Resumed order. */
|
|
1007
1006
|
order?: Order;
|
|
1008
1007
|
}
|
|
1009
|
-
|
|
1008
|
+
interface BulkResumeOrderRequest {
|
|
1010
1009
|
/**
|
|
1011
1010
|
* List of Order IDs.
|
|
1012
1011
|
* @format GUID
|
|
@@ -1017,13 +1016,13 @@ export interface BulkResumeOrderRequest {
|
|
|
1017
1016
|
/** Set to true to return Order entity in response. */
|
|
1018
1017
|
returnFullEntity?: boolean;
|
|
1019
1018
|
}
|
|
1020
|
-
|
|
1019
|
+
interface BulkResumeOrderResponse {
|
|
1021
1020
|
/** Orders that were resumed. */
|
|
1022
1021
|
results?: BulkOrderResult[];
|
|
1023
1022
|
/** Bulk action metadata. */
|
|
1024
1023
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1025
1024
|
}
|
|
1026
|
-
|
|
1025
|
+
interface MessageEnvelope {
|
|
1027
1026
|
/**
|
|
1028
1027
|
* App instance ID.
|
|
1029
1028
|
* @format GUID
|
|
@@ -1039,7 +1038,7 @@ export interface MessageEnvelope {
|
|
|
1039
1038
|
/** Stringify payload. */
|
|
1040
1039
|
data?: string;
|
|
1041
1040
|
}
|
|
1042
|
-
|
|
1041
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1043
1042
|
/**
|
|
1044
1043
|
* ID of a site visitor that has not logged in to the site.
|
|
1045
1044
|
* @format GUID
|
|
@@ -1064,7 +1063,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1064
1063
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1065
1064
|
}
|
|
1066
1065
|
/** @oneof */
|
|
1067
|
-
|
|
1066
|
+
interface IdentificationDataIdOneOf {
|
|
1068
1067
|
/**
|
|
1069
1068
|
* ID of a site visitor that has not logged in to the site.
|
|
1070
1069
|
* @format GUID
|
|
@@ -1086,7 +1085,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1086
1085
|
*/
|
|
1087
1086
|
appId?: string;
|
|
1088
1087
|
}
|
|
1089
|
-
|
|
1088
|
+
declare enum WebhookIdentityType {
|
|
1090
1089
|
UNKNOWN = "UNKNOWN",
|
|
1091
1090
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1092
1091
|
MEMBER = "MEMBER",
|
|
@@ -1094,13 +1093,13 @@ export declare enum WebhookIdentityType {
|
|
|
1094
1093
|
APP = "APP"
|
|
1095
1094
|
}
|
|
1096
1095
|
/** @enumType */
|
|
1097
|
-
|
|
1098
|
-
|
|
1096
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1097
|
+
interface MemberGetOrderRequest {
|
|
1099
1098
|
/**
|
|
1100
1099
|
* Order ID.
|
|
1101
1100
|
* @format GUID
|
|
1102
1101
|
*/
|
|
1103
|
-
|
|
1102
|
+
_id: string;
|
|
1104
1103
|
/**
|
|
1105
1104
|
* Predefined set of fields to return.
|
|
1106
1105
|
*
|
|
@@ -1108,11 +1107,11 @@ export interface MemberGetOrderRequest {
|
|
|
1108
1107
|
*/
|
|
1109
1108
|
fieldSet?: SetWithLiterals;
|
|
1110
1109
|
}
|
|
1111
|
-
|
|
1110
|
+
interface MemberGetOrderResponse {
|
|
1112
1111
|
/** Requested order. */
|
|
1113
1112
|
order?: Order;
|
|
1114
1113
|
}
|
|
1115
|
-
|
|
1114
|
+
interface MemberListOrdersRequest {
|
|
1116
1115
|
/**
|
|
1117
1116
|
* Filter by plan IDs.
|
|
1118
1117
|
* @format GUID
|
|
@@ -1141,7 +1140,7 @@ export interface MemberListOrdersRequest {
|
|
|
1141
1140
|
*/
|
|
1142
1141
|
fieldSet?: SetWithLiterals;
|
|
1143
1142
|
}
|
|
1144
|
-
|
|
1143
|
+
interface MemberListOrdersResponse {
|
|
1145
1144
|
/** Requested orders. */
|
|
1146
1145
|
orders?: Order[];
|
|
1147
1146
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
@@ -1151,28 +1150,28 @@ export interface MemberListOrdersResponse {
|
|
|
1151
1150
|
* TODO: Write orders filter and sort docs page
|
|
1152
1151
|
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
1153
1152
|
*/
|
|
1154
|
-
|
|
1153
|
+
interface QueryOrdersRequest {
|
|
1155
1154
|
/** Query filter. */
|
|
1156
1155
|
query?: QueryV2;
|
|
1157
1156
|
}
|
|
1158
|
-
|
|
1157
|
+
interface QueryOrdersResponse {
|
|
1159
1158
|
/** Order data. */
|
|
1160
1159
|
plans?: Order[];
|
|
1161
1160
|
/** Paging-related data (number of orders returned, offset). */
|
|
1162
1161
|
pagingMetadata?: PagingMetadataV2;
|
|
1163
1162
|
}
|
|
1164
|
-
|
|
1163
|
+
interface RequestCancellationRequest {
|
|
1165
1164
|
/**
|
|
1166
1165
|
* Order ID.
|
|
1167
1166
|
* @format GUID
|
|
1168
1167
|
*/
|
|
1169
|
-
|
|
1168
|
+
_id: string;
|
|
1170
1169
|
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1171
1170
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1172
1171
|
}
|
|
1173
|
-
|
|
1172
|
+
interface RequestCancellationResponse {
|
|
1174
1173
|
}
|
|
1175
|
-
|
|
1174
|
+
interface CreateOnlineOrderRequest {
|
|
1176
1175
|
/**
|
|
1177
1176
|
* Plan ID.
|
|
1178
1177
|
* @format GUID
|
|
@@ -1198,7 +1197,7 @@ export interface CreateOnlineOrderRequest {
|
|
|
1198
1197
|
*/
|
|
1199
1198
|
submissionId?: string | null;
|
|
1200
1199
|
}
|
|
1201
|
-
|
|
1200
|
+
interface OnBehalf {
|
|
1202
1201
|
/**
|
|
1203
1202
|
* Member ID.
|
|
1204
1203
|
* @format GUID
|
|
@@ -1207,17 +1206,17 @@ export interface OnBehalf {
|
|
|
1207
1206
|
/** Method by which checkout is initiated. */
|
|
1208
1207
|
orderMethod?: OrderMethodWithLiterals;
|
|
1209
1208
|
}
|
|
1210
|
-
|
|
1209
|
+
interface CreateOnlineOrderResponse {
|
|
1211
1210
|
/** Created online order. */
|
|
1212
1211
|
order?: Order;
|
|
1213
1212
|
}
|
|
1214
|
-
|
|
1213
|
+
interface CouponsError {
|
|
1215
1214
|
/** Coupon code. */
|
|
1216
1215
|
couponCode?: string;
|
|
1217
1216
|
/** Plan ID. */
|
|
1218
1217
|
planId?: string;
|
|
1219
1218
|
}
|
|
1220
|
-
|
|
1219
|
+
interface CreateGuestOnlineOrderRequest {
|
|
1221
1220
|
/**
|
|
1222
1221
|
* Plan ID.
|
|
1223
1222
|
* @format GUID
|
|
@@ -1245,22 +1244,22 @@ export interface CreateGuestOnlineOrderRequest {
|
|
|
1245
1244
|
*/
|
|
1246
1245
|
submissionId?: string | null;
|
|
1247
1246
|
}
|
|
1248
|
-
|
|
1247
|
+
interface Captcha {
|
|
1249
1248
|
/** Token from captcha */
|
|
1250
1249
|
token?: string;
|
|
1251
1250
|
}
|
|
1252
|
-
|
|
1251
|
+
interface Guest {
|
|
1253
1252
|
/**
|
|
1254
1253
|
* Email for checkout
|
|
1255
1254
|
* @format EMAIL
|
|
1256
1255
|
*/
|
|
1257
1256
|
email?: string;
|
|
1258
1257
|
}
|
|
1259
|
-
|
|
1258
|
+
interface CreateGuestOnlineOrderResponse {
|
|
1260
1259
|
/** Order. */
|
|
1261
1260
|
order?: Order;
|
|
1262
1261
|
}
|
|
1263
|
-
|
|
1262
|
+
interface CreateOfflineOrderRequest {
|
|
1264
1263
|
/**
|
|
1265
1264
|
* ID of the plan being ordered, from the Plans API.
|
|
1266
1265
|
* @format GUID
|
|
@@ -1295,11 +1294,11 @@ export interface CreateOfflineOrderRequest {
|
|
|
1295
1294
|
*/
|
|
1296
1295
|
submissionId?: string | null;
|
|
1297
1296
|
}
|
|
1298
|
-
|
|
1297
|
+
interface CreateOfflineOrderResponse {
|
|
1299
1298
|
/** Order. */
|
|
1300
1299
|
order?: Order;
|
|
1301
1300
|
}
|
|
1302
|
-
|
|
1301
|
+
interface CreateExternalOrderRequest {
|
|
1303
1302
|
/**
|
|
1304
1303
|
* Plan ID.
|
|
1305
1304
|
* @format GUID
|
|
@@ -1311,11 +1310,11 @@ export interface CreateExternalOrderRequest {
|
|
|
1311
1310
|
*/
|
|
1312
1311
|
submissionId?: string | null;
|
|
1313
1312
|
}
|
|
1314
|
-
|
|
1313
|
+
interface CreateExternalOrderResponse {
|
|
1315
1314
|
/** Created order */
|
|
1316
1315
|
order?: Order;
|
|
1317
1316
|
}
|
|
1318
|
-
|
|
1317
|
+
interface GetOnlineOrderPreviewRequest {
|
|
1319
1318
|
/**
|
|
1320
1319
|
* Plan ID.
|
|
1321
1320
|
* @format GUID
|
|
@@ -1334,13 +1333,13 @@ export interface GetOnlineOrderPreviewRequest {
|
|
|
1334
1333
|
*/
|
|
1335
1334
|
couponCode?: string | null;
|
|
1336
1335
|
}
|
|
1337
|
-
|
|
1336
|
+
interface GetOnlineOrderPreviewResponse {
|
|
1338
1337
|
/** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
|
|
1339
1338
|
order?: Order;
|
|
1340
1339
|
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
1341
1340
|
purchaseLimitExceeded?: boolean;
|
|
1342
1341
|
}
|
|
1343
|
-
|
|
1342
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
|
1344
1343
|
/**
|
|
1345
1344
|
* Plan ID.
|
|
1346
1345
|
* @format GUID
|
|
@@ -1364,7 +1363,7 @@ export interface GetGuestOnlineOrderPreviewRequest {
|
|
|
1364
1363
|
*/
|
|
1365
1364
|
email?: string;
|
|
1366
1365
|
}
|
|
1367
|
-
|
|
1366
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
|
1368
1367
|
/** Will be missing if limit is exceeded */
|
|
1369
1368
|
order?: Order;
|
|
1370
1369
|
/**
|
|
@@ -1373,7 +1372,7 @@ export interface GetGuestOnlineOrderPreviewResponse {
|
|
|
1373
1372
|
*/
|
|
1374
1373
|
purchaseLimitExceeded?: boolean;
|
|
1375
1374
|
}
|
|
1376
|
-
|
|
1375
|
+
interface GetOfflineOrderPreviewRequest {
|
|
1377
1376
|
/**
|
|
1378
1377
|
* ID of the plan of the previewed order, from the Plans API.
|
|
1379
1378
|
* @format GUID
|
|
@@ -1397,7 +1396,7 @@ export interface GetOfflineOrderPreviewRequest {
|
|
|
1397
1396
|
*/
|
|
1398
1397
|
couponCode?: string | null;
|
|
1399
1398
|
}
|
|
1400
|
-
|
|
1399
|
+
interface GetOfflineOrderPreviewResponse {
|
|
1401
1400
|
/** The previewed order, as if the plan had been ordered. */
|
|
1402
1401
|
order?: Order;
|
|
1403
1402
|
/**
|
|
@@ -1408,7 +1407,7 @@ export interface GetOfflineOrderPreviewResponse {
|
|
|
1408
1407
|
*/
|
|
1409
1408
|
purchaseLimitExceeded?: boolean;
|
|
1410
1409
|
}
|
|
1411
|
-
|
|
1410
|
+
interface GetPricePreviewRequest {
|
|
1412
1411
|
/**
|
|
1413
1412
|
* ID of plan to preview.
|
|
1414
1413
|
* @format GUID
|
|
@@ -1421,9 +1420,10 @@ export interface GetPricePreviewRequest {
|
|
|
1421
1420
|
*/
|
|
1422
1421
|
couponCode?: string | null;
|
|
1423
1422
|
}
|
|
1424
|
-
|
|
1423
|
+
interface GetPricePreviewResponse {
|
|
1425
1424
|
/**
|
|
1426
|
-
*
|
|
1425
|
+
* @internal
|
|
1426
|
+
* @internal
|
|
1427
1427
|
* @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
|
1428
1428
|
* @replacedBy prices
|
|
1429
1429
|
* @targetRemovalDate 2022-10-01
|
|
@@ -1432,7 +1432,7 @@ export interface GetPricePreviewResponse {
|
|
|
1432
1432
|
/** Pricing details. */
|
|
1433
1433
|
prices?: SpannedPrice[];
|
|
1434
1434
|
}
|
|
1435
|
-
|
|
1435
|
+
interface ChangeStartDateRequest {
|
|
1436
1436
|
/**
|
|
1437
1437
|
* Draft order ID.
|
|
1438
1438
|
* @format GUID
|
|
@@ -1441,15 +1441,15 @@ export interface ChangeStartDateRequest {
|
|
|
1441
1441
|
/** New valid from date (timestamp). */
|
|
1442
1442
|
startDate?: Date | null;
|
|
1443
1443
|
}
|
|
1444
|
-
|
|
1444
|
+
interface ChangeStartDateResponse {
|
|
1445
1445
|
/** Updated draft order. */
|
|
1446
1446
|
order?: Order;
|
|
1447
1447
|
}
|
|
1448
|
-
|
|
1448
|
+
interface OrderStartDateChanged {
|
|
1449
1449
|
/** Order whose `startDate` changed. */
|
|
1450
1450
|
order?: Order;
|
|
1451
1451
|
}
|
|
1452
|
-
|
|
1452
|
+
interface ApplyCouponRequest {
|
|
1453
1453
|
/**
|
|
1454
1454
|
* Draft order ID.
|
|
1455
1455
|
* @format GUID
|
|
@@ -1462,11 +1462,11 @@ export interface ApplyCouponRequest {
|
|
|
1462
1462
|
*/
|
|
1463
1463
|
couponCode?: string;
|
|
1464
1464
|
}
|
|
1465
|
-
|
|
1465
|
+
interface ApplyCouponResponse {
|
|
1466
1466
|
/** Order with applied coupon and recalculated tax. */
|
|
1467
1467
|
order?: Order;
|
|
1468
1468
|
}
|
|
1469
|
-
|
|
1469
|
+
interface SetSubmissionRequest {
|
|
1470
1470
|
/**
|
|
1471
1471
|
* Order ID.
|
|
1472
1472
|
* @format GUID
|
|
@@ -1478,7 +1478,274 @@ export interface SetSubmissionRequest {
|
|
|
1478
1478
|
*/
|
|
1479
1479
|
submissionId?: string;
|
|
1480
1480
|
}
|
|
1481
|
-
|
|
1481
|
+
interface SetSubmissionResponse {
|
|
1482
1482
|
/** Order with submission id */
|
|
1483
1483
|
order?: Order;
|
|
1484
1484
|
}
|
|
1485
|
+
interface BaseEventMetadata {
|
|
1486
|
+
/**
|
|
1487
|
+
* App instance ID.
|
|
1488
|
+
* @format GUID
|
|
1489
|
+
*/
|
|
1490
|
+
instanceId?: string | null;
|
|
1491
|
+
/**
|
|
1492
|
+
* Event type.
|
|
1493
|
+
* @maxLength 150
|
|
1494
|
+
*/
|
|
1495
|
+
eventType?: string;
|
|
1496
|
+
/** The identification type and identity data. */
|
|
1497
|
+
identity?: IdentificationData;
|
|
1498
|
+
}
|
|
1499
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1500
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1501
|
+
_id?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1504
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1505
|
+
*/
|
|
1506
|
+
entityFqdn?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1509
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1510
|
+
*/
|
|
1511
|
+
slug?: string;
|
|
1512
|
+
/** ID of the entity associated with the event. */
|
|
1513
|
+
entityId?: string;
|
|
1514
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1515
|
+
eventTime?: Date | null;
|
|
1516
|
+
/**
|
|
1517
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1518
|
+
* (for example, GDPR).
|
|
1519
|
+
*/
|
|
1520
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1521
|
+
/** If present, indicates the action that triggered the event. */
|
|
1522
|
+
originatedFrom?: string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1525
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1526
|
+
*/
|
|
1527
|
+
entityEventSequence?: string | null;
|
|
1528
|
+
}
|
|
1529
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1530
|
+
data: OrderAutoRenewCanceled;
|
|
1531
|
+
metadata: EventMetadata;
|
|
1532
|
+
}
|
|
1533
|
+
interface OrderCanceledEnvelope {
|
|
1534
|
+
data: OrderCanceled;
|
|
1535
|
+
metadata: EventMetadata;
|
|
1536
|
+
}
|
|
1537
|
+
interface OrderCycleStartedEnvelope {
|
|
1538
|
+
data: OrderCycleStarted;
|
|
1539
|
+
metadata: EventMetadata;
|
|
1540
|
+
}
|
|
1541
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1542
|
+
data: OrderEndDatePostponed;
|
|
1543
|
+
metadata: EventMetadata;
|
|
1544
|
+
}
|
|
1545
|
+
interface OrderEndedEnvelope {
|
|
1546
|
+
data: OrderEnded;
|
|
1547
|
+
metadata: EventMetadata;
|
|
1548
|
+
}
|
|
1549
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1550
|
+
data: OrderMarkedAsPaid;
|
|
1551
|
+
metadata: EventMetadata;
|
|
1552
|
+
}
|
|
1553
|
+
interface OrderPausedEnvelope {
|
|
1554
|
+
data: OrderPaused;
|
|
1555
|
+
metadata: EventMetadata;
|
|
1556
|
+
}
|
|
1557
|
+
interface OrderPurchasedEnvelope {
|
|
1558
|
+
data: OrderPurchased;
|
|
1559
|
+
metadata: EventMetadata;
|
|
1560
|
+
}
|
|
1561
|
+
interface OrderResumedEnvelope {
|
|
1562
|
+
data: OrderResumed;
|
|
1563
|
+
metadata: EventMetadata;
|
|
1564
|
+
}
|
|
1565
|
+
interface OrderStartedEnvelope {
|
|
1566
|
+
data: OrderStarted;
|
|
1567
|
+
metadata: EventMetadata;
|
|
1568
|
+
}
|
|
1569
|
+
interface OrderUpdatedEnvelope {
|
|
1570
|
+
entity: Order;
|
|
1571
|
+
metadata: EventMetadata;
|
|
1572
|
+
}
|
|
1573
|
+
interface OrderCreatedEnvelope {
|
|
1574
|
+
entity: Order;
|
|
1575
|
+
metadata: EventMetadata;
|
|
1576
|
+
}
|
|
1577
|
+
interface OrderStartDateChangedEnvelope {
|
|
1578
|
+
data: OrderStartDateChanged;
|
|
1579
|
+
metadata: EventMetadata;
|
|
1580
|
+
}
|
|
1581
|
+
interface ManagementGetOrderOptions {
|
|
1582
|
+
/**
|
|
1583
|
+
* Predefined set of fields to return.
|
|
1584
|
+
*
|
|
1585
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1586
|
+
*/
|
|
1587
|
+
fieldSet?: SetWithLiterals;
|
|
1588
|
+
}
|
|
1589
|
+
interface ManagementListOrdersOptions {
|
|
1590
|
+
/**
|
|
1591
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
1592
|
+
* @format GUID
|
|
1593
|
+
*/
|
|
1594
|
+
buyerIds?: string[];
|
|
1595
|
+
/**
|
|
1596
|
+
* Filter by plan IDs, from the Plans API.
|
|
1597
|
+
* @format GUID
|
|
1598
|
+
*/
|
|
1599
|
+
planIds?: string[];
|
|
1600
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
1601
|
+
autoRenewCanceled?: boolean | null;
|
|
1602
|
+
/** Filter by order status. */
|
|
1603
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1604
|
+
/** Filter by payment status. */
|
|
1605
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1606
|
+
/**
|
|
1607
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
1608
|
+
*
|
|
1609
|
+
* Max: `50`
|
|
1610
|
+
* @min 1
|
|
1611
|
+
* @max 50
|
|
1612
|
+
*/
|
|
1613
|
+
limit?: number | null;
|
|
1614
|
+
/** Number of orders to skip in the current sort order. */
|
|
1615
|
+
offset?: number | null;
|
|
1616
|
+
/**
|
|
1617
|
+
* Sort order.
|
|
1618
|
+
*
|
|
1619
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1620
|
+
*
|
|
1621
|
+
* Default: `DESC`.
|
|
1622
|
+
*/
|
|
1623
|
+
sorting?: Sorting;
|
|
1624
|
+
/**
|
|
1625
|
+
* Predefined set of fields to return.
|
|
1626
|
+
*
|
|
1627
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1628
|
+
*/
|
|
1629
|
+
fieldSet?: SetWithLiterals;
|
|
1630
|
+
}
|
|
1631
|
+
interface MemberGetOrderOptions {
|
|
1632
|
+
/**
|
|
1633
|
+
* Predefined set of fields to return.
|
|
1634
|
+
*
|
|
1635
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1636
|
+
*/
|
|
1637
|
+
fieldSet?: SetWithLiterals;
|
|
1638
|
+
}
|
|
1639
|
+
interface MemberListOrdersOptions {
|
|
1640
|
+
/**
|
|
1641
|
+
* Filter by plan IDs.
|
|
1642
|
+
* @format GUID
|
|
1643
|
+
*/
|
|
1644
|
+
planIds?: string[];
|
|
1645
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1646
|
+
autoRenewCanceled?: boolean | null;
|
|
1647
|
+
/** Filter by order status. */
|
|
1648
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1649
|
+
/** Filter by payment status. */
|
|
1650
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1651
|
+
/**
|
|
1652
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1653
|
+
* @min 1
|
|
1654
|
+
* @max 50
|
|
1655
|
+
*/
|
|
1656
|
+
limit?: number | null;
|
|
1657
|
+
/** Number of entries to offset. */
|
|
1658
|
+
offset?: number | null;
|
|
1659
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1660
|
+
sorting?: Sorting;
|
|
1661
|
+
/**
|
|
1662
|
+
* Predefined set of fields to return.
|
|
1663
|
+
*
|
|
1664
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1665
|
+
*/
|
|
1666
|
+
fieldSet?: SetWithLiterals;
|
|
1667
|
+
}
|
|
1668
|
+
interface CreateOnlineOrderOptions {
|
|
1669
|
+
/**
|
|
1670
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1671
|
+
*
|
|
1672
|
+
* Default: Current date and time.
|
|
1673
|
+
*/
|
|
1674
|
+
startDate?: Date | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Coupon code to apply.
|
|
1677
|
+
* @minLength 1
|
|
1678
|
+
* @maxLength 20
|
|
1679
|
+
*/
|
|
1680
|
+
couponCode?: string | null;
|
|
1681
|
+
/** Provided if checkout is initiated on buyer's behalf. */
|
|
1682
|
+
onBehalf?: OnBehalf;
|
|
1683
|
+
/**
|
|
1684
|
+
* Submission ID of the form submitted with this order.
|
|
1685
|
+
* @format GUID
|
|
1686
|
+
*/
|
|
1687
|
+
submissionId?: string | null;
|
|
1688
|
+
}
|
|
1689
|
+
interface CreateOfflineOrderOptions {
|
|
1690
|
+
/**
|
|
1691
|
+
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1692
|
+
*
|
|
1693
|
+
* Default: Current date and time.
|
|
1694
|
+
*/
|
|
1695
|
+
startDate?: Date | null;
|
|
1696
|
+
/**
|
|
1697
|
+
* Whether the order is paid.
|
|
1698
|
+
*
|
|
1699
|
+
* Default: `false`
|
|
1700
|
+
*/
|
|
1701
|
+
paid?: boolean | null;
|
|
1702
|
+
/**
|
|
1703
|
+
* Coupon code to apply, from the Coupons API.
|
|
1704
|
+
* @minLength 1
|
|
1705
|
+
* @maxLength 20
|
|
1706
|
+
*/
|
|
1707
|
+
couponCode?: string | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Form submission ID that was submitted with the order.
|
|
1710
|
+
* @format GUID
|
|
1711
|
+
*/
|
|
1712
|
+
submissionId?: string | null;
|
|
1713
|
+
}
|
|
1714
|
+
interface GetOnlineOrderPreviewOptions {
|
|
1715
|
+
/**
|
|
1716
|
+
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1717
|
+
*
|
|
1718
|
+
* Default: Current date and time.
|
|
1719
|
+
*/
|
|
1720
|
+
startDate?: Date | null;
|
|
1721
|
+
/**
|
|
1722
|
+
* Coupon code to apply.
|
|
1723
|
+
* @minLength 1
|
|
1724
|
+
* @maxLength 20
|
|
1725
|
+
*/
|
|
1726
|
+
couponCode?: string | null;
|
|
1727
|
+
}
|
|
1728
|
+
interface GetOfflineOrderPreviewOptions {
|
|
1729
|
+
/**
|
|
1730
|
+
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1731
|
+
*
|
|
1732
|
+
* Default: Current date and time.
|
|
1733
|
+
*/
|
|
1734
|
+
startDate?: Date | null;
|
|
1735
|
+
/**
|
|
1736
|
+
* Coupon code to apply, from the Coupons API.
|
|
1737
|
+
* @minLength 1
|
|
1738
|
+
* @maxLength 20
|
|
1739
|
+
*/
|
|
1740
|
+
couponCode?: string | null;
|
|
1741
|
+
}
|
|
1742
|
+
interface GetPricePreviewOptions {
|
|
1743
|
+
/**
|
|
1744
|
+
* Coupon code to apply, from the Coupons API.
|
|
1745
|
+
* @minLength 1
|
|
1746
|
+
* @maxLength 20
|
|
1747
|
+
*/
|
|
1748
|
+
couponCode?: string | null;
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
export { type SpannedPrice as $, type OrderStartDateChangedEnvelope as A, OrderType as B, type CancellationEffectiveAtWithLiterals as C, OrderMethod as D, OrderStatus as E, CancellationCause as F, type GetOrderResponse as G, CancellationEffectiveAt as H, PaymentStatus as I, Set as J, SortOrder as K, type ListOrdersResponse as L, type ManagementGetOrderOptions as M, type Buyer as N, type Order as O, PeriodUnit as P, type PriceDetails as Q, ReasonNotSuspendable as R, Status as S, type PriceDetailsPricingModelOneOf as T, type Tax as U, type Recurrence as V, WebhookIdentityType as W, type Duration as X, type Coupon as Y, type PricingDetails as Z, type PricingDetailsPricingModelOneOf as _, type ManagementListOrdersOptions as a, type MemberGetOrderResponse as a$, type PriceDuration as a0, type Price as a1, type Fee as a2, type Cancellation as a3, type PausePeriod as a4, type CurrentCycle as a5, type OrderCycle as a6, type FormData as a7, type DomainEvent as a8, type DomainEventBodyOneOf as a9, type PostponeEndDateRequest as aA, type PostponeEndDateResponse as aB, type OrderEndDatePostponed as aC, type CancelOrderRequest as aD, type CancelOrderResponse as aE, type OrderCanceled as aF, type MarkAsPaidRequest as aG, type MarkAsPaidResponse as aH, type OrderMarkedAsPaid as aI, type PauseOrderRequest as aJ, type PauseOrderResponse as aK, type OrderPaused as aL, type BulkPauseOrderRequest as aM, type BulkPauseOrderResponse as aN, type BulkOrderResult as aO, type ItemMetadata as aP, type ApplicationError as aQ, type BulkActionMetadata as aR, type ResumeOrderRequest as aS, type ResumeOrderResponse as aT, type OrderResumed as aU, type BulkResumeOrderRequest as aV, type BulkResumeOrderResponse as aW, type MessageEnvelope as aX, type IdentificationData as aY, type IdentificationDataIdOneOf as aZ, type MemberGetOrderRequest as a_, type EntityCreatedEvent as aa, type RestoreInfo as ab, type EntityUpdatedEvent as ac, type EntityDeletedEvent as ad, type ActionEvent as ae, type Empty as af, type OrderPurchased as ag, type OrderStarted as ah, type OrderCycleStarted as ai, type OrderAutoRenewCanceled as aj, type OrderEnded as ak, type GetOrderRequest as al, type ListOrdersRequest as am, type Sorting as an, type PagingMetadataV2 as ao, type Cursors as ap, type OrdersQueryOrdersRequest as aq, type QueryV2 as ar, type QueryV2PagingMethodOneOf as as, type Paging as at, type CursorPaging as au, type OrdersQueryOrdersResponse as av, type GetOrdersStatsRequest as aw, type GetOrdersStatsResponse as ax, type GetAvailableOrderActionsRequest as ay, type GetAvailableOrderActionsResponse as az, type MemberGetOrderOptions as b, type MemberListOrdersRequest as b0, type QueryOrdersRequest as b1, type QueryOrdersResponse as b2, type RequestCancellationRequest as b3, type RequestCancellationResponse as b4, type CreateOnlineOrderRequest as b5, type OnBehalf as b6, type CouponsError as b7, type CreateGuestOnlineOrderRequest as b8, type Captcha as b9, type Guest as ba, type CreateGuestOnlineOrderResponse as bb, type CreateOfflineOrderRequest as bc, type CreateExternalOrderRequest as bd, type CreateExternalOrderResponse as be, type GetOnlineOrderPreviewRequest as bf, type GetGuestOnlineOrderPreviewRequest as bg, type GetGuestOnlineOrderPreviewResponse as bh, type GetOfflineOrderPreviewRequest as bi, type GetPricePreviewRequest as bj, type ChangeStartDateRequest as bk, type ChangeStartDateResponse as bl, type OrderStartDateChanged as bm, type ApplyCouponRequest as bn, type ApplyCouponResponse as bo, type SetSubmissionRequest as bp, type SetSubmissionResponse as bq, type BaseEventMetadata as br, type EventMetadata as bs, type MemberListOrdersOptions as c, type MemberListOrdersResponse as d, type CreateOnlineOrderOptions as e, type CreateOnlineOrderResponse as f, type CreateOfflineOrderOptions as g, type CreateOfflineOrderResponse as h, type GetOnlineOrderPreviewOptions as i, type GetOnlineOrderPreviewResponse as j, type GetOfflineOrderPreviewOptions as k, type GetOfflineOrderPreviewResponse as l, type GetPricePreviewOptions as m, type GetPricePreviewResponse as n, type OrderAutoRenewCanceledEnvelope as o, type OrderCanceledEnvelope as p, type OrderCycleStartedEnvelope as q, type OrderEndDatePostponedEnvelope as r, type OrderEndedEnvelope as s, type OrderMarkedAsPaidEnvelope as t, type OrderPausedEnvelope as u, type OrderPurchasedEnvelope as v, type OrderResumedEnvelope as w, type OrderStartedEnvelope as x, type OrderUpdatedEnvelope as y, type OrderCreatedEnvelope as z };
|