@wix/auto_sdk_stores_customizations-v-3 1.0.87 → 1.0.89

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.
@@ -121,7 +121,7 @@ interface FreeTextSettings {
121
121
  maxCharCount?: number;
122
122
  /**
123
123
  * Default amount added to a product's price when this choice is assigned to a modifier.
124
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
124
+ * @decimalValue options { gte:0, lte:999999999.99, maxScale:3 }
125
125
  */
126
126
  defaultAddedPrice?: string | null;
127
127
  /**
@@ -166,6 +166,17 @@ interface Choice extends ChoiceValueOneOf {
166
166
  * @format COLOR_HEX
167
167
  */
168
168
  colorCode?: string;
169
+ /**
170
+ * Multiple colors - HEX (#RRGGBB) color code
171
+ * @internal
172
+ */
173
+ colorCodes?: MultipleColors;
174
+ /**
175
+ * The choice value when the choice type is IMAGE — the image itself is what's being selected.
176
+ * Not to be confused with display_image (field 14), which is a decorative overlay independent of choice type.
177
+ * @internal
178
+ */
179
+ image?: string;
169
180
  /**
170
181
  * Choice ID.
171
182
  * @format GUID
@@ -198,7 +209,7 @@ interface Choice extends ChoiceValueOneOf {
198
209
  name?: string;
199
210
  /**
200
211
  * Default amount added to a product's price when this customization is assigned to a modifier.
201
- * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
212
+ * @decimalValue options { gte:0, lte:999999999.99, maxScale:3 }
202
213
  */
203
214
  defaultAddedPrice?: string | null;
204
215
  /**
@@ -228,12 +239,33 @@ interface ChoiceValueOneOf {
228
239
  * @format COLOR_HEX
229
240
  */
230
241
  colorCode?: string;
242
+ /**
243
+ * Multiple colors - HEX (#RRGGBB) color code
244
+ * @internal
245
+ */
246
+ colorCodes?: MultipleColors;
247
+ /**
248
+ * The choice value when the choice type is IMAGE — the image itself is what's being selected.
249
+ * Not to be confused with display_image (field 14), which is a decorative overlay independent of choice type.
250
+ * @internal
251
+ */
252
+ image?: string;
231
253
  }
232
254
  declare enum ChoiceType {
233
255
  /** For a `customizationRenderType` of `TEXT_CHOICES`. */
234
256
  CHOICE_TEXT = "CHOICE_TEXT",
235
257
  /** For `customizationRenderType: SWATCH_CHOICES`. */
236
- ONE_COLOR = "ONE_COLOR"
258
+ ONE_COLOR = "ONE_COLOR",
259
+ /**
260
+ * For `customizationRenderType: SWATCH_CHOICES`.
261
+ * @internal
262
+ */
263
+ MULTIPLE_COLORS = "MULTIPLE_COLORS",
264
+ /**
265
+ * For `customizationRenderType: SWATCH_CHOICES`.
266
+ * @internal
267
+ */
268
+ IMAGE = "IMAGE"
237
269
  }
238
270
  /** @enumType */
239
271
  type ChoiceTypeWithLiterals = ChoiceType | 'CHOICE_TEXT' | 'ONE_COLOR';
@@ -463,6 +495,13 @@ interface GetCustomizationResponse {
463
495
  interface UpdateCustomizationRequest {
464
496
  /** Customization to update. */
465
497
  customization: Customization;
498
+ /**
499
+ * Set of fields to update.
500
+ *
501
+ * Fields that aren't included in `fieldMask.paths` are ignored.
502
+ * @internal
503
+ */
504
+ fieldMask?: string[];
466
505
  /**
467
506
  * Fields to include in the response.
468
507
  *
@@ -527,6 +566,20 @@ interface Sorting {
527
566
  fieldName?: string;
528
567
  /** Sort order. */
529
568
  order?: SortOrderWithLiterals;
569
+ /**
570
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
571
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
572
+ *
573
+ * If multiple filters are provided, they are combined with AND operator.
574
+ *
575
+ * Example:
576
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
577
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
578
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
579
+ * @internal
580
+ * @maxSize 10
581
+ */
582
+ selectItemsBy?: Record<string, any>[] | null;
530
583
  }
531
584
  declare enum SortOrder {
532
585
  /** Ascending order. */
@@ -796,6 +849,11 @@ interface UpdateCustomizationChoicesRequest {
796
849
  interface MaskedChoice {
797
850
  /** Choice to update. */
798
851
  choice?: Choice;
852
+ /**
853
+ * Set of choice fields to update.
854
+ * @internal
855
+ */
856
+ fieldMask?: string[];
799
857
  }
800
858
  interface UpdateCustomizationChoicesResponse {
801
859
  /** Updated customization. */
@@ -904,6 +962,11 @@ interface BulkUpdateCustomizationsRequest {
904
962
  interface MaskedCustomization {
905
963
  /** Customization to update. */
906
964
  customization?: Customization;
965
+ /**
966
+ * Explicit list of fields to update.
967
+ * @internal
968
+ */
969
+ fieldMask?: string[];
907
970
  }
908
971
  interface BulkUpdateCustomizationsResponse {
909
972
  /**
@@ -1765,6 +1828,20 @@ type CustomizationQuery = {
1765
1828
  Sort order.
1766
1829
  */
1767
1830
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
1831
+ /**
1832
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
1833
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
1834
+
1835
+ If multiple filters are provided, they are combined with AND operator.
1836
+
1837
+ Example:
1838
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
1839
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
1840
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
1841
+ @internal: undefined,
1842
+ @maxSize: 10
1843
+ */
1844
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
1768
1845
  }[];
1769
1846
  };
1770
1847
  declare const utils: {
@@ -897,6 +897,8 @@ var CustomizationRenderType = /* @__PURE__ */ ((CustomizationRenderType2) => {
897
897
  var ChoiceType = /* @__PURE__ */ ((ChoiceType2) => {
898
898
  ChoiceType2["CHOICE_TEXT"] = "CHOICE_TEXT";
899
899
  ChoiceType2["ONE_COLOR"] = "ONE_COLOR";
900
+ ChoiceType2["MULTIPLE_COLORS"] = "MULTIPLE_COLORS";
901
+ ChoiceType2["IMAGE"] = "IMAGE";
900
902
  return ChoiceType2;
901
903
  })(ChoiceType || {});
902
904
  var ChoiceSortStrategy = /* @__PURE__ */ ((ChoiceSortStrategy2) => {