@wix/auto_sdk_stores_customizations-v-3 1.0.16 → 1.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/index.d.mts +154 -0
  2. package/build/index.d.ts +154 -0
  3. package/build/index.js +1389 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1346 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +154 -0
  8. package/build/internal/index.d.ts +154 -0
  9. package/build/internal/index.js +1389 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1346 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/internal/meta.d.mts +619 -0
  14. package/build/internal/meta.d.ts +619 -0
  15. package/build/internal/meta.js +873 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +836 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. 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
  20. 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
  21. package/build/meta.d.mts +619 -0
  22. package/build/meta.d.ts +619 -0
  23. package/build/meta.js +873 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +836 -0
  26. package/build/meta.mjs.map +1 -0
  27. 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
  28. 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
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  40. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
  41. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  42. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  43. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
  44. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  45. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  46. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
  47. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  48. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  49. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
  50. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  51. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
  52. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  53. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  54. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
  55. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  67. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
  68. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  69. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  70. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
  71. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  72. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  73. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
  74. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  75. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  76. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
  77. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  78. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
  79. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  80. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  81. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
  82. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  93. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -40
  94. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  95. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  96. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -683
  97. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  98. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  99. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -237
  100. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  101. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  102. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -126
  103. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  104. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -54
  105. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  106. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  107. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -819
  108. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.d.ts +0 -31
  119. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js +0 -31
  120. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.context.js.map +0 -1
  121. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.d.ts +0 -63
  122. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js +0 -669
  123. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.http.js.map +0 -1
  124. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.d.ts +0 -35
  125. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js +0 -200
  126. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.meta.js.map +0 -1
  127. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.d.ts +0 -130
  128. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js +0 -106
  129. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.public.js.map +0 -1
  130. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js +0 -51
  131. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +0 -1
  132. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +0 -1588
  133. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +0 -782
  134. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +0 -1
@@ -1,1588 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * Customizations include options and modifiers which can later be applied to products.
4
- * Options are designed to add variations to a product, where modifiers add a customizable change to the product but without creating another variant.
5
- */
6
- export interface Customization extends CustomizationCustomizationSettingsOneOf {
7
- /**
8
- * Free text input settings.
9
- *
10
- * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
11
- * @immutable
12
- */
13
- freeTextInput?: FreeTextSettings;
14
- /**
15
- * Choices settings.
16
- *
17
- * > **Note:** Must be passed along with `customizationRenderType` of `SWATCH_CHOICES` and `TEXT_CHOICES`.
18
- */
19
- choicesSettings?: ChoicesSettings;
20
- /**
21
- * Customization ID.
22
- * @minLength 1
23
- * @maxLength 36
24
- * @readonly
25
- */
26
- _id?: string | null;
27
- /**
28
- * Revision number, which increments by 1 each time the customization is updated.
29
- * To prevent conflicting changes,
30
- * the current revision must be passed when updating the customization.
31
- *
32
- * Ignored when creating a customization.
33
- * @readonly
34
- */
35
- revision?: string | null;
36
- /**
37
- * Date and time the customization was created.
38
- * @readonly
39
- */
40
- _createdDate?: Date | null;
41
- /**
42
- * Date and time the customization was updated.
43
- * @readonly
44
- */
45
- _updatedDate?: Date | null;
46
- /**
47
- * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
48
- * @minLength 1
49
- * @maxLength 50
50
- */
51
- name?: string;
52
- /**
53
- * Customization type.
54
- * @immutable
55
- */
56
- customizationType?: CustomizationTypeWithLiterals;
57
- /**
58
- * Customization render type.
59
- *
60
- * Defines how the customization will be displayed in the storefront.
61
- * @immutable
62
- */
63
- customizationRenderType?: CustomizationRenderTypeWithLiterals;
64
- /**
65
- * Number of products this customization is assigned to.
66
- * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Customizations API requests.
67
- * @readonly
68
- */
69
- assignedProductsCount?: number | null;
70
- }
71
- /** @oneof */
72
- export interface CustomizationCustomizationSettingsOneOf {
73
- /**
74
- * Free text input settings.
75
- *
76
- * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
77
- * @immutable
78
- */
79
- freeTextInput?: FreeTextSettings;
80
- /**
81
- * Choices settings.
82
- *
83
- * > **Note:** Must be passed along with `customizationRenderType` of `SWATCH_CHOICES` and `TEXT_CHOICES`.
84
- */
85
- choicesSettings?: ChoicesSettings;
86
- }
87
- export declare enum CustomizationType {
88
- UNKNOWN_CUSTOMIZATION_TYPE = "UNKNOWN_CUSTOMIZATION_TYPE",
89
- PRODUCT_OPTION = "PRODUCT_OPTION",
90
- MODIFIER = "MODIFIER"
91
- }
92
- /** @enumType */
93
- export type CustomizationTypeWithLiterals = CustomizationType | 'UNKNOWN_CUSTOMIZATION_TYPE' | 'PRODUCT_OPTION' | 'MODIFIER';
94
- export declare enum CustomizationRenderType {
95
- UNKNOWN_CUSTOMIZATION_RENDER_TYPE = "UNKNOWN_CUSTOMIZATION_RENDER_TYPE",
96
- /** Customization by free text input. */
97
- FREE_TEXT = "FREE_TEXT",
98
- /** Customization by selection of text choices. */
99
- TEXT_CHOICES = "TEXT_CHOICES",
100
- /** Customization by selection of colors. */
101
- SWATCH_CHOICES = "SWATCH_CHOICES"
102
- }
103
- /** @enumType */
104
- export type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'UNKNOWN_CUSTOMIZATION_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
105
- export interface FreeTextSettings {
106
- /** Minimum text character length. */
107
- minCharCount?: number;
108
- /**
109
- * Maximum text character length.
110
- * @max 500
111
- */
112
- maxCharCount?: number;
113
- /**
114
- * Default amount added to a product's price when this choice is assigned to a modifier.
115
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
116
- */
117
- defaultAddedPrice?: string | null;
118
- /**
119
- * Title to display to customer for their free-text input.
120
- * @minLength 1
121
- * @maxLength 100
122
- */
123
- title?: string;
124
- }
125
- export interface ChoicesSettings {
126
- /**
127
- * List of choices.
128
- * @minSize 1
129
- * @maxSize 200
130
- * @immutable
131
- */
132
- choices?: Choice[];
133
- }
134
- export interface Choice extends ChoiceValueOneOf {
135
- /**
136
- * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
137
- * @minLength 3
138
- * @maxLength 20
139
- * @format COLOR_HEX
140
- */
141
- colorCode?: string;
142
- /**
143
- * Choice ID.
144
- * @format GUID
145
- * @readonly
146
- */
147
- _id?: string;
148
- /**
149
- * Choice type.
150
- *
151
- * > **Notes:**
152
- * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` values are: `ONE_COLOR`, `MULTIPLE_COLORS`, or `IMAGE`.
153
- * > + For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`, the supported `choiceType` value is: `CHOICE_TEXT`.
154
- * @immutable
155
- */
156
- choiceType?: ChoiceTypeWithLiterals;
157
- /**
158
- * A read-only key generated based on choice name. Used for eCommerce integration.
159
- * @readonly
160
- * @minLength 1
161
- * @maxLength 50
162
- */
163
- key?: string | null;
164
- /**
165
- * Choice name.
166
- * @minLength 1
167
- * @maxLength 50
168
- */
169
- name?: string;
170
- /**
171
- * Default amount added to a product's price when this customization is assigned to a modifier.
172
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
173
- */
174
- defaultAddedPrice?: string | null;
175
- /**
176
- * Number of products this choice is assigned to .
177
- * @readonly
178
- */
179
- assignedProductsCount?: number;
180
- }
181
- /** @oneof */
182
- export interface ChoiceValueOneOf {
183
- /**
184
- * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
185
- * @minLength 3
186
- * @maxLength 20
187
- * @format COLOR_HEX
188
- */
189
- colorCode?: string;
190
- }
191
- export declare enum ChoiceType {
192
- UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
193
- /** For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`. */
194
- CHOICE_TEXT = "CHOICE_TEXT",
195
- /** For `customizationRenderType: SWATCH_CHOICES`. */
196
- ONE_COLOR = "ONE_COLOR",
197
- /** For `customizationRenderType: SWATCH_CHOICES`. */
198
- MULTIPLE_COLORS = "MULTIPLE_COLORS",
199
- /** For `customizationRenderType: SWATCH_CHOICES`. */
200
- IMAGE = "IMAGE"
201
- }
202
- /** @enumType */
203
- export type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
204
- export interface MultipleColors {
205
- /**
206
- * A list of color codes.
207
- * @minLength 3
208
- * @maxLength 20
209
- * @minSize 2
210
- * @maxSize 2
211
- */
212
- colorCodes?: string[];
213
- }
214
- export interface FocalPoint {
215
- /** X-coordinate of the focal point. */
216
- x?: number;
217
- /** Y-coordinate of the focal point. */
218
- y?: number;
219
- /** crop by height */
220
- height?: number | null;
221
- /** crop by width */
222
- width?: number | null;
223
- }
224
- export interface InvalidateCache extends InvalidateCacheGetByOneOf {
225
- /**
226
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
227
- * @format GUID
228
- */
229
- metaSiteId?: string;
230
- /**
231
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
232
- * @format GUID
233
- */
234
- siteId?: string;
235
- /** Invalidate by App */
236
- app?: App;
237
- /** Invalidate by page id */
238
- page?: Page;
239
- /** Invalidate by URI path */
240
- uri?: URI;
241
- /** Invalidate by file (for media files such as PDFs) */
242
- file?: File;
243
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
244
- customTag?: CustomTag;
245
- /**
246
- * tell us why you're invalidating the cache. You don't need to add your app name
247
- * @maxLength 256
248
- */
249
- reason?: string | null;
250
- /** Is local DS */
251
- localDc?: boolean;
252
- hardPurge?: boolean;
253
- }
254
- /** @oneof */
255
- export interface InvalidateCacheGetByOneOf {
256
- /**
257
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
258
- * @format GUID
259
- */
260
- metaSiteId?: string;
261
- /**
262
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
263
- * @format GUID
264
- */
265
- siteId?: string;
266
- /** Invalidate by App */
267
- app?: App;
268
- /** Invalidate by page id */
269
- page?: Page;
270
- /** Invalidate by URI path */
271
- uri?: URI;
272
- /** Invalidate by file (for media files such as PDFs) */
273
- file?: File;
274
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
275
- customTag?: CustomTag;
276
- }
277
- export interface App {
278
- /**
279
- * The AppDefId
280
- * @minLength 1
281
- */
282
- appDefId?: string;
283
- /**
284
- * The instance Id
285
- * @format GUID
286
- */
287
- instanceId?: string;
288
- }
289
- export interface Page {
290
- /**
291
- * the msid the page is on
292
- * @format GUID
293
- */
294
- metaSiteId?: string;
295
- /**
296
- * Invalidate by Page ID
297
- * @minLength 1
298
- */
299
- pageId?: string;
300
- }
301
- export interface URI {
302
- /**
303
- * the msid the URI is on
304
- * @format GUID
305
- */
306
- metaSiteId?: string;
307
- /**
308
- * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
309
- * @minLength 1
310
- */
311
- uriPath?: string;
312
- }
313
- export interface File {
314
- /**
315
- * the msid the file is related to
316
- * @format GUID
317
- */
318
- metaSiteId?: string;
319
- /**
320
- * Invalidate by filename (for media files such as PDFs)
321
- * @minLength 1
322
- * @maxLength 256
323
- */
324
- fileName?: string;
325
- }
326
- export interface CustomTag {
327
- /**
328
- * the msid the tag is related to
329
- * @format GUID
330
- */
331
- metaSiteId?: string;
332
- /**
333
- * Tag to invalidate by
334
- * @minLength 1
335
- * @maxLength 256
336
- */
337
- tag?: string;
338
- }
339
- export interface CreateCustomizationRequest {
340
- /** Customization to create. */
341
- customization: Customization;
342
- }
343
- export interface CreateCustomizationResponse {
344
- /** Created customization. */
345
- customization?: Customization;
346
- }
347
- export interface GetCustomizationRequest {
348
- /**
349
- * Customization ID.
350
- * @format GUID
351
- */
352
- customizationId: string;
353
- /**
354
- * Fields to include in the response.
355
- *
356
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
357
- * @maxSize 100
358
- */
359
- fields?: RequestedFieldsWithLiterals[];
360
- }
361
- export declare enum RequestedFields {
362
- /** Unknown requested field. */
363
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
364
- /** Assigned products count. */
365
- ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
366
- }
367
- /** @enumType */
368
- export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'ASSIGNED_PRODUCTS_COUNT';
369
- export interface GetCustomizationResponse {
370
- /** Customization. */
371
- customization?: Customization;
372
- }
373
- export interface UpdateCustomizationRequest {
374
- /** Customization to update. */
375
- customization: Customization;
376
- /**
377
- * Fields to include in the response.
378
- *
379
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
380
- * @maxSize 100
381
- */
382
- fields?: RequestedFieldsWithLiterals[];
383
- }
384
- export interface UpdateCustomizationResponse {
385
- /** Updated customization. */
386
- customization?: Customization;
387
- }
388
- export interface DeleteCustomizationRequest {
389
- /**
390
- * Customization ID.
391
- * @format GUID
392
- */
393
- customizationId: string;
394
- }
395
- export interface DeleteCustomizationResponse {
396
- }
397
- export interface QueryCustomizationsRequest {
398
- /** Query options. */
399
- query?: CursorQuery;
400
- /**
401
- * Fields to include in the response.
402
- *
403
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
404
- * @maxSize 100
405
- */
406
- fields?: RequestedFieldsWithLiterals[];
407
- }
408
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
409
- /** 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`. */
410
- cursorPaging?: CursorPaging;
411
- /**
412
- * Filter object in the following format:
413
- * `"filter" : {
414
- * "fieldName1": "value1",
415
- * "fieldName2":{"$operator":"value2"}
416
- * }`
417
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
418
- */
419
- filter?: Record<string, any> | null;
420
- /**
421
- * Sort object in the following format:
422
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
423
- * @maxSize 5
424
- */
425
- sort?: Sorting[];
426
- }
427
- /** @oneof */
428
- export interface CursorQueryPagingMethodOneOf {
429
- /** 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`. */
430
- cursorPaging?: CursorPaging;
431
- }
432
- export interface Sorting {
433
- /**
434
- * Name of the field to sort by.
435
- * @maxLength 512
436
- */
437
- fieldName?: string;
438
- /** Sort order. */
439
- order?: SortOrderWithLiterals;
440
- }
441
- export declare enum SortOrder {
442
- /** Ascending order. */
443
- ASC = "ASC",
444
- /** Descending order. */
445
- DESC = "DESC"
446
- }
447
- /** @enumType */
448
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
449
- export interface CursorPaging {
450
- /**
451
- * Maximum number of items to return in the results.
452
- * @max 100
453
- */
454
- limit?: number | null;
455
- /**
456
- * Pointer to the next or previous page in the list of results.
457
- *
458
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
459
- * Not relevant for the first request.
460
- * @maxLength 16000
461
- */
462
- cursor?: string | null;
463
- }
464
- export interface QueryCustomizationsResponse {
465
- /**
466
- * List of customizations.
467
- * @minSize 1
468
- * @maxSize 200
469
- */
470
- customizations?: Customization[];
471
- /** Details on the paged set of results returned. */
472
- pagingMetadata?: CursorPagingMetadata;
473
- }
474
- export interface CursorPagingMetadata {
475
- /** Number of items returned in the response. */
476
- count?: number | null;
477
- /** Cursor strings that point to the next page, previous page, or both. */
478
- cursors?: Cursors;
479
- /**
480
- * Whether there are more pages to retrieve following the current page.
481
- *
482
- * + `true`: Another page of results can be retrieved.
483
- * + `false`: This is the last page.
484
- */
485
- hasNext?: boolean | null;
486
- }
487
- export interface Cursors {
488
- /**
489
- * Cursor string pointing to the next page in the list of results.
490
- * @maxLength 16000
491
- */
492
- next?: string | null;
493
- /**
494
- * Cursor pointing to the previous page in the list of results.
495
- * @maxLength 16000
496
- */
497
- prev?: string | null;
498
- }
499
- export interface BulkCreateCustomizationsRequest {
500
- /**
501
- * Customizations to create.
502
- * @minSize 1
503
- * @maxSize 100
504
- */
505
- customizations: Customization[];
506
- /**
507
- * Whether to return the full customization entities in the response.
508
- *
509
- * Default: `false`
510
- */
511
- returnEntity?: boolean;
512
- }
513
- export interface BulkCreateCustomizationsResponse {
514
- /**
515
- * Customizations created by bulk action.
516
- * @minSize 1
517
- * @maxSize 100
518
- */
519
- results?: BulkCustomizationResult[];
520
- /** Bulk action metadata. */
521
- bulkActionMetadata?: BulkActionMetadata;
522
- }
523
- export interface BulkCustomizationResult {
524
- /** Bulk action metadata for customization. */
525
- itemMetadata?: ItemMetadata;
526
- /**
527
- * Full customization entity.
528
- *
529
- * Returned only if `returnEntity: true` is passed in the request.
530
- */
531
- customization?: Customization;
532
- }
533
- export interface ItemMetadata {
534
- /**
535
- * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
536
- * @minLength 1
537
- * @maxLength 36
538
- */
539
- _id?: string | null;
540
- /** Index of the item within the request array. Allows for correlation between request and response items. */
541
- originalIndex?: number;
542
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
543
- success?: boolean;
544
- /** Details about the error in case of failure. */
545
- error?: ApplicationError;
546
- }
547
- export interface ApplicationError {
548
- /** Error code. */
549
- code?: string;
550
- /** Description of the error. */
551
- description?: string;
552
- /** Data related to the error. */
553
- data?: Record<string, any> | null;
554
- }
555
- export interface BulkActionMetadata {
556
- /** Number of items that were successfully processed. */
557
- totalSuccesses?: number;
558
- /** Number of items that couldn't be processed. */
559
- totalFailures?: number;
560
- /** Number of failures without details because detailed failure threshold was exceeded. */
561
- undetailedFailures?: number;
562
- }
563
- export interface CustomizationIdsWrapper {
564
- /**
565
- * list of all the customization ids that are invalid
566
- * e.g list of failed choices ids
567
- * @minSize 1
568
- * @maxSize 100
569
- * @minLength 1
570
- * @maxLength 36
571
- */
572
- customizationIds?: string[];
573
- }
574
- export interface AddCustomizationChoicesRequest {
575
- /**
576
- * Customization ID.
577
- * @format GUID
578
- */
579
- customizationId: string;
580
- /**
581
- * Choices to add.
582
- * @minSize 1
583
- * @maxSize 100
584
- */
585
- choices: Choice[];
586
- /**
587
- * Fields to include in the response.
588
- *
589
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
590
- * @maxSize 100
591
- */
592
- fields?: RequestedFieldsWithLiterals[];
593
- }
594
- export interface AddCustomizationChoicesResponse {
595
- /** Updated customization. */
596
- customization?: Customization;
597
- }
598
- export interface SetCustomizationChoicesRequest {
599
- /**
600
- * Customization ID.
601
- * @format GUID
602
- */
603
- customizationId: string;
604
- /**
605
- * Choices to set.
606
- * @minSize 1
607
- * @maxSize 100
608
- */
609
- choices: Choice[];
610
- /**
611
- * Fields to include in the response.
612
- *
613
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
614
- * @maxSize 100
615
- */
616
- fields?: RequestedFieldsWithLiterals[];
617
- }
618
- export interface SetCustomizationChoicesResponse {
619
- /** Updated customization. */
620
- customization?: Customization;
621
- }
622
- export interface RemoveCustomizationChoicesRequest {
623
- /**
624
- * Customization ID.
625
- * @format GUID
626
- */
627
- customizationId: string;
628
- /**
629
- * IDs of choices to remove.
630
- * @format GUID
631
- * @minSize 1
632
- * @maxSize 100
633
- */
634
- choiceIds: string[];
635
- /** Customization revision. */
636
- revision?: string;
637
- /**
638
- * Fields to include in the response.
639
- *
640
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
641
- * @maxSize 100
642
- */
643
- fields?: RequestedFieldsWithLiterals[];
644
- }
645
- export interface RemoveCustomizationChoicesResponse {
646
- /** Updated customization. */
647
- customization?: Customization;
648
- }
649
- export interface BulkAddCustomizationChoicesRequest {
650
- /**
651
- * List of customization IDs and choices.
652
- * @minSize 1
653
- * @maxSize 100
654
- */
655
- customizationsChoices: CustomizationChoices[];
656
- /**
657
- * Whether to return the full customization entities in the response.
658
- *
659
- * Default: `false`
660
- */
661
- returnEntity?: boolean;
662
- /**
663
- * Fields to include in the response.
664
- *
665
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
666
- * @maxSize 100
667
- */
668
- fields?: RequestedFieldsWithLiterals[];
669
- }
670
- export interface CustomizationChoices {
671
- /**
672
- * Customization ID.
673
- * @minLength 1
674
- * @maxLength 36
675
- */
676
- customizationId?: string;
677
- /**
678
- * Choices to add.
679
- * @minSize 1
680
- * @maxSize 100
681
- */
682
- choices?: Choice[];
683
- }
684
- export interface BulkAddCustomizationChoicesResponse {
685
- /**
686
- * Customizations updated by bulk action.
687
- * @minSize 1
688
- * @maxSize 100
689
- */
690
- results?: BulkCustomizationResult[];
691
- /** Bulk action metadata. */
692
- bulkActionMetadata?: BulkActionMetadata;
693
- }
694
- export interface BulkUpdateCustomizationsRequest {
695
- /**
696
- * List of customizations to update.
697
- * @minSize 1
698
- * @maxSize 100
699
- */
700
- customizations: MaskedCustomization[];
701
- /**
702
- * Whether to return the full customization entities in the response.
703
- *
704
- * Default: `false`
705
- */
706
- returnEntity?: boolean;
707
- /**
708
- * Fields to include in the response.
709
- *
710
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
711
- * @maxSize 100
712
- */
713
- fields?: RequestedFieldsWithLiterals[];
714
- }
715
- export interface MaskedCustomization {
716
- /** Customization to update. */
717
- customization?: Customization;
718
- }
719
- export interface BulkUpdateCustomizationsResponse {
720
- /**
721
- * Customizations updated by bulk action.
722
- * @minSize 1
723
- * @maxSize 100
724
- */
725
- results?: BulkCustomizationResult[];
726
- /** Bulk action metadata. */
727
- bulkActionMetadata?: BulkActionMetadata;
728
- }
729
- export interface DomainEvent extends DomainEventBodyOneOf {
730
- createdEvent?: EntityCreatedEvent;
731
- updatedEvent?: EntityUpdatedEvent;
732
- deletedEvent?: EntityDeletedEvent;
733
- actionEvent?: ActionEvent;
734
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
735
- _id?: string;
736
- /**
737
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
738
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
739
- */
740
- entityFqdn?: string;
741
- /**
742
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
743
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
744
- */
745
- slug?: string;
746
- /** ID of the entity associated with the event. */
747
- entityId?: string;
748
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
749
- eventTime?: Date | null;
750
- /**
751
- * Whether the event was triggered as a result of a privacy regulation application
752
- * (for example, GDPR).
753
- */
754
- triggeredByAnonymizeRequest?: boolean | null;
755
- /** If present, indicates the action that triggered the event. */
756
- originatedFrom?: string | null;
757
- /**
758
- * 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.
759
- * 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.
760
- */
761
- entityEventSequence?: string | null;
762
- }
763
- /** @oneof */
764
- export interface DomainEventBodyOneOf {
765
- createdEvent?: EntityCreatedEvent;
766
- updatedEvent?: EntityUpdatedEvent;
767
- deletedEvent?: EntityDeletedEvent;
768
- actionEvent?: ActionEvent;
769
- }
770
- export interface EntityCreatedEvent {
771
- entity?: string;
772
- }
773
- export interface RestoreInfo {
774
- deletedDate?: Date | null;
775
- }
776
- export interface EntityUpdatedEvent {
777
- /**
778
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
779
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
780
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
781
- */
782
- currentEntity?: string;
783
- }
784
- export interface EntityDeletedEvent {
785
- /** Entity that was deleted. */
786
- deletedEntity?: string | null;
787
- }
788
- export interface ActionEvent {
789
- body?: string;
790
- }
791
- export interface Empty {
792
- }
793
- export interface MessageEnvelope {
794
- /**
795
- * App instance ID.
796
- * @format GUID
797
- */
798
- instanceId?: string | null;
799
- /**
800
- * Event type.
801
- * @maxLength 150
802
- */
803
- eventType?: string;
804
- /** The identification type and identity data. */
805
- identity?: IdentificationData;
806
- /** Stringify payload. */
807
- data?: string;
808
- }
809
- export interface IdentificationData extends IdentificationDataIdOneOf {
810
- /**
811
- * ID of a site visitor that has not logged in to the site.
812
- * @format GUID
813
- */
814
- anonymousVisitorId?: string;
815
- /**
816
- * ID of a site visitor that has logged in to the site.
817
- * @format GUID
818
- */
819
- memberId?: string;
820
- /**
821
- * ID of a Wix user (site owner, contributor, etc.).
822
- * @format GUID
823
- */
824
- wixUserId?: string;
825
- /**
826
- * ID of an app.
827
- * @format GUID
828
- */
829
- appId?: string;
830
- /** @readonly */
831
- identityType?: WebhookIdentityTypeWithLiterals;
832
- }
833
- /** @oneof */
834
- export interface IdentificationDataIdOneOf {
835
- /**
836
- * ID of a site visitor that has not logged in to the site.
837
- * @format GUID
838
- */
839
- anonymousVisitorId?: string;
840
- /**
841
- * ID of a site visitor that has logged in to the site.
842
- * @format GUID
843
- */
844
- memberId?: string;
845
- /**
846
- * ID of a Wix user (site owner, contributor, etc.).
847
- * @format GUID
848
- */
849
- wixUserId?: string;
850
- /**
851
- * ID of an app.
852
- * @format GUID
853
- */
854
- appId?: string;
855
- }
856
- export declare enum WebhookIdentityType {
857
- UNKNOWN = "UNKNOWN",
858
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
859
- MEMBER = "MEMBER",
860
- WIX_USER = "WIX_USER",
861
- APP = "APP"
862
- }
863
- /** @enumType */
864
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
865
- export interface BaseEventMetadata {
866
- /**
867
- * App instance ID.
868
- * @format GUID
869
- */
870
- instanceId?: string | null;
871
- /**
872
- * Event type.
873
- * @maxLength 150
874
- */
875
- eventType?: string;
876
- /** The identification type and identity data. */
877
- identity?: IdentificationData;
878
- }
879
- export interface EventMetadata extends BaseEventMetadata {
880
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
881
- _id?: string;
882
- /**
883
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
884
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
885
- */
886
- entityFqdn?: string;
887
- /**
888
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
889
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
890
- */
891
- slug?: string;
892
- /** ID of the entity associated with the event. */
893
- entityId?: string;
894
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
895
- eventTime?: Date | null;
896
- /**
897
- * Whether the event was triggered as a result of a privacy regulation application
898
- * (for example, GDPR).
899
- */
900
- triggeredByAnonymizeRequest?: boolean | null;
901
- /** If present, indicates the action that triggered the event. */
902
- originatedFrom?: string | null;
903
- /**
904
- * 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.
905
- * 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.
906
- */
907
- entityEventSequence?: string | null;
908
- }
909
- export interface CustomizationCreatedEnvelope {
910
- entity: Customization;
911
- metadata: EventMetadata;
912
- }
913
- /**
914
- * Triggered when a customization is created.
915
- * @permissionScope Manage Stores - all permissions
916
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
917
- * @permissionScope Manage Stores
918
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
919
- * @permissionScope Read v3 catalog
920
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
921
- * @permissionScope Manage Products
922
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
923
- * @permissionScope Read Stores - all read permissions
924
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
925
- * @permissionScope Read Products
926
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
927
- * @permissionScope Manage Restaurants - all permissions
928
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
929
- * @permissionScope Product write in v3 catalog
930
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
931
- * @permissionScope Read customizations in v3 catalog
932
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
933
- * @permissionScope Manage v3 catalog
934
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
935
- * @permissionScope Manage Orders
936
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
937
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
938
- * @webhook
939
- * @eventType wix.stores.catalog.v3.customization_created
940
- * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
941
- * @slug created
942
- * @documentationMaturity preview
943
- */
944
- export declare function onCustomizationCreated(handler: (event: CustomizationCreatedEnvelope) => void | Promise<void>): void;
945
- export interface CustomizationDeletedEnvelope {
946
- entity: Customization;
947
- metadata: EventMetadata;
948
- }
949
- /**
950
- * Triggered when a customization is deleted.
951
- * @permissionScope Manage Stores - all permissions
952
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
953
- * @permissionScope Manage Stores
954
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
955
- * @permissionScope Read v3 catalog
956
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
957
- * @permissionScope Manage Products
958
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
959
- * @permissionScope Read Stores - all read permissions
960
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
961
- * @permissionScope Read Products
962
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
963
- * @permissionScope Manage Restaurants - all permissions
964
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
965
- * @permissionScope Product write in v3 catalog
966
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
967
- * @permissionScope Read customizations in v3 catalog
968
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
969
- * @permissionScope Manage v3 catalog
970
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
971
- * @permissionScope Manage Orders
972
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
973
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
974
- * @webhook
975
- * @eventType wix.stores.catalog.v3.customization_deleted
976
- * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
977
- * @slug deleted
978
- * @documentationMaturity preview
979
- */
980
- export declare function onCustomizationDeleted(handler: (event: CustomizationDeletedEnvelope) => void | Promise<void>): void;
981
- export interface CustomizationUpdatedEnvelope {
982
- entity: Customization;
983
- metadata: EventMetadata;
984
- }
985
- /**
986
- * Triggered when a customization is updated.
987
- * @permissionScope Manage Stores - all permissions
988
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
989
- * @permissionScope Manage Stores
990
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
991
- * @permissionScope Read v3 catalog
992
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
993
- * @permissionScope Manage Products
994
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
995
- * @permissionScope Read Stores - all read permissions
996
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
997
- * @permissionScope Read Products
998
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
999
- * @permissionScope Manage Restaurants - all permissions
1000
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1001
- * @permissionScope Product write in v3 catalog
1002
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1003
- * @permissionScope Read customizations in v3 catalog
1004
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1005
- * @permissionScope Manage v3 catalog
1006
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1007
- * @permissionScope Manage Orders
1008
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1009
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
1010
- * @webhook
1011
- * @eventType wix.stores.catalog.v3.customization_updated
1012
- * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
1013
- * @slug updated
1014
- * @documentationMaturity preview
1015
- */
1016
- export declare function onCustomizationUpdated(handler: (event: CustomizationUpdatedEnvelope) => void | Promise<void>): void;
1017
- type CustomizationNonNullablePaths = `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`;
1018
- /**
1019
- * Creates a customization.
1020
- * @param customization - Customization to create.
1021
- * @public
1022
- * @documentationMaturity preview
1023
- * @requiredField customization
1024
- * @requiredField customization.customizationRenderType
1025
- * @requiredField customization.customizationSettings
1026
- * @requiredField customization.customizationType
1027
- * @requiredField customization.freeTextInput.title
1028
- * @requiredField customization.name
1029
- * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
1030
- * @permissionScope Manage Stores - all permissions
1031
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1032
- * @permissionScope Manage Stores
1033
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1034
- * @permissionScope Customization write in v3 catalog
1035
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1036
- * @permissionScope Manage Products
1037
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1038
- * @permissionScope Product write in v3 catalog
1039
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1040
- * @permissionScope Manage v3 catalog
1041
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1042
- * @applicableIdentity APP
1043
- * @returns Created customization.
1044
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.CreateCustomization
1045
- */
1046
- export declare function createCustomization(customization: NonNullablePaths<Customization, `choicesSettings.choices` | `customizationRenderType` | `customizationType` | `freeTextInput.title` | `name`>): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
1047
- /**
1048
- * Retrieves a customization.
1049
- * @param customizationId - Customization ID.
1050
- * @public
1051
- * @documentationMaturity preview
1052
- * @requiredField customizationId
1053
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
1054
- * @permissionScope Manage Stores - all permissions
1055
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1056
- * @permissionScope Manage Stores
1057
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1058
- * @permissionScope Read v3 catalog
1059
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
1060
- * @permissionScope Manage Products
1061
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1062
- * @permissionScope Read Stores - all read permissions
1063
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
1064
- * @permissionScope Read Products
1065
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
1066
- * @permissionScope Manage Restaurants - all permissions
1067
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1068
- * @permissionScope Product write in v3 catalog
1069
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1070
- * @permissionScope Read customizations in v3 catalog
1071
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1072
- * @permissionScope Manage v3 catalog
1073
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1074
- * @permissionScope Manage Orders
1075
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1076
- * @applicableIdentity APP
1077
- * @applicableIdentity VISITOR
1078
- * @returns Customization.
1079
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.GetCustomization
1080
- */
1081
- export declare function getCustomization(customizationId: string, options?: GetCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
1082
- export interface GetCustomizationOptions {
1083
- /**
1084
- * Fields to include in the response.
1085
- *
1086
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1087
- * @maxSize 100
1088
- */
1089
- fields?: RequestedFieldsWithLiterals[];
1090
- }
1091
- /**
1092
- * Updates a customization.
1093
- *
1094
- * Each time the customization is updated, `revision` increments by 1.
1095
- * The current `revision` must be passed when updating the customization.
1096
- * This ensures you're working with the latest customization and prevents unintended overwrites.
1097
- * @param _id - Customization ID.
1098
- * @public
1099
- * @documentationMaturity preview
1100
- * @requiredField _id
1101
- * @requiredField customization
1102
- * @requiredField customization.revision
1103
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1104
- * @permissionScope Manage Stores - all permissions
1105
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1106
- * @permissionScope Manage Stores
1107
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1108
- * @permissionScope Customization write in v3 catalog
1109
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1110
- * @permissionScope Manage Products
1111
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1112
- * @permissionScope Product write in v3 catalog
1113
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1114
- * @permissionScope Manage v3 catalog
1115
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1116
- * @applicableIdentity APP
1117
- * @returns Updated customization.
1118
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomization
1119
- */
1120
- export declare function updateCustomization(_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
1121
- export interface UpdateCustomization {
1122
- /**
1123
- * Free text input settings.
1124
- *
1125
- * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
1126
- * @immutable
1127
- */
1128
- freeTextInput?: FreeTextSettings;
1129
- /**
1130
- * Choices settings.
1131
- *
1132
- * > **Note:** Must be passed along with `customizationRenderType` of `SWATCH_CHOICES` and `TEXT_CHOICES`.
1133
- */
1134
- choicesSettings?: ChoicesSettings;
1135
- /**
1136
- * Customization ID.
1137
- * @minLength 1
1138
- * @maxLength 36
1139
- * @readonly
1140
- */
1141
- _id?: string | null;
1142
- /**
1143
- * Revision number, which increments by 1 each time the customization is updated.
1144
- * To prevent conflicting changes,
1145
- * the current revision must be passed when updating the customization.
1146
- *
1147
- * Ignored when creating a customization.
1148
- * @readonly
1149
- */
1150
- revision?: string | null;
1151
- /**
1152
- * Date and time the customization was created.
1153
- * @readonly
1154
- */
1155
- _createdDate?: Date | null;
1156
- /**
1157
- * Date and time the customization was updated.
1158
- * @readonly
1159
- */
1160
- _updatedDate?: Date | null;
1161
- /**
1162
- * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
1163
- * @minLength 1
1164
- * @maxLength 50
1165
- */
1166
- name?: string;
1167
- /**
1168
- * Customization type.
1169
- * @immutable
1170
- */
1171
- customizationType?: CustomizationTypeWithLiterals;
1172
- /**
1173
- * Customization render type.
1174
- *
1175
- * Defines how the customization will be displayed in the storefront.
1176
- * @immutable
1177
- */
1178
- customizationRenderType?: CustomizationRenderTypeWithLiterals;
1179
- /**
1180
- * Number of products this customization is assigned to.
1181
- * > **Note:** Returned only when you pass `"ASSIGNED_PRODUCTS_COUNT"` to the `fields` array in Customizations API requests.
1182
- * @readonly
1183
- */
1184
- assignedProductsCount?: number | null;
1185
- }
1186
- export interface UpdateCustomizationOptions {
1187
- /**
1188
- * Fields to include in the response.
1189
- *
1190
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1191
- * @maxSize 100
1192
- */
1193
- fields?: RequestedFieldsWithLiterals[];
1194
- }
1195
- /**
1196
- * Deletes a customization.
1197
- *
1198
- * > **Note:** A customization cannot be deleted if it is assigned to one or more products.
1199
- * @param customizationId - Customization ID.
1200
- * @public
1201
- * @documentationMaturity preview
1202
- * @requiredField customizationId
1203
- * @permissionId WIX_STORES.CUSTOMIZATION_DELETE
1204
- * @permissionScope Manage Stores - all permissions
1205
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1206
- * @permissionScope Manage Stores
1207
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1208
- * @permissionScope Customization write in v3 catalog
1209
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1210
- * @permissionScope Manage Products
1211
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1212
- * @permissionScope Product write in v3 catalog
1213
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1214
- * @permissionScope Manage v3 catalog
1215
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1216
- * @applicableIdentity APP
1217
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.DeleteCustomization
1218
- */
1219
- export declare function deleteCustomization(customizationId: string): Promise<void>;
1220
- /**
1221
- * Retrieves a list of up to 100 customizations, given the provided filtering, sorting, and cursor paging.
1222
- * Pass supported values to the `fields` array in the request to include those fields in the response.
1223
- *
1224
- *
1225
- * Query Customizations runs with these defaults, which you can override:
1226
- *
1227
- * - `createdDate` is sorted in `DESC` order
1228
- * - `cursorPaging.limit` is `100`
1229
- *
1230
- * For field support for filters and sorting,
1231
- * see [Customizations: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/customizations-v3/supported-filters-and-sorting).
1232
- *
1233
- * To learn about working with _Query_ endpoints, see
1234
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
1235
- * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
1236
- * @public
1237
- * @documentationMaturity preview
1238
- * @permissionScope Manage Stores - all permissions
1239
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1240
- * @permissionScope Manage Stores
1241
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1242
- * @permissionScope Read v3 catalog
1243
- * @permissionScopeId SCOPE.STORES.CATALOG_READ
1244
- * @permissionScope Manage Products
1245
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1246
- * @permissionScope Read Stores - all read permissions
1247
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
1248
- * @permissionScope Read Products
1249
- * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
1250
- * @permissionScope Manage Restaurants - all permissions
1251
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1252
- * @permissionScope Product write in v3 catalog
1253
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1254
- * @permissionScope Read customizations in v3 catalog
1255
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_READ
1256
- * @permissionScope Manage v3 catalog
1257
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1258
- * @permissionScope Manage Orders
1259
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1260
- * @permissionId WIX_STORES.CUSTOMIZATION_READ
1261
- * @applicableIdentity APP
1262
- * @applicableIdentity VISITOR
1263
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.QueryCustomizations
1264
- */
1265
- export declare function queryCustomizations(options?: QueryCustomizationsOptions): CustomizationsQueryBuilder;
1266
- export interface QueryCustomizationsOptions {
1267
- /**
1268
- * Fields to include in the response.
1269
- *
1270
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1271
- * @maxSize 100
1272
- */
1273
- fields?: RequestedFieldsWithLiterals[] | undefined;
1274
- }
1275
- interface QueryCursorResult {
1276
- cursors: Cursors;
1277
- hasNext: () => boolean;
1278
- hasPrev: () => boolean;
1279
- length: number;
1280
- pageSize: number;
1281
- }
1282
- export interface CustomizationsQueryResult extends QueryCursorResult {
1283
- items: Customization[];
1284
- query: CustomizationsQueryBuilder;
1285
- next: () => Promise<CustomizationsQueryResult>;
1286
- prev: () => Promise<CustomizationsQueryResult>;
1287
- }
1288
- export interface CustomizationsQueryBuilder {
1289
- /** @param propertyName - Property whose value is compared with `value`.
1290
- * @param value - Value to compare against.
1291
- * @documentationMaturity preview
1292
- */
1293
- eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
1294
- /** @param propertyName - Property whose value is compared with `value`.
1295
- * @param value - Value to compare against.
1296
- * @documentationMaturity preview
1297
- */
1298
- ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
1299
- /** @param propertyName - Property whose value is compared with `value`.
1300
- * @param value - Value to compare against.
1301
- * @documentationMaturity preview
1302
- */
1303
- ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
1304
- /** @param propertyName - Property whose value is compared with `value`.
1305
- * @param value - Value to compare against.
1306
- * @documentationMaturity preview
1307
- */
1308
- gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
1309
- /** @param propertyName - Property whose value is compared with `value`.
1310
- * @param value - Value to compare against.
1311
- * @documentationMaturity preview
1312
- */
1313
- le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
1314
- /** @param propertyName - Property whose value is compared with `value`.
1315
- * @param value - Value to compare against.
1316
- * @documentationMaturity preview
1317
- */
1318
- lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
1319
- /** @param propertyName - Property whose value is compared with `string`.
1320
- * @param string - String to compare against. Case-insensitive.
1321
- * @documentationMaturity preview
1322
- */
1323
- startsWith: (propertyName: '_id' | 'name', value: string) => CustomizationsQueryBuilder;
1324
- /** @param propertyName - Property whose value is compared with `values`.
1325
- * @param values - List of values to compare against.
1326
- * @documentationMaturity preview
1327
- */
1328
- hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any[]) => CustomizationsQueryBuilder;
1329
- /** @documentationMaturity preview */
1330
- in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
1331
- /** @documentationMaturity preview */
1332
- exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: boolean) => CustomizationsQueryBuilder;
1333
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1334
- * @documentationMaturity preview
1335
- */
1336
- ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
1337
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1338
- * @documentationMaturity preview
1339
- */
1340
- descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
1341
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1342
- * @documentationMaturity preview
1343
- */
1344
- limit: (limit: number) => CustomizationsQueryBuilder;
1345
- /** @param cursor - A pointer to specific record
1346
- * @documentationMaturity preview
1347
- */
1348
- skipTo: (cursor: string) => CustomizationsQueryBuilder;
1349
- /** @documentationMaturity preview */
1350
- find: () => Promise<CustomizationsQueryResult>;
1351
- }
1352
- /**
1353
- * Creates multiple brands.
1354
- * @param customizations - Customizations to create.
1355
- * @public
1356
- * @documentationMaturity preview
1357
- * @requiredField customizations
1358
- * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
1359
- * @permissionScope Manage Stores - all permissions
1360
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1361
- * @permissionScope Manage Stores
1362
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1363
- * @permissionScope Customization write in v3 catalog
1364
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1365
- * @permissionScope Manage Products
1366
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1367
- * @permissionScope Product write in v3 catalog
1368
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1369
- * @permissionScope Manage v3 catalog
1370
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1371
- * @applicableIdentity APP
1372
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkCreateCustomizations
1373
- */
1374
- export declare function bulkCreateCustomizations(customizations: Customization[], options?: BulkCreateCustomizationsOptions): Promise<NonNullablePaths<BulkCreateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
1375
- [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
1376
- }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1377
- export interface BulkCreateCustomizationsOptions {
1378
- /**
1379
- * Whether to return the full customization entities in the response.
1380
- *
1381
- * Default: `false`
1382
- */
1383
- returnEntity?: boolean;
1384
- }
1385
- /**
1386
- * Adds choices to a customization.
1387
- * @param customizationId - Customization ID.
1388
- * @param choices - Choices to add.
1389
- * @public
1390
- * @documentationMaturity preview
1391
- * @requiredField choices
1392
- * @requiredField customizationId
1393
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1394
- * @permissionScope Manage Stores - all permissions
1395
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1396
- * @permissionScope Manage Stores
1397
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1398
- * @permissionScope Customization write in v3 catalog
1399
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1400
- * @permissionScope Manage Products
1401
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1402
- * @permissionScope Product write in v3 catalog
1403
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1404
- * @permissionScope Manage v3 catalog
1405
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1406
- * @applicableIdentity APP
1407
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.AddCustomizationChoices
1408
- */
1409
- export declare function addCustomizationChoices(customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions): Promise<NonNullablePaths<AddCustomizationChoicesResponse, {
1410
- [P in CustomizationNonNullablePaths]: `customization.${P}`;
1411
- }[CustomizationNonNullablePaths]>>;
1412
- export interface AddCustomizationChoicesOptions {
1413
- /**
1414
- * Fields to include in the response.
1415
- *
1416
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1417
- * @maxSize 100
1418
- */
1419
- fields?: RequestedFieldsWithLiterals[];
1420
- }
1421
- /**
1422
- * Sets a customization's choices. Any and all existing choices will be overridden.
1423
- *
1424
- * > **Note:** A choice cannot be overridden if it is assigned to one or more products.
1425
- * @param customizationId - Customization ID.
1426
- * @param choices - Choices to set.
1427
- * @public
1428
- * @documentationMaturity preview
1429
- * @requiredField choices
1430
- * @requiredField customizationId
1431
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1432
- * @permissionScope Manage Stores - all permissions
1433
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1434
- * @permissionScope Manage Stores
1435
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1436
- * @permissionScope Customization write in v3 catalog
1437
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1438
- * @permissionScope Manage Products
1439
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1440
- * @permissionScope Product write in v3 catalog
1441
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1442
- * @permissionScope Manage v3 catalog
1443
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1444
- * @applicableIdentity APP
1445
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.SetCustomizationChoices
1446
- */
1447
- export declare function setCustomizationChoices(customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions): Promise<NonNullablePaths<SetCustomizationChoicesResponse, {
1448
- [P in CustomizationNonNullablePaths]: `customization.${P}`;
1449
- }[CustomizationNonNullablePaths]>>;
1450
- export interface SetCustomizationChoicesOptions {
1451
- /**
1452
- * Fields to include in the response.
1453
- *
1454
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1455
- * @maxSize 100
1456
- */
1457
- fields?: RequestedFieldsWithLiterals[];
1458
- }
1459
- /**
1460
- * Removes choices from a customization.
1461
- *
1462
- * +> **Note:** A choice cannot be removed if it is assigned to one or more products.
1463
- * @param customizationId - Customization ID.
1464
- * @param choiceIds - IDs of choices to remove.
1465
- * @public
1466
- * @documentationMaturity preview
1467
- * @requiredField choiceIds
1468
- * @requiredField customizationId
1469
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1470
- * @permissionScope Manage Stores - all permissions
1471
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1472
- * @permissionScope Manage Stores
1473
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1474
- * @permissionScope Customization write in v3 catalog
1475
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1476
- * @permissionScope Manage Products
1477
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1478
- * @permissionScope Product write in v3 catalog
1479
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1480
- * @permissionScope Manage v3 catalog
1481
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1482
- * @applicableIdentity APP
1483
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.RemoveCustomizationChoices
1484
- */
1485
- export declare function removeCustomizationChoices(customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions): Promise<NonNullablePaths<RemoveCustomizationChoicesResponse, {
1486
- [P in CustomizationNonNullablePaths]: `customization.${P}`;
1487
- }[CustomizationNonNullablePaths]>>;
1488
- export interface RemoveCustomizationChoicesOptions {
1489
- /** Customization revision. */
1490
- revision?: string;
1491
- /**
1492
- * Fields to include in the response.
1493
- *
1494
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1495
- * @maxSize 100
1496
- */
1497
- fields?: RequestedFieldsWithLiterals[];
1498
- }
1499
- /**
1500
- * Adds choices to multiple customizations.
1501
- * @param customizationsChoices - List of customization IDs and choices.
1502
- * @public
1503
- * @documentationMaturity preview
1504
- * @requiredField customizationsChoices
1505
- * @requiredField customizationsChoices.choices
1506
- * @requiredField customizationsChoices.customizationId
1507
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1508
- * @permissionScope Manage Stores - all permissions
1509
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1510
- * @permissionScope Manage Stores
1511
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1512
- * @permissionScope Customization write in v3 catalog
1513
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1514
- * @permissionScope Manage Products
1515
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1516
- * @permissionScope Product write in v3 catalog
1517
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1518
- * @permissionScope Manage v3 catalog
1519
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1520
- * @applicableIdentity APP
1521
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkAddCustomizationChoices
1522
- */
1523
- export declare function bulkAddCustomizationChoices(customizationsChoices: NonNullablePaths<CustomizationChoices, `choices` | `customizationId`>[], options?: BulkAddCustomizationChoicesOptions): Promise<NonNullablePaths<BulkAddCustomizationChoicesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
1524
- [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
1525
- }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1526
- export interface BulkAddCustomizationChoicesOptions {
1527
- /**
1528
- * Whether to return the full customization entities in the response.
1529
- *
1530
- * Default: `false`
1531
- */
1532
- returnEntity?: boolean;
1533
- /**
1534
- * Fields to include in the response.
1535
- *
1536
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1537
- * @maxSize 100
1538
- */
1539
- fields?: RequestedFieldsWithLiterals[];
1540
- }
1541
- /**
1542
- * Updates multiple customizations.
1543
- *
1544
- * Each time the customization is updated, `revision` increments by 1.
1545
- * The current `revision` must be passed when updating the customization.
1546
- * This ensures you're working with the latest customization and prevents unintended overwrites.
1547
- * @param customizations - List of customizations to update.
1548
- * @public
1549
- * @documentationMaturity preview
1550
- * @requiredField customizations
1551
- * @requiredField customizations.customization._id
1552
- * @requiredField customizations.customization.name
1553
- * @requiredField customizations.customization.revision
1554
- * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1555
- * @permissionScope Manage Stores - all permissions
1556
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1557
- * @permissionScope Manage Stores
1558
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1559
- * @permissionScope Customization write in v3 catalog
1560
- * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1561
- * @permissionScope Manage Products
1562
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1563
- * @permissionScope Product write in v3 catalog
1564
- * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
1565
- * @permissionScope Manage v3 catalog
1566
- * @permissionScopeId SCOPE.STORES.CATALOG_WRITE
1567
- * @applicableIdentity APP
1568
- * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkUpdateCustomizations
1569
- */
1570
- export declare function bulkUpdateCustomizations(customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
1571
- [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
1572
- }[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1573
- export interface BulkUpdateCustomizationsOptions {
1574
- /**
1575
- * Whether to return the full customization entities in the response.
1576
- *
1577
- * Default: `false`
1578
- */
1579
- returnEntity?: boolean;
1580
- /**
1581
- * Fields to include in the response.
1582
- *
1583
- * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1584
- * @maxSize 100
1585
- */
1586
- fields?: RequestedFieldsWithLiterals[];
1587
- }
1588
- export {};