@wix/auto_sdk_packages_packages 1.0.0 → 1.0.1
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 +259 -71
- 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 +323 -86
- 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 +259 -71
- 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 +323 -86
- 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 +259 -71
- 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 +323 -86
- 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 +259 -71
- 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 +323 -86
- 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,6 +1107,7 @@ 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
|
}
|
|
@@ -1074,7 +1182,10 @@ export interface ActionEvent {
|
|
|
1074
1182
|
body?: string;
|
|
1075
1183
|
}
|
|
1076
1184
|
export interface FailureReportRequest {
|
|
1077
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* ID of the product instance that failed.
|
|
1187
|
+
* @format GUID
|
|
1188
|
+
*/
|
|
1078
1189
|
instanceId?: string;
|
|
1079
1190
|
/** Failure reason. */
|
|
1080
1191
|
reason?: FailureReason;
|
|
@@ -1085,6 +1196,7 @@ export interface ProductInstanceFailed {
|
|
|
1085
1196
|
/**
|
|
1086
1197
|
* ID of the product instance that `FAILED`.
|
|
1087
1198
|
* @readonly
|
|
1199
|
+
* @format GUID
|
|
1088
1200
|
*/
|
|
1089
1201
|
productInstanceId?: string;
|
|
1090
1202
|
/** Failure reason. */
|
|
@@ -1120,9 +1232,13 @@ export interface Reschedule {
|
|
|
1120
1232
|
payload?: string | null;
|
|
1121
1233
|
}
|
|
1122
1234
|
export interface UpdateProductInstanceRequest {
|
|
1123
|
-
/**
|
|
1235
|
+
/**
|
|
1236
|
+
* ID of the product instance to update.
|
|
1237
|
+
* @format GUID
|
|
1238
|
+
*/
|
|
1124
1239
|
instanceId?: string;
|
|
1125
1240
|
status?: Status;
|
|
1241
|
+
/** @format COUNTRY */
|
|
1126
1242
|
countryCode?: string | null;
|
|
1127
1243
|
/** Which field to update, currently only status and countryCode are supported. */
|
|
1128
1244
|
fieldToUpdate?: FieldToUpdate;
|
|
@@ -1136,9 +1252,15 @@ export interface UpdateProductInstanceResponse {
|
|
|
1136
1252
|
productInstance?: ProductInstance;
|
|
1137
1253
|
}
|
|
1138
1254
|
export interface UpdatePackageExternalIdRequest {
|
|
1139
|
-
/**
|
|
1255
|
+
/**
|
|
1256
|
+
* ID of the package to update.
|
|
1257
|
+
* @format GUID
|
|
1258
|
+
*/
|
|
1140
1259
|
packageId: string;
|
|
1141
|
-
/**
|
|
1260
|
+
/**
|
|
1261
|
+
* External ID that will be assigned to the package.
|
|
1262
|
+
* @maxLength 100
|
|
1263
|
+
*/
|
|
1142
1264
|
externalId: string;
|
|
1143
1265
|
}
|
|
1144
1266
|
export interface UpdatePackageExternalIdResponse {
|
|
@@ -1154,9 +1276,15 @@ export interface CountPackagesResponse {
|
|
|
1154
1276
|
count?: number;
|
|
1155
1277
|
}
|
|
1156
1278
|
export interface MessageEnvelope {
|
|
1157
|
-
/**
|
|
1279
|
+
/**
|
|
1280
|
+
* App instance ID.
|
|
1281
|
+
* @format GUID
|
|
1282
|
+
*/
|
|
1158
1283
|
instanceId?: string | null;
|
|
1159
|
-
/**
|
|
1284
|
+
/**
|
|
1285
|
+
* Event type.
|
|
1286
|
+
* @maxLength 150
|
|
1287
|
+
*/
|
|
1160
1288
|
eventType?: string;
|
|
1161
1289
|
/** The identification type and identity data. */
|
|
1162
1290
|
identity?: IdentificationData;
|
|
@@ -1164,26 +1292,50 @@ export interface MessageEnvelope {
|
|
|
1164
1292
|
data?: string;
|
|
1165
1293
|
}
|
|
1166
1294
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1167
|
-
/**
|
|
1295
|
+
/**
|
|
1296
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1297
|
+
* @format GUID
|
|
1298
|
+
*/
|
|
1168
1299
|
anonymousVisitorId?: string;
|
|
1169
|
-
/**
|
|
1300
|
+
/**
|
|
1301
|
+
* ID of a site visitor that has logged in to the site.
|
|
1302
|
+
* @format GUID
|
|
1303
|
+
*/
|
|
1170
1304
|
memberId?: string;
|
|
1171
|
-
/**
|
|
1305
|
+
/**
|
|
1306
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1307
|
+
* @format GUID
|
|
1308
|
+
*/
|
|
1172
1309
|
wixUserId?: string;
|
|
1173
|
-
/**
|
|
1310
|
+
/**
|
|
1311
|
+
* ID of an app.
|
|
1312
|
+
* @format GUID
|
|
1313
|
+
*/
|
|
1174
1314
|
appId?: string;
|
|
1175
1315
|
/** @readonly */
|
|
1176
1316
|
identityType?: WebhookIdentityType;
|
|
1177
1317
|
}
|
|
1178
1318
|
/** @oneof */
|
|
1179
1319
|
export interface IdentificationDataIdOneOf {
|
|
1180
|
-
/**
|
|
1320
|
+
/**
|
|
1321
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1322
|
+
* @format GUID
|
|
1323
|
+
*/
|
|
1181
1324
|
anonymousVisitorId?: string;
|
|
1182
|
-
/**
|
|
1325
|
+
/**
|
|
1326
|
+
* ID of a site visitor that has logged in to the site.
|
|
1327
|
+
* @format GUID
|
|
1328
|
+
*/
|
|
1183
1329
|
memberId?: string;
|
|
1184
|
-
/**
|
|
1330
|
+
/**
|
|
1331
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1332
|
+
* @format GUID
|
|
1333
|
+
*/
|
|
1185
1334
|
wixUserId?: string;
|
|
1186
|
-
/**
|
|
1335
|
+
/**
|
|
1336
|
+
* ID of an app.
|
|
1337
|
+
* @format GUID
|
|
1338
|
+
*/
|
|
1187
1339
|
appId?: string;
|
|
1188
1340
|
}
|
|
1189
1341
|
export declare enum WebhookIdentityType {
|
|
@@ -1193,6 +1345,42 @@ export declare enum WebhookIdentityType {
|
|
|
1193
1345
|
WIX_USER = "WIX_USER",
|
|
1194
1346
|
APP = "APP"
|
|
1195
1347
|
}
|
|
1348
|
+
export interface MigrateSubscriptionToPackagesRequest {
|
|
1349
|
+
/** Created package. */
|
|
1350
|
+
productInstance?: ProductInstance;
|
|
1351
|
+
/**
|
|
1352
|
+
* Existing subscriptionId to migrate
|
|
1353
|
+
* @format GUID
|
|
1354
|
+
*/
|
|
1355
|
+
subscriptionId?: string | null;
|
|
1356
|
+
/**
|
|
1357
|
+
* User id of the migration - only for Immigrator
|
|
1358
|
+
* @format GUID
|
|
1359
|
+
*/
|
|
1360
|
+
userId?: string | null;
|
|
1361
|
+
}
|
|
1362
|
+
export interface MigrateSubscriptionToPackagesResponse {
|
|
1363
|
+
package?: Package;
|
|
1364
|
+
}
|
|
1365
|
+
export interface FixBrokenMigrationRequest {
|
|
1366
|
+
/**
|
|
1367
|
+
* Subscription id of the broken subscription
|
|
1368
|
+
* @format GUID
|
|
1369
|
+
*/
|
|
1370
|
+
subscriptionId?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* SBS service id that points to the broken subscription
|
|
1373
|
+
* @format GUID
|
|
1374
|
+
*/
|
|
1375
|
+
sbsServiceId?: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* Owner of the broken subscription
|
|
1378
|
+
* @format GUID
|
|
1379
|
+
*/
|
|
1380
|
+
userId?: string;
|
|
1381
|
+
}
|
|
1382
|
+
export interface FixBrokenMigrationResponse {
|
|
1383
|
+
}
|
|
1196
1384
|
interface CycleIntervalNonNullableFields {
|
|
1197
1385
|
unit: IntervalIntervalUnit;
|
|
1198
1386
|
count: number;
|
|
@@ -1275,11 +1463,21 @@ export interface UpdatePackageExternalIdResponseNonNullableFields {
|
|
|
1275
1463
|
*/
|
|
1276
1464
|
export declare function createPackage(options?: CreatePackageOptions): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
|
|
1277
1465
|
export interface CreatePackageOptions {
|
|
1278
|
-
/**
|
|
1466
|
+
/**
|
|
1467
|
+
* Idempotency key.
|
|
1468
|
+
* @maxLength 100
|
|
1469
|
+
*/
|
|
1279
1470
|
idempotencyKey?: string | null;
|
|
1280
|
-
/**
|
|
1471
|
+
/**
|
|
1472
|
+
* External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix.
|
|
1473
|
+
* @maxLength 100
|
|
1474
|
+
*/
|
|
1281
1475
|
externalId?: string | null;
|
|
1282
|
-
/**
|
|
1476
|
+
/**
|
|
1477
|
+
* Wix services that are resold.
|
|
1478
|
+
* @maxSize 1000
|
|
1479
|
+
* @minSize 1
|
|
1480
|
+
*/
|
|
1283
1481
|
products: ProductInstance[];
|
|
1284
1482
|
}
|
|
1285
1483
|
/**
|
|
@@ -1320,11 +1518,21 @@ export interface CreatePackageOptions {
|
|
|
1320
1518
|
*/
|
|
1321
1519
|
export declare function createPackageV2(options?: CreatePackageV2Options): Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
|
|
1322
1520
|
export interface CreatePackageV2Options {
|
|
1323
|
-
/**
|
|
1521
|
+
/**
|
|
1522
|
+
* Idempotency key.
|
|
1523
|
+
* @maxLength 100
|
|
1524
|
+
*/
|
|
1324
1525
|
idempotencyKey?: string | null;
|
|
1325
|
-
/**
|
|
1526
|
+
/**
|
|
1527
|
+
* External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix.
|
|
1528
|
+
* @maxLength 100
|
|
1529
|
+
*/
|
|
1326
1530
|
externalId?: string | null;
|
|
1327
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* Wix services that are resold.
|
|
1533
|
+
* @maxSize 1000
|
|
1534
|
+
* @minSize 1
|
|
1535
|
+
*/
|
|
1328
1536
|
products: ProductInstance[];
|
|
1329
1537
|
}
|
|
1330
1538
|
/**
|
|
@@ -1352,7 +1560,10 @@ export interface CreatePackageV2Options {
|
|
|
1352
1560
|
*/
|
|
1353
1561
|
export declare function cancelPackage(_id: string, options?: CancelPackageOptions): Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
|
|
1354
1562
|
export interface CancelPackageOptions {
|
|
1355
|
-
/**
|
|
1563
|
+
/**
|
|
1564
|
+
* Idempotency key.
|
|
1565
|
+
* @maxLength 100
|
|
1566
|
+
*/
|
|
1356
1567
|
idempotencyKey?: string | null;
|
|
1357
1568
|
}
|
|
1358
1569
|
/**
|
|
@@ -1473,13 +1684,22 @@ export interface PackagesQueryBuilder {
|
|
|
1473
1684
|
*/
|
|
1474
1685
|
export declare function assignProductInstanceToSite(identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions): Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
|
|
1475
1686
|
export interface AssignProductInstanceToSiteIdentifiers {
|
|
1476
|
-
/**
|
|
1687
|
+
/**
|
|
1688
|
+
* ID of the product instance to assign to a site.
|
|
1689
|
+
* @format GUID
|
|
1690
|
+
*/
|
|
1477
1691
|
instanceId: string;
|
|
1478
|
-
/**
|
|
1692
|
+
/**
|
|
1693
|
+
* ID of the site to which the product instance is assigned.
|
|
1694
|
+
* @format GUID
|
|
1695
|
+
*/
|
|
1479
1696
|
siteId: string;
|
|
1480
1697
|
}
|
|
1481
1698
|
export interface AssignProductInstanceToSiteOptions {
|
|
1482
|
-
/**
|
|
1699
|
+
/**
|
|
1700
|
+
* Idempotency key.
|
|
1701
|
+
* @maxLength 100
|
|
1702
|
+
*/
|
|
1483
1703
|
idempotencyKey?: string | null;
|
|
1484
1704
|
}
|
|
1485
1705
|
/**
|
|
@@ -1503,7 +1723,10 @@ export interface AssignProductInstanceToSiteOptions {
|
|
|
1503
1723
|
*/
|
|
1504
1724
|
export declare function unassignProductInstanceFromSite(instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
|
|
1505
1725
|
export interface UnassignProductInstanceFromSiteOptions {
|
|
1506
|
-
/**
|
|
1726
|
+
/**
|
|
1727
|
+
* Idempotency key.
|
|
1728
|
+
* @maxLength 100
|
|
1729
|
+
*/
|
|
1507
1730
|
idempotencyKey?: string | null;
|
|
1508
1731
|
}
|
|
1509
1732
|
/**
|
|
@@ -1535,7 +1758,10 @@ export interface UnassignProductInstanceFromSiteOptions {
|
|
|
1535
1758
|
*/
|
|
1536
1759
|
export declare function cancelProductInstance(instanceId: string, options?: CancelProductInstanceOptions): Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
|
|
1537
1760
|
export interface CancelProductInstanceOptions {
|
|
1538
|
-
/**
|
|
1761
|
+
/**
|
|
1762
|
+
* Idempotency key.
|
|
1763
|
+
* @maxLength 100
|
|
1764
|
+
*/
|
|
1539
1765
|
idempotencyKey?: string | null;
|
|
1540
1766
|
}
|
|
1541
1767
|
/**
|
|
@@ -1579,11 +1805,15 @@ export interface CancelProductInstanceOptions {
|
|
|
1579
1805
|
*/
|
|
1580
1806
|
export declare function adjustProductInstanceSpecifications(instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
|
|
1581
1807
|
export interface AdjustProductInstanceSpecificationsOptions {
|
|
1582
|
-
/**
|
|
1808
|
+
/**
|
|
1809
|
+
* Idempotency key.
|
|
1810
|
+
* @maxLength 100
|
|
1811
|
+
*/
|
|
1583
1812
|
idempotencyKey?: string | null;
|
|
1584
1813
|
/**
|
|
1585
1814
|
* ID of the product to replace the original instance. Required in case you don't
|
|
1586
1815
|
* provide a new `billingInfo` object.
|
|
1816
|
+
* @format GUID
|
|
1587
1817
|
*/
|
|
1588
1818
|
catalogProductId?: string | null;
|
|
1589
1819
|
/**
|
|
@@ -1605,6 +1835,7 @@ export interface AdjustProductInstanceSpecificationsOptions {
|
|
|
1605
1835
|
* more information about supported codes.
|
|
1606
1836
|
*
|
|
1607
1837
|
* Max: 25 characters
|
|
1838
|
+
* @maxLength 25
|
|
1608
1839
|
*/
|
|
1609
1840
|
discountCode?: string | null;
|
|
1610
1841
|
}
|
|
@@ -1620,9 +1851,15 @@ export interface AdjustProductInstanceSpecificationsOptions {
|
|
|
1620
1851
|
*/
|
|
1621
1852
|
export declare function updatePackageExternalId(identifiers: UpdatePackageExternalIdIdentifiers): Promise<UpdatePackageExternalIdResponse & UpdatePackageExternalIdResponseNonNullableFields>;
|
|
1622
1853
|
export interface UpdatePackageExternalIdIdentifiers {
|
|
1623
|
-
/**
|
|
1854
|
+
/**
|
|
1855
|
+
* ID of the package to update.
|
|
1856
|
+
* @format GUID
|
|
1857
|
+
*/
|
|
1624
1858
|
packageId: string;
|
|
1625
|
-
/**
|
|
1859
|
+
/**
|
|
1860
|
+
* External ID that will be assigned to the package.
|
|
1861
|
+
* @maxLength 100
|
|
1862
|
+
*/
|
|
1626
1863
|
externalId: string;
|
|
1627
1864
|
}
|
|
1628
1865
|
export {};
|