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