@wix/auto_sdk_stores_customizations-v-3 1.0.2 → 1.0.3
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/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
- package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
- package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
- package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
- package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -7,6 +7,7 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
7
7
|
* Free text input settings.
|
|
8
8
|
*
|
|
9
9
|
* > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
|
|
10
|
+
* @immutable
|
|
10
11
|
*/
|
|
11
12
|
freeTextInput?: FreeTextSettings;
|
|
12
13
|
/**
|
|
@@ -17,6 +18,8 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
17
18
|
choicesSettings?: ChoicesSettings;
|
|
18
19
|
/**
|
|
19
20
|
* Customization ID.
|
|
21
|
+
* @minLength 1
|
|
22
|
+
* @maxLength 36
|
|
20
23
|
* @readonly
|
|
21
24
|
*/
|
|
22
25
|
id?: string | null;
|
|
@@ -39,14 +42,22 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
|
|
|
39
42
|
* @readonly
|
|
40
43
|
*/
|
|
41
44
|
updatedDate?: Date | null;
|
|
42
|
-
/**
|
|
45
|
+
/**
|
|
46
|
+
* Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
|
|
47
|
+
* @minLength 1
|
|
48
|
+
* @maxLength 50
|
|
49
|
+
*/
|
|
43
50
|
name?: string;
|
|
44
|
-
/**
|
|
51
|
+
/**
|
|
52
|
+
* Customization type.
|
|
53
|
+
* @immutable
|
|
54
|
+
*/
|
|
45
55
|
customizationType?: CustomizationType;
|
|
46
56
|
/**
|
|
47
57
|
* Customization render type.
|
|
48
58
|
*
|
|
49
59
|
* Defines how the customization will be displayed in the storefront.
|
|
60
|
+
* @immutable
|
|
50
61
|
*/
|
|
51
62
|
customizationRenderType?: CustomizationRenderType;
|
|
52
63
|
/**
|
|
@@ -62,6 +73,7 @@ export interface CustomizationCustomizationSettingsOneOf {
|
|
|
62
73
|
* Free text input settings.
|
|
63
74
|
*
|
|
64
75
|
* > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
|
|
76
|
+
* @immutable
|
|
65
77
|
*/
|
|
66
78
|
freeTextInput?: FreeTextSettings;
|
|
67
79
|
/**
|
|
@@ -85,22 +97,43 @@ export declare enum CustomizationRenderType {
|
|
|
85
97
|
export interface FreeTextSettings {
|
|
86
98
|
/** Minimum text character length. */
|
|
87
99
|
minCharCount?: number;
|
|
88
|
-
/**
|
|
100
|
+
/**
|
|
101
|
+
* Maximum text character length.
|
|
102
|
+
* @max 500
|
|
103
|
+
*/
|
|
89
104
|
maxCharCount?: number;
|
|
90
|
-
/**
|
|
105
|
+
/**
|
|
106
|
+
* Default amount added to a product's price when this choice is assigned to a modifier.
|
|
107
|
+
* @decimalValue options - {gte:0,lte:999999999,maxScale:3}
|
|
108
|
+
*/
|
|
91
109
|
defaultAddedPrice?: string | null;
|
|
92
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* Title to display to customer for their free-text input.
|
|
112
|
+
* @minLength 1
|
|
113
|
+
* @maxLength 100
|
|
114
|
+
*/
|
|
93
115
|
title?: string;
|
|
94
116
|
}
|
|
95
117
|
export interface ChoicesSettings {
|
|
96
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* List of choices.
|
|
120
|
+
* @minSize 1
|
|
121
|
+
* @maxSize 200
|
|
122
|
+
* @immutable
|
|
123
|
+
*/
|
|
97
124
|
choices?: Choice[];
|
|
98
125
|
}
|
|
99
126
|
export interface Choice extends ChoiceValueOneOf {
|
|
100
|
-
/**
|
|
127
|
+
/**
|
|
128
|
+
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
129
|
+
* @minLength 3
|
|
130
|
+
* @maxLength 20
|
|
131
|
+
* @format COLOR_HEX
|
|
132
|
+
*/
|
|
101
133
|
colorCode?: string;
|
|
102
134
|
/**
|
|
103
135
|
* Choice ID.
|
|
136
|
+
* @format GUID
|
|
104
137
|
* @readonly
|
|
105
138
|
*/
|
|
106
139
|
id?: string;
|
|
@@ -110,16 +143,26 @@ export interface Choice extends ChoiceValueOneOf {
|
|
|
110
143
|
* > **Notes:**
|
|
111
144
|
* > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` values are: `ONE_COLOR`, `MULTIPLE_COLORS`, or `IMAGE`.
|
|
112
145
|
* > + For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`, the supported `choiceType` value is: `CHOICE_TEXT`.
|
|
146
|
+
* @immutable
|
|
113
147
|
*/
|
|
114
148
|
choiceType?: ChoiceType;
|
|
115
149
|
/**
|
|
116
150
|
* A read-only key generated based on choice name. Used for eCommerce integration.
|
|
117
151
|
* @readonly
|
|
152
|
+
* @minLength 1
|
|
153
|
+
* @maxLength 50
|
|
118
154
|
*/
|
|
119
155
|
key?: string | null;
|
|
120
|
-
/**
|
|
156
|
+
/**
|
|
157
|
+
* Choice name.
|
|
158
|
+
* @minLength 1
|
|
159
|
+
* @maxLength 50
|
|
160
|
+
*/
|
|
121
161
|
name?: string;
|
|
122
|
-
/**
|
|
162
|
+
/**
|
|
163
|
+
* Default amount added to a product's price when this customization is assigned to a modifier.
|
|
164
|
+
* @decimalValue options - {gte:0,lte:999999999,maxScale:3}
|
|
165
|
+
*/
|
|
123
166
|
defaultAddedPrice?: string | null;
|
|
124
167
|
/**
|
|
125
168
|
* Number of products this choice is assigned to .
|
|
@@ -129,7 +172,12 @@ export interface Choice extends ChoiceValueOneOf {
|
|
|
129
172
|
}
|
|
130
173
|
/** @oneof */
|
|
131
174
|
export interface ChoiceValueOneOf {
|
|
132
|
-
/**
|
|
175
|
+
/**
|
|
176
|
+
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
177
|
+
* @minLength 3
|
|
178
|
+
* @maxLength 20
|
|
179
|
+
* @format COLOR_HEX
|
|
180
|
+
*/
|
|
133
181
|
colorCode?: string;
|
|
134
182
|
}
|
|
135
183
|
export declare enum ChoiceType {
|
|
@@ -144,7 +192,13 @@ export declare enum ChoiceType {
|
|
|
144
192
|
IMAGE = "IMAGE"
|
|
145
193
|
}
|
|
146
194
|
export interface MultipleColors {
|
|
147
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* A list of color codes.
|
|
197
|
+
* @minLength 3
|
|
198
|
+
* @maxLength 20
|
|
199
|
+
* @minSize 2
|
|
200
|
+
* @maxSize 2
|
|
201
|
+
*/
|
|
148
202
|
colorCodes?: string[];
|
|
149
203
|
}
|
|
150
204
|
export interface Image {
|
|
@@ -181,9 +235,15 @@ export interface FocalPoint {
|
|
|
181
235
|
width?: number | null;
|
|
182
236
|
}
|
|
183
237
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
184
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
240
|
+
* @format GUID
|
|
241
|
+
*/
|
|
185
242
|
metaSiteId?: string;
|
|
186
|
-
/**
|
|
243
|
+
/**
|
|
244
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
245
|
+
* @format GUID
|
|
246
|
+
*/
|
|
187
247
|
siteId?: string;
|
|
188
248
|
/** Invalidate by App */
|
|
189
249
|
app?: App;
|
|
@@ -193,7 +253,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
193
253
|
uri?: URI;
|
|
194
254
|
/** Invalidate by file (for media files such as PDFs) */
|
|
195
255
|
file?: File;
|
|
196
|
-
/**
|
|
256
|
+
/**
|
|
257
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
258
|
+
* @maxLength 256
|
|
259
|
+
*/
|
|
197
260
|
reason?: string | null;
|
|
198
261
|
/** Is local DS */
|
|
199
262
|
localDc?: boolean;
|
|
@@ -201,9 +264,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
201
264
|
}
|
|
202
265
|
/** @oneof */
|
|
203
266
|
export interface InvalidateCacheGetByOneOf {
|
|
204
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
269
|
+
* @format GUID
|
|
270
|
+
*/
|
|
205
271
|
metaSiteId?: string;
|
|
206
|
-
/**
|
|
272
|
+
/**
|
|
273
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
274
|
+
* @format GUID
|
|
275
|
+
*/
|
|
207
276
|
siteId?: string;
|
|
208
277
|
/** Invalidate by App */
|
|
209
278
|
app?: App;
|
|
@@ -215,27 +284,52 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
215
284
|
file?: File;
|
|
216
285
|
}
|
|
217
286
|
export interface App {
|
|
218
|
-
/**
|
|
287
|
+
/**
|
|
288
|
+
* The AppDefId
|
|
289
|
+
* @minLength 1
|
|
290
|
+
*/
|
|
219
291
|
appDefId?: string;
|
|
220
|
-
/**
|
|
292
|
+
/**
|
|
293
|
+
* The instance Id
|
|
294
|
+
* @format GUID
|
|
295
|
+
*/
|
|
221
296
|
instanceId?: string;
|
|
222
297
|
}
|
|
223
298
|
export interface Page {
|
|
224
|
-
/**
|
|
299
|
+
/**
|
|
300
|
+
* the msid the page is on
|
|
301
|
+
* @format GUID
|
|
302
|
+
*/
|
|
225
303
|
metaSiteId?: string;
|
|
226
|
-
/**
|
|
304
|
+
/**
|
|
305
|
+
* Invalidate by Page ID
|
|
306
|
+
* @minLength 1
|
|
307
|
+
*/
|
|
227
308
|
pageId?: string;
|
|
228
309
|
}
|
|
229
310
|
export interface URI {
|
|
230
|
-
/**
|
|
311
|
+
/**
|
|
312
|
+
* the msid the URI is on
|
|
313
|
+
* @format GUID
|
|
314
|
+
*/
|
|
231
315
|
metaSiteId?: string;
|
|
232
|
-
/**
|
|
316
|
+
/**
|
|
317
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
318
|
+
* @minLength 1
|
|
319
|
+
*/
|
|
233
320
|
uriPath?: string;
|
|
234
321
|
}
|
|
235
322
|
export interface File {
|
|
236
|
-
/**
|
|
323
|
+
/**
|
|
324
|
+
* the msid the file is related to
|
|
325
|
+
* @format GUID
|
|
326
|
+
*/
|
|
237
327
|
metaSiteId?: string;
|
|
238
|
-
/**
|
|
328
|
+
/**
|
|
329
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
330
|
+
* @minLength 1
|
|
331
|
+
* @maxLength 256
|
|
332
|
+
*/
|
|
239
333
|
fileName?: string;
|
|
240
334
|
}
|
|
241
335
|
export interface CreateCustomizationRequest {
|
|
@@ -247,12 +341,16 @@ export interface CreateCustomizationResponse {
|
|
|
247
341
|
customization?: Customization;
|
|
248
342
|
}
|
|
249
343
|
export interface GetCustomizationRequest {
|
|
250
|
-
/**
|
|
344
|
+
/**
|
|
345
|
+
* Customization ID.
|
|
346
|
+
* @format GUID
|
|
347
|
+
*/
|
|
251
348
|
customizationId: string;
|
|
252
349
|
/**
|
|
253
350
|
* Fields to include in the response.
|
|
254
351
|
*
|
|
255
352
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
353
|
+
* @maxSize 100
|
|
256
354
|
*/
|
|
257
355
|
fields?: RequestedFields[];
|
|
258
356
|
}
|
|
@@ -273,6 +371,7 @@ export interface UpdateCustomizationRequest {
|
|
|
273
371
|
* Fields to include in the response.
|
|
274
372
|
*
|
|
275
373
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
374
|
+
* @maxSize 100
|
|
276
375
|
*/
|
|
277
376
|
fields?: RequestedFields[];
|
|
278
377
|
}
|
|
@@ -281,7 +380,10 @@ export interface UpdateCustomizationResponse {
|
|
|
281
380
|
customization?: Customization;
|
|
282
381
|
}
|
|
283
382
|
export interface DeleteCustomizationRequest {
|
|
284
|
-
/**
|
|
383
|
+
/**
|
|
384
|
+
* Customization ID.
|
|
385
|
+
* @format GUID
|
|
386
|
+
*/
|
|
285
387
|
customizationId: string;
|
|
286
388
|
}
|
|
287
389
|
export interface DeleteCustomizationResponse {
|
|
@@ -293,6 +395,7 @@ export interface QueryCustomizationsRequest {
|
|
|
293
395
|
* Fields to include in the response.
|
|
294
396
|
*
|
|
295
397
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
398
|
+
* @maxSize 100
|
|
296
399
|
*/
|
|
297
400
|
fields?: RequestedFields[];
|
|
298
401
|
}
|
|
@@ -311,6 +414,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
311
414
|
/**
|
|
312
415
|
* Sort object in the following format:
|
|
313
416
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
417
|
+
* @maxSize 5
|
|
314
418
|
*/
|
|
315
419
|
sort?: Sorting[];
|
|
316
420
|
}
|
|
@@ -320,7 +424,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
320
424
|
cursorPaging?: CursorPaging;
|
|
321
425
|
}
|
|
322
426
|
export interface Sorting {
|
|
323
|
-
/**
|
|
427
|
+
/**
|
|
428
|
+
* Name of the field to sort by.
|
|
429
|
+
* @maxLength 512
|
|
430
|
+
*/
|
|
324
431
|
fieldName?: string;
|
|
325
432
|
/** Sort order. */
|
|
326
433
|
order?: SortOrder;
|
|
@@ -332,18 +439,26 @@ export declare enum SortOrder {
|
|
|
332
439
|
DESC = "DESC"
|
|
333
440
|
}
|
|
334
441
|
export interface CursorPaging {
|
|
335
|
-
/**
|
|
442
|
+
/**
|
|
443
|
+
* Maximum number of items to return in the results.
|
|
444
|
+
* @max 100
|
|
445
|
+
*/
|
|
336
446
|
limit?: number | null;
|
|
337
447
|
/**
|
|
338
448
|
* Pointer to the next or previous page in the list of results.
|
|
339
449
|
*
|
|
340
450
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
341
451
|
* Not relevant for the first request.
|
|
452
|
+
* @maxLength 16000
|
|
342
453
|
*/
|
|
343
454
|
cursor?: string | null;
|
|
344
455
|
}
|
|
345
456
|
export interface QueryCustomizationsResponse {
|
|
346
|
-
/**
|
|
457
|
+
/**
|
|
458
|
+
* List of customizations.
|
|
459
|
+
* @minSize 1
|
|
460
|
+
* @maxSize 200
|
|
461
|
+
*/
|
|
347
462
|
customizations?: Customization[];
|
|
348
463
|
/** Details on the paged set of results returned. */
|
|
349
464
|
pagingMetadata?: CursorPagingMetadata;
|
|
@@ -362,13 +477,23 @@ export interface CursorPagingMetadata {
|
|
|
362
477
|
hasNext?: boolean | null;
|
|
363
478
|
}
|
|
364
479
|
export interface Cursors {
|
|
365
|
-
/**
|
|
480
|
+
/**
|
|
481
|
+
* Cursor string pointing to the next page in the list of results.
|
|
482
|
+
* @maxLength 16000
|
|
483
|
+
*/
|
|
366
484
|
next?: string | null;
|
|
367
|
-
/**
|
|
485
|
+
/**
|
|
486
|
+
* Cursor pointing to the previous page in the list of results.
|
|
487
|
+
* @maxLength 16000
|
|
488
|
+
*/
|
|
368
489
|
prev?: string | null;
|
|
369
490
|
}
|
|
370
491
|
export interface BulkCreateCustomizationsRequest {
|
|
371
|
-
/**
|
|
492
|
+
/**
|
|
493
|
+
* Customizations to create.
|
|
494
|
+
* @minSize 1
|
|
495
|
+
* @maxSize 100
|
|
496
|
+
*/
|
|
372
497
|
customizations: Customization[];
|
|
373
498
|
/**
|
|
374
499
|
* Whether to return the full customization entities in the response.
|
|
@@ -378,7 +503,11 @@ export interface BulkCreateCustomizationsRequest {
|
|
|
378
503
|
returnEntity?: boolean;
|
|
379
504
|
}
|
|
380
505
|
export interface BulkCreateCustomizationsResponse {
|
|
381
|
-
/**
|
|
506
|
+
/**
|
|
507
|
+
* Customizations created by bulk action.
|
|
508
|
+
* @minSize 1
|
|
509
|
+
* @maxSize 100
|
|
510
|
+
*/
|
|
382
511
|
results?: BulkCustomizationResult[];
|
|
383
512
|
/** Bulk action metadata. */
|
|
384
513
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -394,7 +523,11 @@ export interface BulkCustomizationResult {
|
|
|
394
523
|
customization?: Customization;
|
|
395
524
|
}
|
|
396
525
|
export interface ItemMetadata {
|
|
397
|
-
/**
|
|
526
|
+
/**
|
|
527
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
528
|
+
* @minLength 1
|
|
529
|
+
* @maxLength 36
|
|
530
|
+
*/
|
|
398
531
|
id?: string | null;
|
|
399
532
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
400
533
|
originalIndex?: number;
|
|
@@ -423,18 +556,30 @@ export interface CustomizationIdsWrapper {
|
|
|
423
556
|
/**
|
|
424
557
|
* list of all the customization ids that are invalid
|
|
425
558
|
* e.g list of failed choices ids
|
|
559
|
+
* @minSize 1
|
|
560
|
+
* @maxSize 100
|
|
561
|
+
* @minLength 1
|
|
562
|
+
* @maxLength 36
|
|
426
563
|
*/
|
|
427
564
|
customizationIds?: string[];
|
|
428
565
|
}
|
|
429
566
|
export interface AddCustomizationChoicesRequest {
|
|
430
|
-
/**
|
|
567
|
+
/**
|
|
568
|
+
* Customization ID.
|
|
569
|
+
* @format GUID
|
|
570
|
+
*/
|
|
431
571
|
customizationId: string;
|
|
432
|
-
/**
|
|
572
|
+
/**
|
|
573
|
+
* Choices to add.
|
|
574
|
+
* @minSize 1
|
|
575
|
+
* @maxSize 100
|
|
576
|
+
*/
|
|
433
577
|
choices: Choice[];
|
|
434
578
|
/**
|
|
435
579
|
* Fields to include in the response.
|
|
436
580
|
*
|
|
437
581
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
582
|
+
* @maxSize 100
|
|
438
583
|
*/
|
|
439
584
|
fields?: RequestedFields[];
|
|
440
585
|
}
|
|
@@ -443,14 +588,22 @@ export interface AddCustomizationChoicesResponse {
|
|
|
443
588
|
customization?: Customization;
|
|
444
589
|
}
|
|
445
590
|
export interface SetCustomizationChoicesRequest {
|
|
446
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* Customization ID.
|
|
593
|
+
* @format GUID
|
|
594
|
+
*/
|
|
447
595
|
customizationId: string;
|
|
448
|
-
/**
|
|
596
|
+
/**
|
|
597
|
+
* Choices to set.
|
|
598
|
+
* @minSize 1
|
|
599
|
+
* @maxSize 100
|
|
600
|
+
*/
|
|
449
601
|
choices: Choice[];
|
|
450
602
|
/**
|
|
451
603
|
* Fields to include in the response.
|
|
452
604
|
*
|
|
453
605
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
606
|
+
* @maxSize 100
|
|
454
607
|
*/
|
|
455
608
|
fields?: RequestedFields[];
|
|
456
609
|
}
|
|
@@ -459,9 +612,17 @@ export interface SetCustomizationChoicesResponse {
|
|
|
459
612
|
customization?: Customization;
|
|
460
613
|
}
|
|
461
614
|
export interface RemoveCustomizationChoicesRequest {
|
|
462
|
-
/**
|
|
615
|
+
/**
|
|
616
|
+
* Customization ID.
|
|
617
|
+
* @format GUID
|
|
618
|
+
*/
|
|
463
619
|
customizationId: string;
|
|
464
|
-
/**
|
|
620
|
+
/**
|
|
621
|
+
* IDs of choices to remove.
|
|
622
|
+
* @format GUID
|
|
623
|
+
* @minSize 1
|
|
624
|
+
* @maxSize 100
|
|
625
|
+
*/
|
|
465
626
|
choiceIds: string[];
|
|
466
627
|
/** Customization revision. */
|
|
467
628
|
revision?: string;
|
|
@@ -469,6 +630,7 @@ export interface RemoveCustomizationChoicesRequest {
|
|
|
469
630
|
* Fields to include in the response.
|
|
470
631
|
*
|
|
471
632
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
633
|
+
* @maxSize 100
|
|
472
634
|
*/
|
|
473
635
|
fields?: RequestedFields[];
|
|
474
636
|
}
|
|
@@ -477,7 +639,11 @@ export interface RemoveCustomizationChoicesResponse {
|
|
|
477
639
|
customization?: Customization;
|
|
478
640
|
}
|
|
479
641
|
export interface BulkAddCustomizationChoicesRequest {
|
|
480
|
-
/**
|
|
642
|
+
/**
|
|
643
|
+
* List of customization IDs and choices.
|
|
644
|
+
* @minSize 1
|
|
645
|
+
* @maxSize 100
|
|
646
|
+
*/
|
|
481
647
|
customizationsChoices: CustomizationChoices[];
|
|
482
648
|
/**
|
|
483
649
|
* Whether to return the full customization entities in the response.
|
|
@@ -489,23 +655,40 @@ export interface BulkAddCustomizationChoicesRequest {
|
|
|
489
655
|
* Fields to include in the response.
|
|
490
656
|
*
|
|
491
657
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
658
|
+
* @maxSize 100
|
|
492
659
|
*/
|
|
493
660
|
fields?: RequestedFields[];
|
|
494
661
|
}
|
|
495
662
|
export interface CustomizationChoices {
|
|
496
|
-
/**
|
|
663
|
+
/**
|
|
664
|
+
* Customization ID.
|
|
665
|
+
* @minLength 1
|
|
666
|
+
* @maxLength 36
|
|
667
|
+
*/
|
|
497
668
|
customizationId?: string;
|
|
498
|
-
/**
|
|
669
|
+
/**
|
|
670
|
+
* Choices to add.
|
|
671
|
+
* @minSize 1
|
|
672
|
+
* @maxSize 100
|
|
673
|
+
*/
|
|
499
674
|
choices?: Choice[];
|
|
500
675
|
}
|
|
501
676
|
export interface BulkAddCustomizationChoicesResponse {
|
|
502
|
-
/**
|
|
677
|
+
/**
|
|
678
|
+
* Customizations updated by bulk action.
|
|
679
|
+
* @minSize 1
|
|
680
|
+
* @maxSize 100
|
|
681
|
+
*/
|
|
503
682
|
results?: BulkCustomizationResult[];
|
|
504
683
|
/** Bulk action metadata. */
|
|
505
684
|
bulkActionMetadata?: BulkActionMetadata;
|
|
506
685
|
}
|
|
507
686
|
export interface BulkUpdateCustomizationsRequest {
|
|
508
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* List of customizations to update.
|
|
689
|
+
* @minSize 1
|
|
690
|
+
* @maxSize 100
|
|
691
|
+
*/
|
|
509
692
|
customizations: MaskedCustomization[];
|
|
510
693
|
/**
|
|
511
694
|
* Whether to return the full customization entities in the response.
|
|
@@ -517,6 +700,7 @@ export interface BulkUpdateCustomizationsRequest {
|
|
|
517
700
|
* Fields to include in the response.
|
|
518
701
|
*
|
|
519
702
|
* Supported values: `ASSIGNED_PRODUCTS_COUNT`
|
|
703
|
+
* @maxSize 100
|
|
520
704
|
*/
|
|
521
705
|
fields?: RequestedFields[];
|
|
522
706
|
}
|
|
@@ -525,7 +709,11 @@ export interface MaskedCustomization {
|
|
|
525
709
|
customization?: Customization;
|
|
526
710
|
}
|
|
527
711
|
export interface BulkUpdateCustomizationsResponse {
|
|
528
|
-
/**
|
|
712
|
+
/**
|
|
713
|
+
* Customizations updated by bulk action.
|
|
714
|
+
* @minSize 1
|
|
715
|
+
* @maxSize 100
|
|
716
|
+
*/
|
|
529
717
|
results?: BulkCustomizationResult[];
|
|
530
718
|
/** Bulk action metadata. */
|
|
531
719
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -605,9 +793,15 @@ export interface ActionEvent {
|
|
|
605
793
|
export interface Empty {
|
|
606
794
|
}
|
|
607
795
|
export interface MessageEnvelope {
|
|
608
|
-
/**
|
|
796
|
+
/**
|
|
797
|
+
* App instance ID.
|
|
798
|
+
* @format GUID
|
|
799
|
+
*/
|
|
609
800
|
instanceId?: string | null;
|
|
610
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* Event type.
|
|
803
|
+
* @maxLength 150
|
|
804
|
+
*/
|
|
611
805
|
eventType?: string;
|
|
612
806
|
/** The identification type and identity data. */
|
|
613
807
|
identity?: IdentificationData;
|
|
@@ -615,26 +809,50 @@ export interface MessageEnvelope {
|
|
|
615
809
|
data?: string;
|
|
616
810
|
}
|
|
617
811
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
618
|
-
/**
|
|
812
|
+
/**
|
|
813
|
+
* ID of a site visitor that has not logged in to the site.
|
|
814
|
+
* @format GUID
|
|
815
|
+
*/
|
|
619
816
|
anonymousVisitorId?: string;
|
|
620
|
-
/**
|
|
817
|
+
/**
|
|
818
|
+
* ID of a site visitor that has logged in to the site.
|
|
819
|
+
* @format GUID
|
|
820
|
+
*/
|
|
621
821
|
memberId?: string;
|
|
622
|
-
/**
|
|
822
|
+
/**
|
|
823
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
824
|
+
* @format GUID
|
|
825
|
+
*/
|
|
623
826
|
wixUserId?: string;
|
|
624
|
-
/**
|
|
827
|
+
/**
|
|
828
|
+
* ID of an app.
|
|
829
|
+
* @format GUID
|
|
830
|
+
*/
|
|
625
831
|
appId?: string;
|
|
626
832
|
/** @readonly */
|
|
627
833
|
identityType?: WebhookIdentityType;
|
|
628
834
|
}
|
|
629
835
|
/** @oneof */
|
|
630
836
|
export interface IdentificationDataIdOneOf {
|
|
631
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* ID of a site visitor that has not logged in to the site.
|
|
839
|
+
* @format GUID
|
|
840
|
+
*/
|
|
632
841
|
anonymousVisitorId?: string;
|
|
633
|
-
/**
|
|
842
|
+
/**
|
|
843
|
+
* ID of a site visitor that has logged in to the site.
|
|
844
|
+
* @format GUID
|
|
845
|
+
*/
|
|
634
846
|
memberId?: string;
|
|
635
|
-
/**
|
|
847
|
+
/**
|
|
848
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
849
|
+
* @format GUID
|
|
850
|
+
*/
|
|
636
851
|
wixUserId?: string;
|
|
637
|
-
/**
|
|
852
|
+
/**
|
|
853
|
+
* ID of an app.
|
|
854
|
+
* @format GUID
|
|
855
|
+
*/
|
|
638
856
|
appId?: string;
|
|
639
857
|
}
|
|
640
858
|
export declare enum WebhookIdentityType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"stores-catalog-v3-customization-customizations-v-3.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v3-customization-customizations-v-3.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"stores-catalog-v3-customization-customizations-v-3.types.js","sourceRoot":"","sources":["../../../src/stores-catalog-v3-customization-customizations-v-3.types.ts"],"names":[],"mappings":";;;AAuFA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,8EAAyD,CAAA;IACzD,sDAAiC,CAAA;IACjC,0CAAqB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,kGAAuE,CAAA;IACvE,kDAAuB,CAAA;IACvB,wDAA6B,CAAA;IAC7B,4DAAiC,CAAA;AACnC,CAAC,EALW,uBAAuB,uCAAvB,uBAAuB,QAKlC;AA4FD,IAAY,UAUX;AAVD,WAAY,UAAU;IACpB,yDAA2C,CAAA;IAC3C,yEAAyE;IACzE,yCAA2B,CAAA;IAC3B,qDAAqD;IACrD,qCAAuB,CAAA;IACvB,qDAAqD;IACrD,iDAAmC,CAAA;IACnC,qDAAqD;IACrD,6BAAe,CAAA;AACjB,CAAC,EAVW,UAAU,0BAAV,UAAU,QAUrB;AAiLD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,+BAA+B;IAC/B,sEAAmD,CAAA;IACnD,+BAA+B;IAC/B,sEAAmD,CAAA;AACrD,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAkFD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,uBAAuB;IACvB,wBAAW,CAAA;IACX,wBAAwB;IACxB,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAocD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|