@wix/auto_sdk_stores_subscription-options 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.d.ts +6 -6
  2. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.js +5 -5
  3. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -1
  4. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.d.ts +21 -21
  5. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.js +129 -129
  6. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -1
  7. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.d.ts +12 -12
  8. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.js +77 -77
  9. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -1
  10. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.d.ts +40 -40
  11. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.js +25 -25
  12. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -1
  13. package/build/cjs/src/stores-v1-subscription-option-subscription-options.types.d.ts +188 -100
  14. package/build/cjs/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -1
  15. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.d.ts +299 -198
  16. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.js +186 -186
  17. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -1
  18. package/build/es/src/stores-v1-subscription-option-subscription-options.context.d.ts +6 -6
  19. package/build/es/src/stores-v1-subscription-option-subscription-options.context.js +5 -5
  20. package/build/es/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -1
  21. package/build/es/src/stores-v1-subscription-option-subscription-options.http.d.ts +21 -21
  22. package/build/es/src/stores-v1-subscription-option-subscription-options.http.js +124 -124
  23. package/build/es/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -1
  24. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.d.ts +12 -12
  25. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.js +67 -67
  26. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -1
  27. package/build/es/src/stores-v1-subscription-option-subscription-options.public.d.ts +40 -40
  28. package/build/es/src/stores-v1-subscription-option-subscription-options.public.js +20 -20
  29. package/build/es/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -1
  30. package/build/es/src/stores-v1-subscription-option-subscription-options.types.d.ts +188 -100
  31. package/build/es/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -1
  32. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.d.ts +299 -198
  33. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.js +181 -181
  34. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -1
  35. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.d.ts +6 -6
  36. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.js +5 -5
  37. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -1
  38. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.d.ts +21 -21
  39. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.js +129 -129
  40. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -1
  41. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.d.ts +12 -12
  42. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.js +77 -77
  43. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -1
  44. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.d.ts +40 -40
  45. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.js +25 -25
  46. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -1
  47. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.types.d.ts +188 -100
  48. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -1
  49. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.d.ts +299 -198
  50. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.js +186 -186
  51. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -1
  52. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.d.ts +6 -6
  53. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.js +5 -5
  54. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -1
  55. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.d.ts +21 -21
  56. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.js +124 -124
  57. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -1
  58. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.d.ts +12 -12
  59. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.js +67 -67
  60. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -1
  61. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.d.ts +40 -40
  62. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.js +20 -20
  63. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -1
  64. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.d.ts +188 -100
  65. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -1
  66. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.d.ts +299 -198
  67. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.js +181 -181
  68. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -1
  69. package/package.json +2 -2
@@ -1,9 +1,19 @@
1
1
  export interface SubscriptionOption {
2
- /** Subscription option ID (auto-generated upon subscription option creation). */
2
+ /**
3
+ * Subscription option ID (auto-generated upon subscription option creation).
4
+ * @format GUID
5
+ */
3
6
  _id?: string | null;
4
- /** Subscription option title. */
7
+ /**
8
+ * Subscription option title.
9
+ * @minLength 1
10
+ * @maxLength 20
11
+ */
5
12
  title?: string | null;
6
- /** Subscription option description (optional). */
13
+ /**
14
+ * Subscription option description (optional).
15
+ * @maxLength 60
16
+ */
7
17
  description?: string | null;
8
18
  /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
9
19
  subscriptionSettings?: SubscriptionSettings;
@@ -18,7 +28,11 @@ export interface SubscriptionSettings {
18
28
  frequency?: SubscriptionFrequency;
19
29
  /** Whether subscription is renewed automatically at the end of each period. */
20
30
  autoRenewal?: boolean;
21
- /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
31
+ /**
32
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
33
+ * @min 2
34
+ * @max 999
35
+ */
22
36
  billingCycles?: number | null;
23
37
  }
24
38
  /** Frequency unit of recurring payment */
@@ -41,68 +55,49 @@ export declare enum DiscountType {
41
55
  AMOUNT = "AMOUNT",
42
56
  PERCENT = "PERCENT"
43
57
  }
44
- export interface CreateSubscriptionOptionRequest {
45
- /** Subscription option info. */
46
- subscriptionOption: SubscriptionOption;
47
- }
48
- export interface CreateSubscriptionOptionResponse {
49
- /** Newly created subscription option. */
50
- subscriptionOption?: SubscriptionOption;
51
- }
52
- export interface UpdateSubscriptionOptionRequest {
53
- /** Subscription option info. Only the passed parameters will be updated. */
54
- subscriptionOption: SubscriptionOption;
55
- }
56
- export interface UpdateSubscriptionOptionResponse {
57
- /** Updated subscription option. */
58
- subscriptionOption?: SubscriptionOption;
59
- }
60
- export interface DeleteSubscriptionOptionRequest {
61
- /** ID of the subscription option to delete. */
58
+ export interface GetSubscriptionOptionRequest {
59
+ /**
60
+ * Subscription option ID.
61
+ * @minLength 1
62
+ * @format GUID
63
+ */
62
64
  _id: string;
63
65
  }
64
- export interface DeleteSubscriptionOptionResponse {
65
- }
66
- export interface BulkCreateSubscriptionOptionsRequest {
67
- /** Subscription options info. */
68
- subscriptionOptions: SubscriptionOption[];
69
- }
70
- export interface BulkCreateSubscriptionOptionsResponse {
71
- /** Newly created subscription options. */
72
- subscriptionOptions?: SubscriptionOption[];
73
- }
74
- export interface BulkUpdateSubscriptionOptionsRequest {
75
- /** Subscription options info. Only the passed parameters in each subscription option will be updated. */
76
- subscriptionOptions: SubscriptionOption[];
77
- }
78
- export interface BulkUpdateSubscriptionOptionsResponse {
79
- /** Updated subscription options. */
80
- subscriptionOptions?: SubscriptionOption[];
81
- }
82
- export interface BulkDeleteSubscriptionOptionsRequest {
83
- /** IDs of the subscription options to delete. */
84
- ids: string[];
85
- }
86
- export interface BulkDeleteSubscriptionOptionsResponse {
66
+ export interface GetSubscriptionOptionResponse {
67
+ /** Subscription option. */
68
+ subscriptionOption?: SubscriptionOption;
87
69
  }
88
- export interface AssignSubscriptionOptionsToProductRequest {
89
- /** Product ID. */
70
+ export interface GetSubscriptionOptionsForProductRequest {
71
+ /**
72
+ * Product ID.
73
+ * @minLength 1
74
+ */
90
75
  productId: string;
91
- /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
92
- assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
76
+ /** Whether to include hidden subscription options in the results. */
77
+ includeHiddenSubscriptionOptions?: boolean;
78
+ }
79
+ export interface GetSubscriptionOptionsForProductResponse {
80
+ /** Subscription options. */
81
+ subscriptionOptions?: SubscriptionOptionInProduct[];
93
82
  }
94
83
  export interface SubscriptionOptionInProduct {
95
- /** Subscription option ID. */
84
+ /**
85
+ * Subscription option ID.
86
+ * @format GUID
87
+ */
96
88
  _id?: string;
97
89
  /** Whether the subscription option is hidden for the product (the default is false). */
98
90
  hidden?: boolean;
99
91
  /**
100
92
  * Subscription option title.
93
+ * @minLength 1
94
+ * @maxLength 20
101
95
  * @readonly
102
96
  */
103
97
  title?: string | null;
104
98
  /**
105
99
  * Subscription option description (optional).
100
+ * @maxLength 60
106
101
  * @readonly
107
102
  */
108
103
  description?: string | null;
@@ -117,36 +112,12 @@ export interface SubscriptionOptionInProduct {
117
112
  */
118
113
  discount?: Discount;
119
114
  }
120
- export interface AssignSubscriptionOptionsToProductResponse {
121
- }
122
- export interface AllowOneTimePurchasesRequest {
123
- /** Product ID. */
124
- productId: string;
125
- /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
126
- allowed: boolean | null;
127
- }
128
- export interface AllowOneTimePurchasesResponse {
129
- }
130
- export interface GetSubscriptionOptionRequest {
131
- /** Subscription option ID. */
132
- _id: string;
133
- }
134
- export interface GetSubscriptionOptionResponse {
135
- /** Subscription option. */
136
- subscriptionOption?: SubscriptionOption;
137
- }
138
- export interface GetSubscriptionOptionsForProductRequest {
139
- /** Product ID. */
140
- productId: string;
141
- /** Whether to include hidden subscription options in the results. */
142
- includeHiddenSubscriptionOptions?: boolean;
143
- }
144
- export interface GetSubscriptionOptionsForProductResponse {
145
- /** Subscription options. */
146
- subscriptionOptions?: SubscriptionOptionInProduct[];
147
- }
148
115
  export interface ListSubscriptionOptionsRequest {
149
- /** Subscription option IDs. */
116
+ /**
117
+ * Subscription option IDs.
118
+ * @format GUID
119
+ * @maxSize 100
120
+ */
150
121
  ids?: string[];
151
122
  }
152
123
  export interface ListSubscriptionOptionsResponse {
@@ -156,7 +127,11 @@ export interface ListSubscriptionOptionsResponse {
156
127
  export interface CalculatePricesRequest {
157
128
  /** original price to which subscription options discount will be applied */
158
129
  price?: number;
159
- /** ids of subscription options which will be applied to original price */
130
+ /**
131
+ * ids of subscription options which will be applied to original price
132
+ * @format GUID
133
+ * @maxSize 100
134
+ */
160
135
  ids?: string[];
161
136
  }
162
137
  export interface CalculatePricesResponse {
@@ -185,9 +160,14 @@ export interface BulkCalculatePricesRequest {
185
160
  /**
186
161
  * Original prices to which subscription options discount will be applied.
187
162
  * Key is identifier unique per price that can be used to match calculated prices with original price
163
+ * @maxSize 1001
188
164
  */
189
165
  prices?: Record<string, number>;
190
- /** ids of subscription options which will be applied to original price */
166
+ /**
167
+ * ids of subscription options which will be applied to original price
168
+ * @format GUID
169
+ * @maxSize 100
170
+ */
191
171
  ids?: string[];
192
172
  }
193
173
  export interface BulkCalculatePricesResponse {
@@ -198,18 +178,30 @@ export interface BulkCalculatePricesResponse {
198
178
  calculatedPrices?: Record<string, CalculatePricesResponse>;
199
179
  }
200
180
  export interface BulkCalculatePricesRequestV2 {
201
- /** Original prices to be calculated for each corresponding product id with related subscription plan ids */
181
+ /**
182
+ * Original prices to be calculated for each corresponding product id with related subscription plan ids
183
+ * @maxSize 100
184
+ */
202
185
  items?: BulkCalculatePricesRequestItem[];
203
186
  }
204
187
  export interface BulkCalculatePricesRequestItem {
205
- /** Calculation id (product id) */
188
+ /**
189
+ * Calculation id (product id)
190
+ * @minLength 1
191
+ * @maxLength 36
192
+ */
206
193
  _id?: string;
207
194
  /**
208
195
  * Original prices to which subscription options discount will be applied.
209
196
  * Key is identifier unique per price that can be used to match calculated prices with original price
197
+ * @maxSize 1001
210
198
  */
211
199
  prices?: Record<string, number>;
212
- /** ids of subscription options which will be applied to original price. */
200
+ /**
201
+ * ids of subscription options which will be applied to original price.
202
+ * @format GUID
203
+ * @maxSize 100
204
+ */
213
205
  subscriptionOptionIds?: string[];
214
206
  }
215
207
  export interface BulkCalculatePricesResponseV2 {
@@ -220,7 +212,10 @@ export interface BulkCalculatePricesResponseV2 {
220
212
  calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];
221
213
  }
222
214
  export interface BulkCalculatePricesResponseItem {
223
- /** Calculation id (product id) */
215
+ /**
216
+ * Calculation id (product id)
217
+ * @minLength 1
218
+ */
224
219
  _id?: string;
225
220
  /**
226
221
  * Key is identifier unique per price that can be used to match calculated prices with original price
@@ -229,7 +224,11 @@ export interface BulkCalculatePricesResponseItem {
229
224
  calculatedPrices?: Record<string, CalculatePricesResponse>;
230
225
  }
231
226
  export interface GetProductIdsForSubscriptionOptionRequest {
232
- /** Subscription option ID. */
227
+ /**
228
+ * Subscription option ID.
229
+ * @minLength 1
230
+ * @format GUID
231
+ */
233
232
  _id: string;
234
233
  /** Whether to include hidden products in the returned results. */
235
234
  includeHiddenProducts?: boolean;
@@ -237,7 +236,10 @@ export interface GetProductIdsForSubscriptionOptionRequest {
237
236
  paging?: Paging;
238
237
  }
239
238
  export interface Paging {
240
- /** Amount of items to load per page. */
239
+ /**
240
+ * Amount of items to load per page.
241
+ * @max 100
242
+ */
241
243
  limit?: number | null;
242
244
  /** Number of items to skip in the display (relevant for all pages after the first). */
243
245
  offset?: number | null;
@@ -257,13 +259,99 @@ export interface PagingMetadata {
257
259
  offset?: number;
258
260
  }
259
261
  export interface GetOneTimePurchasesStatusRequest {
260
- /** Product ID. */
262
+ /**
263
+ * Product ID.
264
+ * @minLength 1
265
+ */
261
266
  productId: string;
262
267
  }
263
268
  export interface GetOneTimePurchasesStatusResponse {
264
269
  /** Whether the specified product is available for one-time purchase */
265
270
  allowed?: boolean;
266
271
  }
272
+ export interface CreateSubscriptionOptionRequest {
273
+ /** Subscription option info. */
274
+ subscriptionOption: SubscriptionOption;
275
+ }
276
+ export interface CreateSubscriptionOptionResponse {
277
+ /** Newly created subscription option. */
278
+ subscriptionOption?: SubscriptionOption;
279
+ }
280
+ export interface UpdateSubscriptionOptionRequest {
281
+ /** Subscription option info. Only the passed parameters will be updated. */
282
+ subscriptionOption: SubscriptionOption;
283
+ }
284
+ export interface UpdateSubscriptionOptionResponse {
285
+ /** Updated subscription option. */
286
+ subscriptionOption?: SubscriptionOption;
287
+ }
288
+ export interface DeleteSubscriptionOptionRequest {
289
+ /**
290
+ * ID of the subscription option to delete.
291
+ * @minLength 1
292
+ * @format GUID
293
+ */
294
+ _id: string;
295
+ }
296
+ export interface DeleteSubscriptionOptionResponse {
297
+ }
298
+ export interface BulkCreateSubscriptionOptionsRequest {
299
+ /**
300
+ * Subscription options info.
301
+ * @maxSize 100
302
+ */
303
+ subscriptionOptions: SubscriptionOption[];
304
+ }
305
+ export interface BulkCreateSubscriptionOptionsResponse {
306
+ /** Newly created subscription options. */
307
+ subscriptionOptions?: SubscriptionOption[];
308
+ }
309
+ export interface BulkUpdateSubscriptionOptionsRequest {
310
+ /**
311
+ * Subscription options info. Only the passed parameters in each subscription option will be updated.
312
+ * @maxSize 100
313
+ */
314
+ subscriptionOptions: SubscriptionOption[];
315
+ }
316
+ export interface BulkUpdateSubscriptionOptionsResponse {
317
+ /** Updated subscription options. */
318
+ subscriptionOptions?: SubscriptionOption[];
319
+ }
320
+ export interface BulkDeleteSubscriptionOptionsRequest {
321
+ /**
322
+ * IDs of the subscription options to delete.
323
+ * @maxSize 100
324
+ * @format GUID
325
+ */
326
+ ids: string[];
327
+ }
328
+ export interface BulkDeleteSubscriptionOptionsResponse {
329
+ }
330
+ export interface AssignSubscriptionOptionsToProductRequest {
331
+ /**
332
+ * Product ID.
333
+ * @minLength 1
334
+ */
335
+ productId: string;
336
+ /**
337
+ * Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product.
338
+ * @maxSize 6
339
+ */
340
+ assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
341
+ }
342
+ export interface AssignSubscriptionOptionsToProductResponse {
343
+ }
344
+ export interface AllowOneTimePurchasesRequest {
345
+ /**
346
+ * Product ID.
347
+ * @minLength 1
348
+ */
349
+ productId: string;
350
+ /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
351
+ allowed: boolean | null;
352
+ }
353
+ export interface AllowOneTimePurchasesResponse {
354
+ }
267
355
  interface SubscriptionSettingsNonNullableFields {
268
356
  frequency: SubscriptionFrequency;
269
357
  autoRenewal: boolean;
@@ -276,18 +364,6 @@ export interface SubscriptionOptionNonNullableFields {
276
364
  subscriptionSettings?: SubscriptionSettingsNonNullableFields;
277
365
  discount?: DiscountNonNullableFields;
278
366
  }
279
- export interface CreateSubscriptionOptionResponseNonNullableFields {
280
- subscriptionOption?: SubscriptionOptionNonNullableFields;
281
- }
282
- export interface UpdateSubscriptionOptionResponseNonNullableFields {
283
- subscriptionOption?: SubscriptionOptionNonNullableFields;
284
- }
285
- export interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
286
- subscriptionOptions: SubscriptionOptionNonNullableFields[];
287
- }
288
- export interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
289
- subscriptionOptions: SubscriptionOptionNonNullableFields[];
290
- }
291
367
  export interface GetSubscriptionOptionResponseNonNullableFields {
292
368
  subscriptionOption?: SubscriptionOptionNonNullableFields;
293
369
  }
@@ -312,6 +388,112 @@ export interface GetProductIdsForSubscriptionOptionResponseNonNullableFields {
312
388
  export interface GetOneTimePurchasesStatusResponseNonNullableFields {
313
389
  allowed: boolean;
314
390
  }
391
+ export interface CreateSubscriptionOptionResponseNonNullableFields {
392
+ subscriptionOption?: SubscriptionOptionNonNullableFields;
393
+ }
394
+ export interface UpdateSubscriptionOptionResponseNonNullableFields {
395
+ subscriptionOption?: SubscriptionOptionNonNullableFields;
396
+ }
397
+ export interface BulkCreateSubscriptionOptionsResponseNonNullableFields {
398
+ subscriptionOptions: SubscriptionOptionNonNullableFields[];
399
+ }
400
+ export interface BulkUpdateSubscriptionOptionsResponseNonNullableFields {
401
+ subscriptionOptions: SubscriptionOptionNonNullableFields[];
402
+ }
403
+ /**
404
+ * Retrieves a subscription option by ID.
405
+ * @param _id - Subscription option ID.
406
+ * @public
407
+ * @documentationMaturity preview
408
+ * @requiredField _id
409
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
410
+ * @permissionScope Manage Stores - all permissions
411
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
412
+ * @permissionScope Manage Products
413
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
414
+ * @permissionScope Read Stores - all read permissions
415
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
416
+ * @permissionScope Read Products
417
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
418
+ * @applicableIdentity APP
419
+ * @returns Subscription option.
420
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOption
421
+ * @deprecated
422
+ */
423
+ export declare function getSubscriptionOption(_id: string): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
424
+ /**
425
+ * Retrieves all subscription options assigned to a specified product.
426
+ * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
427
+ * @param productId - Product ID.
428
+ * @public
429
+ * @documentationMaturity preview
430
+ * @requiredField productId
431
+ * @param options - Options.
432
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
433
+ * @permissionScope Manage Stores - all permissions
434
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
435
+ * @permissionScope Manage Products
436
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
437
+ * @permissionScope Read Stores - all read permissions
438
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
439
+ * @permissionScope Read Products
440
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
441
+ * @applicableIdentity APP
442
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOptionsForProduct
443
+ * @deprecated
444
+ */
445
+ export declare function getSubscriptionOptionsForProduct(productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields>;
446
+ export interface GetSubscriptionOptionsForProductOptions {
447
+ /** Whether to include hidden subscription options in the results. */
448
+ includeHiddenSubscriptionOptions?: boolean;
449
+ }
450
+ /**
451
+ * Retrieves the IDs of products associated with a specified subscription option.
452
+ * @param _id - Subscription option ID.
453
+ * @public
454
+ * @documentationMaturity preview
455
+ * @requiredField _id
456
+ * @param options - Paging and other options.
457
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
458
+ * @permissionScope Manage Stores - all permissions
459
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
460
+ * @permissionScope Manage Products
461
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
462
+ * @permissionScope Read Stores - all read permissions
463
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
464
+ * @permissionScope Read Products
465
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
466
+ * @applicableIdentity APP
467
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetProductIdsForSubscriptionOption
468
+ * @deprecated
469
+ */
470
+ export declare function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields>;
471
+ export interface GetProductIdsForSubscriptionOptionOptions {
472
+ /** Whether to include hidden products in the returned results. */
473
+ includeHiddenProducts?: boolean;
474
+ /** Optional pagination parameters */
475
+ paging?: Paging;
476
+ }
477
+ /**
478
+ * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
479
+ * @param productId - Product ID.
480
+ * @public
481
+ * @documentationMaturity preview
482
+ * @requiredField productId
483
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
484
+ * @permissionScope Manage Stores - all permissions
485
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
486
+ * @permissionScope Manage Products
487
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
488
+ * @permissionScope Read Stores - all read permissions
489
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
490
+ * @permissionScope Read Products
491
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
492
+ * @applicableIdentity APP
493
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetOneTimePurchasesStatus
494
+ * @deprecated
495
+ */
496
+ export declare function getOneTimePurchasesStatus(productId: string): Promise<GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields>;
315
497
  /**
316
498
  * Creates a subscription option.
317
499
  * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
@@ -354,11 +536,21 @@ export declare function createSubscriptionOption(subscriptionOption: Subscriptio
354
536
  */
355
537
  export declare function updateSubscriptionOption(_id: string | null, subscriptionOption: UpdateSubscriptionOption): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
356
538
  export interface UpdateSubscriptionOption {
357
- /** Subscription option ID (auto-generated upon subscription option creation). */
539
+ /**
540
+ * Subscription option ID (auto-generated upon subscription option creation).
541
+ * @format GUID
542
+ */
358
543
  _id?: string | null;
359
- /** Subscription option title. */
544
+ /**
545
+ * Subscription option title.
546
+ * @minLength 1
547
+ * @maxLength 20
548
+ */
360
549
  title?: string | null;
361
- /** Subscription option description (optional). */
550
+ /**
551
+ * Subscription option description (optional).
552
+ * @maxLength 60
553
+ */
362
554
  description?: string | null;
363
555
  /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
364
556
  subscriptionSettings?: SubscriptionSettings;
@@ -457,7 +649,10 @@ export declare function bulkDeleteSubscriptionOptions(ids: string[]): Promise<vo
457
649
  */
458
650
  export declare function assignSubscriptionOptionsToProduct(productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise<void>;
459
651
  export interface AssignSubscriptionOptionsToProductOptions {
460
- /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
652
+ /**
653
+ * Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product.
654
+ * @maxSize 6
655
+ */
461
656
  assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
462
657
  }
463
658
  /**
@@ -479,98 +674,4 @@ export interface AssignSubscriptionOptionsToProductOptions {
479
674
  * @deprecated
480
675
  */
481
676
  export declare function allowOneTimePurchases(productId: string, allowed: boolean | null): Promise<void>;
482
- /**
483
- * Retrieves a subscription option by ID.
484
- * @param _id - Subscription option ID.
485
- * @public
486
- * @documentationMaturity preview
487
- * @requiredField _id
488
- * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
489
- * @permissionScope Manage Stores - all permissions
490
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
491
- * @permissionScope Manage Products
492
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
493
- * @permissionScope Read Stores - all read permissions
494
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
495
- * @permissionScope Read Products
496
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
497
- * @applicableIdentity APP
498
- * @returns Subscription option.
499
- * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOption
500
- * @deprecated
501
- */
502
- export declare function getSubscriptionOption(_id: string): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
503
- /**
504
- * Retrieves all subscription options assigned to a specified product.
505
- * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
506
- * @param productId - Product ID.
507
- * @public
508
- * @documentationMaturity preview
509
- * @requiredField productId
510
- * @param options - Options.
511
- * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
512
- * @permissionScope Manage Stores - all permissions
513
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
514
- * @permissionScope Manage Products
515
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
516
- * @permissionScope Read Stores - all read permissions
517
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
518
- * @permissionScope Read Products
519
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
520
- * @applicableIdentity APP
521
- * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOptionsForProduct
522
- * @deprecated
523
- */
524
- export declare function getSubscriptionOptionsForProduct(productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields>;
525
- export interface GetSubscriptionOptionsForProductOptions {
526
- /** Whether to include hidden subscription options in the results. */
527
- includeHiddenSubscriptionOptions?: boolean;
528
- }
529
- /**
530
- * Retrieves the IDs of products associated with a specified subscription option.
531
- * @param _id - Subscription option ID.
532
- * @public
533
- * @documentationMaturity preview
534
- * @requiredField _id
535
- * @param options - Paging and other options.
536
- * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
537
- * @permissionScope Manage Stores - all permissions
538
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
539
- * @permissionScope Manage Products
540
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
541
- * @permissionScope Read Stores - all read permissions
542
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
543
- * @permissionScope Read Products
544
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
545
- * @applicableIdentity APP
546
- * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetProductIdsForSubscriptionOption
547
- * @deprecated
548
- */
549
- export declare function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields>;
550
- export interface GetProductIdsForSubscriptionOptionOptions {
551
- /** Whether to include hidden products in the returned results. */
552
- includeHiddenProducts?: boolean;
553
- /** Optional pagination parameters */
554
- paging?: Paging;
555
- }
556
- /**
557
- * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
558
- * @param productId - Product ID.
559
- * @public
560
- * @documentationMaturity preview
561
- * @requiredField productId
562
- * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
563
- * @permissionScope Manage Stores - all permissions
564
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
565
- * @permissionScope Manage Products
566
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
567
- * @permissionScope Read Stores - all read permissions
568
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
569
- * @permissionScope Read Products
570
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
571
- * @applicableIdentity APP
572
- * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetOneTimePurchasesStatus
573
- * @deprecated
574
- */
575
- export declare function getOneTimePurchasesStatus(productId: string): Promise<GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields>;
576
677
  export {};