@wix/auto_sdk_packages_packages 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/premium-reseller-v1-packages-packages.context.d.ts +1 -1
- package/build/cjs/src/premium-reseller-v1-packages-packages.types.d.ts +330 -142
- package/build/cjs/src/premium-reseller-v1-packages-packages.types.js.map +1 -1
- package/build/cjs/src/premium-reseller-v1-packages-packages.universal.d.ts +392 -155
- package/build/cjs/src/premium-reseller-v1-packages-packages.universal.js.map +1 -1
- package/build/es/src/premium-reseller-v1-packages-packages.context.d.ts +1 -1
- package/build/es/src/premium-reseller-v1-packages-packages.types.d.ts +330 -142
- package/build/es/src/premium-reseller-v1-packages-packages.types.js.map +1 -1
- package/build/es/src/premium-reseller-v1-packages-packages.universal.d.ts +392 -155
- package/build/es/src/premium-reseller-v1-packages-packages.universal.js.map +1 -1
- package/build/internal/cjs/src/premium-reseller-v1-packages-packages.context.d.ts +1 -1
- package/build/internal/cjs/src/premium-reseller-v1-packages-packages.types.d.ts +330 -142
- package/build/internal/cjs/src/premium-reseller-v1-packages-packages.types.js.map +1 -1
- package/build/internal/cjs/src/premium-reseller-v1-packages-packages.universal.d.ts +392 -155
- package/build/internal/cjs/src/premium-reseller-v1-packages-packages.universal.js.map +1 -1
- package/build/internal/es/src/premium-reseller-v1-packages-packages.context.d.ts +1 -1
- package/build/internal/es/src/premium-reseller-v1-packages-packages.types.d.ts +330 -142
- package/build/internal/es/src/premium-reseller-v1-packages-packages.types.js.map +1 -1
- package/build/internal/es/src/premium-reseller-v1-packages-packages.universal.d.ts +392 -155
- package/build/internal/es/src/premium-reseller-v1-packages-packages.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -6,6 +6,7 @@ export interface Package {
|
|
|
6
6
|
/**
|
|
7
7
|
* Package ID.
|
|
8
8
|
* @readonly
|
|
9
|
+
* @format GUID
|
|
9
10
|
*/
|
|
10
11
|
id?: string;
|
|
11
12
|
/**
|
|
@@ -13,6 +14,7 @@ export interface Package {
|
|
|
13
14
|
* [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
|
|
14
15
|
* for more details.
|
|
15
16
|
* @readonly
|
|
17
|
+
* @format GUID
|
|
16
18
|
*/
|
|
17
19
|
accountId?: string;
|
|
18
20
|
/**
|
|
@@ -20,6 +22,7 @@ export interface Package {
|
|
|
20
22
|
* This field isn't validated by Wix.
|
|
21
23
|
*
|
|
22
24
|
* Max: 100 characters
|
|
25
|
+
* @maxLength 100
|
|
23
26
|
*/
|
|
24
27
|
externalId?: string | null;
|
|
25
28
|
/**
|
|
@@ -27,6 +30,8 @@ export interface Package {
|
|
|
27
30
|
*
|
|
28
31
|
* Min: 1 product instance
|
|
29
32
|
* Max: 1000 product instances
|
|
33
|
+
* @maxSize 1000
|
|
34
|
+
* @minSize 1
|
|
30
35
|
*/
|
|
31
36
|
productInstances?: ProductInstance[];
|
|
32
37
|
/**
|
|
@@ -52,18 +57,21 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
|
|
|
52
57
|
* `catalogProductId`. Allows you to identify different instances of the same
|
|
53
58
|
* product in a package.
|
|
54
59
|
* @readonly
|
|
60
|
+
* @format GUID
|
|
55
61
|
*/
|
|
56
62
|
instanceId?: string;
|
|
57
63
|
/**
|
|
58
64
|
* ID of the Wix site that the product instance is assigned to.
|
|
59
65
|
* See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites)
|
|
60
66
|
* for more information.
|
|
67
|
+
* @format GUID
|
|
61
68
|
*/
|
|
62
69
|
siteId?: string | null;
|
|
63
70
|
/**
|
|
64
71
|
* Product ID, as defined in the Wix Premium Product Catalog.
|
|
65
72
|
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com)
|
|
66
73
|
* for more details about available Wix services.
|
|
74
|
+
* @format GUID
|
|
67
75
|
*/
|
|
68
76
|
catalogProductId?: string;
|
|
69
77
|
/**
|
|
@@ -92,6 +100,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
|
|
|
92
100
|
* format. Specifies where customers can claim vouchers that may come with the
|
|
93
101
|
* product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more
|
|
94
102
|
* information about vouchers and supported locations.
|
|
103
|
+
* @format COUNTRY
|
|
95
104
|
*/
|
|
96
105
|
countryCode?: string | null;
|
|
97
106
|
/**
|
|
@@ -107,6 +116,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
|
|
|
107
116
|
* [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
|
|
108
117
|
*
|
|
109
118
|
* Max: 25 characters
|
|
119
|
+
* @maxLength 25
|
|
110
120
|
*/
|
|
111
121
|
discountCode?: string | null;
|
|
112
122
|
/**
|
|
@@ -116,6 +126,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
|
|
|
116
126
|
* Premium plan. The referenced product instance must have either status `"PENDING"` or
|
|
117
127
|
* `"ACTIVE"`. You can use each product instance only a single time as reference
|
|
118
128
|
* instance.
|
|
129
|
+
* @format GUID
|
|
119
130
|
*/
|
|
120
131
|
referenceProductInstanceId?: string | null;
|
|
121
132
|
}
|
|
@@ -154,7 +165,10 @@ export declare enum CycleDescriptorType {
|
|
|
154
165
|
export interface CycleInterval {
|
|
155
166
|
/** Unit of the billing cycle. */
|
|
156
167
|
unit?: IntervalIntervalUnit;
|
|
157
|
-
/**
|
|
168
|
+
/**
|
|
169
|
+
* Count of units that make up the billing cycle.
|
|
170
|
+
* @min 1
|
|
171
|
+
*/
|
|
158
172
|
count?: number;
|
|
159
173
|
}
|
|
160
174
|
export declare enum Status {
|
|
@@ -181,49 +195,50 @@ export interface ProductInstanceCycle {
|
|
|
181
195
|
/** Duration of the billing cycle. Available only for `RECURRING` payments. */
|
|
182
196
|
cycleDuration?: CycleInterval;
|
|
183
197
|
}
|
|
184
|
-
export interface MigrateSubscriptionToPackagesRequest {
|
|
185
|
-
/** Created package. */
|
|
186
|
-
productInstance?: ProductInstance;
|
|
187
|
-
/** Existing subscriptionId to migrate */
|
|
188
|
-
subscriptionId?: string | null;
|
|
189
|
-
/** User id of the migration - only for Immigrator */
|
|
190
|
-
userId?: string | null;
|
|
191
|
-
}
|
|
192
|
-
export interface MigrateSubscriptionToPackagesResponse {
|
|
193
|
-
package?: Package;
|
|
194
|
-
}
|
|
195
|
-
export interface FixBrokenMigrationRequest {
|
|
196
|
-
/** Subscription id of the broken subscription */
|
|
197
|
-
subscriptionId?: string;
|
|
198
|
-
/** SBS service id that points to the broken subscription */
|
|
199
|
-
sbsServiceId?: string;
|
|
200
|
-
/** Owner of the broken subscription */
|
|
201
|
-
userId?: string;
|
|
202
|
-
}
|
|
203
|
-
export interface FixBrokenMigrationResponse {
|
|
204
|
-
}
|
|
205
198
|
export interface CreatePackageRequest {
|
|
206
|
-
/**
|
|
199
|
+
/**
|
|
200
|
+
* Idempotency key.
|
|
201
|
+
* @maxLength 100
|
|
202
|
+
*/
|
|
207
203
|
idempotencyKey?: string | null;
|
|
208
|
-
/**
|
|
204
|
+
/**
|
|
205
|
+
* External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix.
|
|
206
|
+
* @maxLength 100
|
|
207
|
+
*/
|
|
209
208
|
externalId?: string | null;
|
|
210
|
-
/**
|
|
209
|
+
/**
|
|
210
|
+
* Wix services that are resold.
|
|
211
|
+
* @maxSize 1000
|
|
212
|
+
* @minSize 1
|
|
213
|
+
*/
|
|
211
214
|
products: ProductInstance[];
|
|
212
215
|
}
|
|
213
216
|
export interface CreatePackageResponse {
|
|
214
|
-
/**
|
|
217
|
+
/**
|
|
218
|
+
* Idempotency key.
|
|
219
|
+
* @maxLength 100
|
|
220
|
+
*/
|
|
215
221
|
idempotencyKey?: string | null;
|
|
216
222
|
/** Created package. */
|
|
217
223
|
package?: Package;
|
|
218
224
|
}
|
|
219
225
|
export interface CancelPackageRequest {
|
|
220
|
-
/**
|
|
226
|
+
/**
|
|
227
|
+
* Idempotency key.
|
|
228
|
+
* @maxLength 100
|
|
229
|
+
*/
|
|
221
230
|
idempotencyKey?: string | null;
|
|
222
|
-
/**
|
|
231
|
+
/**
|
|
232
|
+
* ID of the package to cancel.
|
|
233
|
+
* @format GUID
|
|
234
|
+
*/
|
|
223
235
|
id: string;
|
|
224
236
|
}
|
|
225
237
|
export interface CancelPackageResponse {
|
|
226
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Idempotency key.
|
|
240
|
+
* @maxLength 100
|
|
241
|
+
*/
|
|
227
242
|
idempotencyKey?: string | null;
|
|
228
243
|
/** Canceled package. */
|
|
229
244
|
package?: Package;
|
|
@@ -233,7 +248,10 @@ export interface PackageCanceled {
|
|
|
233
248
|
package?: Package;
|
|
234
249
|
}
|
|
235
250
|
export interface GetPackageRequest {
|
|
236
|
-
/**
|
|
251
|
+
/**
|
|
252
|
+
* Package ID.
|
|
253
|
+
* @format GUID
|
|
254
|
+
*/
|
|
237
255
|
id: string;
|
|
238
256
|
}
|
|
239
257
|
export interface GetPackageResponse {
|
|
@@ -274,7 +292,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
274
292
|
cursorPaging?: CursorPaging;
|
|
275
293
|
}
|
|
276
294
|
export interface Sorting {
|
|
277
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* Name of the field to sort by.
|
|
297
|
+
* @maxLength 512
|
|
298
|
+
*/
|
|
278
299
|
fieldName?: string;
|
|
279
300
|
/** Sort order. */
|
|
280
301
|
order?: SortOrder;
|
|
@@ -290,13 +311,17 @@ export interface Paging {
|
|
|
290
311
|
offset?: number | null;
|
|
291
312
|
}
|
|
292
313
|
export interface CursorPaging {
|
|
293
|
-
/**
|
|
314
|
+
/**
|
|
315
|
+
* Maximum number of items to return in the results.
|
|
316
|
+
* @max 100
|
|
317
|
+
*/
|
|
294
318
|
limit?: number | null;
|
|
295
319
|
/**
|
|
296
320
|
* Pointer to the next or previous page in the list of results.
|
|
297
321
|
*
|
|
298
322
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
299
323
|
* Not relevant for the first request.
|
|
324
|
+
* @maxLength 16000
|
|
300
325
|
*/
|
|
301
326
|
cursor?: string | null;
|
|
302
327
|
}
|
|
@@ -307,6 +332,7 @@ export interface QueryPackagesResponse {
|
|
|
307
332
|
* Retrieved packages.
|
|
308
333
|
*
|
|
309
334
|
* Max: 1000 packages
|
|
335
|
+
* @maxSize 1000
|
|
310
336
|
*/
|
|
311
337
|
packages?: Package[];
|
|
312
338
|
}
|
|
@@ -323,21 +349,39 @@ export interface PagingMetadataV2 {
|
|
|
323
349
|
cursors?: Cursors;
|
|
324
350
|
}
|
|
325
351
|
export interface Cursors {
|
|
326
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* Cursor string pointing to the next page in the list of results.
|
|
354
|
+
* @maxLength 16000
|
|
355
|
+
*/
|
|
327
356
|
next?: string | null;
|
|
328
|
-
/**
|
|
357
|
+
/**
|
|
358
|
+
* Cursor pointing to the previous page in the list of results.
|
|
359
|
+
* @maxLength 16000
|
|
360
|
+
*/
|
|
329
361
|
prev?: string | null;
|
|
330
362
|
}
|
|
331
363
|
export interface AssignProductInstanceToSiteRequest {
|
|
332
|
-
/**
|
|
364
|
+
/**
|
|
365
|
+
* Idempotency key.
|
|
366
|
+
* @maxLength 100
|
|
367
|
+
*/
|
|
333
368
|
idempotencyKey?: string | null;
|
|
334
|
-
/**
|
|
369
|
+
/**
|
|
370
|
+
* ID of the product instance to assign to a site.
|
|
371
|
+
* @format GUID
|
|
372
|
+
*/
|
|
335
373
|
instanceId: string;
|
|
336
|
-
/**
|
|
374
|
+
/**
|
|
375
|
+
* ID of the site to which the product instance is assigned.
|
|
376
|
+
* @format GUID
|
|
377
|
+
*/
|
|
337
378
|
siteId: string;
|
|
338
379
|
}
|
|
339
380
|
export interface AssignProductInstanceToSiteResponse {
|
|
340
|
-
/**
|
|
381
|
+
/**
|
|
382
|
+
* Idempotency key.
|
|
383
|
+
* @maxLength 100
|
|
384
|
+
*/
|
|
341
385
|
idempotencyKey?: string | null;
|
|
342
386
|
/** Updated package that includes the assigned product instance. */
|
|
343
387
|
package?: Package;
|
|
@@ -348,22 +392,33 @@ export interface AssignedProductInstanceToSite {
|
|
|
348
392
|
/**
|
|
349
393
|
* ID of the product instance that was assigned to the site.
|
|
350
394
|
* @readonly
|
|
395
|
+
* @format GUID
|
|
351
396
|
*/
|
|
352
397
|
productInstanceId?: string;
|
|
353
398
|
/**
|
|
354
399
|
* ID of the site the product instance was assigned to.
|
|
355
400
|
* @readonly
|
|
401
|
+
* @format GUID
|
|
356
402
|
*/
|
|
357
403
|
siteId?: string;
|
|
358
404
|
}
|
|
359
405
|
export interface UnassignProductInstanceFromSiteRequest {
|
|
360
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* Idempotency key.
|
|
408
|
+
* @maxLength 100
|
|
409
|
+
*/
|
|
361
410
|
idempotencyKey?: string | null;
|
|
362
|
-
/**
|
|
411
|
+
/**
|
|
412
|
+
* ID of the product instance to unassign from a site.
|
|
413
|
+
* @format GUID
|
|
414
|
+
*/
|
|
363
415
|
instanceId: string;
|
|
364
416
|
}
|
|
365
417
|
export interface UnassignProductInstanceFromSiteResponse {
|
|
366
|
-
/**
|
|
418
|
+
/**
|
|
419
|
+
* Idempotency key.
|
|
420
|
+
* @maxLength 100
|
|
421
|
+
*/
|
|
367
422
|
idempotencyKey?: string | null;
|
|
368
423
|
/** Updated package that includes the unassigned product instance. */
|
|
369
424
|
package?: Package;
|
|
@@ -374,22 +429,33 @@ export interface UnassignedProductInstanceFromSite {
|
|
|
374
429
|
/**
|
|
375
430
|
* ID of the product instance that was unassigned from the site.
|
|
376
431
|
* @readonly
|
|
432
|
+
* @format GUID
|
|
377
433
|
*/
|
|
378
434
|
productInstanceId?: string;
|
|
379
435
|
/**
|
|
380
436
|
* MetasiteId of the site the product instance was unassigned from.
|
|
381
437
|
* @readonly
|
|
438
|
+
* @format GUID
|
|
382
439
|
*/
|
|
383
440
|
metaSiteId?: string;
|
|
384
441
|
}
|
|
385
442
|
export interface CancelProductInstanceRequest {
|
|
386
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* Idempotency key.
|
|
445
|
+
* @maxLength 100
|
|
446
|
+
*/
|
|
387
447
|
idempotencyKey?: string | null;
|
|
388
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* ID of the product instance to cancel.
|
|
450
|
+
* @format GUID
|
|
451
|
+
*/
|
|
389
452
|
instanceId: string;
|
|
390
453
|
}
|
|
391
454
|
export interface CancelProductInstanceResponse {
|
|
392
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* Idempotency key.
|
|
457
|
+
* @maxLength 100
|
|
458
|
+
*/
|
|
393
459
|
idempotencyKey?: string | null;
|
|
394
460
|
/** Updated package that includes the previously included the canceled product instance. */
|
|
395
461
|
package?: Package;
|
|
@@ -400,17 +466,25 @@ export interface ProductInstanceCanceled {
|
|
|
400
466
|
/**
|
|
401
467
|
* ID of the product instance that was canceled.
|
|
402
468
|
* @readonly
|
|
469
|
+
* @format GUID
|
|
403
470
|
*/
|
|
404
471
|
productInstanceId?: string;
|
|
405
472
|
}
|
|
406
473
|
export interface AdjustProductInstanceSpecificationsRequest {
|
|
407
|
-
/**
|
|
474
|
+
/**
|
|
475
|
+
* Idempotency key.
|
|
476
|
+
* @maxLength 100
|
|
477
|
+
*/
|
|
408
478
|
idempotencyKey?: string | null;
|
|
409
|
-
/**
|
|
479
|
+
/**
|
|
480
|
+
* ID of the product instance to adjust.
|
|
481
|
+
* @format GUID
|
|
482
|
+
*/
|
|
410
483
|
instanceId: string;
|
|
411
484
|
/**
|
|
412
485
|
* ID of the product to replace the original instance. Required in case you don't
|
|
413
486
|
* provide a new `billingInfo` object.
|
|
487
|
+
* @format GUID
|
|
414
488
|
*/
|
|
415
489
|
catalogProductId?: string | null;
|
|
416
490
|
/**
|
|
@@ -432,11 +506,15 @@ export interface AdjustProductInstanceSpecificationsRequest {
|
|
|
432
506
|
* more information about supported codes.
|
|
433
507
|
*
|
|
434
508
|
* Max: 25 characters
|
|
509
|
+
* @maxLength 25
|
|
435
510
|
*/
|
|
436
511
|
discountCode?: string | null;
|
|
437
512
|
}
|
|
438
513
|
export interface AdjustProductInstanceSpecificationsResponse {
|
|
439
|
-
/**
|
|
514
|
+
/**
|
|
515
|
+
* Idempotency key.
|
|
516
|
+
* @maxLength 100
|
|
517
|
+
*/
|
|
440
518
|
idempotencyKey?: string | null;
|
|
441
519
|
/** Updated package that includes the adjusted product instance. */
|
|
442
520
|
package?: Package;
|
|
@@ -447,6 +525,7 @@ export interface AdjustedProductInstanceSpecifications {
|
|
|
447
525
|
/**
|
|
448
526
|
* ID of the product instance to adjust.
|
|
449
527
|
* @readonly
|
|
528
|
+
* @format GUID
|
|
450
529
|
*/
|
|
451
530
|
productInstanceId?: string;
|
|
452
531
|
}
|
|
@@ -495,7 +574,10 @@ export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
|
|
|
495
574
|
pendingChange?: SubscriptionPendingChange;
|
|
496
575
|
/** Triggered when a recurring charge attempt fails for a subscription. */
|
|
497
576
|
recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
|
|
498
|
-
/**
|
|
577
|
+
/**
|
|
578
|
+
* ID of the subscription's event.
|
|
579
|
+
* @format GUID
|
|
580
|
+
*/
|
|
499
581
|
eventId?: string | null;
|
|
500
582
|
/**
|
|
501
583
|
* Date and time of the event in
|
|
@@ -569,13 +651,20 @@ export interface SubscriptionCreated {
|
|
|
569
651
|
* owner has purchased including details about the billing.
|
|
570
652
|
*/
|
|
571
653
|
export interface Subscription {
|
|
572
|
-
/**
|
|
654
|
+
/**
|
|
655
|
+
* ID of the subscription.
|
|
656
|
+
* @format GUID
|
|
657
|
+
*/
|
|
573
658
|
id?: string;
|
|
574
|
-
/**
|
|
659
|
+
/**
|
|
660
|
+
* ID of the Wix account that purchased the subscription.
|
|
661
|
+
* @format GUID
|
|
662
|
+
*/
|
|
575
663
|
userId?: string;
|
|
576
664
|
/**
|
|
577
665
|
* ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
|
|
578
666
|
* for which the subscription was purchased.
|
|
667
|
+
* @format GUID
|
|
579
668
|
*/
|
|
580
669
|
productId?: string;
|
|
581
670
|
/**
|
|
@@ -594,6 +683,7 @@ export interface Subscription {
|
|
|
594
683
|
* ID of the metasite that the subscription is assigned to.
|
|
595
684
|
* Available only when the subscription is assigned to a Wix site.
|
|
596
685
|
* Subscriptions for account level products can't be assigned to a Wix site.
|
|
686
|
+
* @format GUID
|
|
597
687
|
*/
|
|
598
688
|
metaSiteId?: string | null;
|
|
599
689
|
/** Information about the system that manages the subscription's billing. */
|
|
@@ -621,6 +711,7 @@ export interface Subscription {
|
|
|
621
711
|
/**
|
|
622
712
|
* ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
|
|
623
713
|
* that the product, for which the subscription was purchased, belongs to.
|
|
714
|
+
* @format GUID
|
|
624
715
|
*/
|
|
625
716
|
productTypeId?: string;
|
|
626
717
|
/** Version number, which increments by 1 each time the subscription is updated. */
|
|
@@ -742,7 +833,10 @@ export declare enum ReactivationReasonEnum {
|
|
|
742
833
|
export interface SubscriptionAssigned {
|
|
743
834
|
/** Assigned subscription. */
|
|
744
835
|
subscription?: Subscription;
|
|
745
|
-
/**
|
|
836
|
+
/**
|
|
837
|
+
* ID of the metasite that the subscription has been assigned to before the update.
|
|
838
|
+
* @format GUID
|
|
839
|
+
*/
|
|
746
840
|
previousMetaSiteId?: string | null;
|
|
747
841
|
}
|
|
748
842
|
/** Triggered when a subscription is canceled. */
|
|
@@ -790,8 +884,8 @@ export interface CancellationDetails {
|
|
|
790
884
|
/**
|
|
791
885
|
* Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
|
|
792
886
|
* `cancellationCode` and `cancellationReason` are taken from the request of
|
|
793
|
-
* [Cancel Immediately](https://
|
|
794
|
-
* or [Cancel Immediately Offline](https://
|
|
887
|
+
* [Cancel Immediately](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately)
|
|
888
|
+
* or [Cancel Immediately Offline](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately-offline).
|
|
795
889
|
* For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
|
|
796
890
|
* is `null` or an empty string.
|
|
797
891
|
*
|
|
@@ -841,7 +935,10 @@ export interface SubscriptionAutoRenewTurnedOff {
|
|
|
841
935
|
export interface SubscriptionUnassigned {
|
|
842
936
|
/** Unassigned subscription. */
|
|
843
937
|
subscription?: Subscription;
|
|
844
|
-
/**
|
|
938
|
+
/**
|
|
939
|
+
* ID of the metasite that the subscription has been assigned to before the event.
|
|
940
|
+
* @format GUID
|
|
941
|
+
*/
|
|
845
942
|
previousMetaSiteId?: string;
|
|
846
943
|
/**
|
|
847
944
|
* Reason why the subscription is unassigned.
|
|
@@ -885,9 +982,15 @@ export interface ContractSwitched {
|
|
|
885
982
|
subscription?: Subscription;
|
|
886
983
|
/** Billing cycle before the update. */
|
|
887
984
|
previousCycle?: Cycle;
|
|
888
|
-
/**
|
|
985
|
+
/**
|
|
986
|
+
* ID of the product belonging to the subscription before the update.
|
|
987
|
+
* @format GUID
|
|
988
|
+
*/
|
|
889
989
|
previousProductId?: string;
|
|
890
|
-
/**
|
|
990
|
+
/**
|
|
991
|
+
* ID of the product type that the subscription's original product belonged to before the update.
|
|
992
|
+
* @format GUID
|
|
993
|
+
*/
|
|
891
994
|
previousProductTypeId?: string;
|
|
892
995
|
/**
|
|
893
996
|
* Update type. __Note__: Doesn't include information about a product adjustment.
|
|
@@ -908,6 +1011,7 @@ export interface ContractSwitched {
|
|
|
908
1011
|
/**
|
|
909
1012
|
* ID of the metasite the subscription has been assigned to previously.
|
|
910
1013
|
* Available only in case the subscription is assigned to a different site.
|
|
1014
|
+
* @format GUID
|
|
911
1015
|
*/
|
|
912
1016
|
previousMetaSiteId?: string | null;
|
|
913
1017
|
/**
|
|
@@ -947,7 +1051,10 @@ export declare enum ContractSwitchReason {
|
|
|
947
1051
|
}
|
|
948
1052
|
/** Triggered when a subscription's price is increased. */
|
|
949
1053
|
export interface ProductPriceIncreaseData {
|
|
950
|
-
/**
|
|
1054
|
+
/**
|
|
1055
|
+
* Price of the subscription before the update.
|
|
1056
|
+
* @format DECIMAL_VALUE
|
|
1057
|
+
*/
|
|
951
1058
|
previousPrice?: string | null;
|
|
952
1059
|
/** A value that is used in order to select the correct email template to send the user regarding the price increase. */
|
|
953
1060
|
emailTemplateSelector?: string | null;
|
|
@@ -1000,83 +1107,15 @@ export interface ProductInstanceUpdated {
|
|
|
1000
1107
|
/**
|
|
1001
1108
|
* ID of the product instance that was adjusted.
|
|
1002
1109
|
* @readonly
|
|
1110
|
+
* @format GUID
|
|
1003
1111
|
*/
|
|
1004
1112
|
productInstanceId?: string;
|
|
1005
1113
|
}
|
|
1006
|
-
export interface
|
|
1007
|
-
createdEvent?: EntityCreatedEvent;
|
|
1008
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1009
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1010
|
-
actionEvent?: ActionEvent;
|
|
1011
|
-
/**
|
|
1012
|
-
* Unique event ID.
|
|
1013
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1014
|
-
*/
|
|
1015
|
-
id?: string;
|
|
1016
|
-
/**
|
|
1017
|
-
* Assumes actions are also always typed to an entity_type
|
|
1018
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1019
|
-
*/
|
|
1020
|
-
entityFqdn?: string;
|
|
1021
|
-
/**
|
|
1022
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1023
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1024
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1025
|
-
*/
|
|
1026
|
-
slug?: string;
|
|
1027
|
-
/** ID of the entity associated with the event. */
|
|
1028
|
-
entityId?: string;
|
|
1029
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1030
|
-
eventTime?: Date | null;
|
|
1031
|
-
/**
|
|
1032
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1033
|
-
* (for example, GDPR).
|
|
1034
|
-
*/
|
|
1035
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1036
|
-
/** If present, indicates the action that triggered the event. */
|
|
1037
|
-
originatedFrom?: string | null;
|
|
1038
|
-
/**
|
|
1039
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
1040
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1041
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1042
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1043
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1044
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1045
|
-
*/
|
|
1046
|
-
entityEventSequence?: string | null;
|
|
1047
|
-
}
|
|
1048
|
-
/** @oneof */
|
|
1049
|
-
export interface DomainEventBodyOneOf {
|
|
1050
|
-
createdEvent?: EntityCreatedEvent;
|
|
1051
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1052
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1053
|
-
actionEvent?: ActionEvent;
|
|
1054
|
-
}
|
|
1055
|
-
export interface EntityCreatedEvent {
|
|
1056
|
-
entityAsJson?: string;
|
|
1057
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1058
|
-
restoreInfo?: RestoreInfo;
|
|
1059
|
-
}
|
|
1060
|
-
export interface RestoreInfo {
|
|
1061
|
-
deletedDate?: Date | null;
|
|
1062
|
-
}
|
|
1063
|
-
export interface EntityUpdatedEvent {
|
|
1114
|
+
export interface FailureReportRequest {
|
|
1064
1115
|
/**
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1116
|
+
* ID of the product instance that failed.
|
|
1117
|
+
* @format GUID
|
|
1068
1118
|
*/
|
|
1069
|
-
currentEntityAsJson?: string;
|
|
1070
|
-
}
|
|
1071
|
-
export interface EntityDeletedEvent {
|
|
1072
|
-
/** Entity that was deleted */
|
|
1073
|
-
deletedEntityAsJson?: string | null;
|
|
1074
|
-
}
|
|
1075
|
-
export interface ActionEvent {
|
|
1076
|
-
bodyAsJson?: string;
|
|
1077
|
-
}
|
|
1078
|
-
export interface FailureReportRequest {
|
|
1079
|
-
/** ID of the product instance that failed. */
|
|
1080
1119
|
instanceId?: string;
|
|
1081
1120
|
/** Failure reason. */
|
|
1082
1121
|
reason?: FailureReason;
|
|
@@ -1087,6 +1126,7 @@ export interface ProductInstanceFailed {
|
|
|
1087
1126
|
/**
|
|
1088
1127
|
* ID of the product instance that `FAILED`.
|
|
1089
1128
|
* @readonly
|
|
1129
|
+
* @format GUID
|
|
1090
1130
|
*/
|
|
1091
1131
|
productInstanceId?: string;
|
|
1092
1132
|
/** Failure reason. */
|
|
@@ -1122,9 +1162,13 @@ export interface Reschedule {
|
|
|
1122
1162
|
payload?: string | null;
|
|
1123
1163
|
}
|
|
1124
1164
|
export interface UpdateProductInstanceRequest {
|
|
1125
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* ID of the product instance to update.
|
|
1167
|
+
* @format GUID
|
|
1168
|
+
*/
|
|
1126
1169
|
instanceId?: string;
|
|
1127
1170
|
status?: Status;
|
|
1171
|
+
/** @format COUNTRY */
|
|
1128
1172
|
countryCode?: string | null;
|
|
1129
1173
|
/** Which field to update, currently only status and countryCode are supported. */
|
|
1130
1174
|
fieldToUpdate?: FieldToUpdate;
|
|
@@ -1138,9 +1182,15 @@ export interface UpdateProductInstanceResponse {
|
|
|
1138
1182
|
productInstance?: ProductInstance;
|
|
1139
1183
|
}
|
|
1140
1184
|
export interface UpdatePackageExternalIdRequest {
|
|
1141
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* ID of the package to update.
|
|
1187
|
+
* @format GUID
|
|
1188
|
+
*/
|
|
1142
1189
|
packageId: string;
|
|
1143
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* External ID that will be assigned to the package.
|
|
1192
|
+
* @maxLength 100
|
|
1193
|
+
*/
|
|
1144
1194
|
externalId: string;
|
|
1145
1195
|
}
|
|
1146
1196
|
export interface UpdatePackageExternalIdResponse {
|
|
@@ -1155,10 +1205,88 @@ export interface CountPackagesResponse {
|
|
|
1155
1205
|
/** Number of packages */
|
|
1156
1206
|
count?: number;
|
|
1157
1207
|
}
|
|
1208
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1209
|
+
createdEvent?: EntityCreatedEvent;
|
|
1210
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1211
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1212
|
+
actionEvent?: ActionEvent;
|
|
1213
|
+
/**
|
|
1214
|
+
* Unique event ID.
|
|
1215
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1216
|
+
*/
|
|
1217
|
+
id?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* Assumes actions are also always typed to an entity_type
|
|
1220
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1221
|
+
*/
|
|
1222
|
+
entityFqdn?: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1225
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1226
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1227
|
+
*/
|
|
1228
|
+
slug?: string;
|
|
1229
|
+
/** ID of the entity associated with the event. */
|
|
1230
|
+
entityId?: string;
|
|
1231
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1232
|
+
eventTime?: Date | null;
|
|
1233
|
+
/**
|
|
1234
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1235
|
+
* (for example, GDPR).
|
|
1236
|
+
*/
|
|
1237
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1238
|
+
/** If present, indicates the action that triggered the event. */
|
|
1239
|
+
originatedFrom?: string | null;
|
|
1240
|
+
/**
|
|
1241
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1242
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1243
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1244
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1245
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1246
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1247
|
+
*/
|
|
1248
|
+
entityEventSequence?: string | null;
|
|
1249
|
+
}
|
|
1250
|
+
/** @oneof */
|
|
1251
|
+
export interface DomainEventBodyOneOf {
|
|
1252
|
+
createdEvent?: EntityCreatedEvent;
|
|
1253
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1254
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1255
|
+
actionEvent?: ActionEvent;
|
|
1256
|
+
}
|
|
1257
|
+
export interface EntityCreatedEvent {
|
|
1258
|
+
entityAsJson?: string;
|
|
1259
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1260
|
+
restoreInfo?: RestoreInfo;
|
|
1261
|
+
}
|
|
1262
|
+
export interface RestoreInfo {
|
|
1263
|
+
deletedDate?: Date | null;
|
|
1264
|
+
}
|
|
1265
|
+
export interface EntityUpdatedEvent {
|
|
1266
|
+
/**
|
|
1267
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1268
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1269
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1270
|
+
*/
|
|
1271
|
+
currentEntityAsJson?: string;
|
|
1272
|
+
}
|
|
1273
|
+
export interface EntityDeletedEvent {
|
|
1274
|
+
/** Entity that was deleted */
|
|
1275
|
+
deletedEntityAsJson?: string | null;
|
|
1276
|
+
}
|
|
1277
|
+
export interface ActionEvent {
|
|
1278
|
+
bodyAsJson?: string;
|
|
1279
|
+
}
|
|
1158
1280
|
export interface MessageEnvelope {
|
|
1159
|
-
/**
|
|
1281
|
+
/**
|
|
1282
|
+
* App instance ID.
|
|
1283
|
+
* @format GUID
|
|
1284
|
+
*/
|
|
1160
1285
|
instanceId?: string | null;
|
|
1161
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* Event type.
|
|
1288
|
+
* @maxLength 150
|
|
1289
|
+
*/
|
|
1162
1290
|
eventType?: string;
|
|
1163
1291
|
/** The identification type and identity data. */
|
|
1164
1292
|
identity?: IdentificationData;
|
|
@@ -1166,26 +1294,50 @@ export interface MessageEnvelope {
|
|
|
1166
1294
|
data?: string;
|
|
1167
1295
|
}
|
|
1168
1296
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1169
|
-
/**
|
|
1297
|
+
/**
|
|
1298
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1299
|
+
* @format GUID
|
|
1300
|
+
*/
|
|
1170
1301
|
anonymousVisitorId?: string;
|
|
1171
|
-
/**
|
|
1302
|
+
/**
|
|
1303
|
+
* ID of a site visitor that has logged in to the site.
|
|
1304
|
+
* @format GUID
|
|
1305
|
+
*/
|
|
1172
1306
|
memberId?: string;
|
|
1173
|
-
/**
|
|
1307
|
+
/**
|
|
1308
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1309
|
+
* @format GUID
|
|
1310
|
+
*/
|
|
1174
1311
|
wixUserId?: string;
|
|
1175
|
-
/**
|
|
1312
|
+
/**
|
|
1313
|
+
* ID of an app.
|
|
1314
|
+
* @format GUID
|
|
1315
|
+
*/
|
|
1176
1316
|
appId?: string;
|
|
1177
1317
|
/** @readonly */
|
|
1178
1318
|
identityType?: WebhookIdentityType;
|
|
1179
1319
|
}
|
|
1180
1320
|
/** @oneof */
|
|
1181
1321
|
export interface IdentificationDataIdOneOf {
|
|
1182
|
-
/**
|
|
1322
|
+
/**
|
|
1323
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1324
|
+
* @format GUID
|
|
1325
|
+
*/
|
|
1183
1326
|
anonymousVisitorId?: string;
|
|
1184
|
-
/**
|
|
1327
|
+
/**
|
|
1328
|
+
* ID of a site visitor that has logged in to the site.
|
|
1329
|
+
* @format GUID
|
|
1330
|
+
*/
|
|
1185
1331
|
memberId?: string;
|
|
1186
|
-
/**
|
|
1332
|
+
/**
|
|
1333
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1334
|
+
* @format GUID
|
|
1335
|
+
*/
|
|
1187
1336
|
wixUserId?: string;
|
|
1188
|
-
/**
|
|
1337
|
+
/**
|
|
1338
|
+
* ID of an app.
|
|
1339
|
+
* @format GUID
|
|
1340
|
+
*/
|
|
1189
1341
|
appId?: string;
|
|
1190
1342
|
}
|
|
1191
1343
|
export declare enum WebhookIdentityType {
|
|
@@ -1195,6 +1347,42 @@ export declare enum WebhookIdentityType {
|
|
|
1195
1347
|
WIX_USER = "WIX_USER",
|
|
1196
1348
|
APP = "APP"
|
|
1197
1349
|
}
|
|
1350
|
+
export interface MigrateSubscriptionToPackagesRequest {
|
|
1351
|
+
/** Created package. */
|
|
1352
|
+
productInstance?: ProductInstance;
|
|
1353
|
+
/**
|
|
1354
|
+
* Existing subscriptionId to migrate
|
|
1355
|
+
* @format GUID
|
|
1356
|
+
*/
|
|
1357
|
+
subscriptionId?: string | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* User id of the migration - only for Immigrator
|
|
1360
|
+
* @format GUID
|
|
1361
|
+
*/
|
|
1362
|
+
userId?: string | null;
|
|
1363
|
+
}
|
|
1364
|
+
export interface MigrateSubscriptionToPackagesResponse {
|
|
1365
|
+
package?: Package;
|
|
1366
|
+
}
|
|
1367
|
+
export interface FixBrokenMigrationRequest {
|
|
1368
|
+
/**
|
|
1369
|
+
* Subscription id of the broken subscription
|
|
1370
|
+
* @format GUID
|
|
1371
|
+
*/
|
|
1372
|
+
subscriptionId?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* SBS service id that points to the broken subscription
|
|
1375
|
+
* @format GUID
|
|
1376
|
+
*/
|
|
1377
|
+
sbsServiceId?: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Owner of the broken subscription
|
|
1380
|
+
* @format GUID
|
|
1381
|
+
*/
|
|
1382
|
+
userId?: string;
|
|
1383
|
+
}
|
|
1384
|
+
export interface FixBrokenMigrationResponse {
|
|
1385
|
+
}
|
|
1198
1386
|
interface CycleIntervalNonNullableFields {
|
|
1199
1387
|
unit: IntervalIntervalUnit;
|
|
1200
1388
|
count: number;
|