@wix/auto_sdk_stores_customizations-v-3 1.0.80 → 1.0.82

package/build/internal/es/index.typings.d.mts

@@ -204,18 +204,16 @@ interface Choice extends ChoiceValueOneOf {
     /**
      * Optional image displayed alongside a ONE_COLOR choice in the storefront.
      * Only valid for ONE_COLOR choices; not populated for other choice types.
-     * @internal
      */
     displayImage?: string;
     /**
-     * IDs of primary choices that this choice is grouped under for storefront filtering.
-     * A choice with `primaryChoiceIds` is considered a "linked" choice.
-     * Linked choices are excluded from the top-level storefront filter list
-     * and displayed only under their primary choice groups.
+     * IDs of the primary choices this choice is grouped under.
      *
-     * A linked choice can have multiple primaries, in which case it appears under each primary group.
-     * Only a single level of primary-linked grouping is supported. A choice that is a primary can't also be a linked choice.
-     * @internal
+     * A choice that has `primaryChoiceIds` is a "linked" choice; a choice without `primaryChoiceIds` is a "primary" choice.
+     * A linked choice can reference up to 4 primary choices and appears nested under each of them on the storefront,
+     * rather than in the top-level choice list.
+     *
+     * Only one level of grouping is supported: a primary choice cannot itself be a linked choice.
      * @format GUID
      * @maxSize 4
      */
@@ -456,12 +454,11 @@ declare enum RequestedFields {
     /**
      * Returns display images for choices.
      * @documentationMaturity preview
-     * @internal
      */
     CHOICE_DISPLAY_IMAGE = "CHOICE_DISPLAY_IMAGE"
 }
 /** @enumType */
-type RequestedFieldsWithLiterals = RequestedFields | 'ASSIGNED_PRODUCTS_COUNT';
+type RequestedFieldsWithLiterals = RequestedFields | 'ASSIGNED_PRODUCTS_COUNT' | 'CHOICE_DISPLAY_IMAGE';
 interface GetCustomizationResponse {
     /** Customization. */
     customization?: Customization;
@@ -816,7 +813,7 @@ interface ReorderCustomizationChoicesRequest {
     /** Revision number, which increments by 1 each time the customization is updated. To prevent conflicting changes, the current revision must be passed when updating the customization. */
     revision: string;
     /**
-     * Choice IDs in the desired display order. Must contain exactly the same set of IDs as the customization's current choices — no additions or removals.
+     * 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.
      * @format GUID
      * @minSize 1
      * @maxSize 200
@@ -825,20 +822,20 @@ interface ReorderCustomizationChoicesRequest {
     /**
      * Fields to include in the response.
      *
-     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`.
      * @maxSize 100
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 interface ReorderCustomizationChoicesResponse {
-    /** Updated customization. */
+    /** Updated customization, with `choices` in the new order and `choicesSettings.sortOrder` set to `MANUAL`. */
     customization?: Customization;
 }
 /** Additional error details returned with the `CHOICE_IDS_MISMATCH` error. */
 interface ChoiceIdsMismatchData {
-    /** Choice IDs that exist in the customization but are missing from the request. */
+    /** Choice IDs that exist in the customization but are missing from `choiceIds`. */
     missingIds?: string[];
-    /** Choice IDs included in the request that don't exist in the customization. */
+    /** Choice IDs included in `choiceIds` that don't exist in the customization, or that appear in `choiceIds` more than once. */
     extraIds?: string[];
 }
 interface BulkAddCustomizationChoicesRequest {
@@ -1882,7 +1879,7 @@ interface RemoveCustomizationChoicesOptions {
  * @param revision - Revision number, which increments by 1 each time the customization is updated.
  * To prevent conflicting changes,
  * the current revision must be passed when updating the customization.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField customizationId
  * @requiredField options.choices
@@ -1912,13 +1909,16 @@ interface UpdateCustomizationChoicesOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * Reorders a customization's choices. The new order is persisted and reflected in the customization's choices list.
- * Calling this endpoint sets `choicesSettings.sortOrder` to `MANUAL`.
+ * Sets the display order of a customization's choices.
+ *
+ * Each time the customization is updated, `revision` increments by 1. The current `revision` must be passed when updating the customization. This ensures you're working with the latest customization and prevents unintended overwrites.
+ *
+ * The new order is persisted in the customization's `choices` list. Calling this method also sets `choicesSettings.sortOrder` to `MANUAL`.
  *
- * To control how choices are sorted in storefront filter panels, use [Update Customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/update-customization) to set the `choicesSettings.sortOrder` field.
+ * To change how choices are sorted in storefront filter panels without specifying an explicit order, call [Update Customization](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/update-customization) and set the `choicesSettings.sortOrder` field.
  * @param customizationId - Customization ID.
  * @param revision - Revision number, which increments by 1 each time the customization is updated. To prevent conflicting changes, the current revision must be passed when updating the customization.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField customizationId
  * @requiredField options.choiceIds
@@ -1932,7 +1932,7 @@ declare function reorderCustomizationChoices(customizationId: string, revision:
 }>;
 interface ReorderCustomizationChoicesOptions {
     /**
-     * Choice IDs in the desired display order. Must contain exactly the same set of IDs as the customization's current choices — no additions or removals.
+     * 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.
      * @format GUID
      * @minSize 1
      * @maxSize 200
@@ -1941,7 +1941,7 @@ interface ReorderCustomizationChoicesOptions {
     /**
      * Fields to include in the response.
      *
-     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`.
      * @maxSize 100
      */
     fields?: RequestedFieldsWithLiterals[];