@wix/auto_sdk_packages_packages 1.0.3 → 1.0.5

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.
Files changed (123) hide show
  1. package/build/cjs/index.d.ts +273 -1
  2. package/build/cjs/index.js +953 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +1867 -1
  5. package/build/cjs/index.typings.js +864 -15
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +543 -1
  8. package/build/cjs/meta.js +574 -15
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/{internal/cjs/src/premium-reseller-v1-packages-packages.public.d.ts → es/index.d.mts} +27 -16
  11. package/build/es/index.mjs +906 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/{internal/cjs/src/premium-reseller-v1-packages-packages.universal.d.ts → es/index.typings.d.mts} +192 -149
  14. package/build/es/index.typings.mjs +817 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +543 -0
  17. package/build/es/meta.mjs +541 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/internal/cjs/index.d.ts +273 -1
  20. package/build/internal/cjs/index.js +953 -15
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +1867 -1
  23. package/build/internal/cjs/index.typings.js +864 -15
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +543 -1
  26. package/build/internal/cjs/meta.js +574 -15
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/{cjs/src/premium-reseller-v1-packages-packages.public.d.ts → internal/es/index.d.mts} +27 -16
  29. package/build/internal/es/index.mjs +906 -0
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/{cjs/src/premium-reseller-v1-packages-packages.universal.d.ts → internal/es/index.typings.d.mts} +192 -149
  32. package/build/internal/es/index.typings.mjs +817 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/internal/es/meta.d.mts +543 -0
  35. package/build/internal/es/meta.mjs +541 -0
  36. package/build/internal/es/meta.mjs.map +1 -0
  37. package/package.json +11 -10
  38. package/build/cjs/src/premium-reseller-v1-packages-packages.context.d.ts +0 -14
  39. package/build/cjs/src/premium-reseller-v1-packages-packages.context.js +0 -34
  40. package/build/cjs/src/premium-reseller-v1-packages-packages.context.js.map +0 -1
  41. package/build/cjs/src/premium-reseller-v1-packages-packages.http.d.ts +0 -219
  42. package/build/cjs/src/premium-reseller-v1-packages-packages.http.js +0 -563
  43. package/build/cjs/src/premium-reseller-v1-packages-packages.http.js.map +0 -1
  44. package/build/cjs/src/premium-reseller-v1-packages-packages.meta.d.ts +0 -38
  45. package/build/cjs/src/premium-reseller-v1-packages-packages.meta.js +0 -218
  46. package/build/cjs/src/premium-reseller-v1-packages-packages.meta.js.map +0 -1
  47. package/build/cjs/src/premium-reseller-v1-packages-packages.public.js +0 -84
  48. package/build/cjs/src/premium-reseller-v1-packages-packages.public.js.map +0 -1
  49. package/build/cjs/src/premium-reseller-v1-packages-packages.types.d.ts +0 -1377
  50. package/build/cjs/src/premium-reseller-v1-packages-packages.types.js +0 -155
  51. package/build/cjs/src/premium-reseller-v1-packages-packages.types.js.map +0 -1
  52. package/build/cjs/src/premium-reseller-v1-packages-packages.universal.js +0 -756
  53. package/build/cjs/src/premium-reseller-v1-packages-packages.universal.js.map +0 -1
  54. package/build/es/index.d.ts +0 -1
  55. package/build/es/index.js +0 -2
  56. package/build/es/index.js.map +0 -1
  57. package/build/es/index.typings.d.ts +0 -1
  58. package/build/es/index.typings.js +0 -2
  59. package/build/es/index.typings.js.map +0 -1
  60. package/build/es/meta.d.ts +0 -1
  61. package/build/es/meta.js +0 -2
  62. package/build/es/meta.js.map +0 -1
  63. package/build/es/src/premium-reseller-v1-packages-packages.context.d.ts +0 -14
  64. package/build/es/src/premium-reseller-v1-packages-packages.context.js +0 -14
  65. package/build/es/src/premium-reseller-v1-packages-packages.context.js.map +0 -1
  66. package/build/es/src/premium-reseller-v1-packages-packages.http.d.ts +0 -219
  67. package/build/es/src/premium-reseller-v1-packages-packages.http.js +0 -550
  68. package/build/es/src/premium-reseller-v1-packages-packages.http.js.map +0 -1
  69. package/build/es/src/premium-reseller-v1-packages-packages.meta.d.ts +0 -38
  70. package/build/es/src/premium-reseller-v1-packages-packages.meta.js +0 -182
  71. package/build/es/src/premium-reseller-v1-packages-packages.meta.js.map +0 -1
  72. package/build/es/src/premium-reseller-v1-packages-packages.public.d.ts +0 -262
  73. package/build/es/src/premium-reseller-v1-packages-packages.public.js +0 -54
  74. package/build/es/src/premium-reseller-v1-packages-packages.public.js.map +0 -1
  75. package/build/es/src/premium-reseller-v1-packages-packages.types.d.ts +0 -1377
  76. package/build/es/src/premium-reseller-v1-packages-packages.types.js +0 -152
  77. package/build/es/src/premium-reseller-v1-packages-packages.types.js.map +0 -1
  78. package/build/es/src/premium-reseller-v1-packages-packages.universal.d.ts +0 -1824
  79. package/build/es/src/premium-reseller-v1-packages-packages.universal.js +0 -720
  80. package/build/es/src/premium-reseller-v1-packages-packages.universal.js.map +0 -1
  81. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.context.d.ts +0 -14
  82. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.context.js +0 -34
  83. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.context.js.map +0 -1
  84. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.http.d.ts +0 -219
  85. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.http.js +0 -563
  86. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.http.js.map +0 -1
  87. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.meta.d.ts +0 -38
  88. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.meta.js +0 -218
  89. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.meta.js.map +0 -1
  90. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.public.js +0 -84
  91. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.public.js.map +0 -1
  92. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.types.d.ts +0 -1377
  93. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.types.js +0 -155
  94. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.types.js.map +0 -1
  95. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.universal.js +0 -756
  96. package/build/internal/cjs/src/premium-reseller-v1-packages-packages.universal.js.map +0 -1
  97. package/build/internal/es/index.d.ts +0 -1
  98. package/build/internal/es/index.js +0 -2
  99. package/build/internal/es/index.js.map +0 -1
  100. package/build/internal/es/index.typings.d.ts +0 -1
  101. package/build/internal/es/index.typings.js +0 -2
  102. package/build/internal/es/index.typings.js.map +0 -1
  103. package/build/internal/es/meta.d.ts +0 -1
  104. package/build/internal/es/meta.js +0 -2
  105. package/build/internal/es/meta.js.map +0 -1
  106. package/build/internal/es/src/premium-reseller-v1-packages-packages.context.d.ts +0 -14
  107. package/build/internal/es/src/premium-reseller-v1-packages-packages.context.js +0 -14
  108. package/build/internal/es/src/premium-reseller-v1-packages-packages.context.js.map +0 -1
  109. package/build/internal/es/src/premium-reseller-v1-packages-packages.http.d.ts +0 -219
  110. package/build/internal/es/src/premium-reseller-v1-packages-packages.http.js +0 -550
  111. package/build/internal/es/src/premium-reseller-v1-packages-packages.http.js.map +0 -1
  112. package/build/internal/es/src/premium-reseller-v1-packages-packages.meta.d.ts +0 -38
  113. package/build/internal/es/src/premium-reseller-v1-packages-packages.meta.js +0 -182
  114. package/build/internal/es/src/premium-reseller-v1-packages-packages.meta.js.map +0 -1
  115. package/build/internal/es/src/premium-reseller-v1-packages-packages.public.d.ts +0 -262
  116. package/build/internal/es/src/premium-reseller-v1-packages-packages.public.js +0 -54
  117. package/build/internal/es/src/premium-reseller-v1-packages-packages.public.js.map +0 -1
  118. package/build/internal/es/src/premium-reseller-v1-packages-packages.types.d.ts +0 -1377
  119. package/build/internal/es/src/premium-reseller-v1-packages-packages.types.js +0 -152
  120. package/build/internal/es/src/premium-reseller-v1-packages-packages.types.js.map +0 -1
  121. package/build/internal/es/src/premium-reseller-v1-packages-packages.universal.d.ts +0 -1824
  122. package/build/internal/es/src/premium-reseller-v1-packages-packages.universal.js +0 -720
  123. package/build/internal/es/src/premium-reseller-v1-packages-packages.universal.js.map +0 -1
@@ -1,9 +1,10 @@
1
1
  import { NonNullablePaths } from '@wix/sdk-types';
2
+
2
3
  /**
3
4
  * A package is group of instances of Wix services that a reseller offers to a
4
5
  * customer as part of a single transaction.
5
6
  */
6
- export interface Package {
7
+ interface Package {
7
8
  /**
8
9
  * Package ID.
9
10
  * @readonly
@@ -50,7 +51,7 @@ export interface Package {
50
51
  * A product instance is a specific instance of a Wix service that a reseller
51
52
  * offers to one of their customers.
52
53
  */
53
- export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
54
+ interface ProductInstance extends ProductInstanceContractDetailsOneOf {
54
55
  /** Billing information for the contract between the reseller and Wix. */
55
56
  billingInfo?: ProductInstanceCycle;
56
57
  /**
@@ -79,7 +80,7 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
79
80
  * Status of the product instance.
80
81
  * @readonly
81
82
  */
82
- status?: Status;
83
+ status?: StatusWithLiterals;
83
84
  /**
84
85
  * Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`.
85
86
  * @readonly
@@ -132,18 +133,20 @@ export interface ProductInstance extends ProductInstanceContractDetailsOneOf {
132
133
  referenceProductInstanceId?: string | null;
133
134
  }
134
135
  /** @oneof */
135
- export interface ProductInstanceContractDetailsOneOf {
136
+ interface ProductInstanceContractDetailsOneOf {
136
137
  /** Billing information for the contract between the reseller and Wix. */
137
138
  billingInfo?: ProductInstanceCycle;
138
139
  }
139
- export declare enum FailureReasonFailureReason {
140
+ declare enum FailureReasonFailureReason {
140
141
  UNKNOWN = "UNKNOWN",
141
142
  /** The product instance couldn't be created because the Resellers API timed out. */
142
143
  DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT",
143
144
  /** The product instance couldn't be created because an external process failed. */
144
145
  EXTERNAL_FAILURE = "EXTERNAL_FAILURE"
145
146
  }
146
- export declare enum IntervalIntervalUnit {
147
+ /** @enumType */
148
+ type FailureReasonFailureReasonWithLiterals = FailureReasonFailureReason | 'UNKNOWN' | 'DELIVERY_TIMEOUT' | 'EXTERNAL_FAILURE';
149
+ declare enum IntervalIntervalUnit {
147
150
  /** unknown interval unit */
148
151
  UNKNOWN = "UNKNOWN",
149
152
  /** Day */
@@ -155,7 +158,9 @@ export declare enum IntervalIntervalUnit {
155
158
  /** Year */
156
159
  YEAR = "YEAR"
157
160
  }
158
- export declare enum CycleDescriptorType {
161
+ /** @enumType */
162
+ type IntervalIntervalUnitWithLiterals = IntervalIntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
163
+ declare enum CycleDescriptorType {
159
164
  /** The payment type hasn't been set. */
160
165
  UNKNOWN = "UNKNOWN",
161
166
  /** The reseller pays Wix in a single payment. */
@@ -163,16 +168,18 @@ export declare enum CycleDescriptorType {
163
168
  /** The reseller pays Wix on a recurring schedule. */
164
169
  RECURRING = "RECURRING"
165
170
  }
166
- export interface CycleInterval {
171
+ /** @enumType */
172
+ type CycleDescriptorTypeWithLiterals = CycleDescriptorType | 'UNKNOWN' | 'ONE_TIME' | 'RECURRING';
173
+ interface CycleInterval {
167
174
  /** Unit of the billing cycle. */
168
- unit?: IntervalIntervalUnit;
175
+ unit?: IntervalIntervalUnitWithLiterals;
169
176
  /**
170
177
  * Count of units that make up the billing cycle.
171
178
  * @min 1
172
179
  */
173
180
  count?: number;
174
181
  }
175
- export declare enum Status {
182
+ declare enum Status {
176
183
  /** The product instance isn't yet available to the customer. */
177
184
  PENDING = "PENDING",
178
185
  /** The customer can use the product instance. */
@@ -184,19 +191,21 @@ export declare enum Status {
184
191
  /** The product instance isn't yet available to the customer, because an external provider or the customer must take an action. */
185
192
  AWAITING_ACTION = "AWAITING_ACTION"
186
193
  }
187
- export interface FailureReason {
194
+ /** @enumType */
195
+ type StatusWithLiterals = Status | 'PENDING' | 'ENABLED' | 'CANCELED' | 'FAILED' | 'AWAITING_ACTION';
196
+ interface FailureReason {
188
197
  /** Failure code. */
189
- code?: FailureReasonFailureReason;
198
+ code?: FailureReasonFailureReasonWithLiterals;
190
199
  /** Failure message. */
191
200
  message?: string;
192
201
  }
193
- export interface ProductInstanceCycle {
202
+ interface ProductInstanceCycle {
194
203
  /** Payment type. */
195
- type?: CycleDescriptorType;
204
+ type?: CycleDescriptorTypeWithLiterals;
196
205
  /** Duration of the billing cycle. Available only for `RECURRING` payments. */
197
206
  cycleDuration?: CycleInterval;
198
207
  }
199
- export interface CreatePackageRequest {
208
+ interface CreatePackageRequest {
200
209
  /**
201
210
  * Idempotency key.
202
211
  * @maxLength 100
@@ -214,7 +223,7 @@ export interface CreatePackageRequest {
214
223
  */
215
224
  products: ProductInstance[];
216
225
  }
217
- export interface CreatePackageResponse {
226
+ interface CreatePackageResponse {
218
227
  /**
219
228
  * Idempotency key.
220
229
  * @maxLength 100
@@ -223,7 +232,7 @@ export interface CreatePackageResponse {
223
232
  /** Created package. */
224
233
  package?: Package;
225
234
  }
226
- export interface CancelPackageRequest {
235
+ interface CancelPackageRequest {
227
236
  /**
228
237
  * Idempotency key.
229
238
  * @maxLength 100
@@ -235,7 +244,7 @@ export interface CancelPackageRequest {
235
244
  */
236
245
  _id: string;
237
246
  }
238
- export interface CancelPackageResponse {
247
+ interface CancelPackageResponse {
239
248
  /**
240
249
  * Idempotency key.
241
250
  * @maxLength 100
@@ -244,40 +253,40 @@ export interface CancelPackageResponse {
244
253
  /** Canceled package. */
245
254
  package?: Package;
246
255
  }
247
- export interface PackageCanceled {
256
+ interface PackageCanceled {
248
257
  /** Canceled package. */
249
258
  package?: Package;
250
259
  }
251
- export interface GetPackageRequest {
260
+ interface GetPackageRequest {
252
261
  /**
253
262
  * Package ID.
254
263
  * @format GUID
255
264
  */
256
265
  _id: string;
257
266
  }
258
- export interface GetPackageResponse {
267
+ interface GetPackageResponse {
259
268
  /** Retrieved package. */
260
269
  package?: Package;
261
270
  }
262
- export interface QueryPackagesRequest {
271
+ interface QueryPackagesRequest {
263
272
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
264
273
  query: QueryV2;
265
274
  }
266
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
267
- /** Paging options to limit and skip the number of items. */
275
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
276
+ /** Paging options to limit and offset the number of items. */
268
277
  paging?: Paging;
269
278
  /** 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`. */
270
279
  cursorPaging?: CursorPaging;
271
280
  /**
272
281
  * Filter object.
273
282
  *
274
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
283
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
275
284
  */
276
285
  filter?: Record<string, any> | null;
277
286
  /**
278
287
  * Sort object.
279
288
  *
280
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
289
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
281
290
  */
282
291
  sort?: Sorting[];
283
292
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -286,32 +295,34 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
286
295
  fieldsets?: string[];
287
296
  }
288
297
  /** @oneof */
289
- export interface QueryV2PagingMethodOneOf {
290
- /** Paging options to limit and skip the number of items. */
298
+ interface QueryV2PagingMethodOneOf {
299
+ /** Paging options to limit and offset the number of items. */
291
300
  paging?: Paging;
292
301
  /** 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`. */
293
302
  cursorPaging?: CursorPaging;
294
303
  }
295
- export interface Sorting {
304
+ interface Sorting {
296
305
  /**
297
306
  * Name of the field to sort by.
298
307
  * @maxLength 512
299
308
  */
300
309
  fieldName?: string;
301
310
  /** Sort order. */
302
- order?: SortOrder;
311
+ order?: SortOrderWithLiterals;
303
312
  }
304
- export declare enum SortOrder {
313
+ declare enum SortOrder {
305
314
  ASC = "ASC",
306
315
  DESC = "DESC"
307
316
  }
308
- export interface Paging {
317
+ /** @enumType */
318
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
319
+ interface Paging {
309
320
  /** Number of items to load. */
310
321
  limit?: number | null;
311
322
  /** Number of items to skip in the current sort order. */
312
323
  offset?: number | null;
313
324
  }
314
- export interface CursorPaging {
325
+ interface CursorPaging {
315
326
  /**
316
327
  * Maximum number of items to return in the results.
317
328
  * @max 100
@@ -326,7 +337,7 @@ export interface CursorPaging {
326
337
  */
327
338
  cursor?: string | null;
328
339
  }
329
- export interface QueryPackagesResponse {
340
+ interface QueryPackagesResponse {
330
341
  /** Paging metadata. */
331
342
  metadata?: PagingMetadataV2;
332
343
  /**
@@ -337,7 +348,7 @@ export interface QueryPackagesResponse {
337
348
  */
338
349
  packages?: Package[];
339
350
  }
340
- export interface PagingMetadataV2 {
351
+ interface PagingMetadataV2 {
341
352
  /** Number of items returned in the response. */
342
353
  count?: number | null;
343
354
  /** Offset that was requested. */
@@ -349,7 +360,7 @@ export interface PagingMetadataV2 {
349
360
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
350
361
  cursors?: Cursors;
351
362
  }
352
- export interface Cursors {
363
+ interface Cursors {
353
364
  /**
354
365
  * Cursor string pointing to the next page in the list of results.
355
366
  * @maxLength 16000
@@ -361,7 +372,7 @@ export interface Cursors {
361
372
  */
362
373
  prev?: string | null;
363
374
  }
364
- export interface AssignProductInstanceToSiteRequest {
375
+ interface AssignProductInstanceToSiteRequest {
365
376
  /**
366
377
  * Idempotency key.
367
378
  * @maxLength 100
@@ -378,7 +389,7 @@ export interface AssignProductInstanceToSiteRequest {
378
389
  */
379
390
  siteId: string;
380
391
  }
381
- export interface AssignProductInstanceToSiteResponse {
392
+ interface AssignProductInstanceToSiteResponse {
382
393
  /**
383
394
  * Idempotency key.
384
395
  * @maxLength 100
@@ -387,7 +398,7 @@ export interface AssignProductInstanceToSiteResponse {
387
398
  /** Updated package that includes the assigned product instance. */
388
399
  package?: Package;
389
400
  }
390
- export interface AssignedProductInstanceToSite {
401
+ interface AssignedProductInstanceToSite {
391
402
  /** Updated package. */
392
403
  package?: Package;
393
404
  /**
@@ -403,7 +414,7 @@ export interface AssignedProductInstanceToSite {
403
414
  */
404
415
  siteId?: string;
405
416
  }
406
- export interface UnassignProductInstanceFromSiteRequest {
417
+ interface UnassignProductInstanceFromSiteRequest {
407
418
  /**
408
419
  * Idempotency key.
409
420
  * @maxLength 100
@@ -415,7 +426,7 @@ export interface UnassignProductInstanceFromSiteRequest {
415
426
  */
416
427
  instanceId: string;
417
428
  }
418
- export interface UnassignProductInstanceFromSiteResponse {
429
+ interface UnassignProductInstanceFromSiteResponse {
419
430
  /**
420
431
  * Idempotency key.
421
432
  * @maxLength 100
@@ -424,7 +435,7 @@ export interface UnassignProductInstanceFromSiteResponse {
424
435
  /** Updated package that includes the unassigned product instance. */
425
436
  package?: Package;
426
437
  }
427
- export interface UnassignedProductInstanceFromSite {
438
+ interface UnassignedProductInstanceFromSite {
428
439
  /** Updated package. */
429
440
  package?: Package;
430
441
  /**
@@ -440,7 +451,7 @@ export interface UnassignedProductInstanceFromSite {
440
451
  */
441
452
  metaSiteId?: string;
442
453
  }
443
- export interface CancelProductInstanceRequest {
454
+ interface CancelProductInstanceRequest {
444
455
  /**
445
456
  * Idempotency key.
446
457
  * @maxLength 100
@@ -452,7 +463,7 @@ export interface CancelProductInstanceRequest {
452
463
  */
453
464
  instanceId: string;
454
465
  }
455
- export interface CancelProductInstanceResponse {
466
+ interface CancelProductInstanceResponse {
456
467
  /**
457
468
  * Idempotency key.
458
469
  * @maxLength 100
@@ -461,7 +472,7 @@ export interface CancelProductInstanceResponse {
461
472
  /** Updated package that includes the previously included the canceled product instance. */
462
473
  package?: Package;
463
474
  }
464
- export interface ProductInstanceCanceled {
475
+ interface ProductInstanceCanceled {
465
476
  /** Updated package. */
466
477
  package?: Package;
467
478
  /**
@@ -471,7 +482,7 @@ export interface ProductInstanceCanceled {
471
482
  */
472
483
  productInstanceId?: string;
473
484
  }
474
- export interface AdjustProductInstanceSpecificationsRequest {
485
+ interface AdjustProductInstanceSpecificationsRequest {
475
486
  /**
476
487
  * Idempotency key.
477
488
  * @maxLength 100
@@ -511,7 +522,7 @@ export interface AdjustProductInstanceSpecificationsRequest {
511
522
  */
512
523
  discountCode?: string | null;
513
524
  }
514
- export interface AdjustProductInstanceSpecificationsResponse {
525
+ interface AdjustProductInstanceSpecificationsResponse {
515
526
  /**
516
527
  * Idempotency key.
517
528
  * @maxLength 100
@@ -520,7 +531,7 @@ export interface AdjustProductInstanceSpecificationsResponse {
520
531
  /** Updated package that includes the adjusted product instance. */
521
532
  package?: Package;
522
533
  }
523
- export interface AdjustedProductInstanceSpecifications {
534
+ interface AdjustedProductInstanceSpecifications {
524
535
  /** Updated package. */
525
536
  package?: Package;
526
537
  /**
@@ -530,7 +541,7 @@ export interface AdjustedProductInstanceSpecifications {
530
541
  */
531
542
  productInstanceId?: string;
532
543
  }
533
- export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
544
+ interface SubscriptionEvent extends SubscriptionEventEventOneOf {
534
545
  /** Triggered when a subscription is created. */
535
546
  created?: SubscriptionCreated;
536
547
  /**
@@ -588,7 +599,7 @@ export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
588
599
  eventDate?: Date | null;
589
600
  }
590
601
  /** @oneof */
591
- export interface SubscriptionEventEventOneOf {
602
+ interface SubscriptionEventEventOneOf {
592
603
  /** Triggered when a subscription is created. */
593
604
  created?: SubscriptionCreated;
594
605
  /**
@@ -635,7 +646,7 @@ export interface SubscriptionEventEventOneOf {
635
646
  recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
636
647
  }
637
648
  /** Triggered when a subscription is created. */
638
- export interface SubscriptionCreated {
649
+ interface SubscriptionCreated {
639
650
  /** Created subscription. */
640
651
  subscription?: Subscription;
641
652
  /** Metadata for the `created` event. */
@@ -651,7 +662,7 @@ export interface SubscriptionCreated {
651
662
  * A subscription holds information about a Premium product that a Wix account
652
663
  * owner has purchased including details about the billing.
653
664
  */
654
- export interface Subscription {
665
+ interface Subscription {
655
666
  /**
656
667
  * ID of the subscription.
657
668
  * @format GUID
@@ -701,7 +712,7 @@ export interface Subscription {
701
712
  * + `CANCELLED`: Subscription isn't active because it has been canceled.
702
713
  * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
703
714
  */
704
- status?: SubscriptionStatus;
715
+ status?: SubscriptionStatusWithLiterals;
705
716
  /**
706
717
  * Date and time the subscription was last transferred from one Wix account to
707
718
  * another in
@@ -737,8 +748,15 @@ export interface Subscription {
737
748
  * format.
738
749
  */
739
750
  countryCode?: string | null;
751
+ /**
752
+ * Seats of the product that the subscription was purchased for.
753
+ * Will be Null for products that don't support seats.
754
+ * @min 1
755
+ * @max 500
756
+ */
757
+ seats?: number | null;
740
758
  }
741
- export interface BillingReference {
759
+ interface BillingReference {
742
760
  /**
743
761
  * Name of the billing system that manages the subscription.
744
762
  *
@@ -748,13 +766,13 @@ export interface BillingReference {
748
766
  * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
749
767
  * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
750
768
  */
751
- providerName?: ProviderName;
769
+ providerName?: ProviderNameWithLiterals;
752
770
  /** Current provider reference ID. */
753
771
  providerReferenceId?: string | null;
754
772
  /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
755
773
  previousProviderReferenceIds?: string[];
756
774
  }
757
- export declare enum ProviderName {
775
+ declare enum ProviderName {
758
776
  UNKNOWN = "UNKNOWN",
759
777
  SBS = "SBS",
760
778
  LICENSER = "LICENSER",
@@ -762,26 +780,28 @@ export declare enum ProviderName {
762
780
  RESELLER = "RESELLER",
763
781
  RECURRING_INVOICES = "RECURRING_INVOICES"
764
782
  }
765
- export interface Cycle extends CycleCycleSelectorOneOf {
783
+ /** @enumType */
784
+ type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES';
785
+ interface Cycle extends CycleCycleSelectorOneOf {
766
786
  /** repetitive interval */
767
787
  interval?: Interval;
768
788
  /** one time */
769
789
  oneTime?: OneTime;
770
790
  }
771
791
  /** @oneof */
772
- export interface CycleCycleSelectorOneOf {
792
+ interface CycleCycleSelectorOneOf {
773
793
  /** repetitive interval */
774
794
  interval?: Interval;
775
795
  /** one time */
776
796
  oneTime?: OneTime;
777
797
  }
778
- export interface Interval {
798
+ interface Interval {
779
799
  /** interval unit of measure */
780
- unit?: IntervalUnit;
800
+ unit?: IntervalUnitWithLiterals;
781
801
  /** number of interval */
782
802
  count?: number;
783
803
  }
784
- export declare enum IntervalUnit {
804
+ declare enum IntervalUnit {
785
805
  /** unknown interval unit */
786
806
  UNKNOWN = "UNKNOWN",
787
807
  /** day */
@@ -793,9 +813,11 @@ export declare enum IntervalUnit {
793
813
  /** year */
794
814
  YEAR = "YEAR"
795
815
  }
796
- export interface OneTime {
816
+ /** @enumType */
817
+ type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
818
+ interface OneTime {
797
819
  }
798
- export declare enum SubscriptionStatus {
820
+ declare enum SubscriptionStatus {
799
821
  UNKNOWN = "UNKNOWN",
800
822
  AUTO_RENEW_ON = "AUTO_RENEW_ON",
801
823
  AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
@@ -803,9 +825,11 @@ export declare enum SubscriptionStatus {
803
825
  CANCELLED = "CANCELLED",
804
826
  TRANSFERRED = "TRANSFERRED"
805
827
  }
828
+ /** @enumType */
829
+ type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED';
806
830
  /** Triggered when a subscription is reactivated. */
807
- export interface ReactivationData {
808
- reactivationReason?: ReactivationReasonEnum;
831
+ interface ReactivationData {
832
+ reactivationReason?: ReactivationReasonEnumWithLiterals;
809
833
  /**
810
834
  * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
811
835
  * number of days it was inactive during the time of resolving the dispute
@@ -817,7 +841,7 @@ export interface ReactivationData {
817
841
  differenceInDays?: number | null;
818
842
  }
819
843
  /** Reason for subscription reactivation */
820
- export declare enum ReactivationReasonEnum {
844
+ declare enum ReactivationReasonEnum {
821
845
  UNKNOWN = "UNKNOWN",
822
846
  /**
823
847
  * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
@@ -827,11 +851,13 @@ export declare enum ReactivationReasonEnum {
827
851
  /** Subscription was reactivated after a chargeback dispute */
828
852
  REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
829
853
  }
854
+ /** @enumType */
855
+ type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK';
830
856
  /**
831
857
  * Triggered when a subscription is assigned to a Wix site, including the initial
832
858
  * assignment of a floating subscription or a re-assignement from a different site.
833
859
  */
834
- export interface SubscriptionAssigned {
860
+ interface SubscriptionAssigned {
835
861
  /** Assigned subscription. */
836
862
  subscription?: Subscription;
837
863
  /**
@@ -841,7 +867,7 @@ export interface SubscriptionAssigned {
841
867
  previousMetaSiteId?: string | null;
842
868
  }
843
869
  /** Triggered when a subscription is canceled. */
844
- export interface SubscriptionCancelled {
870
+ interface SubscriptionCancelled {
845
871
  /** Canceled subscription. */
846
872
  subscription?: Subscription;
847
873
  /** Details about the cancellation including who canceled the subscription and why. */
@@ -856,7 +882,7 @@ export interface SubscriptionCancelled {
856
882
  canceledInFreeTrial?: boolean;
857
883
  }
858
884
  /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
859
- export interface CancellationDetails {
885
+ interface CancellationDetails {
860
886
  /**
861
887
  * Cancellation code.
862
888
  *
@@ -895,16 +921,18 @@ export interface CancellationDetails {
895
921
  * + `"APP_MANAGED"`: The service provider has canceled the subscription.
896
922
  * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
897
923
  */
898
- initiator?: Initiator;
924
+ initiator?: InitiatorWithLiterals;
899
925
  }
900
- export declare enum Initiator {
926
+ declare enum Initiator {
901
927
  UNKNOWN = "UNKNOWN",
902
928
  USER_REQUESTED = "USER_REQUESTED",
903
929
  APP_MANAGED = "APP_MANAGED",
904
930
  PASSIVE = "PASSIVE"
905
931
  }
932
+ /** @enumType */
933
+ type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE';
906
934
  /** Triggered when the subscription's auto renew is turned on. */
907
- export interface SubscriptionAutoRenewTurnedOn {
935
+ interface SubscriptionAutoRenewTurnedOn {
908
936
  /** Subscription for which auto renew is turned on. */
909
937
  subscription?: Subscription;
910
938
  /**
@@ -917,7 +945,7 @@ export interface SubscriptionAutoRenewTurnedOn {
917
945
  initiator?: string | null;
918
946
  }
919
947
  /** Triggered when the subscription's auto renew is turned off. */
920
- export interface SubscriptionAutoRenewTurnedOff {
948
+ interface SubscriptionAutoRenewTurnedOff {
921
949
  /** Subscription for which auto renew is turned off. */
922
950
  subscription?: Subscription;
923
951
  /** Details about the cancellation including who canceled the subscription and why. */
@@ -933,7 +961,7 @@ export interface SubscriptionAutoRenewTurnedOff {
933
961
  * Triggered when a subscription is unassigned from a Wix site and becomes
934
962
  * floating.
935
963
  */
936
- export interface SubscriptionUnassigned {
964
+ interface SubscriptionUnassigned {
937
965
  /** Unassigned subscription. */
938
966
  subscription?: Subscription;
939
967
  /**
@@ -948,27 +976,29 @@ export interface SubscriptionUnassigned {
948
976
  * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
949
977
  * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
950
978
  */
951
- unassignReason?: UnassignReason;
979
+ unassignReason?: UnassignReasonWithLiterals;
952
980
  }
953
- export declare enum UnassignReason {
981
+ declare enum UnassignReason {
954
982
  UNKNOWN = "UNKNOWN",
955
983
  USER_REQUESTED = "USER_REQUESTED",
956
984
  REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
957
985
  }
986
+ /** @enumType */
987
+ type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION';
958
988
  /**
959
989
  * Triggered when a subscription is transferred from one Wix account to another.
960
990
  * A transfer includes cancelling the original subscription and creating a new
961
991
  * subscription for the target account. The event returns both the original
962
992
  * and the new subscription.
963
993
  */
964
- export interface SubscriptionTransferred {
994
+ interface SubscriptionTransferred {
965
995
  /** Original subscription that was canceled for the transfer. */
966
996
  originSubscription?: Subscription;
967
997
  /** Newly created subscription for the target account. */
968
998
  targetSubscription?: Subscription;
969
999
  }
970
1000
  /** Triggered when a recurring charge succeeds for a subscription. */
971
- export interface RecurringChargeSucceeded {
1001
+ interface RecurringChargeSucceeded {
972
1002
  /** Subscription for which the recurring charge has succeeded. */
973
1003
  subscription?: Subscription;
974
1004
  /** Indication that there was a successful charge at the end of the free trial period */
@@ -978,7 +1008,7 @@ export interface RecurringChargeSucceeded {
978
1008
  * Triggered when a subscription was updated including when its product has been
979
1009
  * up- or downgraded or the billing cycle is changed.
980
1010
  */
981
- export interface ContractSwitched {
1011
+ interface ContractSwitched {
982
1012
  /** Updated subscription. */
983
1013
  subscription?: Subscription;
984
1014
  /** Billing cycle before the update. */
@@ -1008,7 +1038,7 @@ export interface ContractSwitched {
1008
1038
  * + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
1009
1039
  * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
1010
1040
  */
1011
- contractSwitchType?: ContractSwitchType;
1041
+ contractSwitchType?: ContractSwitchTypeWithLiterals;
1012
1042
  /**
1013
1043
  * ID of the metasite the subscription has been assigned to previously.
1014
1044
  * Available only in case the subscription is assigned to a different site.
@@ -1021,7 +1051,7 @@ export interface ContractSwitched {
1021
1051
  * + `"PRICE_INCREASE"`: The subscription's price has been increased.
1022
1052
  * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
1023
1053
  */
1024
- contractSwitchReason?: ContractSwitchReason;
1054
+ contractSwitchReason?: ContractSwitchReasonWithLiterals;
1025
1055
  /** Information about the price update. Available only for updates with a price increase. */
1026
1056
  productPriceIncreaseData?: ProductPriceIncreaseData;
1027
1057
  /**
@@ -1031,10 +1061,10 @@ export interface ContractSwitched {
1031
1061
  * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
1032
1062
  * + `DOWNGRADE`: The product has been downgraded.
1033
1063
  */
1034
- productAdjustment?: ProductAdjustment;
1064
+ productAdjustment?: ProductAdjustmentWithLiterals;
1035
1065
  }
1036
1066
  /** Copied from SBS */
1037
- export declare enum ContractSwitchType {
1067
+ declare enum ContractSwitchType {
1038
1068
  NOT_APPLICABLE = "NOT_APPLICABLE",
1039
1069
  ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
1040
1070
  CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
@@ -1046,12 +1076,16 @@ export declare enum ContractSwitchType {
1046
1076
  PENDING_CHANGES = "PENDING_CHANGES",
1047
1077
  DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
1048
1078
  }
1049
- export declare enum ContractSwitchReason {
1079
+ /** @enumType */
1080
+ type ContractSwitchTypeWithLiterals = ContractSwitchType | 'NOT_APPLICABLE' | 'ADDITIONAL_QUANTITY' | 'CREDIT_UNUSED_PERIOD' | 'REFUND_PRICE_DIFF' | 'ADJUST_PERIOD_END' | 'DOWNGRADE_GRACE_PERIOD' | 'FULL_AMOUNT_PERIOD' | 'END_OF_PERIOD' | 'PENDING_CHANGES' | 'DOWNGRADE_RENEWAL';
1081
+ declare enum ContractSwitchReason {
1050
1082
  EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
1051
1083
  PRICE_INCREASE = "PRICE_INCREASE"
1052
1084
  }
1085
+ /** @enumType */
1086
+ type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE';
1053
1087
  /** Triggered when a subscription's price is increased. */
1054
- export interface ProductPriceIncreaseData {
1088
+ interface ProductPriceIncreaseData {
1055
1089
  /**
1056
1090
  * Price of the subscription before the update.
1057
1091
  * @format DECIMAL_VALUE
@@ -1062,26 +1096,30 @@ export interface ProductPriceIncreaseData {
1062
1096
  /** Used to differentiate between migration segments. Does not have to be unique per segment. */
1063
1097
  segmentName?: string | null;
1064
1098
  /** Used to determine how the price increase was triggered. */
1065
- priceIncreaseTrigger?: PriceIncreaseTrigger;
1099
+ priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals;
1066
1100
  }
1067
1101
  /** Reason for Price Increase Trigger */
1068
- export declare enum PriceIncreaseTrigger {
1102
+ declare enum PriceIncreaseTrigger {
1069
1103
  NEAR_RENEWAL = "NEAR_RENEWAL",
1070
1104
  RECURRING_SUCCESS = "RECURRING_SUCCESS",
1071
1105
  MANUAL = "MANUAL"
1072
1106
  }
1107
+ /** @enumType */
1108
+ type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL';
1073
1109
  /** Triggered when a subscription's product is adusted. */
1074
- export declare enum ProductAdjustment {
1110
+ declare enum ProductAdjustment {
1075
1111
  /** flag to show that the ContractSwitchedEvent is not applicable / needed */
1076
1112
  NOT_APPLICABLE = "NOT_APPLICABLE",
1077
1113
  /** flag to show that the ContractSwitchedEvent is a Downgrade */
1078
1114
  DOWNGRADE = "DOWNGRADE"
1079
1115
  }
1116
+ /** @enumType */
1117
+ type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE';
1080
1118
  /**
1081
1119
  * Triggered when a subscription gets close to the end of its billing cycle.
1082
1120
  * The exact number of days is defined in the billing system.
1083
1121
  */
1084
- export interface SubscriptionNearEndOfPeriod {
1122
+ interface SubscriptionNearEndOfPeriod {
1085
1123
  /** Subscription that got close to the end of its billing cycle. */
1086
1124
  subscription?: Subscription;
1087
1125
  /** Whether the subscription is within the free trial period. */
@@ -1091,18 +1129,18 @@ export interface SubscriptionNearEndOfPeriod {
1091
1129
  * Triggered when a subscription is updated and the change doesn't happen
1092
1130
  * immediately but at the end of the current billing cycle.
1093
1131
  */
1094
- export interface SubscriptionPendingChange {
1132
+ interface SubscriptionPendingChange {
1095
1133
  /** Subscription for which a pending update is triggered. */
1096
1134
  subscription?: Subscription;
1097
1135
  }
1098
1136
  /** Triggered when a recurring charge attempt failed for a subscription. */
1099
- export interface RecurringChargeAttemptFailed {
1137
+ interface RecurringChargeAttemptFailed {
1100
1138
  /** Subscription for which the recurring charge attempt has failed. */
1101
1139
  subscription?: Subscription;
1102
1140
  }
1103
- export interface Empty {
1141
+ interface Empty {
1104
1142
  }
1105
- export interface ProductInstanceUpdated {
1143
+ interface ProductInstanceUpdated {
1106
1144
  /** Updated package. */
1107
1145
  package?: Package;
1108
1146
  /**
@@ -1112,7 +1150,7 @@ export interface ProductInstanceUpdated {
1112
1150
  */
1113
1151
  productInstanceId?: string;
1114
1152
  }
1115
- export interface FailureReportRequest {
1153
+ interface FailureReportRequest {
1116
1154
  /**
1117
1155
  * ID of the product instance that failed.
1118
1156
  * @format GUID
@@ -1121,7 +1159,7 @@ export interface FailureReportRequest {
1121
1159
  /** Failure reason. */
1122
1160
  reason?: FailureReason;
1123
1161
  }
1124
- export interface ProductInstanceFailed {
1162
+ interface ProductInstanceFailed {
1125
1163
  /** Updated package. */
1126
1164
  package?: Package;
1127
1165
  /**
@@ -1133,56 +1171,58 @@ export interface ProductInstanceFailed {
1133
1171
  /** Failure reason. */
1134
1172
  reason?: FailureReason;
1135
1173
  }
1136
- export interface Task {
1174
+ interface Task {
1137
1175
  key?: TaskKey;
1138
1176
  executeAt?: Date | null;
1139
1177
  payload?: string | null;
1140
1178
  }
1141
- export interface TaskKey {
1179
+ interface TaskKey {
1142
1180
  appId?: string;
1143
1181
  instanceId?: string;
1144
1182
  subjectId?: string | null;
1145
1183
  }
1146
- export interface TaskAction extends TaskActionActionOneOf {
1184
+ interface TaskAction extends TaskActionActionOneOf {
1147
1185
  complete?: Complete;
1148
1186
  cancel?: Cancel;
1149
1187
  reschedule?: Reschedule;
1150
1188
  }
1151
1189
  /** @oneof */
1152
- export interface TaskActionActionOneOf {
1190
+ interface TaskActionActionOneOf {
1153
1191
  complete?: Complete;
1154
1192
  cancel?: Cancel;
1155
1193
  reschedule?: Reschedule;
1156
1194
  }
1157
- export interface Complete {
1195
+ interface Complete {
1158
1196
  }
1159
- export interface Cancel {
1197
+ interface Cancel {
1160
1198
  }
1161
- export interface Reschedule {
1199
+ interface Reschedule {
1162
1200
  executeAt?: Date | null;
1163
1201
  payload?: string | null;
1164
1202
  }
1165
- export interface UpdateProductInstanceRequest {
1203
+ interface UpdateProductInstanceRequest {
1166
1204
  /**
1167
1205
  * ID of the product instance to update.
1168
1206
  * @format GUID
1169
1207
  */
1170
1208
  instanceId?: string;
1171
- status?: Status;
1209
+ status?: StatusWithLiterals;
1172
1210
  /** @format COUNTRY */
1173
1211
  countryCode?: string | null;
1174
1212
  /** Which field to update, currently only status and countryCode are supported. */
1175
- fieldToUpdate?: FieldToUpdate;
1213
+ fieldToUpdate?: FieldToUpdateWithLiterals;
1176
1214
  }
1177
- export declare enum FieldToUpdate {
1215
+ declare enum FieldToUpdate {
1178
1216
  STATUS = "STATUS",
1179
1217
  COUNTRY_CODE = "COUNTRY_CODE"
1180
1218
  }
1181
- export interface UpdateProductInstanceResponse {
1219
+ /** @enumType */
1220
+ type FieldToUpdateWithLiterals = FieldToUpdate | 'STATUS' | 'COUNTRY_CODE';
1221
+ interface UpdateProductInstanceResponse {
1182
1222
  /** Updated Product Instance */
1183
1223
  productInstance?: ProductInstance;
1184
1224
  }
1185
- export interface UpdatePackageExternalIdRequest {
1225
+ interface UpdatePackageExternalIdRequest {
1186
1226
  /**
1187
1227
  * ID of the package to update.
1188
1228
  * @format GUID
@@ -1194,19 +1234,19 @@ export interface UpdatePackageExternalIdRequest {
1194
1234
  */
1195
1235
  externalId: string;
1196
1236
  }
1197
- export interface UpdatePackageExternalIdResponse {
1237
+ interface UpdatePackageExternalIdResponse {
1198
1238
  /** Updated package. */
1199
1239
  updatedPackage?: Package;
1200
1240
  }
1201
- export interface CountPackagesRequest {
1241
+ interface CountPackagesRequest {
1202
1242
  /** Filter on what packages to count */
1203
1243
  filter?: Record<string, any> | null;
1204
1244
  }
1205
- export interface CountPackagesResponse {
1245
+ interface CountPackagesResponse {
1206
1246
  /** Number of packages */
1207
1247
  count?: number;
1208
1248
  }
1209
- export interface DomainEvent extends DomainEventBodyOneOf {
1249
+ interface DomainEvent extends DomainEventBodyOneOf {
1210
1250
  createdEvent?: EntityCreatedEvent;
1211
1251
  updatedEvent?: EntityUpdatedEvent;
1212
1252
  deletedEvent?: EntityDeletedEvent;
@@ -1241,19 +1281,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1241
1281
  entityEventSequence?: string | null;
1242
1282
  }
1243
1283
  /** @oneof */
1244
- export interface DomainEventBodyOneOf {
1284
+ interface DomainEventBodyOneOf {
1245
1285
  createdEvent?: EntityCreatedEvent;
1246
1286
  updatedEvent?: EntityUpdatedEvent;
1247
1287
  deletedEvent?: EntityDeletedEvent;
1248
1288
  actionEvent?: ActionEvent;
1249
1289
  }
1250
- export interface EntityCreatedEvent {
1290
+ interface EntityCreatedEvent {
1251
1291
  entity?: string;
1252
1292
  }
1253
- export interface RestoreInfo {
1293
+ interface RestoreInfo {
1254
1294
  deletedDate?: Date | null;
1255
1295
  }
1256
- export interface EntityUpdatedEvent {
1296
+ interface EntityUpdatedEvent {
1257
1297
  /**
1258
1298
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1259
1299
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1261,14 +1301,14 @@ export interface EntityUpdatedEvent {
1261
1301
  */
1262
1302
  currentEntity?: string;
1263
1303
  }
1264
- export interface EntityDeletedEvent {
1304
+ interface EntityDeletedEvent {
1265
1305
  /** Entity that was deleted. */
1266
1306
  deletedEntity?: string | null;
1267
1307
  }
1268
- export interface ActionEvent {
1308
+ interface ActionEvent {
1269
1309
  body?: string;
1270
1310
  }
1271
- export interface MessageEnvelope {
1311
+ interface MessageEnvelope {
1272
1312
  /**
1273
1313
  * App instance ID.
1274
1314
  * @format GUID
@@ -1284,7 +1324,7 @@ export interface MessageEnvelope {
1284
1324
  /** Stringify payload. */
1285
1325
  data?: string;
1286
1326
  }
1287
- export interface IdentificationData extends IdentificationDataIdOneOf {
1327
+ interface IdentificationData extends IdentificationDataIdOneOf {
1288
1328
  /**
1289
1329
  * ID of a site visitor that has not logged in to the site.
1290
1330
  * @format GUID
@@ -1306,10 +1346,10 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1306
1346
  */
1307
1347
  appId?: string;
1308
1348
  /** @readonly */
1309
- identityType?: WebhookIdentityType;
1349
+ identityType?: WebhookIdentityTypeWithLiterals;
1310
1350
  }
1311
1351
  /** @oneof */
1312
- export interface IdentificationDataIdOneOf {
1352
+ interface IdentificationDataIdOneOf {
1313
1353
  /**
1314
1354
  * ID of a site visitor that has not logged in to the site.
1315
1355
  * @format GUID
@@ -1331,14 +1371,16 @@ export interface IdentificationDataIdOneOf {
1331
1371
  */
1332
1372
  appId?: string;
1333
1373
  }
1334
- export declare enum WebhookIdentityType {
1374
+ declare enum WebhookIdentityType {
1335
1375
  UNKNOWN = "UNKNOWN",
1336
1376
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1337
1377
  MEMBER = "MEMBER",
1338
1378
  WIX_USER = "WIX_USER",
1339
1379
  APP = "APP"
1340
1380
  }
1341
- export interface MigrateSubscriptionToPackagesRequest {
1381
+ /** @enumType */
1382
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1383
+ interface MigrateSubscriptionToPackagesRequest {
1342
1384
  /** Created package. */
1343
1385
  productInstance?: ProductInstance;
1344
1386
  /**
@@ -1352,10 +1394,10 @@ export interface MigrateSubscriptionToPackagesRequest {
1352
1394
  */
1353
1395
  userId?: string | null;
1354
1396
  }
1355
- export interface MigrateSubscriptionToPackagesResponse {
1397
+ interface MigrateSubscriptionToPackagesResponse {
1356
1398
  package?: Package;
1357
1399
  }
1358
- export interface FixBrokenMigrationRequest {
1400
+ interface FixBrokenMigrationRequest {
1359
1401
  /**
1360
1402
  * Subscription id of the broken subscription
1361
1403
  * @format GUID
@@ -1372,7 +1414,7 @@ export interface FixBrokenMigrationRequest {
1372
1414
  */
1373
1415
  userId?: string;
1374
1416
  }
1375
- export interface FixBrokenMigrationResponse {
1417
+ interface FixBrokenMigrationResponse {
1376
1418
  }
1377
1419
  type PackagesNonNullablePaths = `_id` | `accountId` | `productInstances` | `productInstances.${number}.billingInfo.type` | `productInstances.${number}.billingInfo.cycleDuration.unit` | `productInstances.${number}.billingInfo.cycleDuration.count` | `productInstances.${number}.instanceId` | `productInstances.${number}.catalogProductId` | `productInstances.${number}.status` | `productInstances.${number}.failure.code` | `productInstances.${number}.failure.message`;
1378
1420
  /**
@@ -1404,10 +1446,10 @@ type PackagesNonNullablePaths = `_id` | `accountId` | `productInstances` | `prod
1404
1446
  * @replacedBy com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2
1405
1447
  * @targetRemovalDate 2024-12-31
1406
1448
  */
1407
- export declare function createPackage(options?: NonNullablePaths<CreatePackageOptions, `products`>): Promise<NonNullablePaths<CreatePackageResponse, {
1449
+ declare function createPackage(options?: NonNullablePaths<CreatePackageOptions, `products`>): Promise<NonNullablePaths<CreatePackageResponse, {
1408
1450
  [P in PackagesNonNullablePaths]: `package.${P}`;
1409
1451
  }[PackagesNonNullablePaths]>>;
1410
- export interface CreatePackageOptions {
1452
+ interface CreatePackageOptions {
1411
1453
  /**
1412
1454
  * Idempotency key.
1413
1455
  * @maxLength 100
@@ -1461,10 +1503,10 @@ export interface CreatePackageOptions {
1461
1503
  * @permissionId premium.reseller-package.manage
1462
1504
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2
1463
1505
  */
1464
- export declare function createPackageV2(options?: NonNullablePaths<CreatePackageV2Options, `products` | `products.${number}.countryCode`>): Promise<NonNullablePaths<CreatePackageResponse, {
1506
+ declare function createPackageV2(options?: NonNullablePaths<CreatePackageV2Options, `products` | `products.${number}.countryCode`>): Promise<NonNullablePaths<CreatePackageResponse, {
1465
1507
  [P in PackagesNonNullablePaths]: `package.${P}`;
1466
1508
  }[PackagesNonNullablePaths]>>;
1467
- export interface CreatePackageV2Options {
1509
+ interface CreatePackageV2Options {
1468
1510
  /**
1469
1511
  * Idempotency key.
1470
1512
  * @maxLength 100
@@ -1505,10 +1547,10 @@ export interface CreatePackageV2Options {
1505
1547
  * @permissionId premium.reseller-package.manage
1506
1548
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelPackage
1507
1549
  */
1508
- export declare function cancelPackage(_id: string, options?: CancelPackageOptions): Promise<NonNullablePaths<CancelPackageResponse, {
1550
+ declare function cancelPackage(_id: string, options?: CancelPackageOptions): Promise<NonNullablePaths<CancelPackageResponse, {
1509
1551
  [P in PackagesNonNullablePaths]: `package.${P}`;
1510
1552
  }[PackagesNonNullablePaths]>>;
1511
- export interface CancelPackageOptions {
1553
+ interface CancelPackageOptions {
1512
1554
  /**
1513
1555
  * Idempotency key.
1514
1556
  * @maxLength 100
@@ -1533,7 +1575,7 @@ export interface CancelPackageOptions {
1533
1575
  * @returns Retrieved package.
1534
1576
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.GetPackage
1535
1577
  */
1536
- export declare function getPackage(_id: string): Promise<NonNullablePaths<Package, PackagesNonNullablePaths>>;
1578
+ declare function getPackage(_id: string): Promise<NonNullablePaths<Package, PackagesNonNullablePaths>>;
1537
1579
  /**
1538
1580
  * Retrieves a list of packages, given the provided paging, filtering, and sorting.
1539
1581
  *
@@ -1587,7 +1629,7 @@ export declare function getPackage(_id: string): Promise<NonNullablePaths<Packag
1587
1629
  * @permissionId premium.reseller-package.read
1588
1630
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.QueryPackages
1589
1631
  */
1590
- export declare function queryPackages(): PackagesQueryBuilder;
1632
+ declare function queryPackages(): PackagesQueryBuilder;
1591
1633
  interface QueryCursorResult {
1592
1634
  cursors: Cursors;
1593
1635
  hasNext: () => boolean;
@@ -1595,13 +1637,13 @@ interface QueryCursorResult {
1595
1637
  length: number;
1596
1638
  pageSize: number;
1597
1639
  }
1598
- export interface PackagesQueryResult extends QueryCursorResult {
1640
+ interface PackagesQueryResult extends QueryCursorResult {
1599
1641
  items: Package[];
1600
1642
  query: PackagesQueryBuilder;
1601
1643
  next: () => Promise<PackagesQueryResult>;
1602
1644
  prev: () => Promise<PackagesQueryResult>;
1603
1645
  }
1604
- export interface PackagesQueryBuilder {
1646
+ interface PackagesQueryBuilder {
1605
1647
  /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1606
1648
  * @documentationMaturity preview
1607
1649
  */
@@ -1631,10 +1673,10 @@ export interface PackagesQueryBuilder {
1631
1673
  * @permissionId premium.reseller-package.manage
1632
1674
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.AssignProductInstanceToSite
1633
1675
  */
1634
- export declare function assignProductInstanceToSite(identifiers: NonNullablePaths<AssignProductInstanceToSiteIdentifiers, `instanceId` | `siteId`>, options?: AssignProductInstanceToSiteOptions): Promise<NonNullablePaths<AssignProductInstanceToSiteResponse, {
1676
+ declare function assignProductInstanceToSite(identifiers: NonNullablePaths<AssignProductInstanceToSiteIdentifiers, `instanceId` | `siteId`>, options?: AssignProductInstanceToSiteOptions): Promise<NonNullablePaths<AssignProductInstanceToSiteResponse, {
1635
1677
  [P in PackagesNonNullablePaths]: `package.${P}`;
1636
1678
  }[PackagesNonNullablePaths]>>;
1637
- export interface AssignProductInstanceToSiteIdentifiers {
1679
+ interface AssignProductInstanceToSiteIdentifiers {
1638
1680
  /**
1639
1681
  * ID of the product instance to assign to a site.
1640
1682
  * @format GUID
@@ -1646,7 +1688,7 @@ export interface AssignProductInstanceToSiteIdentifiers {
1646
1688
  */
1647
1689
  siteId: string;
1648
1690
  }
1649
- export interface AssignProductInstanceToSiteOptions {
1691
+ interface AssignProductInstanceToSiteOptions {
1650
1692
  /**
1651
1693
  * Idempotency key.
1652
1694
  * @maxLength 100
@@ -1672,10 +1714,10 @@ export interface AssignProductInstanceToSiteOptions {
1672
1714
  * @permissionId premium.reseller-package.manage
1673
1715
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.UnassignProductInstanceFromSite
1674
1716
  */
1675
- export declare function unassignProductInstanceFromSite(instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<NonNullablePaths<UnassignProductInstanceFromSiteResponse, {
1717
+ declare function unassignProductInstanceFromSite(instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<NonNullablePaths<UnassignProductInstanceFromSiteResponse, {
1676
1718
  [P in PackagesNonNullablePaths]: `package.${P}`;
1677
1719
  }[PackagesNonNullablePaths]>>;
1678
- export interface UnassignProductInstanceFromSiteOptions {
1720
+ interface UnassignProductInstanceFromSiteOptions {
1679
1721
  /**
1680
1722
  * Idempotency key.
1681
1723
  * @maxLength 100
@@ -1709,10 +1751,10 @@ export interface UnassignProductInstanceFromSiteOptions {
1709
1751
  * @permissionId premium.reseller-package.manage
1710
1752
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelProductInstance
1711
1753
  */
1712
- export declare function cancelProductInstance(instanceId: string, options?: CancelProductInstanceOptions): Promise<NonNullablePaths<CancelProductInstanceResponse, {
1754
+ declare function cancelProductInstance(instanceId: string, options?: CancelProductInstanceOptions): Promise<NonNullablePaths<CancelProductInstanceResponse, {
1713
1755
  [P in PackagesNonNullablePaths]: `package.${P}`;
1714
1756
  }[PackagesNonNullablePaths]>>;
1715
- export interface CancelProductInstanceOptions {
1757
+ interface CancelProductInstanceOptions {
1716
1758
  /**
1717
1759
  * Idempotency key.
1718
1760
  * @maxLength 100
@@ -1758,10 +1800,10 @@ export interface CancelProductInstanceOptions {
1758
1800
  * @permissionId premium.reseller-package.manage
1759
1801
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.AdjustProductInstanceSpecifications
1760
1802
  */
1761
- export declare function adjustProductInstanceSpecifications(instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<NonNullablePaths<AdjustProductInstanceSpecificationsResponse, {
1803
+ declare function adjustProductInstanceSpecifications(instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<NonNullablePaths<AdjustProductInstanceSpecificationsResponse, {
1762
1804
  [P in PackagesNonNullablePaths]: `package.${P}`;
1763
1805
  }[PackagesNonNullablePaths]>>;
1764
- export interface AdjustProductInstanceSpecificationsOptions {
1806
+ interface AdjustProductInstanceSpecificationsOptions {
1765
1807
  /**
1766
1808
  * Idempotency key.
1767
1809
  * @maxLength 100
@@ -1806,10 +1848,10 @@ export interface AdjustProductInstanceSpecificationsOptions {
1806
1848
  * @permissionId PREMIUM.PACKAGE_UPDATE_EXTERNAL_ID
1807
1849
  * @fqn com.wixpress.premium.reseller.packages.v1.Packages.UpdatePackageExternalId
1808
1850
  */
1809
- export declare function updatePackageExternalId(identifiers: NonNullablePaths<UpdatePackageExternalIdIdentifiers, `externalId` | `packageId`>): Promise<NonNullablePaths<UpdatePackageExternalIdResponse, {
1851
+ declare function updatePackageExternalId(identifiers: NonNullablePaths<UpdatePackageExternalIdIdentifiers, `externalId` | `packageId`>): Promise<NonNullablePaths<UpdatePackageExternalIdResponse, {
1810
1852
  [P in PackagesNonNullablePaths]: `updatedPackage.${P}`;
1811
1853
  }[PackagesNonNullablePaths]>>;
1812
- export interface UpdatePackageExternalIdIdentifiers {
1854
+ interface UpdatePackageExternalIdIdentifiers {
1813
1855
  /**
1814
1856
  * ID of the package to update.
1815
1857
  * @format GUID
@@ -1821,4 +1863,5 @@ export interface UpdatePackageExternalIdIdentifiers {
1821
1863
  */
1822
1864
  externalId: string;
1823
1865
  }
1824
- export {};
1866
+
1867
+ export { type ActionEvent, type AdjustProductInstanceSpecificationsOptions, type AdjustProductInstanceSpecificationsRequest, type AdjustProductInstanceSpecificationsResponse, type AdjustedProductInstanceSpecifications, type AssignProductInstanceToSiteIdentifiers, type AssignProductInstanceToSiteOptions, type AssignProductInstanceToSiteRequest, type AssignProductInstanceToSiteResponse, type AssignedProductInstanceToSite, type BillingReference, type Cancel, type CancelPackageOptions, type CancelPackageRequest, type CancelPackageResponse, type CancelProductInstanceOptions, type CancelProductInstanceRequest, type CancelProductInstanceResponse, type CancellationDetails, type Complete, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type CountPackagesRequest, type CountPackagesResponse, type CreatePackageOptions, type CreatePackageRequest, type CreatePackageResponse, type CreatePackageV2Options, type CursorPaging, type Cursors, type Cycle, type CycleCycleSelectorOneOf, CycleDescriptorType, type CycleDescriptorTypeWithLiterals, type CycleInterval, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailureReason, FailureReasonFailureReason, type FailureReasonFailureReasonWithLiterals, type FailureReportRequest, FieldToUpdate, type FieldToUpdateWithLiterals, type FixBrokenMigrationRequest, type FixBrokenMigrationResponse, type GetPackageRequest, type GetPackageResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalIntervalUnit, type IntervalIntervalUnitWithLiterals, IntervalUnit, type IntervalUnitWithLiterals, type MessageEnvelope, type MigrateSubscriptionToPackagesRequest, type MigrateSubscriptionToPackagesResponse, type OneTime, type Package, type PackageCanceled, type PackagesQueryBuilder, type PackagesQueryResult, type Paging, type PagingMetadataV2, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductInstance, type ProductInstanceCanceled, type ProductInstanceContractDetailsOneOf, type ProductInstanceCycle, type ProductInstanceFailed, type ProductInstanceUpdated, type ProductPriceIncreaseData, ProviderName, type ProviderNameWithLiterals, type QueryPackagesRequest, type QueryPackagesResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, type Reschedule, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type UnassignProductInstanceFromSiteOptions, type UnassignProductInstanceFromSiteRequest, type UnassignProductInstanceFromSiteResponse, UnassignReason, type UnassignReasonWithLiterals, type UnassignedProductInstanceFromSite, type UpdatePackageExternalIdIdentifiers, type UpdatePackageExternalIdRequest, type UpdatePackageExternalIdResponse, type UpdateProductInstanceRequest, type UpdateProductInstanceResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, unassignProductInstanceFromSite, updatePackageExternalId };