@wix/auto_sdk_stores_customizations-v-3 1.0.16 → 1.0.18
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 +154 -0
- package/build/index.d.ts +154 -0
- package/build/index.js +1389 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1346 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +154 -0
- package/build/internal/index.d.ts +154 -0
- package/build/internal/index.js +1389 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1346 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +619 -0
- package/build/internal/meta.d.ts +619 -0
- package/build/internal/meta.js +873 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +836 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → internal/stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.mts} +377 -108
- package/build/{cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → internal/stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.ts} +377 -108
- package/build/meta.d.mts +619 -0
- package/build/meta.d.ts +619 -0
- package/build/meta.js +873 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +836 -0
- package/build/meta.mjs.map +1 -0
- package/build/{internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.mts} +377 -108
- package/build/{internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts → stores-catalog-v3-customization-customizations-v-3.universal-CT4feroB.d.ts} +377 -108
- 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-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.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-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.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-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.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-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Customizations include options and modifiers which can later be applied to products.
|
|
3
3
|
* Options are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.
|
|
4
4
|
*/
|
|
5
|
-
|
|
5
|
+
interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
6
6
|
/**
|
|
7
7
|
* Free text input settings.
|
|
8
8
|
*
|
|
@@ -22,7 +22,7 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
22
22
|
* @maxLength 36
|
|
23
23
|
* @readonly
|
|
24
24
|
*/
|
|
25
|
-
|
|
25
|
+
_id?: string | null;
|
|
26
26
|
/**
|
|
27
27
|
* Revision number, which increments by 1 each time the customization is updated.
|
|
28
28
|
* To prevent conflicting changes,
|
|
@@ -36,12 +36,12 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
36
36
|
* Date and time the customization was created.
|
|
37
37
|
* @readonly
|
|
38
38
|
*/
|
|
39
|
-
|
|
39
|
+
_createdDate?: Date | null;
|
|
40
40
|
/**
|
|
41
41
|
* Date and time the customization was updated.
|
|
42
42
|
* @readonly
|
|
43
43
|
*/
|
|
44
|
-
|
|
44
|
+
_updatedDate?: Date | null;
|
|
45
45
|
/**
|
|
46
46
|
* Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
|
|
47
47
|
* @minLength 1
|
|
@@ -68,7 +68,7 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
68
68
|
assignedProductsCount?: number | null;
|
|
69
69
|
}
|
|
70
70
|
/** @oneof */
|
|
71
|
-
|
|
71
|
+
interface CustomizationCustomizationSettingsOneOf {
|
|
72
72
|
/**
|
|
73
73
|
* Free text input settings.
|
|
74
74
|
*
|
|
@@ -83,14 +83,14 @@ export interface CustomizationCustomizationSettingsOneOf {
|
|
|
83
83
|
*/
|
|
84
84
|
choicesSettings?: ChoicesSettings;
|
|
85
85
|
}
|
|
86
|
-
|
|
86
|
+
declare enum CustomizationType {
|
|
87
87
|
UNKNOWN_CUSTOMIZATION_TYPE = "UNKNOWN_CUSTOMIZATION_TYPE",
|
|
88
88
|
PRODUCT_OPTION = "PRODUCT_OPTION",
|
|
89
89
|
MODIFIER = "MODIFIER"
|
|
90
90
|
}
|
|
91
91
|
/** @enumType */
|
|
92
|
-
|
|
93
|
-
|
|
92
|
+
type CustomizationTypeWithLiterals = CustomizationType | 'UNKNOWN_CUSTOMIZATION_TYPE' | 'PRODUCT_OPTION' | 'MODIFIER';
|
|
93
|
+
declare enum CustomizationRenderType {
|
|
94
94
|
UNKNOWN_CUSTOMIZATION_RENDER_TYPE = "UNKNOWN_CUSTOMIZATION_RENDER_TYPE",
|
|
95
95
|
/** Customization by free text input. */
|
|
96
96
|
FREE_TEXT = "FREE_TEXT",
|
|
@@ -100,8 +100,8 @@ export declare enum CustomizationRenderType {
|
|
|
100
100
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
101
101
|
}
|
|
102
102
|
/** @enumType */
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'UNKNOWN_CUSTOMIZATION_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
104
|
+
interface FreeTextSettings {
|
|
105
105
|
/** Minimum text character length. */
|
|
106
106
|
minCharCount?: number;
|
|
107
107
|
/**
|
|
@@ -121,7 +121,7 @@ export interface FreeTextSettings {
|
|
|
121
121
|
*/
|
|
122
122
|
title?: string;
|
|
123
123
|
}
|
|
124
|
-
|
|
124
|
+
interface ChoicesSettings {
|
|
125
125
|
/**
|
|
126
126
|
* List of choices.
|
|
127
127
|
* @minSize 1
|
|
@@ -130,7 +130,7 @@ export interface ChoicesSettings {
|
|
|
130
130
|
*/
|
|
131
131
|
choices?: Choice[];
|
|
132
132
|
}
|
|
133
|
-
|
|
133
|
+
interface Choice extends ChoiceValueOneOf {
|
|
134
134
|
/**
|
|
135
135
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
136
136
|
* @minLength 3
|
|
@@ -143,7 +143,7 @@ export interface Choice extends ChoiceValueOneOf {
|
|
|
143
143
|
* @format GUID
|
|
144
144
|
* @readonly
|
|
145
145
|
*/
|
|
146
|
-
|
|
146
|
+
_id?: string;
|
|
147
147
|
/**
|
|
148
148
|
* Choice type.
|
|
149
149
|
*
|
|
@@ -178,7 +178,7 @@ export interface Choice extends ChoiceValueOneOf {
|
|
|
178
178
|
assignedProductsCount?: number;
|
|
179
179
|
}
|
|
180
180
|
/** @oneof */
|
|
181
|
-
|
|
181
|
+
interface ChoiceValueOneOf {
|
|
182
182
|
/**
|
|
183
183
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
184
184
|
* @minLength 3
|
|
@@ -187,7 +187,7 @@ export interface ChoiceValueOneOf {
|
|
|
187
187
|
*/
|
|
188
188
|
colorCode?: string;
|
|
189
189
|
}
|
|
190
|
-
|
|
190
|
+
declare enum ChoiceType {
|
|
191
191
|
UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
|
|
192
192
|
/** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
|
|
193
193
|
CHOICE_TEXT = "CHOICE_TEXT",
|
|
@@ -199,8 +199,8 @@ export declare enum ChoiceType {
|
|
|
199
199
|
IMAGE = "IMAGE"
|
|
200
200
|
}
|
|
201
201
|
/** @enumType */
|
|
202
|
-
|
|
203
|
-
|
|
202
|
+
type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
|
|
203
|
+
interface MultipleColors {
|
|
204
204
|
/**
|
|
205
205
|
* A list of color codes.
|
|
206
206
|
* @minLength 3
|
|
@@ -210,30 +210,7 @@ export interface MultipleColors {
|
|
|
210
210
|
*/
|
|
211
211
|
colorCodes?: string[];
|
|
212
212
|
}
|
|
213
|
-
|
|
214
|
-
/** WixMedia image ID. */
|
|
215
|
-
id?: string;
|
|
216
|
-
/** Image URL. */
|
|
217
|
-
url?: string;
|
|
218
|
-
/**
|
|
219
|
-
* Original image height.
|
|
220
|
-
* @readonly
|
|
221
|
-
*/
|
|
222
|
-
height?: number;
|
|
223
|
-
/**
|
|
224
|
-
* Original image width.
|
|
225
|
-
* @readonly
|
|
226
|
-
*/
|
|
227
|
-
width?: number;
|
|
228
|
-
/** Image alt text. */
|
|
229
|
-
altText?: string | null;
|
|
230
|
-
/**
|
|
231
|
-
* Image filename.
|
|
232
|
-
* @readonly
|
|
233
|
-
*/
|
|
234
|
-
filename?: string | null;
|
|
235
|
-
}
|
|
236
|
-
export interface FocalPoint {
|
|
213
|
+
interface FocalPoint {
|
|
237
214
|
/** X-coordinate of the focal point. */
|
|
238
215
|
x?: number;
|
|
239
216
|
/** Y-coordinate of the focal point. */
|
|
@@ -243,7 +220,7 @@ export interface FocalPoint {
|
|
|
243
220
|
/** crop by width */
|
|
244
221
|
width?: number | null;
|
|
245
222
|
}
|
|
246
|
-
|
|
223
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
247
224
|
/**
|
|
248
225
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
249
226
|
* @format GUID
|
|
@@ -274,7 +251,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
274
251
|
hardPurge?: boolean;
|
|
275
252
|
}
|
|
276
253
|
/** @oneof */
|
|
277
|
-
|
|
254
|
+
interface InvalidateCacheGetByOneOf {
|
|
278
255
|
/**
|
|
279
256
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
280
257
|
* @format GUID
|
|
@@ -296,7 +273,7 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
296
273
|
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
297
274
|
customTag?: CustomTag;
|
|
298
275
|
}
|
|
299
|
-
|
|
276
|
+
interface App {
|
|
300
277
|
/**
|
|
301
278
|
* The AppDefId
|
|
302
279
|
* @minLength 1
|
|
@@ -308,7 +285,7 @@ export interface App {
|
|
|
308
285
|
*/
|
|
309
286
|
instanceId?: string;
|
|
310
287
|
}
|
|
311
|
-
|
|
288
|
+
interface Page {
|
|
312
289
|
/**
|
|
313
290
|
* the msid the page is on
|
|
314
291
|
* @format GUID
|
|
@@ -320,7 +297,7 @@ export interface Page {
|
|
|
320
297
|
*/
|
|
321
298
|
pageId?: string;
|
|
322
299
|
}
|
|
323
|
-
|
|
300
|
+
interface URI {
|
|
324
301
|
/**
|
|
325
302
|
* the msid the URI is on
|
|
326
303
|
* @format GUID
|
|
@@ -332,7 +309,7 @@ export interface URI {
|
|
|
332
309
|
*/
|
|
333
310
|
uriPath?: string;
|
|
334
311
|
}
|
|
335
|
-
|
|
312
|
+
interface File {
|
|
336
313
|
/**
|
|
337
314
|
* the msid the file is related to
|
|
338
315
|
* @format GUID
|
|
@@ -345,7 +322,7 @@ export interface File {
|
|
|
345
322
|
*/
|
|
346
323
|
fileName?: string;
|
|
347
324
|
}
|
|
348
|
-
|
|
325
|
+
interface CustomTag {
|
|
349
326
|
/**
|
|
350
327
|
* the msid the tag is related to
|
|
351
328
|
* @format GUID
|
|
@@ -358,15 +335,15 @@ export interface CustomTag {
|
|
|
358
335
|
*/
|
|
359
336
|
tag?: string;
|
|
360
337
|
}
|
|
361
|
-
|
|
338
|
+
interface CreateCustomizationRequest {
|
|
362
339
|
/** Customization to create. */
|
|
363
340
|
customization: Customization;
|
|
364
341
|
}
|
|
365
|
-
|
|
342
|
+
interface CreateCustomizationResponse {
|
|
366
343
|
/** Created customization. */
|
|
367
344
|
customization?: Customization;
|
|
368
345
|
}
|
|
369
|
-
|
|
346
|
+
interface GetCustomizationRequest {
|
|
370
347
|
/**
|
|
371
348
|
* Customization ID.
|
|
372
349
|
* @format GUID
|
|
@@ -380,19 +357,19 @@ export interface GetCustomizationRequest {
|
|
|
380
357
|
*/
|
|
381
358
|
fields?: RequestedFieldsWithLiterals[];
|
|
382
359
|
}
|
|
383
|
-
|
|
360
|
+
declare enum RequestedFields {
|
|
384
361
|
/** Unknown requested field. */
|
|
385
362
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
386
363
|
/** Assigned products count. */
|
|
387
364
|
ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
|
|
388
365
|
}
|
|
389
366
|
/** @enumType */
|
|
390
|
-
|
|
391
|
-
|
|
367
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'ASSIGNED_PRODUCTS_COUNT';
|
|
368
|
+
interface GetCustomizationResponse {
|
|
392
369
|
/** Customization. */
|
|
393
370
|
customization?: Customization;
|
|
394
371
|
}
|
|
395
|
-
|
|
372
|
+
interface UpdateCustomizationRequest {
|
|
396
373
|
/** Customization to update. */
|
|
397
374
|
customization: Customization;
|
|
398
375
|
/**
|
|
@@ -403,20 +380,20 @@ export interface UpdateCustomizationRequest {
|
|
|
403
380
|
*/
|
|
404
381
|
fields?: RequestedFieldsWithLiterals[];
|
|
405
382
|
}
|
|
406
|
-
|
|
383
|
+
interface UpdateCustomizationResponse {
|
|
407
384
|
/** Updated customization. */
|
|
408
385
|
customization?: Customization;
|
|
409
386
|
}
|
|
410
|
-
|
|
387
|
+
interface DeleteCustomizationRequest {
|
|
411
388
|
/**
|
|
412
389
|
* Customization ID.
|
|
413
390
|
* @format GUID
|
|
414
391
|
*/
|
|
415
392
|
customizationId: string;
|
|
416
393
|
}
|
|
417
|
-
|
|
394
|
+
interface DeleteCustomizationResponse {
|
|
418
395
|
}
|
|
419
|
-
|
|
396
|
+
interface QueryCustomizationsRequest {
|
|
420
397
|
/** Query options. */
|
|
421
398
|
query?: CursorQuery;
|
|
422
399
|
/**
|
|
@@ -427,7 +404,7 @@ export interface QueryCustomizationsRequest {
|
|
|
427
404
|
*/
|
|
428
405
|
fields?: RequestedFieldsWithLiterals[];
|
|
429
406
|
}
|
|
430
|
-
|
|
407
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
431
408
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
432
409
|
cursorPaging?: CursorPaging;
|
|
433
410
|
/**
|
|
@@ -447,11 +424,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
447
424
|
sort?: Sorting[];
|
|
448
425
|
}
|
|
449
426
|
/** @oneof */
|
|
450
|
-
|
|
427
|
+
interface CursorQueryPagingMethodOneOf {
|
|
451
428
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
452
429
|
cursorPaging?: CursorPaging;
|
|
453
430
|
}
|
|
454
|
-
|
|
431
|
+
interface Sorting {
|
|
455
432
|
/**
|
|
456
433
|
* Name of the field to sort by.
|
|
457
434
|
* @maxLength 512
|
|
@@ -460,15 +437,15 @@ export interface Sorting {
|
|
|
460
437
|
/** Sort order. */
|
|
461
438
|
order?: SortOrderWithLiterals;
|
|
462
439
|
}
|
|
463
|
-
|
|
440
|
+
declare enum SortOrder {
|
|
464
441
|
/** Ascending order. */
|
|
465
442
|
ASC = "ASC",
|
|
466
443
|
/** Descending order. */
|
|
467
444
|
DESC = "DESC"
|
|
468
445
|
}
|
|
469
446
|
/** @enumType */
|
|
470
|
-
|
|
471
|
-
|
|
447
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
448
|
+
interface CursorPaging {
|
|
472
449
|
/**
|
|
473
450
|
* Maximum number of items to return in the results.
|
|
474
451
|
* @max 100
|
|
@@ -483,7 +460,7 @@ export interface CursorPaging {
|
|
|
483
460
|
*/
|
|
484
461
|
cursor?: string | null;
|
|
485
462
|
}
|
|
486
|
-
|
|
463
|
+
interface QueryCustomizationsResponse {
|
|
487
464
|
/**
|
|
488
465
|
* List of customizations.
|
|
489
466
|
* @minSize 1
|
|
@@ -493,7 +470,7 @@ export interface QueryCustomizationsResponse {
|
|
|
493
470
|
/** Details on the paged set of results returned. */
|
|
494
471
|
pagingMetadata?: CursorPagingMetadata;
|
|
495
472
|
}
|
|
496
|
-
|
|
473
|
+
interface CursorPagingMetadata {
|
|
497
474
|
/** Number of items returned in the response. */
|
|
498
475
|
count?: number | null;
|
|
499
476
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -506,7 +483,7 @@ export interface CursorPagingMetadata {
|
|
|
506
483
|
*/
|
|
507
484
|
hasNext?: boolean | null;
|
|
508
485
|
}
|
|
509
|
-
|
|
486
|
+
interface Cursors {
|
|
510
487
|
/**
|
|
511
488
|
* Cursor string pointing to the next page in the list of results.
|
|
512
489
|
* @maxLength 16000
|
|
@@ -518,7 +495,7 @@ export interface Cursors {
|
|
|
518
495
|
*/
|
|
519
496
|
prev?: string | null;
|
|
520
497
|
}
|
|
521
|
-
|
|
498
|
+
interface BulkCreateCustomizationsRequest {
|
|
522
499
|
/**
|
|
523
500
|
* Customizations to create.
|
|
524
501
|
* @minSize 1
|
|
@@ -532,7 +509,7 @@ export interface BulkCreateCustomizationsRequest {
|
|
|
532
509
|
*/
|
|
533
510
|
returnEntity?: boolean;
|
|
534
511
|
}
|
|
535
|
-
|
|
512
|
+
interface BulkCreateCustomizationsResponse {
|
|
536
513
|
/**
|
|
537
514
|
* Customizations created by bulk action.
|
|
538
515
|
* @minSize 1
|
|
@@ -542,7 +519,7 @@ export interface BulkCreateCustomizationsResponse {
|
|
|
542
519
|
/** Bulk action metadata. */
|
|
543
520
|
bulkActionMetadata?: BulkActionMetadata;
|
|
544
521
|
}
|
|
545
|
-
|
|
522
|
+
interface BulkCustomizationResult {
|
|
546
523
|
/** Bulk action metadata for customization. */
|
|
547
524
|
itemMetadata?: ItemMetadata;
|
|
548
525
|
/**
|
|
@@ -552,13 +529,13 @@ export interface BulkCustomizationResult {
|
|
|
552
529
|
*/
|
|
553
530
|
customization?: Customization;
|
|
554
531
|
}
|
|
555
|
-
|
|
532
|
+
interface ItemMetadata {
|
|
556
533
|
/**
|
|
557
534
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
558
535
|
* @minLength 1
|
|
559
536
|
* @maxLength 36
|
|
560
537
|
*/
|
|
561
|
-
|
|
538
|
+
_id?: string | null;
|
|
562
539
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
563
540
|
originalIndex?: number;
|
|
564
541
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -566,7 +543,7 @@ export interface ItemMetadata {
|
|
|
566
543
|
/** Details about the error in case of failure. */
|
|
567
544
|
error?: ApplicationError;
|
|
568
545
|
}
|
|
569
|
-
|
|
546
|
+
interface ApplicationError {
|
|
570
547
|
/** Error code. */
|
|
571
548
|
code?: string;
|
|
572
549
|
/** Description of the error. */
|
|
@@ -574,7 +551,7 @@ export interface ApplicationError {
|
|
|
574
551
|
/** Data related to the error. */
|
|
575
552
|
data?: Record<string, any> | null;
|
|
576
553
|
}
|
|
577
|
-
|
|
554
|
+
interface BulkActionMetadata {
|
|
578
555
|
/** Number of items that were successfully processed. */
|
|
579
556
|
totalSuccesses?: number;
|
|
580
557
|
/** Number of items that couldn't be processed. */
|
|
@@ -582,7 +559,7 @@ export interface BulkActionMetadata {
|
|
|
582
559
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
583
560
|
undetailedFailures?: number;
|
|
584
561
|
}
|
|
585
|
-
|
|
562
|
+
interface CustomizationIdsWrapper {
|
|
586
563
|
/**
|
|
587
564
|
* list of all the customization ids that are invalid
|
|
588
565
|
* e.g list of failed choices ids
|
|
@@ -593,7 +570,7 @@ export interface CustomizationIdsWrapper {
|
|
|
593
570
|
*/
|
|
594
571
|
customizationIds?: string[];
|
|
595
572
|
}
|
|
596
|
-
|
|
573
|
+
interface AddCustomizationChoicesRequest {
|
|
597
574
|
/**
|
|
598
575
|
* Customization ID.
|
|
599
576
|
* @format GUID
|
|
@@ -613,11 +590,11 @@ export interface AddCustomizationChoicesRequest {
|
|
|
613
590
|
*/
|
|
614
591
|
fields?: RequestedFieldsWithLiterals[];
|
|
615
592
|
}
|
|
616
|
-
|
|
593
|
+
interface AddCustomizationChoicesResponse {
|
|
617
594
|
/** Updated customization. */
|
|
618
595
|
customization?: Customization;
|
|
619
596
|
}
|
|
620
|
-
|
|
597
|
+
interface SetCustomizationChoicesRequest {
|
|
621
598
|
/**
|
|
622
599
|
* Customization ID.
|
|
623
600
|
* @format GUID
|
|
@@ -637,11 +614,11 @@ export interface SetCustomizationChoicesRequest {
|
|
|
637
614
|
*/
|
|
638
615
|
fields?: RequestedFieldsWithLiterals[];
|
|
639
616
|
}
|
|
640
|
-
|
|
617
|
+
interface SetCustomizationChoicesResponse {
|
|
641
618
|
/** Updated customization. */
|
|
642
619
|
customization?: Customization;
|
|
643
620
|
}
|
|
644
|
-
|
|
621
|
+
interface RemoveCustomizationChoicesRequest {
|
|
645
622
|
/**
|
|
646
623
|
* Customization ID.
|
|
647
624
|
* @format GUID
|
|
@@ -664,11 +641,11 @@ export interface RemoveCustomizationChoicesRequest {
|
|
|
664
641
|
*/
|
|
665
642
|
fields?: RequestedFieldsWithLiterals[];
|
|
666
643
|
}
|
|
667
|
-
|
|
644
|
+
interface RemoveCustomizationChoicesResponse {
|
|
668
645
|
/** Updated customization. */
|
|
669
646
|
customization?: Customization;
|
|
670
647
|
}
|
|
671
|
-
|
|
648
|
+
interface BulkAddCustomizationChoicesRequest {
|
|
672
649
|
/**
|
|
673
650
|
* List of customization IDs and choices.
|
|
674
651
|
* @minSize 1
|
|
@@ -689,7 +666,7 @@ export interface BulkAddCustomizationChoicesRequest {
|
|
|
689
666
|
*/
|
|
690
667
|
fields?: RequestedFieldsWithLiterals[];
|
|
691
668
|
}
|
|
692
|
-
|
|
669
|
+
interface CustomizationChoices {
|
|
693
670
|
/**
|
|
694
671
|
* Customization ID.
|
|
695
672
|
* @minLength 1
|
|
@@ -703,7 +680,7 @@ export interface CustomizationChoices {
|
|
|
703
680
|
*/
|
|
704
681
|
choices?: Choice[];
|
|
705
682
|
}
|
|
706
|
-
|
|
683
|
+
interface BulkAddCustomizationChoicesResponse {
|
|
707
684
|
/**
|
|
708
685
|
* Customizations updated by bulk action.
|
|
709
686
|
* @minSize 1
|
|
@@ -713,7 +690,7 @@ export interface BulkAddCustomizationChoicesResponse {
|
|
|
713
690
|
/** Bulk action metadata. */
|
|
714
691
|
bulkActionMetadata?: BulkActionMetadata;
|
|
715
692
|
}
|
|
716
|
-
|
|
693
|
+
interface BulkUpdateCustomizationsRequest {
|
|
717
694
|
/**
|
|
718
695
|
* List of customizations to update.
|
|
719
696
|
* @minSize 1
|
|
@@ -734,11 +711,11 @@ export interface BulkUpdateCustomizationsRequest {
|
|
|
734
711
|
*/
|
|
735
712
|
fields?: RequestedFieldsWithLiterals[];
|
|
736
713
|
}
|
|
737
|
-
|
|
714
|
+
interface MaskedCustomization {
|
|
738
715
|
/** Customization to update. */
|
|
739
716
|
customization?: Customization;
|
|
740
717
|
}
|
|
741
|
-
|
|
718
|
+
interface BulkUpdateCustomizationsResponse {
|
|
742
719
|
/**
|
|
743
720
|
* Customizations updated by bulk action.
|
|
744
721
|
* @minSize 1
|
|
@@ -748,13 +725,13 @@ export interface BulkUpdateCustomizationsResponse {
|
|
|
748
725
|
/** Bulk action metadata. */
|
|
749
726
|
bulkActionMetadata?: BulkActionMetadata;
|
|
750
727
|
}
|
|
751
|
-
|
|
728
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
752
729
|
createdEvent?: EntityCreatedEvent;
|
|
753
730
|
updatedEvent?: EntityUpdatedEvent;
|
|
754
731
|
deletedEvent?: EntityDeletedEvent;
|
|
755
732
|
actionEvent?: ActionEvent;
|
|
756
733
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
757
|
-
|
|
734
|
+
_id?: string;
|
|
758
735
|
/**
|
|
759
736
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
760
737
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -783,38 +760,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
783
760
|
entityEventSequence?: string | null;
|
|
784
761
|
}
|
|
785
762
|
/** @oneof */
|
|
786
|
-
|
|
763
|
+
interface DomainEventBodyOneOf {
|
|
787
764
|
createdEvent?: EntityCreatedEvent;
|
|
788
765
|
updatedEvent?: EntityUpdatedEvent;
|
|
789
766
|
deletedEvent?: EntityDeletedEvent;
|
|
790
767
|
actionEvent?: ActionEvent;
|
|
791
768
|
}
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
795
|
-
restoreInfo?: RestoreInfo;
|
|
769
|
+
interface EntityCreatedEvent {
|
|
770
|
+
entity?: string;
|
|
796
771
|
}
|
|
797
|
-
|
|
772
|
+
interface RestoreInfo {
|
|
798
773
|
deletedDate?: Date | null;
|
|
799
774
|
}
|
|
800
|
-
|
|
775
|
+
interface EntityUpdatedEvent {
|
|
801
776
|
/**
|
|
802
777
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
803
778
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
804
779
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
805
780
|
*/
|
|
806
|
-
|
|
781
|
+
currentEntity?: string;
|
|
807
782
|
}
|
|
808
|
-
|
|
783
|
+
interface EntityDeletedEvent {
|
|
809
784
|
/** Entity that was deleted. */
|
|
810
|
-
|
|
785
|
+
deletedEntity?: string | null;
|
|
811
786
|
}
|
|
812
|
-
|
|
813
|
-
|
|
787
|
+
interface ActionEvent {
|
|
788
|
+
body?: string;
|
|
814
789
|
}
|
|
815
|
-
|
|
790
|
+
interface Empty {
|
|
816
791
|
}
|
|
817
|
-
|
|
792
|
+
interface MessageEnvelope {
|
|
818
793
|
/**
|
|
819
794
|
* App instance ID.
|
|
820
795
|
* @format GUID
|
|
@@ -830,7 +805,7 @@ export interface MessageEnvelope {
|
|
|
830
805
|
/** Stringify payload. */
|
|
831
806
|
data?: string;
|
|
832
807
|
}
|
|
833
|
-
|
|
808
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
834
809
|
/**
|
|
835
810
|
* ID of a site visitor that has not logged in to the site.
|
|
836
811
|
* @format GUID
|
|
@@ -855,7 +830,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
855
830
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
856
831
|
}
|
|
857
832
|
/** @oneof */
|
|
858
|
-
|
|
833
|
+
interface IdentificationDataIdOneOf {
|
|
859
834
|
/**
|
|
860
835
|
* ID of a site visitor that has not logged in to the site.
|
|
861
836
|
* @format GUID
|
|
@@ -877,7 +852,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
877
852
|
*/
|
|
878
853
|
appId?: string;
|
|
879
854
|
}
|
|
880
|
-
|
|
855
|
+
declare enum WebhookIdentityType {
|
|
881
856
|
UNKNOWN = "UNKNOWN",
|
|
882
857
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
883
858
|
MEMBER = "MEMBER",
|
|
@@ -885,4 +860,298 @@ export declare enum WebhookIdentityType {
|
|
|
885
860
|
APP = "APP"
|
|
886
861
|
}
|
|
887
862
|
/** @enumType */
|
|
888
|
-
|
|
863
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
864
|
+
interface BaseEventMetadata {
|
|
865
|
+
/**
|
|
866
|
+
* App instance ID.
|
|
867
|
+
* @format GUID
|
|
868
|
+
*/
|
|
869
|
+
instanceId?: string | null;
|
|
870
|
+
/**
|
|
871
|
+
* Event type.
|
|
872
|
+
* @maxLength 150
|
|
873
|
+
*/
|
|
874
|
+
eventType?: string;
|
|
875
|
+
/** The identification type and identity data. */
|
|
876
|
+
identity?: IdentificationData;
|
|
877
|
+
}
|
|
878
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
879
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
880
|
+
_id?: string;
|
|
881
|
+
/**
|
|
882
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
883
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
884
|
+
*/
|
|
885
|
+
entityFqdn?: string;
|
|
886
|
+
/**
|
|
887
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
888
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
889
|
+
*/
|
|
890
|
+
slug?: string;
|
|
891
|
+
/** ID of the entity associated with the event. */
|
|
892
|
+
entityId?: string;
|
|
893
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
894
|
+
eventTime?: Date | null;
|
|
895
|
+
/**
|
|
896
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
897
|
+
* (for example, GDPR).
|
|
898
|
+
*/
|
|
899
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
900
|
+
/** If present, indicates the action that triggered the event. */
|
|
901
|
+
originatedFrom?: string | null;
|
|
902
|
+
/**
|
|
903
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
904
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
905
|
+
*/
|
|
906
|
+
entityEventSequence?: string | null;
|
|
907
|
+
}
|
|
908
|
+
interface CustomizationCreatedEnvelope {
|
|
909
|
+
entity: Customization;
|
|
910
|
+
metadata: EventMetadata;
|
|
911
|
+
}
|
|
912
|
+
interface CustomizationDeletedEnvelope {
|
|
913
|
+
entity: Customization;
|
|
914
|
+
metadata: EventMetadata;
|
|
915
|
+
}
|
|
916
|
+
interface CustomizationUpdatedEnvelope {
|
|
917
|
+
entity: Customization;
|
|
918
|
+
metadata: EventMetadata;
|
|
919
|
+
}
|
|
920
|
+
interface GetCustomizationOptions {
|
|
921
|
+
/**
|
|
922
|
+
* Fields to include in the response.
|
|
923
|
+
*
|
|
924
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
925
|
+
* @maxSize 100
|
|
926
|
+
*/
|
|
927
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
928
|
+
}
|
|
929
|
+
interface UpdateCustomization {
|
|
930
|
+
/**
|
|
931
|
+
* Free text input settings.
|
|
932
|
+
*
|
|
933
|
+
* > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
|
|
934
|
+
* @immutable
|
|
935
|
+
*/
|
|
936
|
+
freeTextInput?: FreeTextSettings;
|
|
937
|
+
/**
|
|
938
|
+
* Choices settings.
|
|
939
|
+
*
|
|
940
|
+
* > **Note:** Must be passed along with `customizationRenderType` of `SWATCH_CHOICES` and `TEXT_CHOICES`.
|
|
941
|
+
*/
|
|
942
|
+
choicesSettings?: ChoicesSettings;
|
|
943
|
+
/**
|
|
944
|
+
* Customization ID.
|
|
945
|
+
* @minLength 1
|
|
946
|
+
* @maxLength 36
|
|
947
|
+
* @readonly
|
|
948
|
+
*/
|
|
949
|
+
_id?: string | null;
|
|
950
|
+
/**
|
|
951
|
+
* Revision number, which increments by 1 each time the customization is updated.
|
|
952
|
+
* To prevent conflicting changes,
|
|
953
|
+
* the current revision must be passed when updating the customization.
|
|
954
|
+
*
|
|
955
|
+
* Ignored when creating a customization.
|
|
956
|
+
* @readonly
|
|
957
|
+
*/
|
|
958
|
+
revision?: string | null;
|
|
959
|
+
/**
|
|
960
|
+
* Date and time the customization was created.
|
|
961
|
+
* @readonly
|
|
962
|
+
*/
|
|
963
|
+
_createdDate?: Date | null;
|
|
964
|
+
/**
|
|
965
|
+
* Date and time the customization was updated.
|
|
966
|
+
* @readonly
|
|
967
|
+
*/
|
|
968
|
+
_updatedDate?: Date | null;
|
|
969
|
+
/**
|
|
970
|
+
* Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
|
|
971
|
+
* @minLength 1
|
|
972
|
+
* @maxLength 50
|
|
973
|
+
*/
|
|
974
|
+
name?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Customization type.
|
|
977
|
+
* @immutable
|
|
978
|
+
*/
|
|
979
|
+
customizationType?: CustomizationTypeWithLiterals;
|
|
980
|
+
/**
|
|
981
|
+
* Customization render type.
|
|
982
|
+
*
|
|
983
|
+
* Defines how the customization will be displayed in the storefront.
|
|
984
|
+
* @immutable
|
|
985
|
+
*/
|
|
986
|
+
customizationRenderType?: CustomizationRenderTypeWithLiterals;
|
|
987
|
+
/**
|
|
988
|
+
* Number of products this customization is assigned to.
|
|
989
|
+
* > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Customizations API requests.
|
|
990
|
+
* @readonly
|
|
991
|
+
*/
|
|
992
|
+
assignedProductsCount?: number | null;
|
|
993
|
+
}
|
|
994
|
+
interface UpdateCustomizationOptions {
|
|
995
|
+
/**
|
|
996
|
+
* Fields to include in the response.
|
|
997
|
+
*
|
|
998
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
999
|
+
* @maxSize 100
|
|
1000
|
+
*/
|
|
1001
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1002
|
+
}
|
|
1003
|
+
interface QueryCustomizationsOptions {
|
|
1004
|
+
/**
|
|
1005
|
+
* Fields to include in the response.
|
|
1006
|
+
*
|
|
1007
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1008
|
+
* @maxSize 100
|
|
1009
|
+
*/
|
|
1010
|
+
fields?: RequestedFieldsWithLiterals[] | undefined;
|
|
1011
|
+
}
|
|
1012
|
+
interface QueryCursorResult {
|
|
1013
|
+
cursors: Cursors;
|
|
1014
|
+
hasNext: () => boolean;
|
|
1015
|
+
hasPrev: () => boolean;
|
|
1016
|
+
length: number;
|
|
1017
|
+
pageSize: number;
|
|
1018
|
+
}
|
|
1019
|
+
interface CustomizationsQueryResult extends QueryCursorResult {
|
|
1020
|
+
items: Customization[];
|
|
1021
|
+
query: CustomizationsQueryBuilder;
|
|
1022
|
+
next: () => Promise<CustomizationsQueryResult>;
|
|
1023
|
+
prev: () => Promise<CustomizationsQueryResult>;
|
|
1024
|
+
}
|
|
1025
|
+
interface CustomizationsQueryBuilder {
|
|
1026
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1027
|
+
* @param value - Value to compare against.
|
|
1028
|
+
* @documentationMaturity preview
|
|
1029
|
+
*/
|
|
1030
|
+
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1031
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1032
|
+
* @param value - Value to compare against.
|
|
1033
|
+
* @documentationMaturity preview
|
|
1034
|
+
*/
|
|
1035
|
+
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1036
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1037
|
+
* @param value - Value to compare against.
|
|
1038
|
+
* @documentationMaturity preview
|
|
1039
|
+
*/
|
|
1040
|
+
ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1041
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1042
|
+
* @param value - Value to compare against.
|
|
1043
|
+
* @documentationMaturity preview
|
|
1044
|
+
*/
|
|
1045
|
+
gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1046
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1047
|
+
* @param value - Value to compare against.
|
|
1048
|
+
* @documentationMaturity preview
|
|
1049
|
+
*/
|
|
1050
|
+
le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1051
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1052
|
+
* @param value - Value to compare against.
|
|
1053
|
+
* @documentationMaturity preview
|
|
1054
|
+
*/
|
|
1055
|
+
lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
|
|
1056
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1057
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1058
|
+
* @documentationMaturity preview
|
|
1059
|
+
*/
|
|
1060
|
+
startsWith: (propertyName: '_id' | 'name', value: string) => CustomizationsQueryBuilder;
|
|
1061
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1062
|
+
* @param values - List of values to compare against.
|
|
1063
|
+
* @documentationMaturity preview
|
|
1064
|
+
*/
|
|
1065
|
+
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any[]) => CustomizationsQueryBuilder;
|
|
1066
|
+
/** @documentationMaturity preview */
|
|
1067
|
+
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
|
|
1068
|
+
/** @documentationMaturity preview */
|
|
1069
|
+
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: boolean) => CustomizationsQueryBuilder;
|
|
1070
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1071
|
+
* @documentationMaturity preview
|
|
1072
|
+
*/
|
|
1073
|
+
ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
|
|
1074
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1075
|
+
* @documentationMaturity preview
|
|
1076
|
+
*/
|
|
1077
|
+
descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
|
|
1078
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1079
|
+
* @documentationMaturity preview
|
|
1080
|
+
*/
|
|
1081
|
+
limit: (limit: number) => CustomizationsQueryBuilder;
|
|
1082
|
+
/** @param cursor - A pointer to specific record
|
|
1083
|
+
* @documentationMaturity preview
|
|
1084
|
+
*/
|
|
1085
|
+
skipTo: (cursor: string) => CustomizationsQueryBuilder;
|
|
1086
|
+
/** @documentationMaturity preview */
|
|
1087
|
+
find: () => Promise<CustomizationsQueryResult>;
|
|
1088
|
+
}
|
|
1089
|
+
interface BulkCreateCustomizationsOptions {
|
|
1090
|
+
/**
|
|
1091
|
+
* Whether to return the full customization entities in the response.
|
|
1092
|
+
*
|
|
1093
|
+
* Default: `false`
|
|
1094
|
+
*/
|
|
1095
|
+
returnEntity?: boolean;
|
|
1096
|
+
}
|
|
1097
|
+
interface AddCustomizationChoicesOptions {
|
|
1098
|
+
/**
|
|
1099
|
+
* Fields to include in the response.
|
|
1100
|
+
*
|
|
1101
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1102
|
+
* @maxSize 100
|
|
1103
|
+
*/
|
|
1104
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1105
|
+
}
|
|
1106
|
+
interface SetCustomizationChoicesOptions {
|
|
1107
|
+
/**
|
|
1108
|
+
* Fields to include in the response.
|
|
1109
|
+
*
|
|
1110
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1111
|
+
* @maxSize 100
|
|
1112
|
+
*/
|
|
1113
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1114
|
+
}
|
|
1115
|
+
interface RemoveCustomizationChoicesOptions {
|
|
1116
|
+
/** Customization revision. */
|
|
1117
|
+
revision?: string;
|
|
1118
|
+
/**
|
|
1119
|
+
* Fields to include in the response.
|
|
1120
|
+
*
|
|
1121
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1122
|
+
* @maxSize 100
|
|
1123
|
+
*/
|
|
1124
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1125
|
+
}
|
|
1126
|
+
interface BulkAddCustomizationChoicesOptions {
|
|
1127
|
+
/**
|
|
1128
|
+
* Whether to return the full customization entities in the response.
|
|
1129
|
+
*
|
|
1130
|
+
* Default: `false`
|
|
1131
|
+
*/
|
|
1132
|
+
returnEntity?: boolean;
|
|
1133
|
+
/**
|
|
1134
|
+
* Fields to include in the response.
|
|
1135
|
+
*
|
|
1136
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1137
|
+
* @maxSize 100
|
|
1138
|
+
*/
|
|
1139
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1140
|
+
}
|
|
1141
|
+
interface BulkUpdateCustomizationsOptions {
|
|
1142
|
+
/**
|
|
1143
|
+
* Whether to return the full customization entities in the response.
|
|
1144
|
+
*
|
|
1145
|
+
* Default: `false`
|
|
1146
|
+
*/
|
|
1147
|
+
returnEntity?: boolean;
|
|
1148
|
+
/**
|
|
1149
|
+
* Fields to include in the response.
|
|
1150
|
+
*
|
|
1151
|
+
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
1152
|
+
* @maxSize 100
|
|
1153
|
+
*/
|
|
1154
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
export { type CursorQueryPagingMethodOneOf as $, type AddCustomizationChoicesOptions as A, type BulkCreateCustomizationsOptions as B, type Customization as C, type App as D, type URI as E, type FreeTextSettings as F, type GetCustomizationOptions as G, type File as H, type InvalidateCache as I, type CustomTag as J, type CreateCustomizationRequest as K, type CreateCustomizationResponse as L, type MaskedCustomization as M, type GetCustomizationRequest as N, type GetCustomizationResponse as O, type Page as P, type QueryCustomizationsOptions as Q, type RemoveCustomizationChoicesOptions as R, type SetCustomizationChoicesOptions as S, type UpdateCustomizationRequest as T, type UpdateCustomization as U, type UpdateCustomizationResponse as V, WebhookIdentityType as W, type DeleteCustomizationRequest as X, type DeleteCustomizationResponse as Y, type QueryCustomizationsRequest as Z, type CursorQuery as _, type UpdateCustomizationOptions as a, type Sorting as a0, type CursorPaging as a1, type QueryCustomizationsResponse as a2, type CursorPagingMetadata as a3, type Cursors as a4, type BulkCreateCustomizationsRequest as a5, type BulkCustomizationResult as a6, type ItemMetadata as a7, type ApplicationError as a8, type BulkActionMetadata as a9, type CustomizationIdsWrapper as aa, type AddCustomizationChoicesRequest as ab, type SetCustomizationChoicesRequest as ac, type RemoveCustomizationChoicesRequest as ad, type BulkAddCustomizationChoicesRequest as ae, type BulkUpdateCustomizationsRequest as af, type DomainEvent as ag, type DomainEventBodyOneOf as ah, type EntityCreatedEvent as ai, type RestoreInfo as aj, type EntityUpdatedEvent as ak, type EntityDeletedEvent as al, type ActionEvent as am, type Empty as an, type MessageEnvelope as ao, type IdentificationData as ap, type IdentificationDataIdOneOf as aq, type BaseEventMetadata as ar, type EventMetadata as as, type CustomizationsQueryResult as at, type CustomizationsQueryBuilder as b, type BulkCreateCustomizationsResponse as c, type Choice as d, type AddCustomizationChoicesResponse as e, type SetCustomizationChoicesResponse as f, type RemoveCustomizationChoicesResponse as g, type CustomizationChoices as h, type BulkAddCustomizationChoicesOptions as i, type BulkAddCustomizationChoicesResponse as j, type BulkUpdateCustomizationsOptions as k, type BulkUpdateCustomizationsResponse as l, type CustomizationCreatedEnvelope as m, type CustomizationDeletedEnvelope as n, type CustomizationUpdatedEnvelope as o, CustomizationType as p, CustomizationRenderType as q, ChoiceType as r, RequestedFields as s, SortOrder as t, type CustomizationCustomizationSettingsOneOf as u, type ChoicesSettings as v, type ChoiceValueOneOf as w, type MultipleColors as x, type FocalPoint as y, type InvalidateCacheGetByOneOf as z };
|