@wix/auto_sdk_stores_customizations-v-3 1.0.88 → 1.0.90

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 (41) hide show
  1. package/build/cjs/index.js +2 -0
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +7 -7
  4. package/build/cjs/index.typings.js +2 -0
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +6 -6
  7. package/build/cjs/meta.js +2 -0
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.js +21 -21
  10. package/build/cjs/schemas.js.map +1 -1
  11. package/build/es/index.mjs +2 -0
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +7 -7
  14. package/build/es/index.typings.mjs +2 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +6 -6
  17. package/build/es/meta.mjs +2 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/es/schemas.mjs +21 -21
  20. package/build/es/schemas.mjs.map +1 -1
  21. package/build/internal/cjs/index.js +2 -0
  22. package/build/internal/cjs/index.js.map +1 -1
  23. package/build/internal/cjs/index.typings.d.ts +85 -8
  24. package/build/internal/cjs/index.typings.js +2 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -1
  26. package/build/internal/cjs/meta.d.ts +151 -7
  27. package/build/internal/cjs/meta.js +2 -0
  28. package/build/internal/cjs/meta.js.map +1 -1
  29. package/build/internal/cjs/schemas.js +21 -21
  30. package/build/internal/cjs/schemas.js.map +1 -1
  31. package/build/internal/es/index.mjs +2 -0
  32. package/build/internal/es/index.mjs.map +1 -1
  33. package/build/internal/es/index.typings.d.mts +85 -8
  34. package/build/internal/es/index.typings.mjs +2 -0
  35. package/build/internal/es/index.typings.mjs.map +1 -1
  36. package/build/internal/es/meta.d.mts +151 -7
  37. package/build/internal/es/meta.mjs +2 -0
  38. package/build/internal/es/meta.mjs.map +1 -1
  39. package/build/internal/es/schemas.mjs +21 -21
  40. package/build/internal/es/schemas.mjs.map +1 -1
  41. package/package.json +4 -4
@@ -145,10 +145,18 @@ interface ChoicesSettings {
145
145
  /**
146
146
  * List of choices.
147
147
  * @minSize 1
148
- * @maxSize 200
148
+ * @maxSize 1000
149
149
  * @immutable
150
150
  */
151
151
  choices?: Choice[];
152
+ /**
153
+ * Strategy for sorting choices in storefront filter panels. Use [Update Customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/update-customization) to change this value.
154
+ * `sortOrder` is set to `MANUAL` when calling [Reorder Customization Choices](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/reorder-customization-choices).
155
+ *
156
+ * Default: `DEFAULT`
157
+ * @internal
158
+ */
159
+ sortOrder?: ChoiceSortStrategyWithLiterals;
152
160
  }
153
161
  interface Choice extends ChoiceValueOneOf {
154
162
  /**
@@ -158,6 +166,17 @@ interface Choice extends ChoiceValueOneOf {
158
166
  * @format COLOR_HEX
159
167
  */
160
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?: Image;
161
180
  /**
162
181
  * Choice ID.
163
182
  * @format GUID
@@ -220,12 +239,33 @@ interface ChoiceValueOneOf {
220
239
  * @format COLOR_HEX
221
240
  */
222
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?: Image;
223
253
  }
224
254
  declare enum ChoiceType {
225
255
  /** For a `customizationRenderType` of `TEXT_CHOICES`. */
226
256
  CHOICE_TEXT = "CHOICE_TEXT",
227
257
  /** For `customizationRenderType: SWATCH_CHOICES`. */
228
- 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"
229
269
  }
230
270
  /** @enumType */
231
271
  type ChoiceTypeWithLiterals = ChoiceType | 'CHOICE_TEXT' | 'ONE_COLOR';
@@ -256,11 +296,29 @@ interface Image {
256
296
  width?: number;
257
297
  /** Image alt text. */
258
298
  altText?: string | null;
299
+ /**
300
+ * Image URL expiration date (when relevant).
301
+ * @internal
302
+ * @readonly
303
+ */
304
+ urlExpirationDate?: Date | null;
259
305
  /**
260
306
  * Image filename.
261
307
  * @readonly
262
308
  */
263
309
  filename?: string | null;
310
+ /**
311
+ * Image size in bytes.
312
+ * @internal
313
+ * @readonly
314
+ * @format DECIMAL_VALUE
315
+ */
316
+ sizeInBytes?: string | null;
317
+ /**
318
+ * Focal point of the image.
319
+ * @internal
320
+ */
321
+ focalPoint?: FocalPoint;
264
322
  }
265
323
  interface FocalPoint {
266
324
  /** X-coordinate of the focal point. */
@@ -298,12 +356,25 @@ interface CommonImage {
298
356
  * @maxLength 200
299
357
  */
300
358
  altText?: string | null;
359
+ /**
360
+ * Image URL expiration date (when relevant).
361
+ * @internal
362
+ * @readonly
363
+ */
364
+ urlExpirationDate?: Date | null;
301
365
  /**
302
366
  * Image filename.
303
367
  * @readonly
304
368
  * @maxLength 200
305
369
  */
306
370
  filename?: string | null;
371
+ /**
372
+ * Image size in bytes.
373
+ * @internal
374
+ * @readonly
375
+ * @format DECIMAL_VALUE
376
+ */
377
+ sizeInBytes?: string | null;
307
378
  }
308
379
  declare enum ChoiceSortStrategy {
309
380
  /** Default. Text choices are sorted by name, swatch choices are sorted by product count. */
@@ -511,6 +582,13 @@ interface GetCustomizationResponse {
511
582
  interface UpdateCustomizationRequest {
512
583
  /** Customization to update. */
513
584
  customization: Customization;
585
+ /**
586
+ * Set of fields to update.
587
+ *
588
+ * Fields that aren't included in `fieldMask.paths` are ignored.
589
+ * @internal
590
+ */
591
+ fieldMask?: string[];
514
592
  /**
515
593
  * Fields to include in the response.
516
594
  *
@@ -575,6 +653,20 @@ interface Sorting {
575
653
  fieldName?: string;
576
654
  /** Sort order. */
577
655
  order?: SortOrderWithLiterals;
656
+ /**
657
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
658
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
659
+ *
660
+ * If multiple filters are provided, they are combined with AND operator.
661
+ *
662
+ * Example:
663
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
664
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
665
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
666
+ * @internal
667
+ * @maxSize 10
668
+ */
669
+ selectItemsBy?: Record<string, any>[] | null;
578
670
  }
579
671
  declare enum SortOrder {
580
672
  /** Ascending order. */
@@ -749,7 +841,7 @@ interface AddCustomizationChoicesRequest {
749
841
  /**
750
842
  * Choices to add.
751
843
  * @minSize 1
752
- * @maxSize 100
844
+ * @maxSize 1000
753
845
  */
754
846
  choices: Choice[];
755
847
  /**
@@ -773,7 +865,7 @@ interface SetCustomizationChoicesRequest {
773
865
  /**
774
866
  * Choices to set.
775
867
  * @minSize 1
776
- * @maxSize 200
868
+ * @maxSize 1000
777
869
  */
778
870
  choices: Choice[];
779
871
  /**
@@ -844,6 +936,11 @@ interface UpdateCustomizationChoicesRequest {
844
936
  interface MaskedChoice {
845
937
  /** Choice to update. */
846
938
  choice?: Choice;
939
+ /**
940
+ * Set of choice fields to update.
941
+ * @internal
942
+ */
943
+ fieldMask?: string[];
847
944
  }
848
945
  interface UpdateCustomizationChoicesResponse {
849
946
  /** Updated customization. */
@@ -861,7 +958,7 @@ interface ReorderCustomizationChoicesRequest {
861
958
  * Choice IDs in the desired display order. Must contain exactly the same IDs as the customization's current choices, with no additions, removals, or duplicates.
862
959
  * @format GUID
863
960
  * @minSize 1
864
- * @maxSize 200
961
+ * @maxSize 1000
865
962
  */
866
963
  choiceIds: string[];
867
964
  /**
@@ -887,7 +984,7 @@ interface BulkAddCustomizationChoicesRequest {
887
984
  /**
888
985
  * List of customization IDs and choices.
889
986
  * @minSize 1
890
- * @maxSize 100
987
+ * @maxSize 1000
891
988
  */
892
989
  customizationsChoices: CustomizationChoices[];
893
990
  /**
@@ -922,7 +1019,7 @@ interface BulkAddCustomizationChoicesResponse {
922
1019
  /**
923
1020
  * Customizations updated by bulk action.
924
1021
  * @minSize 1
925
- * @maxSize 100
1022
+ * @maxSize 1000
926
1023
  */
927
1024
  results?: BulkCustomizationResult[];
928
1025
  /** Bulk action metadata. */
@@ -952,6 +1049,11 @@ interface BulkUpdateCustomizationsRequest {
952
1049
  interface MaskedCustomization {
953
1050
  /** Customization to update. */
954
1051
  customization?: Customization;
1052
+ /**
1053
+ * Explicit list of fields to update.
1054
+ * @internal
1055
+ */
1056
+ fieldMask?: string[];
955
1057
  }
956
1058
  interface BulkUpdateCustomizationsResponse {
957
1059
  /**
@@ -1006,8 +1108,18 @@ interface DomainEventBodyOneOf {
1006
1108
  }
1007
1109
  interface EntityCreatedEvent {
1008
1110
  entityAsJson?: string;
1111
+ /**
1112
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
1113
+ * @internal
1114
+ */
1115
+ triggeredByUndelete?: boolean | null;
1009
1116
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1010
1117
  restoreInfo?: RestoreInfo;
1118
+ /**
1119
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1120
+ * @internal
1121
+ */
1122
+ additionalMetadataAsJson?: string | null;
1011
1123
  }
1012
1124
  interface RestoreInfo {
1013
1125
  deletedDate?: Date | null;
@@ -1019,10 +1131,42 @@ interface EntityUpdatedEvent {
1019
1131
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1020
1132
  */
1021
1133
  currentEntityAsJson?: string;
1134
+ /**
1135
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
1136
+ * wont populate it / have any reference to it in the API.
1137
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
1138
+ * the developer should send only the new (current) entity.
1139
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
1140
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
1141
+ * @internal
1142
+ * @deprecated
1143
+ */
1144
+ previousEntityAsJson?: string | null;
1145
+ /**
1146
+ * Map of fully qualified field paths to their previous values for fields that changed.
1147
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
1148
+ * @internal
1149
+ */
1150
+ modifiedFields?: Record<string, any>;
1151
+ /**
1152
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1153
+ * @internal
1154
+ */
1155
+ additionalMetadataAsJson?: string | null;
1022
1156
  }
1023
1157
  interface EntityDeletedEvent {
1158
+ /**
1159
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
1160
+ * @internal
1161
+ */
1162
+ movedToTrash?: boolean | null;
1024
1163
  /** Entity that was deleted. */
1025
1164
  deletedEntityAsJson?: string | null;
1165
+ /**
1166
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
1167
+ * @internal
1168
+ */
1169
+ additionalMetadataAsJson?: string | null;
1026
1170
  }
1027
1171
  interface ActionEvent {
1028
1172
  bodyAsJson?: string;
@@ -886,6 +886,8 @@ var CustomizationRenderType = /* @__PURE__ */ ((CustomizationRenderType2) => {
886
886
  var ChoiceType = /* @__PURE__ */ ((ChoiceType2) => {
887
887
  ChoiceType2["CHOICE_TEXT"] = "CHOICE_TEXT";
888
888
  ChoiceType2["ONE_COLOR"] = "ONE_COLOR";
889
+ ChoiceType2["MULTIPLE_COLORS"] = "MULTIPLE_COLORS";
890
+ ChoiceType2["IMAGE"] = "IMAGE";
889
891
  return ChoiceType2;
890
892
  })(ChoiceType || {});
891
893
  var ChoiceSortStrategy = /* @__PURE__ */ ((ChoiceSortStrategy2) => {