@wix/auto_sdk_stores_subscription-options 1.0.0

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 (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.d.ts +16 -0
  11. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.js +21 -0
  12. package/build/cjs/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -0
  13. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.d.ts +140 -0
  14. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.js +491 -0
  15. package/build/cjs/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -0
  16. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.d.ts +40 -0
  17. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.js +258 -0
  18. package/build/cjs/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -0
  19. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.d.ts +201 -0
  20. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.js +81 -0
  21. package/build/cjs/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -0
  22. package/build/cjs/src/stores-v1-subscription-option-subscription-options.types.d.ts +315 -0
  23. package/build/cjs/src/stores-v1-subscription-option-subscription-options.types.js +20 -0
  24. package/build/cjs/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -0
  25. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.d.ts +646 -0
  26. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.js +632 -0
  27. package/build/cjs/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/stores-v1-subscription-option-subscription-options.context.d.ts +16 -0
  39. package/build/es/src/stores-v1-subscription-option-subscription-options.context.js +16 -0
  40. package/build/es/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -0
  41. package/build/es/src/stores-v1-subscription-option-subscription-options.http.d.ts +140 -0
  42. package/build/es/src/stores-v1-subscription-option-subscription-options.http.js +476 -0
  43. package/build/es/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -0
  44. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.d.ts +40 -0
  45. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.js +220 -0
  46. package/build/es/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -0
  47. package/build/es/src/stores-v1-subscription-option-subscription-options.public.d.ts +201 -0
  48. package/build/es/src/stores-v1-subscription-option-subscription-options.public.js +64 -0
  49. package/build/es/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -0
  50. package/build/es/src/stores-v1-subscription-option-subscription-options.types.d.ts +315 -0
  51. package/build/es/src/stores-v1-subscription-option-subscription-options.types.js +17 -0
  52. package/build/es/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -0
  53. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.d.ts +646 -0
  54. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.js +594 -0
  55. package/build/es/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.d.ts +16 -0
  66. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.js +21 -0
  67. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -0
  68. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.d.ts +140 -0
  69. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.js +491 -0
  70. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -0
  71. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.d.ts +40 -0
  72. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.js +258 -0
  73. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -0
  74. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.d.ts +201 -0
  75. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.js +81 -0
  76. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -0
  77. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.types.d.ts +315 -0
  78. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.types.js +20 -0
  79. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -0
  80. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.d.ts +646 -0
  81. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.js +632 -0
  82. package/build/internal/cjs/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.d.ts +16 -0
  93. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.js +16 -0
  94. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.context.js.map +1 -0
  95. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.d.ts +140 -0
  96. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.js +476 -0
  97. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.http.js.map +1 -0
  98. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.d.ts +40 -0
  99. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.js +220 -0
  100. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.meta.js.map +1 -0
  101. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.d.ts +201 -0
  102. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.js +64 -0
  103. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.public.js.map +1 -0
  104. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.d.ts +315 -0
  105. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.js +17 -0
  106. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.types.js.map +1 -0
  107. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.d.ts +646 -0
  108. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.js +594 -0
  109. package/build/internal/es/src/stores-v1-subscription-option-subscription-options.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,646 @@
1
+ export interface SubscriptionOption {
2
+ /** Subscription option ID (auto-generated upon subscription option creation). */
3
+ _id?: string | null;
4
+ /** Subscription option title. */
5
+ title?: string | null;
6
+ /** Subscription option description (optional). */
7
+ description?: string | null;
8
+ /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
9
+ subscriptionSettings?: SubscriptionSettings;
10
+ /**
11
+ * Discount info (optional).
12
+ * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.
13
+ */
14
+ discount?: Discount;
15
+ }
16
+ export interface SubscriptionSettings {
17
+ /** Frequency of recurring payment. */
18
+ frequency?: SubscriptionFrequency;
19
+ /** Whether subscription is renewed automatically at the end of each period. */
20
+ autoRenewal?: boolean;
21
+ /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
22
+ billingCycles?: number | null;
23
+ }
24
+ /** Frequency unit of recurring payment */
25
+ export declare enum SubscriptionFrequency {
26
+ UNDEFINED = "UNDEFINED",
27
+ DAY = "DAY",
28
+ WEEK = "WEEK",
29
+ MONTH = "MONTH",
30
+ YEAR = "YEAR"
31
+ }
32
+ export interface Discount {
33
+ /** Discount type. */
34
+ type?: DiscountType;
35
+ /** Discount value. */
36
+ value?: number;
37
+ }
38
+ export declare enum DiscountType {
39
+ UNDEFINED = "UNDEFINED",
40
+ /** No discount */
41
+ AMOUNT = "AMOUNT",
42
+ PERCENT = "PERCENT"
43
+ }
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. */
62
+ _id: string;
63
+ }
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 {
87
+ }
88
+ export interface AssignSubscriptionOptionsToProductRequest {
89
+ /** Product ID. */
90
+ 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[];
93
+ }
94
+ export interface SubscriptionOptionInProduct {
95
+ /** Subscription option ID. */
96
+ _id?: string;
97
+ /** Whether the subscription option is hidden for the product (the default is false). */
98
+ hidden?: boolean;
99
+ /**
100
+ * Subscription option title.
101
+ * @readonly
102
+ */
103
+ title?: string | null;
104
+ /**
105
+ * Subscription option description (optional).
106
+ * @readonly
107
+ */
108
+ description?: string | null;
109
+ /**
110
+ * Subscription payment settings. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
111
+ * @readonly
112
+ */
113
+ subscriptionSettings?: SubscriptionSettings;
114
+ /**
115
+ * Discount info (optional).
116
+ * @readonly
117
+ */
118
+ discount?: Discount;
119
+ }
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
+ export interface ListSubscriptionOptionsRequest {
149
+ /** Subscription option IDs. */
150
+ ids?: string[];
151
+ }
152
+ export interface ListSubscriptionOptionsResponse {
153
+ /** Subscription options. */
154
+ subscriptionOptions?: SubscriptionOption[];
155
+ }
156
+ export interface CalculatePricesRequest {
157
+ /** original price to which subscription options discount will be applied */
158
+ price?: number;
159
+ /** ids of subscription options which will be applied to original price */
160
+ ids?: string[];
161
+ }
162
+ export interface CalculatePricesResponse {
163
+ /** array of calculated prices */
164
+ prices?: SubscriptionOptionPrices[];
165
+ /** price to which subscription options discount applied */
166
+ originalPrice?: number;
167
+ }
168
+ export interface SubscriptionOptionPrices {
169
+ /** Subscription option id */
170
+ _id?: string;
171
+ /** Price data calculated for subscription option */
172
+ priceData?: SubscriptionOptionPriceData;
173
+ /** Price data calculated for subscription option, converted to the currency requested in request header */
174
+ convertedPriceData?: SubscriptionOptionPriceData;
175
+ }
176
+ export interface SubscriptionOptionPriceData {
177
+ /** Subscription option price currency */
178
+ currency?: string;
179
+ /** Price calculated after subscription option discount applied */
180
+ discountedPrice?: number;
181
+ /** Price calculated after subscription option discount applied, formatted with the currency */
182
+ formattedDiscountedPrice?: string;
183
+ }
184
+ export interface BulkCalculatePricesRequest {
185
+ /**
186
+ * Original prices to which subscription options discount will be applied.
187
+ * Key is identifier unique per price that can be used to match calculated prices with original price
188
+ */
189
+ prices?: Record<string, number>;
190
+ /** ids of subscription options which will be applied to original price */
191
+ ids?: string[];
192
+ }
193
+ export interface BulkCalculatePricesResponse {
194
+ /**
195
+ * Key is identifier unique per price that can be used to match calculated prices with original price
196
+ * Value is response with calculated prices for each subscription option
197
+ */
198
+ calculatedPrices?: Record<string, CalculatePricesResponse>;
199
+ }
200
+ export interface BulkCalculatePricesRequestV2 {
201
+ /** Original prices to be calculated for each corresponding product id with related subscription plan ids */
202
+ items?: BulkCalculatePricesRequestItem[];
203
+ }
204
+ export interface BulkCalculatePricesRequestItem {
205
+ /** Calculation id (product id) */
206
+ _id?: string;
207
+ /**
208
+ * Original prices to which subscription options discount will be applied.
209
+ * Key is identifier unique per price that can be used to match calculated prices with original price
210
+ */
211
+ prices?: Record<string, number>;
212
+ /** ids of subscription options which will be applied to original price. */
213
+ subscriptionOptionIds?: string[];
214
+ }
215
+ export interface BulkCalculatePricesResponseV2 {
216
+ /**
217
+ * Key is identifier unique per price that can be used to match calculated prices with original price
218
+ * Value is response with calculated prices for each subscription option for each product
219
+ */
220
+ calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];
221
+ }
222
+ export interface BulkCalculatePricesResponseItem {
223
+ /** Calculation id (product id) */
224
+ _id?: string;
225
+ /**
226
+ * Key is identifier unique per price that can be used to match calculated prices with original price
227
+ * Value is response with calculated prices for each subscription option
228
+ */
229
+ calculatedPrices?: Record<string, CalculatePricesResponse>;
230
+ }
231
+ export interface GetProductIdsForSubscriptionOptionRequest {
232
+ /** Subscription option ID. */
233
+ _id: string;
234
+ /** Whether to include hidden products in the returned results. */
235
+ includeHiddenProducts?: boolean;
236
+ /** Optional pagination parameters */
237
+ paging?: Paging;
238
+ }
239
+ export interface Paging {
240
+ /** Amount of items to load per page. */
241
+ limit?: number | null;
242
+ /** Number of items to skip in the display (relevant for all pages after the first). */
243
+ offset?: number | null;
244
+ }
245
+ export interface GetProductIdsForSubscriptionOptionResponse {
246
+ /** IDs of products associated with the specified subscription option. */
247
+ productIds?: string[];
248
+ /** Paging metadata. */
249
+ metadata?: PagingMetadata;
250
+ /** Number of total results. */
251
+ totalResults?: number;
252
+ }
253
+ export interface PagingMetadata {
254
+ /** Amount of items to load per page. */
255
+ items?: number;
256
+ /** Number of items to skip in the display (relevant for all pages after the first). */
257
+ offset?: number;
258
+ }
259
+ export interface GetOneTimePurchasesStatusRequest {
260
+ /** Product ID. */
261
+ productId: string;
262
+ }
263
+ export interface GetOneTimePurchasesStatusResponse {
264
+ /** Whether the specified product is available for one-time purchase */
265
+ allowed?: boolean;
266
+ }
267
+ interface SubscriptionSettingsNonNullableFields {
268
+ frequency: SubscriptionFrequency;
269
+ autoRenewal: boolean;
270
+ }
271
+ interface DiscountNonNullableFields {
272
+ type: DiscountType;
273
+ value: number;
274
+ }
275
+ export interface SubscriptionOptionNonNullableFields {
276
+ subscriptionSettings?: SubscriptionSettingsNonNullableFields;
277
+ discount?: DiscountNonNullableFields;
278
+ }
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
+ export interface GetSubscriptionOptionResponseNonNullableFields {
292
+ subscriptionOption?: SubscriptionOptionNonNullableFields;
293
+ }
294
+ interface SubscriptionOptionInProductNonNullableFields {
295
+ _id: string;
296
+ hidden: boolean;
297
+ subscriptionSettings?: SubscriptionSettingsNonNullableFields;
298
+ discount?: DiscountNonNullableFields;
299
+ }
300
+ export interface GetSubscriptionOptionsForProductResponseNonNullableFields {
301
+ subscriptionOptions: SubscriptionOptionInProductNonNullableFields[];
302
+ }
303
+ interface PagingMetadataNonNullableFields {
304
+ items: number;
305
+ offset: number;
306
+ }
307
+ export interface GetProductIdsForSubscriptionOptionResponseNonNullableFields {
308
+ productIds: string[];
309
+ metadata?: PagingMetadataNonNullableFields;
310
+ totalResults: number;
311
+ }
312
+ export interface GetOneTimePurchasesStatusResponseNonNullableFields {
313
+ allowed: boolean;
314
+ }
315
+ /**
316
+ * Creates a subscription option.
317
+ * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
318
+ * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
319
+ * @param subscriptionOption - Subscription option info.
320
+ * @public
321
+ * @documentationMaturity preview
322
+ * @requiredField subscriptionOption
323
+ * @requiredField subscriptionOption.subscriptionSettings
324
+ * @requiredField subscriptionOption.title
325
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
326
+ * @permissionScope Manage Stores - all permissions
327
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
328
+ * @permissionScope Manage Products
329
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
330
+ * @applicableIdentity APP
331
+ * @returns Newly created subscription option.
332
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.CreateSubscriptionOption
333
+ * @deprecated
334
+ */
335
+ export declare function createSubscriptionOption(subscriptionOption: SubscriptionOption): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
336
+ /**
337
+ * Updates a subscription option.
338
+ * Only parameters passed will be updated.
339
+ * <blockquote class='warning'>
340
+ *
341
+ * __Deprecation Notice:__
342
+ *
343
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
344
+ *
345
+ * </blockquote>
346
+ * @param _id - Subscription option ID (auto-generated upon subscription option creation).
347
+ * @public
348
+ * @documentationMaturity preview
349
+ * @requiredField _id
350
+ * @requiredField subscriptionOption
351
+ * @param subscriptionOption - Subscription option update options.
352
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
353
+ * @permissionScope Manage Stores - all permissions
354
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
355
+ * @permissionScope Manage Products
356
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
357
+ * @applicableIdentity APP
358
+ * @returns Updated subscription option.
359
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.UpdateSubscriptionOption
360
+ * @deprecated
361
+ */
362
+ export declare function updateSubscriptionOption(_id: string | null, subscriptionOption: UpdateSubscriptionOption): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
363
+ export interface UpdateSubscriptionOption {
364
+ /** Subscription option ID (auto-generated upon subscription option creation). */
365
+ _id?: string | null;
366
+ /** Subscription option title. */
367
+ title?: string | null;
368
+ /** Subscription option description (optional). */
369
+ description?: string | null;
370
+ /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
371
+ subscriptionSettings?: SubscriptionSettings;
372
+ /**
373
+ * Discount info (optional).
374
+ * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.
375
+ */
376
+ discount?: Discount;
377
+ }
378
+ /**
379
+ * Deletes a subscription option.
380
+ * <blockquote class='warning'>
381
+ *
382
+ * __Deprecation Notice:__
383
+ *
384
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
385
+ *
386
+ * </blockquote>
387
+ * @param _id - ID of the subscription option to delete.
388
+ * @public
389
+ * @documentationMaturity preview
390
+ * @requiredField _id
391
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
392
+ * @permissionScope Manage Stores - all permissions
393
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
394
+ * @permissionScope Manage Products
395
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
396
+ * @applicableIdentity APP
397
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.DeleteSubscriptionOption
398
+ * @deprecated
399
+ */
400
+ export declare function deleteSubscriptionOption(_id: string): Promise<void>;
401
+ /**
402
+ * Creates multiple subscription options (up to 100).
403
+ * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).
404
+ * Subscription options that are not assigned to a product will not be visible in the Wix business manager.
405
+ * @param subscriptionOptions - Subscription options info.
406
+ * @public
407
+ * @documentationMaturity preview
408
+ * @requiredField subscriptionOptions
409
+ * @requiredField subscriptionOptions.subscriptionSettings
410
+ * @requiredField subscriptionOptions.title
411
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
412
+ * @permissionScope Manage Stores - all permissions
413
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
414
+ * @permissionScope Manage Products
415
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
416
+ * @applicableIdentity APP
417
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkCreateSubscriptionOptions
418
+ * @deprecated
419
+ */
420
+ export declare function bulkCreateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise<BulkCreateSubscriptionOptionsResponse & BulkCreateSubscriptionOptionsResponseNonNullableFields>;
421
+ /**
422
+ * Updates multiple subscription options.
423
+ * Only parameters passed will be updated.
424
+ * <blockquote class='warning'>
425
+ *
426
+ * __Deprecation Notice:__
427
+ *
428
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
429
+ *
430
+ * </blockquote>
431
+ * @param subscriptionOptions - Subscription options info. Only the passed parameters in each subscription option will be updated.
432
+ * @public
433
+ * @documentationMaturity preview
434
+ * @requiredField subscriptionOptions
435
+ * @requiredField subscriptionOptions._id
436
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
437
+ * @permissionScope Manage Stores - all permissions
438
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
439
+ * @permissionScope Manage Products
440
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
441
+ * @applicableIdentity APP
442
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkUpdateSubscriptionOptions
443
+ * @deprecated
444
+ */
445
+ export declare function bulkUpdateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise<BulkUpdateSubscriptionOptionsResponse & BulkUpdateSubscriptionOptionsResponseNonNullableFields>;
446
+ /**
447
+ * Deletes multiple subscription options.
448
+ * <blockquote class='warning'>
449
+ *
450
+ * __Deprecation Notice:__
451
+ *
452
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
453
+ *
454
+ * </blockquote>
455
+ * @param ids - IDs of the subscription options to delete.
456
+ * @public
457
+ * @documentationMaturity preview
458
+ * @requiredField ids
459
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
460
+ * @permissionScope Manage Stores - all permissions
461
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
462
+ * @permissionScope Manage Products
463
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
464
+ * @applicableIdentity APP
465
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.BulkDeleteSubscriptionOptions
466
+ * @deprecated
467
+ */
468
+ export declare function bulkDeleteSubscriptionOptions(ids: string[]): Promise<void>;
469
+ /**
470
+ * Assign up to 6 subscription options to a specified product.
471
+ * Pass an empty array to remove all subscription options assigned to a product.
472
+ * <blockquote class='warning'>
473
+ *
474
+ * __Deprecation Notice:__
475
+ *
476
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
477
+ *
478
+ * </blockquote>
479
+ * @param productId - Product ID.
480
+ * @public
481
+ * @documentationMaturity preview
482
+ * @requiredField productId
483
+ * @param options - Subscription option assignment options.
484
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
485
+ * @permissionScope Manage Stores - all permissions
486
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
487
+ * @permissionScope Manage Products
488
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
489
+ * @applicableIdentity APP
490
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.AssignSubscriptionOptionsToProduct
491
+ * @deprecated
492
+ */
493
+ export declare function assignSubscriptionOptionsToProduct(productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise<void>;
494
+ export interface AssignSubscriptionOptionsToProductOptions {
495
+ /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
496
+ assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
497
+ }
498
+ /**
499
+ * Allow for one-time purchase of a product.
500
+ * By default, product can be sold only as part of a subscription, not as a one-time purchase.
501
+ * <blockquote class='warning'>
502
+ *
503
+ * __Deprecation Notice:__
504
+ *
505
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
506
+ *
507
+ * </blockquote>
508
+ * @param productId - Product ID.
509
+ * @param allowed - Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.
510
+ * @public
511
+ * @documentationMaturity preview
512
+ * @requiredField allowed
513
+ * @requiredField productId
514
+ * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS
515
+ * @permissionScope Manage Stores - all permissions
516
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
517
+ * @permissionScope Manage Products
518
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
519
+ * @applicableIdentity APP
520
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsWriteApi.AllowOneTimePurchases
521
+ * @deprecated
522
+ */
523
+ export declare function allowOneTimePurchases(productId: string, allowed: boolean | null): Promise<void>;
524
+ /**
525
+ * Retrieves a subscription option by ID.
526
+ * <blockquote class='warning'>
527
+ *
528
+ * __Deprecation Notice:__
529
+ *
530
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
531
+ *
532
+ * </blockquote>
533
+ * @param _id - Subscription option ID.
534
+ * @public
535
+ * @documentationMaturity preview
536
+ * @requiredField _id
537
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
538
+ * @permissionScope Manage Stores - all permissions
539
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
540
+ * @permissionScope Manage Products
541
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
542
+ * @permissionScope Read Stores - all read permissions
543
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
544
+ * @permissionScope Read Products
545
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
546
+ * @applicableIdentity APP
547
+ * @returns Subscription option.
548
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOption
549
+ * @deprecated
550
+ */
551
+ export declare function getSubscriptionOption(_id: string): Promise<SubscriptionOption & SubscriptionOptionNonNullableFields>;
552
+ /**
553
+ * Retrieves all subscription options assigned to a specified product.
554
+ * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.
555
+ * <blockquote class='warning'>
556
+ *
557
+ * __Deprecation Notice:__
558
+ *
559
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
560
+ *
561
+ * </blockquote>
562
+ * @param productId - Product ID.
563
+ * @public
564
+ * @documentationMaturity preview
565
+ * @requiredField productId
566
+ * @param options - Options.
567
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
568
+ * @permissionScope Manage Stores - all permissions
569
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
570
+ * @permissionScope Manage Products
571
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
572
+ * @permissionScope Read Stores - all read permissions
573
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
574
+ * @permissionScope Read Products
575
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
576
+ * @applicableIdentity APP
577
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetSubscriptionOptionsForProduct
578
+ * @deprecated
579
+ */
580
+ export declare function getSubscriptionOptionsForProduct(productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise<GetSubscriptionOptionsForProductResponse & GetSubscriptionOptionsForProductResponseNonNullableFields>;
581
+ export interface GetSubscriptionOptionsForProductOptions {
582
+ /** Whether to include hidden subscription options in the results. */
583
+ includeHiddenSubscriptionOptions?: boolean;
584
+ }
585
+ /**
586
+ * Retrieves the IDs of products associated with a specified subscription option.
587
+ * <blockquote class='warning'>
588
+ *
589
+ * __Deprecation Notice:__
590
+ *
591
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
592
+ *
593
+ * </blockquote>
594
+ * @param _id - Subscription option ID.
595
+ * @public
596
+ * @documentationMaturity preview
597
+ * @requiredField _id
598
+ * @param options - Paging and other options.
599
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
600
+ * @permissionScope Manage Stores - all permissions
601
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
602
+ * @permissionScope Manage Products
603
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
604
+ * @permissionScope Read Stores - all read permissions
605
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
606
+ * @permissionScope Read Products
607
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
608
+ * @applicableIdentity APP
609
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetProductIdsForSubscriptionOption
610
+ * @deprecated
611
+ */
612
+ export declare function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise<GetProductIdsForSubscriptionOptionResponse & GetProductIdsForSubscriptionOptionResponseNonNullableFields>;
613
+ export interface GetProductIdsForSubscriptionOptionOptions {
614
+ /** Whether to include hidden products in the returned results. */
615
+ includeHiddenProducts?: boolean;
616
+ /** Optional pagination parameters */
617
+ paging?: Paging;
618
+ }
619
+ /**
620
+ * Checks whether a specified product (associated with subscription options) is available for one-time purchase.
621
+ * <blockquote class='warning'>
622
+ *
623
+ * __Deprecation Notice:__
624
+ *
625
+ * This endpoint has been deprecated and will be removed on January 29, 2024.
626
+ *
627
+ * </blockquote>
628
+ * @param productId - Product ID.
629
+ * @public
630
+ * @documentationMaturity preview
631
+ * @requiredField productId
632
+ * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS
633
+ * @permissionScope Manage Stores - all permissions
634
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
635
+ * @permissionScope Manage Products
636
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
637
+ * @permissionScope Read Stores - all read permissions
638
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
639
+ * @permissionScope Read Products
640
+ * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
641
+ * @applicableIdentity APP
642
+ * @fqn wix.ecommerce.subscription.option.api.v1.SubscriptionOptionsReadApi.GetOneTimePurchasesStatus
643
+ * @deprecated
644
+ */
645
+ export declare function getOneTimePurchasesStatus(productId: string): Promise<GetOneTimePurchasesStatusResponse & GetOneTimePurchasesStatusResponseNonNullableFields>;
646
+ export {};