@wix/auto_sdk_pricing-plans_orders 1.0.58 → 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 -2369
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.js +0 -956
- 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 -2369
- package/build/es/src/pricing-plans-v2-order-orders.universal.js +0 -915
- 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 -2386
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.js +0 -956
- 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 -2386
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.js +0 -915
- 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
|
|
@@ -43,14 +43,6 @@ export interface Order {
|
|
|
43
43
|
* @readonly
|
|
44
44
|
*/
|
|
45
45
|
buyer?: Buyer;
|
|
46
|
-
/**
|
|
47
|
-
* __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
|
|
48
|
-
* @readonly
|
|
49
|
-
* @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
|
|
50
|
-
* @replacedBy pricing
|
|
51
|
-
* @targetRemovalDate 2022-10-01
|
|
52
|
-
*/
|
|
53
|
-
priceDetails?: PriceDetails;
|
|
54
46
|
/**
|
|
55
47
|
* Order pricing model, price, and payment schedule.
|
|
56
48
|
*
|
|
@@ -152,19 +144,19 @@ export interface Order {
|
|
|
152
144
|
* Date and time the order was created.
|
|
153
145
|
* @readonly
|
|
154
146
|
*/
|
|
155
|
-
|
|
147
|
+
_createdDate?: Date | null;
|
|
156
148
|
/**
|
|
157
149
|
* Date and time the order was updated.
|
|
158
150
|
* @readonly
|
|
159
151
|
*/
|
|
160
|
-
|
|
152
|
+
_updatedDate?: Date | null;
|
|
161
153
|
/**
|
|
162
154
|
* Information about the form submitted during the plan's checkout.
|
|
163
155
|
* @readonly
|
|
164
156
|
*/
|
|
165
157
|
formData?: FormData;
|
|
166
158
|
}
|
|
167
|
-
|
|
159
|
+
interface Buyer {
|
|
168
160
|
/**
|
|
169
161
|
* Member ID for a Wix site member, from the Members API.
|
|
170
162
|
* @format GUID
|
|
@@ -178,7 +170,7 @@ export interface Buyer {
|
|
|
178
170
|
*/
|
|
179
171
|
contactId?: string;
|
|
180
172
|
}
|
|
181
|
-
|
|
173
|
+
interface PriceDetails extends PriceDetailsPricingModelOneOf {
|
|
182
174
|
/** Order has recurring payments. */
|
|
183
175
|
subscription?: Recurrence;
|
|
184
176
|
/** One-time payment. Order is valid for a specified duration. */
|
|
@@ -224,7 +216,7 @@ export interface PriceDetails extends PriceDetailsPricingModelOneOf {
|
|
|
224
216
|
coupon?: Coupon;
|
|
225
217
|
}
|
|
226
218
|
/** @oneof */
|
|
227
|
-
|
|
219
|
+
interface PriceDetailsPricingModelOneOf {
|
|
228
220
|
/** Order has recurring payments. */
|
|
229
221
|
subscription?: Recurrence;
|
|
230
222
|
/** One-time payment. Order is valid for a specified duration. */
|
|
@@ -232,7 +224,7 @@ export interface PriceDetailsPricingModelOneOf {
|
|
|
232
224
|
/** One-time payment. Order is valid until it is canceled. */
|
|
233
225
|
singlePaymentUnlimited?: boolean | null;
|
|
234
226
|
}
|
|
235
|
-
|
|
227
|
+
interface Tax {
|
|
236
228
|
/** Name of the tax. For example, VAT. */
|
|
237
229
|
name?: string;
|
|
238
230
|
/** Whether tax is included in the original price. When `false`, tax is added at checkout. */
|
|
@@ -249,7 +241,7 @@ export interface Tax {
|
|
|
249
241
|
amount?: string;
|
|
250
242
|
}
|
|
251
243
|
/** An object specifying how often and for how long payments recur (may be forever). */
|
|
252
|
-
|
|
244
|
+
interface Recurrence {
|
|
253
245
|
/**
|
|
254
246
|
* Number of payment cycles the subscription is valid for.
|
|
255
247
|
* `0` for unlimited plans or for plans that are valid until canceled.
|
|
@@ -264,7 +256,7 @@ export interface Recurrence {
|
|
|
264
256
|
cycleCount?: number | null;
|
|
265
257
|
}
|
|
266
258
|
/** A duration expressed in number of time units. */
|
|
267
|
-
|
|
259
|
+
interface Duration {
|
|
268
260
|
/**
|
|
269
261
|
* Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
|
|
270
262
|
* @min 1
|
|
@@ -273,7 +265,7 @@ export interface Duration {
|
|
|
273
265
|
/** Unit of time for the cycle duration. */
|
|
274
266
|
unit?: PeriodUnitWithLiterals;
|
|
275
267
|
}
|
|
276
|
-
|
|
268
|
+
declare enum PeriodUnit {
|
|
277
269
|
/** Not defined. */
|
|
278
270
|
UNDEFINED = "UNDEFINED",
|
|
279
271
|
/** Time unit is a day. */
|
|
@@ -286,8 +278,8 @@ export declare enum PeriodUnit {
|
|
|
286
278
|
YEAR = "YEAR"
|
|
287
279
|
}
|
|
288
280
|
/** @enumType */
|
|
289
|
-
|
|
290
|
-
|
|
281
|
+
type PeriodUnitWithLiterals = PeriodUnit | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
282
|
+
interface Coupon {
|
|
291
283
|
/**
|
|
292
284
|
* Code of the applied coupon.
|
|
293
285
|
* @minLength 1
|
|
@@ -304,9 +296,9 @@ export interface Coupon {
|
|
|
304
296
|
* @format GUID
|
|
305
297
|
* @readonly
|
|
306
298
|
*/
|
|
307
|
-
|
|
299
|
+
_id?: string;
|
|
308
300
|
}
|
|
309
|
-
|
|
301
|
+
interface PricingDetails extends PricingDetailsPricingModelOneOf {
|
|
310
302
|
/** Pricing model for an order with recurring payment cycles. */
|
|
311
303
|
subscription?: Recurrence;
|
|
312
304
|
/** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
|
|
@@ -320,7 +312,7 @@ export interface PricingDetails extends PricingDetailsPricingModelOneOf {
|
|
|
320
312
|
prices?: SpannedPrice[];
|
|
321
313
|
}
|
|
322
314
|
/** @oneof */
|
|
323
|
-
|
|
315
|
+
interface PricingDetailsPricingModelOneOf {
|
|
324
316
|
/** Pricing model for an order with recurring payment cycles. */
|
|
325
317
|
subscription?: Recurrence;
|
|
326
318
|
/** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
|
|
@@ -328,7 +320,7 @@ export interface PricingDetailsPricingModelOneOf {
|
|
|
328
320
|
/** Pricing model for an order with a one-time payment and the order is valid until canceled. */
|
|
329
321
|
singlePaymentUnlimited?: boolean | null;
|
|
330
322
|
}
|
|
331
|
-
|
|
323
|
+
interface SpannedPrice {
|
|
332
324
|
/**
|
|
333
325
|
* Cycle duration to apply `price` for.
|
|
334
326
|
*
|
|
@@ -339,7 +331,7 @@ export interface SpannedPrice {
|
|
|
339
331
|
/** Order price. */
|
|
340
332
|
price?: Price;
|
|
341
333
|
}
|
|
342
|
-
|
|
334
|
+
interface PriceDuration {
|
|
343
335
|
/**
|
|
344
336
|
* Price starts to apply with this cycle.
|
|
345
337
|
*
|
|
@@ -357,7 +349,7 @@ export interface PriceDuration {
|
|
|
357
349
|
*/
|
|
358
350
|
numberOfCycles?: number | null;
|
|
359
351
|
}
|
|
360
|
-
|
|
352
|
+
interface Price {
|
|
361
353
|
/**
|
|
362
354
|
* Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`.
|
|
363
355
|
* @format DECIMAL_VALUE
|
|
@@ -395,7 +387,7 @@ export interface Price {
|
|
|
395
387
|
*/
|
|
396
388
|
proration?: string;
|
|
397
389
|
}
|
|
398
|
-
|
|
390
|
+
interface Fee {
|
|
399
391
|
/**
|
|
400
392
|
* Fee name
|
|
401
393
|
* @minLength 1
|
|
@@ -408,7 +400,7 @@ export interface Fee {
|
|
|
408
400
|
*/
|
|
409
401
|
amount?: string;
|
|
410
402
|
}
|
|
411
|
-
|
|
403
|
+
declare enum OrderType {
|
|
412
404
|
/** Undefined order type. */
|
|
413
405
|
UNDEFINED = "UNDEFINED",
|
|
414
406
|
/** The buyer purchased the plan using the site. */
|
|
@@ -419,8 +411,8 @@ export declare enum OrderType {
|
|
|
419
411
|
EXTERNAL = "EXTERNAL"
|
|
420
412
|
}
|
|
421
413
|
/** @enumType */
|
|
422
|
-
|
|
423
|
-
|
|
414
|
+
type OrderTypeWithLiterals = OrderType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE' | 'EXTERNAL';
|
|
415
|
+
declare enum OrderMethod {
|
|
424
416
|
/** Unknown order method. */
|
|
425
417
|
UNKNOWN = "UNKNOWN",
|
|
426
418
|
/** Mail Order / Telephone Order transaction. */
|
|
@@ -429,8 +421,8 @@ export declare enum OrderMethod {
|
|
|
429
421
|
POS = "POS"
|
|
430
422
|
}
|
|
431
423
|
/** @enumType */
|
|
432
|
-
|
|
433
|
-
|
|
424
|
+
type OrderMethodWithLiterals = OrderMethod | 'UNKNOWN' | 'MOTO' | 'POS';
|
|
425
|
+
declare enum OrderStatus {
|
|
434
426
|
/** Undefined order status. */
|
|
435
427
|
UNDEFINED = "UNDEFINED",
|
|
436
428
|
/** Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer. */
|
|
@@ -447,8 +439,8 @@ export declare enum OrderStatus {
|
|
|
447
439
|
CANCELED = "CANCELED"
|
|
448
440
|
}
|
|
449
441
|
/** @enumType */
|
|
450
|
-
|
|
451
|
-
|
|
442
|
+
type OrderStatusWithLiterals = OrderStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'CANCELED';
|
|
443
|
+
interface Cancellation {
|
|
452
444
|
/** Date and time the cancellation was requested. */
|
|
453
445
|
requestedDate?: Date | null;
|
|
454
446
|
/** Reason for the cancellation. */
|
|
@@ -456,7 +448,7 @@ export interface Cancellation {
|
|
|
456
448
|
/** When the cancellation takes effect. Set when cancelling the order. */
|
|
457
449
|
effectiveAt?: CancellationEffectiveAtWithLiterals;
|
|
458
450
|
}
|
|
459
|
-
|
|
451
|
+
declare enum CancellationCause {
|
|
460
452
|
/** Undefined cancellation cause. */
|
|
461
453
|
UNDEFINED = "UNDEFINED",
|
|
462
454
|
/** Wix user canceled the order. */
|
|
@@ -471,8 +463,8 @@ export declare enum CancellationCause {
|
|
|
471
463
|
UNKNOWN = "UNKNOWN"
|
|
472
464
|
}
|
|
473
465
|
/** @enumType */
|
|
474
|
-
|
|
475
|
-
|
|
466
|
+
type CancellationCauseWithLiterals = CancellationCause | 'UNDEFINED' | 'OWNER_ACTION' | 'MEMBER_ACTION' | 'PAYMENT_FAILURE' | 'PAYMENT_SETUP_FAILURE' | 'UNKNOWN';
|
|
467
|
+
declare enum CancellationEffectiveAt {
|
|
476
468
|
/** Undefined cancellation time. */
|
|
477
469
|
UNDEFINED = "UNDEFINED",
|
|
478
470
|
/** Cancellation occurs immediately and the buyer can no longer use the plan. */
|
|
@@ -481,8 +473,8 @@ export declare enum CancellationEffectiveAt {
|
|
|
481
473
|
NEXT_PAYMENT_DATE = "NEXT_PAYMENT_DATE"
|
|
482
474
|
}
|
|
483
475
|
/** @enumType */
|
|
484
|
-
|
|
485
|
-
|
|
476
|
+
type CancellationEffectiveAtWithLiterals = CancellationEffectiveAt | 'UNDEFINED' | 'IMMEDIATELY' | 'NEXT_PAYMENT_DATE';
|
|
477
|
+
declare enum PaymentStatus {
|
|
486
478
|
/** Undefined payment status. */
|
|
487
479
|
UNDEFINED = "UNDEFINED",
|
|
488
480
|
/** Payment has been paid. */
|
|
@@ -499,8 +491,8 @@ export declare enum PaymentStatus {
|
|
|
499
491
|
NOT_APPLICABLE = "NOT_APPLICABLE"
|
|
500
492
|
}
|
|
501
493
|
/** @enumType */
|
|
502
|
-
|
|
503
|
-
|
|
494
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | 'PENDING' | 'NOT_APPLICABLE';
|
|
495
|
+
interface PausePeriod {
|
|
504
496
|
/** Status of the pause period. */
|
|
505
497
|
status?: StatusWithLiterals;
|
|
506
498
|
/** Start date and time of the pause period. */
|
|
@@ -512,7 +504,7 @@ export interface PausePeriod {
|
|
|
512
504
|
*/
|
|
513
505
|
resumeDate?: Date | null;
|
|
514
506
|
}
|
|
515
|
-
|
|
507
|
+
declare enum Status {
|
|
516
508
|
/** Undefined status. */
|
|
517
509
|
UNDEFINED = "UNDEFINED",
|
|
518
510
|
/** Status while the order is paused. */
|
|
@@ -521,12 +513,12 @@ export declare enum Status {
|
|
|
521
513
|
ENDED = "ENDED"
|
|
522
514
|
}
|
|
523
515
|
/** @enumType */
|
|
524
|
-
|
|
516
|
+
type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | 'ENDED';
|
|
525
517
|
/**
|
|
526
518
|
* Current cycle will be empty when order is cancelled, expired or order start date is in the future
|
|
527
519
|
* Current cycle start and end dates take into account free trial days and suspensions
|
|
528
520
|
*/
|
|
529
|
-
|
|
521
|
+
interface CurrentCycle {
|
|
530
522
|
/**
|
|
531
523
|
* Index of the current payment cycle in the order.
|
|
532
524
|
*
|
|
@@ -539,7 +531,7 @@ export interface CurrentCycle {
|
|
|
539
531
|
endedDate?: Date | null;
|
|
540
532
|
}
|
|
541
533
|
/** Order cycle start and end dates take into account free trial days and suspensions */
|
|
542
|
-
|
|
534
|
+
interface OrderCycle {
|
|
543
535
|
/**
|
|
544
536
|
* Index of this cycle in the order.
|
|
545
537
|
*
|
|
@@ -551,7 +543,7 @@ export interface OrderCycle {
|
|
|
551
543
|
/** End date and time for this order cycle. */
|
|
552
544
|
endedDate?: Date | null;
|
|
553
545
|
}
|
|
554
|
-
|
|
546
|
+
interface FormData {
|
|
555
547
|
/**
|
|
556
548
|
* 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
549
|
* @format GUID
|
|
@@ -568,13 +560,13 @@ export interface FormData {
|
|
|
568
560
|
*/
|
|
569
561
|
submissionData?: Record<string, any>;
|
|
570
562
|
}
|
|
571
|
-
|
|
563
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
572
564
|
createdEvent?: EntityCreatedEvent;
|
|
573
565
|
updatedEvent?: EntityUpdatedEvent;
|
|
574
566
|
deletedEvent?: EntityDeletedEvent;
|
|
575
567
|
actionEvent?: ActionEvent;
|
|
576
568
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
577
|
-
|
|
569
|
+
_id?: string;
|
|
578
570
|
/**
|
|
579
571
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
580
572
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -603,42 +595,40 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
603
595
|
entityEventSequence?: string | null;
|
|
604
596
|
}
|
|
605
597
|
/** @oneof */
|
|
606
|
-
|
|
598
|
+
interface DomainEventBodyOneOf {
|
|
607
599
|
createdEvent?: EntityCreatedEvent;
|
|
608
600
|
updatedEvent?: EntityUpdatedEvent;
|
|
609
601
|
deletedEvent?: EntityDeletedEvent;
|
|
610
602
|
actionEvent?: ActionEvent;
|
|
611
603
|
}
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
615
|
-
restoreInfo?: RestoreInfo;
|
|
604
|
+
interface EntityCreatedEvent {
|
|
605
|
+
entity?: string;
|
|
616
606
|
}
|
|
617
|
-
|
|
607
|
+
interface RestoreInfo {
|
|
618
608
|
deletedDate?: Date | null;
|
|
619
609
|
}
|
|
620
|
-
|
|
610
|
+
interface EntityUpdatedEvent {
|
|
621
611
|
/**
|
|
622
612
|
* 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
613
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
624
614
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
625
615
|
*/
|
|
626
|
-
|
|
616
|
+
currentEntity?: string;
|
|
627
617
|
}
|
|
628
|
-
|
|
618
|
+
interface EntityDeletedEvent {
|
|
629
619
|
/** Entity that was deleted. */
|
|
630
|
-
|
|
620
|
+
deletedEntity?: string | null;
|
|
631
621
|
}
|
|
632
|
-
|
|
633
|
-
|
|
622
|
+
interface ActionEvent {
|
|
623
|
+
body?: string;
|
|
634
624
|
}
|
|
635
|
-
|
|
625
|
+
interface Empty {
|
|
636
626
|
}
|
|
637
|
-
|
|
627
|
+
interface OrderPurchased {
|
|
638
628
|
/** Order that was paid for. If a free or an offline order, the order that was created. */
|
|
639
629
|
order?: Order;
|
|
640
630
|
}
|
|
641
|
-
|
|
631
|
+
interface OrderStarted {
|
|
642
632
|
/** Order that reached its `startDate`. */
|
|
643
633
|
order?: Order;
|
|
644
634
|
}
|
|
@@ -647,27 +637,27 @@ export interface OrderStarted {
|
|
|
647
637
|
*
|
|
648
638
|
* This webhook does not trigger at the initial start of an offline order.
|
|
649
639
|
*/
|
|
650
|
-
|
|
640
|
+
interface OrderCycleStarted {
|
|
651
641
|
/** Order whose new cycle started. */
|
|
652
642
|
order?: Order;
|
|
653
643
|
/** 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
644
|
cycleNumber?: number;
|
|
655
645
|
}
|
|
656
646
|
/** Emitted when a recurring order is canceled for the next payment cycle */
|
|
657
|
-
|
|
647
|
+
interface OrderAutoRenewCanceled {
|
|
658
648
|
/** Order that is canceled, effective at the end of the current payment cycle. */
|
|
659
649
|
order?: Order;
|
|
660
650
|
}
|
|
661
|
-
|
|
651
|
+
interface OrderEnded {
|
|
662
652
|
/** Order that ended. */
|
|
663
653
|
order?: Order;
|
|
664
654
|
}
|
|
665
|
-
|
|
655
|
+
interface GetOrderRequest {
|
|
666
656
|
/**
|
|
667
657
|
* Order ID.
|
|
668
658
|
* @format GUID
|
|
669
659
|
*/
|
|
670
|
-
|
|
660
|
+
_id: string;
|
|
671
661
|
/**
|
|
672
662
|
* Predefined set of fields to return.
|
|
673
663
|
*
|
|
@@ -675,7 +665,7 @@ export interface GetOrderRequest {
|
|
|
675
665
|
*/
|
|
676
666
|
fieldSet?: SetWithLiterals;
|
|
677
667
|
}
|
|
678
|
-
|
|
668
|
+
declare enum Set {
|
|
679
669
|
/** Same behavior as `BASIC`.` */
|
|
680
670
|
UNKNOWN_SET = "UNKNOWN_SET",
|
|
681
671
|
/** Doesn't return any order form submission data. */
|
|
@@ -684,12 +674,12 @@ export declare enum Set {
|
|
|
684
674
|
FULL = "FULL"
|
|
685
675
|
}
|
|
686
676
|
/** @enumType */
|
|
687
|
-
|
|
688
|
-
|
|
677
|
+
type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
|
|
678
|
+
interface GetOrderResponse {
|
|
689
679
|
/** Order. */
|
|
690
680
|
order?: Order;
|
|
691
681
|
}
|
|
692
|
-
|
|
682
|
+
interface ListOrdersRequest {
|
|
693
683
|
/**
|
|
694
684
|
* Filter by a buyer's member ID, from the Members API.
|
|
695
685
|
* @format GUID
|
|
@@ -731,7 +721,7 @@ export interface ListOrdersRequest {
|
|
|
731
721
|
*/
|
|
732
722
|
fieldSet?: SetWithLiterals;
|
|
733
723
|
}
|
|
734
|
-
|
|
724
|
+
interface Sorting {
|
|
735
725
|
/**
|
|
736
726
|
* Name of the field to sort by.
|
|
737
727
|
* @maxLength 512
|
|
@@ -740,19 +730,19 @@ export interface Sorting {
|
|
|
740
730
|
/** Sort order. */
|
|
741
731
|
order?: SortOrderWithLiterals;
|
|
742
732
|
}
|
|
743
|
-
|
|
733
|
+
declare enum SortOrder {
|
|
744
734
|
ASC = "ASC",
|
|
745
735
|
DESC = "DESC"
|
|
746
736
|
}
|
|
747
737
|
/** @enumType */
|
|
748
|
-
|
|
749
|
-
|
|
738
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
739
|
+
interface ListOrdersResponse {
|
|
750
740
|
/** List of orders. */
|
|
751
741
|
orders?: Order[];
|
|
752
742
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
753
743
|
pagingMetadata?: PagingMetadataV2;
|
|
754
744
|
}
|
|
755
|
-
|
|
745
|
+
interface PagingMetadataV2 {
|
|
756
746
|
/** Number of items returned in the response. */
|
|
757
747
|
count?: number | null;
|
|
758
748
|
/** Offset that was requested. */
|
|
@@ -764,7 +754,7 @@ export interface PagingMetadataV2 {
|
|
|
764
754
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
765
755
|
cursors?: Cursors;
|
|
766
756
|
}
|
|
767
|
-
|
|
757
|
+
interface Cursors {
|
|
768
758
|
/**
|
|
769
759
|
* Cursor string pointing to the next page in the list of results.
|
|
770
760
|
* @maxLength 16000
|
|
@@ -776,11 +766,11 @@ export interface Cursors {
|
|
|
776
766
|
*/
|
|
777
767
|
prev?: string | null;
|
|
778
768
|
}
|
|
779
|
-
|
|
769
|
+
interface OrdersQueryOrdersRequest {
|
|
780
770
|
/** Query filter. */
|
|
781
771
|
query?: QueryV2;
|
|
782
772
|
}
|
|
783
|
-
|
|
773
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
784
774
|
/** Paging options to limit and skip the number of items. */
|
|
785
775
|
paging?: Paging;
|
|
786
776
|
/** 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 +793,19 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
803
793
|
fieldsets?: string[];
|
|
804
794
|
}
|
|
805
795
|
/** @oneof */
|
|
806
|
-
|
|
796
|
+
interface QueryV2PagingMethodOneOf {
|
|
807
797
|
/** Paging options to limit and skip the number of items. */
|
|
808
798
|
paging?: Paging;
|
|
809
799
|
/** 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
800
|
cursorPaging?: CursorPaging;
|
|
811
801
|
}
|
|
812
|
-
|
|
802
|
+
interface Paging {
|
|
813
803
|
/** Number of items to load. */
|
|
814
804
|
limit?: number | null;
|
|
815
805
|
/** Number of items to skip in the current sort order. */
|
|
816
806
|
offset?: number | null;
|
|
817
807
|
}
|
|
818
|
-
|
|
808
|
+
interface CursorPaging {
|
|
819
809
|
/**
|
|
820
810
|
* Maximum number of items to return in the results.
|
|
821
811
|
* @max 100
|
|
@@ -830,28 +820,28 @@ export interface CursorPaging {
|
|
|
830
820
|
*/
|
|
831
821
|
cursor?: string | null;
|
|
832
822
|
}
|
|
833
|
-
|
|
823
|
+
interface OrdersQueryOrdersResponse {
|
|
834
824
|
/** Retrieved orders. */
|
|
835
825
|
plans?: Order[];
|
|
836
826
|
/** Paging-related data (number of orders returned, offset). */
|
|
837
827
|
pagingMetadata?: PagingMetadataV2;
|
|
838
828
|
}
|
|
839
|
-
|
|
829
|
+
interface GetOrdersStatsRequest {
|
|
840
830
|
}
|
|
841
|
-
|
|
831
|
+
interface GetOrdersStatsResponse {
|
|
842
832
|
/** Total number of orders. */
|
|
843
833
|
totalOrderCount?: number;
|
|
844
834
|
/** Number of active orders. */
|
|
845
835
|
activeOrderCount?: number;
|
|
846
836
|
}
|
|
847
|
-
|
|
837
|
+
interface GetAvailableOrderActionsRequest {
|
|
848
838
|
/**
|
|
849
839
|
* Order ID.
|
|
850
840
|
* @format GUID
|
|
851
841
|
*/
|
|
852
|
-
|
|
842
|
+
_id?: string;
|
|
853
843
|
}
|
|
854
|
-
|
|
844
|
+
interface GetAvailableOrderActionsResponse {
|
|
855
845
|
/** Whether the order can be suspended. */
|
|
856
846
|
suspendable?: boolean;
|
|
857
847
|
/** If the order cannot be suspended, a reason is returned here. */
|
|
@@ -859,7 +849,7 @@ export interface GetAvailableOrderActionsResponse {
|
|
|
859
849
|
/** Whether the order can be canceled by the buyer. */
|
|
860
850
|
cancelableByBuyer?: boolean;
|
|
861
851
|
}
|
|
862
|
-
|
|
852
|
+
declare enum ReasonNotSuspendable {
|
|
863
853
|
/** Undefined reason. */
|
|
864
854
|
UNDEFINED = "UNDEFINED",
|
|
865
855
|
/** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
|
|
@@ -878,13 +868,13 @@ export declare enum ReasonNotSuspendable {
|
|
|
878
868
|
OLD_STRIPE = "OLD_STRIPE"
|
|
879
869
|
}
|
|
880
870
|
/** @enumType */
|
|
881
|
-
|
|
882
|
-
|
|
871
|
+
type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
|
|
872
|
+
interface PostponeEndDateRequest {
|
|
883
873
|
/**
|
|
884
874
|
* Order ID.
|
|
885
875
|
* @format GUID
|
|
886
876
|
*/
|
|
887
|
-
|
|
877
|
+
_id: string;
|
|
888
878
|
/**
|
|
889
879
|
* New end date and time.
|
|
890
880
|
*
|
|
@@ -892,59 +882,59 @@ export interface PostponeEndDateRequest {
|
|
|
892
882
|
*/
|
|
893
883
|
endDate: Date | null;
|
|
894
884
|
}
|
|
895
|
-
|
|
885
|
+
interface PostponeEndDateResponse {
|
|
896
886
|
}
|
|
897
|
-
|
|
887
|
+
interface OrderEndDatePostponed {
|
|
898
888
|
/** Order whose `endDate` was postponed. */
|
|
899
889
|
order?: Order;
|
|
900
890
|
}
|
|
901
|
-
|
|
891
|
+
interface CancelOrderRequest {
|
|
902
892
|
/**
|
|
903
893
|
* Order ID.
|
|
904
894
|
* @format GUID
|
|
905
895
|
*/
|
|
906
|
-
|
|
896
|
+
_id: string;
|
|
907
897
|
/** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
|
|
908
898
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
909
899
|
}
|
|
910
|
-
|
|
900
|
+
interface CancelOrderResponse {
|
|
911
901
|
}
|
|
912
902
|
/**
|
|
913
903
|
* Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
|
|
914
904
|
*
|
|
915
905
|
* To determine the specific reason of the cancellation check `order.cancellation.cause` field.
|
|
916
906
|
*/
|
|
917
|
-
|
|
907
|
+
interface OrderCanceled {
|
|
918
908
|
/** Canceled order. */
|
|
919
909
|
order?: Order;
|
|
920
910
|
}
|
|
921
|
-
|
|
911
|
+
interface MarkAsPaidRequest {
|
|
922
912
|
/**
|
|
923
913
|
* Order ID.
|
|
924
914
|
* @format GUID
|
|
925
915
|
*/
|
|
926
|
-
|
|
916
|
+
_id: string;
|
|
927
917
|
}
|
|
928
|
-
|
|
918
|
+
interface MarkAsPaidResponse {
|
|
929
919
|
}
|
|
930
|
-
|
|
920
|
+
interface OrderMarkedAsPaid {
|
|
931
921
|
/** Order that was marked as paid. */
|
|
932
922
|
order?: Order;
|
|
933
923
|
}
|
|
934
|
-
|
|
924
|
+
interface PauseOrderRequest {
|
|
935
925
|
/**
|
|
936
926
|
* Order ID.
|
|
937
927
|
* @format GUID
|
|
938
928
|
*/
|
|
939
|
-
|
|
929
|
+
_id: string;
|
|
940
930
|
}
|
|
941
|
-
|
|
931
|
+
interface PauseOrderResponse {
|
|
942
932
|
}
|
|
943
|
-
|
|
933
|
+
interface OrderPaused {
|
|
944
934
|
/** Paused order. */
|
|
945
935
|
order?: Order;
|
|
946
936
|
}
|
|
947
|
-
|
|
937
|
+
interface BulkPauseOrderRequest {
|
|
948
938
|
/**
|
|
949
939
|
* List of Order IDs.
|
|
950
940
|
* @format GUID
|
|
@@ -955,21 +945,21 @@ export interface BulkPauseOrderRequest {
|
|
|
955
945
|
/** Set to true to return Order entity in response. */
|
|
956
946
|
returnFullEntity?: boolean;
|
|
957
947
|
}
|
|
958
|
-
|
|
948
|
+
interface BulkPauseOrderResponse {
|
|
959
949
|
/** Orders that were paused. */
|
|
960
950
|
results?: BulkOrderResult[];
|
|
961
951
|
/** Bulk action metadata. */
|
|
962
952
|
bulkActionMetadata?: BulkActionMetadata;
|
|
963
953
|
}
|
|
964
|
-
|
|
954
|
+
interface BulkOrderResult {
|
|
965
955
|
/** Item metadata */
|
|
966
956
|
itemMetadata?: ItemMetadata;
|
|
967
957
|
/** The order. */
|
|
968
958
|
order?: Order;
|
|
969
959
|
}
|
|
970
|
-
|
|
960
|
+
interface ItemMetadata {
|
|
971
961
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
972
|
-
|
|
962
|
+
_id?: string | null;
|
|
973
963
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
974
964
|
originalIndex?: number;
|
|
975
965
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -977,7 +967,7 @@ export interface ItemMetadata {
|
|
|
977
967
|
/** Details about the error in case of failure. */
|
|
978
968
|
error?: ApplicationError;
|
|
979
969
|
}
|
|
980
|
-
|
|
970
|
+
interface ApplicationError {
|
|
981
971
|
/** Error code. */
|
|
982
972
|
code?: string;
|
|
983
973
|
/** Description of the error. */
|
|
@@ -985,7 +975,7 @@ export interface ApplicationError {
|
|
|
985
975
|
/** Data related to the error. */
|
|
986
976
|
data?: Record<string, any> | null;
|
|
987
977
|
}
|
|
988
|
-
|
|
978
|
+
interface BulkActionMetadata {
|
|
989
979
|
/** Number of items that were successfully processed. */
|
|
990
980
|
totalSuccesses?: number;
|
|
991
981
|
/** Number of items that couldn't be processed. */
|
|
@@ -993,20 +983,20 @@ export interface BulkActionMetadata {
|
|
|
993
983
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
994
984
|
undetailedFailures?: number;
|
|
995
985
|
}
|
|
996
|
-
|
|
986
|
+
interface ResumeOrderRequest {
|
|
997
987
|
/**
|
|
998
988
|
* Order ID.
|
|
999
989
|
* @format GUID
|
|
1000
990
|
*/
|
|
1001
|
-
|
|
991
|
+
_id: string;
|
|
1002
992
|
}
|
|
1003
|
-
|
|
993
|
+
interface ResumeOrderResponse {
|
|
1004
994
|
}
|
|
1005
|
-
|
|
995
|
+
interface OrderResumed {
|
|
1006
996
|
/** Resumed order. */
|
|
1007
997
|
order?: Order;
|
|
1008
998
|
}
|
|
1009
|
-
|
|
999
|
+
interface BulkResumeOrderRequest {
|
|
1010
1000
|
/**
|
|
1011
1001
|
* List of Order IDs.
|
|
1012
1002
|
* @format GUID
|
|
@@ -1017,13 +1007,13 @@ export interface BulkResumeOrderRequest {
|
|
|
1017
1007
|
/** Set to true to return Order entity in response. */
|
|
1018
1008
|
returnFullEntity?: boolean;
|
|
1019
1009
|
}
|
|
1020
|
-
|
|
1010
|
+
interface BulkResumeOrderResponse {
|
|
1021
1011
|
/** Orders that were resumed. */
|
|
1022
1012
|
results?: BulkOrderResult[];
|
|
1023
1013
|
/** Bulk action metadata. */
|
|
1024
1014
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1025
1015
|
}
|
|
1026
|
-
|
|
1016
|
+
interface MessageEnvelope {
|
|
1027
1017
|
/**
|
|
1028
1018
|
* App instance ID.
|
|
1029
1019
|
* @format GUID
|
|
@@ -1039,7 +1029,7 @@ export interface MessageEnvelope {
|
|
|
1039
1029
|
/** Stringify payload. */
|
|
1040
1030
|
data?: string;
|
|
1041
1031
|
}
|
|
1042
|
-
|
|
1032
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1043
1033
|
/**
|
|
1044
1034
|
* ID of a site visitor that has not logged in to the site.
|
|
1045
1035
|
* @format GUID
|
|
@@ -1064,7 +1054,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1064
1054
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1065
1055
|
}
|
|
1066
1056
|
/** @oneof */
|
|
1067
|
-
|
|
1057
|
+
interface IdentificationDataIdOneOf {
|
|
1068
1058
|
/**
|
|
1069
1059
|
* ID of a site visitor that has not logged in to the site.
|
|
1070
1060
|
* @format GUID
|
|
@@ -1086,7 +1076,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1086
1076
|
*/
|
|
1087
1077
|
appId?: string;
|
|
1088
1078
|
}
|
|
1089
|
-
|
|
1079
|
+
declare enum WebhookIdentityType {
|
|
1090
1080
|
UNKNOWN = "UNKNOWN",
|
|
1091
1081
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1092
1082
|
MEMBER = "MEMBER",
|
|
@@ -1094,13 +1084,13 @@ export declare enum WebhookIdentityType {
|
|
|
1094
1084
|
APP = "APP"
|
|
1095
1085
|
}
|
|
1096
1086
|
/** @enumType */
|
|
1097
|
-
|
|
1098
|
-
|
|
1087
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1088
|
+
interface MemberGetOrderRequest {
|
|
1099
1089
|
/**
|
|
1100
1090
|
* Order ID.
|
|
1101
1091
|
* @format GUID
|
|
1102
1092
|
*/
|
|
1103
|
-
|
|
1093
|
+
_id: string;
|
|
1104
1094
|
/**
|
|
1105
1095
|
* Predefined set of fields to return.
|
|
1106
1096
|
*
|
|
@@ -1108,11 +1098,11 @@ export interface MemberGetOrderRequest {
|
|
|
1108
1098
|
*/
|
|
1109
1099
|
fieldSet?: SetWithLiterals;
|
|
1110
1100
|
}
|
|
1111
|
-
|
|
1101
|
+
interface MemberGetOrderResponse {
|
|
1112
1102
|
/** Requested order. */
|
|
1113
1103
|
order?: Order;
|
|
1114
1104
|
}
|
|
1115
|
-
|
|
1105
|
+
interface MemberListOrdersRequest {
|
|
1116
1106
|
/**
|
|
1117
1107
|
* Filter by plan IDs.
|
|
1118
1108
|
* @format GUID
|
|
@@ -1141,7 +1131,7 @@ export interface MemberListOrdersRequest {
|
|
|
1141
1131
|
*/
|
|
1142
1132
|
fieldSet?: SetWithLiterals;
|
|
1143
1133
|
}
|
|
1144
|
-
|
|
1134
|
+
interface MemberListOrdersResponse {
|
|
1145
1135
|
/** Requested orders. */
|
|
1146
1136
|
orders?: Order[];
|
|
1147
1137
|
/** Object containing paging-related data (number of orders returned, offset). */
|
|
@@ -1151,28 +1141,28 @@ export interface MemberListOrdersResponse {
|
|
|
1151
1141
|
* TODO: Write orders filter and sort docs page
|
|
1152
1142
|
* Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
|
|
1153
1143
|
*/
|
|
1154
|
-
|
|
1144
|
+
interface QueryOrdersRequest {
|
|
1155
1145
|
/** Query filter. */
|
|
1156
1146
|
query?: QueryV2;
|
|
1157
1147
|
}
|
|
1158
|
-
|
|
1148
|
+
interface QueryOrdersResponse {
|
|
1159
1149
|
/** Order data. */
|
|
1160
1150
|
plans?: Order[];
|
|
1161
1151
|
/** Paging-related data (number of orders returned, offset). */
|
|
1162
1152
|
pagingMetadata?: PagingMetadataV2;
|
|
1163
1153
|
}
|
|
1164
|
-
|
|
1154
|
+
interface RequestCancellationRequest {
|
|
1165
1155
|
/**
|
|
1166
1156
|
* Order ID.
|
|
1167
1157
|
* @format GUID
|
|
1168
1158
|
*/
|
|
1169
|
-
|
|
1159
|
+
_id: string;
|
|
1170
1160
|
/** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
|
|
1171
1161
|
effectiveAt: CancellationEffectiveAtWithLiterals;
|
|
1172
1162
|
}
|
|
1173
|
-
|
|
1163
|
+
interface RequestCancellationResponse {
|
|
1174
1164
|
}
|
|
1175
|
-
|
|
1165
|
+
interface CreateOnlineOrderRequest {
|
|
1176
1166
|
/**
|
|
1177
1167
|
* Plan ID.
|
|
1178
1168
|
* @format GUID
|
|
@@ -1198,7 +1188,7 @@ export interface CreateOnlineOrderRequest {
|
|
|
1198
1188
|
*/
|
|
1199
1189
|
submissionId?: string | null;
|
|
1200
1190
|
}
|
|
1201
|
-
|
|
1191
|
+
interface OnBehalf {
|
|
1202
1192
|
/**
|
|
1203
1193
|
* Member ID.
|
|
1204
1194
|
* @format GUID
|
|
@@ -1207,17 +1197,17 @@ export interface OnBehalf {
|
|
|
1207
1197
|
/** Method by which checkout is initiated. */
|
|
1208
1198
|
orderMethod?: OrderMethodWithLiterals;
|
|
1209
1199
|
}
|
|
1210
|
-
|
|
1200
|
+
interface CreateOnlineOrderResponse {
|
|
1211
1201
|
/** Created online order. */
|
|
1212
1202
|
order?: Order;
|
|
1213
1203
|
}
|
|
1214
|
-
|
|
1204
|
+
interface CouponsError {
|
|
1215
1205
|
/** Coupon code. */
|
|
1216
1206
|
couponCode?: string;
|
|
1217
1207
|
/** Plan ID. */
|
|
1218
1208
|
planId?: string;
|
|
1219
1209
|
}
|
|
1220
|
-
|
|
1210
|
+
interface CreateGuestOnlineOrderRequest {
|
|
1221
1211
|
/**
|
|
1222
1212
|
* Plan ID.
|
|
1223
1213
|
* @format GUID
|
|
@@ -1245,22 +1235,22 @@ export interface CreateGuestOnlineOrderRequest {
|
|
|
1245
1235
|
*/
|
|
1246
1236
|
submissionId?: string | null;
|
|
1247
1237
|
}
|
|
1248
|
-
|
|
1238
|
+
interface Captcha {
|
|
1249
1239
|
/** Token from captcha */
|
|
1250
1240
|
token?: string;
|
|
1251
1241
|
}
|
|
1252
|
-
|
|
1242
|
+
interface Guest {
|
|
1253
1243
|
/**
|
|
1254
1244
|
* Email for checkout
|
|
1255
1245
|
* @format EMAIL
|
|
1256
1246
|
*/
|
|
1257
1247
|
email?: string;
|
|
1258
1248
|
}
|
|
1259
|
-
|
|
1249
|
+
interface CreateGuestOnlineOrderResponse {
|
|
1260
1250
|
/** Order. */
|
|
1261
1251
|
order?: Order;
|
|
1262
1252
|
}
|
|
1263
|
-
|
|
1253
|
+
interface CreateOfflineOrderRequest {
|
|
1264
1254
|
/**
|
|
1265
1255
|
* ID of the plan being ordered, from the Plans API.
|
|
1266
1256
|
* @format GUID
|
|
@@ -1295,11 +1285,11 @@ export interface CreateOfflineOrderRequest {
|
|
|
1295
1285
|
*/
|
|
1296
1286
|
submissionId?: string | null;
|
|
1297
1287
|
}
|
|
1298
|
-
|
|
1288
|
+
interface CreateOfflineOrderResponse {
|
|
1299
1289
|
/** Order. */
|
|
1300
1290
|
order?: Order;
|
|
1301
1291
|
}
|
|
1302
|
-
|
|
1292
|
+
interface CreateExternalOrderRequest {
|
|
1303
1293
|
/**
|
|
1304
1294
|
* Plan ID.
|
|
1305
1295
|
* @format GUID
|
|
@@ -1311,11 +1301,11 @@ export interface CreateExternalOrderRequest {
|
|
|
1311
1301
|
*/
|
|
1312
1302
|
submissionId?: string | null;
|
|
1313
1303
|
}
|
|
1314
|
-
|
|
1304
|
+
interface CreateExternalOrderResponse {
|
|
1315
1305
|
/** Created order */
|
|
1316
1306
|
order?: Order;
|
|
1317
1307
|
}
|
|
1318
|
-
|
|
1308
|
+
interface GetOnlineOrderPreviewRequest {
|
|
1319
1309
|
/**
|
|
1320
1310
|
* Plan ID.
|
|
1321
1311
|
* @format GUID
|
|
@@ -1334,13 +1324,13 @@ export interface GetOnlineOrderPreviewRequest {
|
|
|
1334
1324
|
*/
|
|
1335
1325
|
couponCode?: string | null;
|
|
1336
1326
|
}
|
|
1337
|
-
|
|
1327
|
+
interface GetOnlineOrderPreviewResponse {
|
|
1338
1328
|
/** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
|
|
1339
1329
|
order?: Order;
|
|
1340
1330
|
/** Whether the member has already reached purchase limit for the order's plan. */
|
|
1341
1331
|
purchaseLimitExceeded?: boolean;
|
|
1342
1332
|
}
|
|
1343
|
-
|
|
1333
|
+
interface GetGuestOnlineOrderPreviewRequest {
|
|
1344
1334
|
/**
|
|
1345
1335
|
* Plan ID.
|
|
1346
1336
|
* @format GUID
|
|
@@ -1364,7 +1354,7 @@ export interface GetGuestOnlineOrderPreviewRequest {
|
|
|
1364
1354
|
*/
|
|
1365
1355
|
email?: string;
|
|
1366
1356
|
}
|
|
1367
|
-
|
|
1357
|
+
interface GetGuestOnlineOrderPreviewResponse {
|
|
1368
1358
|
/** Will be missing if limit is exceeded */
|
|
1369
1359
|
order?: Order;
|
|
1370
1360
|
/**
|
|
@@ -1373,7 +1363,7 @@ export interface GetGuestOnlineOrderPreviewResponse {
|
|
|
1373
1363
|
*/
|
|
1374
1364
|
purchaseLimitExceeded?: boolean;
|
|
1375
1365
|
}
|
|
1376
|
-
|
|
1366
|
+
interface GetOfflineOrderPreviewRequest {
|
|
1377
1367
|
/**
|
|
1378
1368
|
* ID of the plan of the previewed order, from the Plans API.
|
|
1379
1369
|
* @format GUID
|
|
@@ -1397,7 +1387,7 @@ export interface GetOfflineOrderPreviewRequest {
|
|
|
1397
1387
|
*/
|
|
1398
1388
|
couponCode?: string | null;
|
|
1399
1389
|
}
|
|
1400
|
-
|
|
1390
|
+
interface GetOfflineOrderPreviewResponse {
|
|
1401
1391
|
/** The previewed order, as if the plan had been ordered. */
|
|
1402
1392
|
order?: Order;
|
|
1403
1393
|
/**
|
|
@@ -1408,7 +1398,7 @@ export interface GetOfflineOrderPreviewResponse {
|
|
|
1408
1398
|
*/
|
|
1409
1399
|
purchaseLimitExceeded?: boolean;
|
|
1410
1400
|
}
|
|
1411
|
-
|
|
1401
|
+
interface GetPricePreviewRequest {
|
|
1412
1402
|
/**
|
|
1413
1403
|
* ID of plan to preview.
|
|
1414
1404
|
* @format GUID
|
|
@@ -1421,18 +1411,11 @@ export interface GetPricePreviewRequest {
|
|
|
1421
1411
|
*/
|
|
1422
1412
|
couponCode?: string | null;
|
|
1423
1413
|
}
|
|
1424
|
-
|
|
1425
|
-
/**
|
|
1426
|
-
* __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
|
1427
|
-
* @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
|
|
1428
|
-
* @replacedBy prices
|
|
1429
|
-
* @targetRemovalDate 2022-10-01
|
|
1430
|
-
*/
|
|
1431
|
-
price?: PriceDetails;
|
|
1414
|
+
interface GetPricePreviewResponse {
|
|
1432
1415
|
/** Pricing details. */
|
|
1433
1416
|
prices?: SpannedPrice[];
|
|
1434
1417
|
}
|
|
1435
|
-
|
|
1418
|
+
interface ChangeStartDateRequest {
|
|
1436
1419
|
/**
|
|
1437
1420
|
* Draft order ID.
|
|
1438
1421
|
* @format GUID
|
|
@@ -1441,15 +1424,15 @@ export interface ChangeStartDateRequest {
|
|
|
1441
1424
|
/** New valid from date (timestamp). */
|
|
1442
1425
|
startDate?: Date | null;
|
|
1443
1426
|
}
|
|
1444
|
-
|
|
1427
|
+
interface ChangeStartDateResponse {
|
|
1445
1428
|
/** Updated draft order. */
|
|
1446
1429
|
order?: Order;
|
|
1447
1430
|
}
|
|
1448
|
-
|
|
1431
|
+
interface OrderStartDateChanged {
|
|
1449
1432
|
/** Order whose `startDate` changed. */
|
|
1450
1433
|
order?: Order;
|
|
1451
1434
|
}
|
|
1452
|
-
|
|
1435
|
+
interface ApplyCouponRequest {
|
|
1453
1436
|
/**
|
|
1454
1437
|
* Draft order ID.
|
|
1455
1438
|
* @format GUID
|
|
@@ -1462,11 +1445,11 @@ export interface ApplyCouponRequest {
|
|
|
1462
1445
|
*/
|
|
1463
1446
|
couponCode?: string;
|
|
1464
1447
|
}
|
|
1465
|
-
|
|
1448
|
+
interface ApplyCouponResponse {
|
|
1466
1449
|
/** Order with applied coupon and recalculated tax. */
|
|
1467
1450
|
order?: Order;
|
|
1468
1451
|
}
|
|
1469
|
-
|
|
1452
|
+
interface SetSubmissionRequest {
|
|
1470
1453
|
/**
|
|
1471
1454
|
* Order ID.
|
|
1472
1455
|
* @format GUID
|
|
@@ -1478,7 +1461,274 @@ export interface SetSubmissionRequest {
|
|
|
1478
1461
|
*/
|
|
1479
1462
|
submissionId?: string;
|
|
1480
1463
|
}
|
|
1481
|
-
|
|
1464
|
+
interface SetSubmissionResponse {
|
|
1482
1465
|
/** Order with submission id */
|
|
1483
1466
|
order?: Order;
|
|
1484
1467
|
}
|
|
1468
|
+
interface BaseEventMetadata {
|
|
1469
|
+
/**
|
|
1470
|
+
* App instance ID.
|
|
1471
|
+
* @format GUID
|
|
1472
|
+
*/
|
|
1473
|
+
instanceId?: string | null;
|
|
1474
|
+
/**
|
|
1475
|
+
* Event type.
|
|
1476
|
+
* @maxLength 150
|
|
1477
|
+
*/
|
|
1478
|
+
eventType?: string;
|
|
1479
|
+
/** The identification type and identity data. */
|
|
1480
|
+
identity?: IdentificationData;
|
|
1481
|
+
}
|
|
1482
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1483
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1484
|
+
_id?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1487
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1488
|
+
*/
|
|
1489
|
+
entityFqdn?: string;
|
|
1490
|
+
/**
|
|
1491
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1492
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1493
|
+
*/
|
|
1494
|
+
slug?: string;
|
|
1495
|
+
/** ID of the entity associated with the event. */
|
|
1496
|
+
entityId?: string;
|
|
1497
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1498
|
+
eventTime?: Date | null;
|
|
1499
|
+
/**
|
|
1500
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1501
|
+
* (for example, GDPR).
|
|
1502
|
+
*/
|
|
1503
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1504
|
+
/** If present, indicates the action that triggered the event. */
|
|
1505
|
+
originatedFrom?: string | null;
|
|
1506
|
+
/**
|
|
1507
|
+
* 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.
|
|
1508
|
+
* 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.
|
|
1509
|
+
*/
|
|
1510
|
+
entityEventSequence?: string | null;
|
|
1511
|
+
}
|
|
1512
|
+
interface OrderAutoRenewCanceledEnvelope {
|
|
1513
|
+
data: OrderAutoRenewCanceled;
|
|
1514
|
+
metadata: EventMetadata;
|
|
1515
|
+
}
|
|
1516
|
+
interface OrderCanceledEnvelope {
|
|
1517
|
+
data: OrderCanceled;
|
|
1518
|
+
metadata: EventMetadata;
|
|
1519
|
+
}
|
|
1520
|
+
interface OrderCycleStartedEnvelope {
|
|
1521
|
+
data: OrderCycleStarted;
|
|
1522
|
+
metadata: EventMetadata;
|
|
1523
|
+
}
|
|
1524
|
+
interface OrderEndDatePostponedEnvelope {
|
|
1525
|
+
data: OrderEndDatePostponed;
|
|
1526
|
+
metadata: EventMetadata;
|
|
1527
|
+
}
|
|
1528
|
+
interface OrderEndedEnvelope {
|
|
1529
|
+
data: OrderEnded;
|
|
1530
|
+
metadata: EventMetadata;
|
|
1531
|
+
}
|
|
1532
|
+
interface OrderMarkedAsPaidEnvelope {
|
|
1533
|
+
data: OrderMarkedAsPaid;
|
|
1534
|
+
metadata: EventMetadata;
|
|
1535
|
+
}
|
|
1536
|
+
interface OrderPausedEnvelope {
|
|
1537
|
+
data: OrderPaused;
|
|
1538
|
+
metadata: EventMetadata;
|
|
1539
|
+
}
|
|
1540
|
+
interface OrderPurchasedEnvelope {
|
|
1541
|
+
data: OrderPurchased;
|
|
1542
|
+
metadata: EventMetadata;
|
|
1543
|
+
}
|
|
1544
|
+
interface OrderResumedEnvelope {
|
|
1545
|
+
data: OrderResumed;
|
|
1546
|
+
metadata: EventMetadata;
|
|
1547
|
+
}
|
|
1548
|
+
interface OrderStartedEnvelope {
|
|
1549
|
+
data: OrderStarted;
|
|
1550
|
+
metadata: EventMetadata;
|
|
1551
|
+
}
|
|
1552
|
+
interface OrderUpdatedEnvelope {
|
|
1553
|
+
entity: Order;
|
|
1554
|
+
metadata: EventMetadata;
|
|
1555
|
+
}
|
|
1556
|
+
interface OrderCreatedEnvelope {
|
|
1557
|
+
entity: Order;
|
|
1558
|
+
metadata: EventMetadata;
|
|
1559
|
+
}
|
|
1560
|
+
interface OrderStartDateChangedEnvelope {
|
|
1561
|
+
data: OrderStartDateChanged;
|
|
1562
|
+
metadata: EventMetadata;
|
|
1563
|
+
}
|
|
1564
|
+
interface ManagementGetOrderOptions {
|
|
1565
|
+
/**
|
|
1566
|
+
* Predefined set of fields to return.
|
|
1567
|
+
*
|
|
1568
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1569
|
+
*/
|
|
1570
|
+
fieldSet?: SetWithLiterals;
|
|
1571
|
+
}
|
|
1572
|
+
interface ManagementListOrdersOptions {
|
|
1573
|
+
/**
|
|
1574
|
+
* Filter by a buyer's member ID, from the Members API.
|
|
1575
|
+
* @format GUID
|
|
1576
|
+
*/
|
|
1577
|
+
buyerIds?: string[];
|
|
1578
|
+
/**
|
|
1579
|
+
* Filter by plan IDs, from the Plans API.
|
|
1580
|
+
* @format GUID
|
|
1581
|
+
*/
|
|
1582
|
+
planIds?: string[];
|
|
1583
|
+
/** Filter by whether or not the auto-renewal of recurring orders was canceled. */
|
|
1584
|
+
autoRenewCanceled?: boolean | null;
|
|
1585
|
+
/** Filter by order status. */
|
|
1586
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1587
|
+
/** Filter by payment status. */
|
|
1588
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1589
|
+
/**
|
|
1590
|
+
* Number of orders to return. See Sorting and Paging for more information.
|
|
1591
|
+
*
|
|
1592
|
+
* Max: `50`
|
|
1593
|
+
* @min 1
|
|
1594
|
+
* @max 50
|
|
1595
|
+
*/
|
|
1596
|
+
limit?: number | null;
|
|
1597
|
+
/** Number of orders to skip in the current sort order. */
|
|
1598
|
+
offset?: number | null;
|
|
1599
|
+
/**
|
|
1600
|
+
* Sort order.
|
|
1601
|
+
*
|
|
1602
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
1603
|
+
*
|
|
1604
|
+
* Default: `DESC`.
|
|
1605
|
+
*/
|
|
1606
|
+
sorting?: Sorting;
|
|
1607
|
+
/**
|
|
1608
|
+
* Predefined set of fields to return.
|
|
1609
|
+
*
|
|
1610
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1611
|
+
*/
|
|
1612
|
+
fieldSet?: SetWithLiterals;
|
|
1613
|
+
}
|
|
1614
|
+
interface MemberGetOrderOptions {
|
|
1615
|
+
/**
|
|
1616
|
+
* Predefined set of fields to return.
|
|
1617
|
+
*
|
|
1618
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1619
|
+
*/
|
|
1620
|
+
fieldSet?: SetWithLiterals;
|
|
1621
|
+
}
|
|
1622
|
+
interface MemberListOrdersOptions {
|
|
1623
|
+
/**
|
|
1624
|
+
* Filter by plan IDs.
|
|
1625
|
+
* @format GUID
|
|
1626
|
+
*/
|
|
1627
|
+
planIds?: string[];
|
|
1628
|
+
/** Filter for orders where auto renewal was canceled. */
|
|
1629
|
+
autoRenewCanceled?: boolean | null;
|
|
1630
|
+
/** Filter by order status. */
|
|
1631
|
+
orderStatuses?: OrderStatusWithLiterals[];
|
|
1632
|
+
/** Filter by payment status. */
|
|
1633
|
+
paymentStatuses?: PaymentStatusWithLiterals[];
|
|
1634
|
+
/**
|
|
1635
|
+
* Limit the number of pricing plans returned. Default limit is 50.
|
|
1636
|
+
* @min 1
|
|
1637
|
+
* @max 50
|
|
1638
|
+
*/
|
|
1639
|
+
limit?: number | null;
|
|
1640
|
+
/** Number of entries to offset. */
|
|
1641
|
+
offset?: number | null;
|
|
1642
|
+
/** Sorting direction (defaults to ASC) and field to sort by. */
|
|
1643
|
+
sorting?: Sorting;
|
|
1644
|
+
/**
|
|
1645
|
+
* Predefined set of fields to return.
|
|
1646
|
+
*
|
|
1647
|
+
* Default: If `fieldSet` is omitted, no order form submission data is returned.
|
|
1648
|
+
*/
|
|
1649
|
+
fieldSet?: SetWithLiterals;
|
|
1650
|
+
}
|
|
1651
|
+
interface CreateOnlineOrderOptions {
|
|
1652
|
+
/**
|
|
1653
|
+
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1654
|
+
*
|
|
1655
|
+
* Default: Current date and time.
|
|
1656
|
+
*/
|
|
1657
|
+
startDate?: Date | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Coupon code to apply.
|
|
1660
|
+
* @minLength 1
|
|
1661
|
+
* @maxLength 20
|
|
1662
|
+
*/
|
|
1663
|
+
couponCode?: string | null;
|
|
1664
|
+
/** Provided if checkout is initiated on buyer's behalf. */
|
|
1665
|
+
onBehalf?: OnBehalf;
|
|
1666
|
+
/**
|
|
1667
|
+
* Submission ID of the form submitted with this order.
|
|
1668
|
+
* @format GUID
|
|
1669
|
+
*/
|
|
1670
|
+
submissionId?: string | null;
|
|
1671
|
+
}
|
|
1672
|
+
interface CreateOfflineOrderOptions {
|
|
1673
|
+
/**
|
|
1674
|
+
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1675
|
+
*
|
|
1676
|
+
* Default: Current date and time.
|
|
1677
|
+
*/
|
|
1678
|
+
startDate?: Date | null;
|
|
1679
|
+
/**
|
|
1680
|
+
* Whether the order is paid.
|
|
1681
|
+
*
|
|
1682
|
+
* Default: `false`
|
|
1683
|
+
*/
|
|
1684
|
+
paid?: boolean | null;
|
|
1685
|
+
/**
|
|
1686
|
+
* Coupon code to apply, from the Coupons API.
|
|
1687
|
+
* @minLength 1
|
|
1688
|
+
* @maxLength 20
|
|
1689
|
+
*/
|
|
1690
|
+
couponCode?: string | null;
|
|
1691
|
+
/**
|
|
1692
|
+
* Form submission ID that was submitted with the order.
|
|
1693
|
+
* @format GUID
|
|
1694
|
+
*/
|
|
1695
|
+
submissionId?: string | null;
|
|
1696
|
+
}
|
|
1697
|
+
interface GetOnlineOrderPreviewOptions {
|
|
1698
|
+
/**
|
|
1699
|
+
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1700
|
+
*
|
|
1701
|
+
* Default: Current date and time.
|
|
1702
|
+
*/
|
|
1703
|
+
startDate?: Date | null;
|
|
1704
|
+
/**
|
|
1705
|
+
* Coupon code to apply.
|
|
1706
|
+
* @minLength 1
|
|
1707
|
+
* @maxLength 20
|
|
1708
|
+
*/
|
|
1709
|
+
couponCode?: string | null;
|
|
1710
|
+
}
|
|
1711
|
+
interface GetOfflineOrderPreviewOptions {
|
|
1712
|
+
/**
|
|
1713
|
+
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
1714
|
+
*
|
|
1715
|
+
* Default: Current date and time.
|
|
1716
|
+
*/
|
|
1717
|
+
startDate?: Date | null;
|
|
1718
|
+
/**
|
|
1719
|
+
* Coupon code to apply, from the Coupons API.
|
|
1720
|
+
* @minLength 1
|
|
1721
|
+
* @maxLength 20
|
|
1722
|
+
*/
|
|
1723
|
+
couponCode?: string | null;
|
|
1724
|
+
}
|
|
1725
|
+
interface GetPricePreviewOptions {
|
|
1726
|
+
/**
|
|
1727
|
+
* Coupon code to apply, from the Coupons API.
|
|
1728
|
+
* @minLength 1
|
|
1729
|
+
* @maxLength 20
|
|
1730
|
+
*/
|
|
1731
|
+
couponCode?: string | null;
|
|
1732
|
+
}
|
|
1733
|
+
|
|
1734
|
+
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 };
|