@wix/auto_sdk_stores_customizations-v-3 1.0.80 → 1.0.82

package/build/cjs/index.typings.d.ts

@@ -193,6 +193,23 @@ interface Choice extends ChoiceValueOneOf {
      * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
      */
     defaultAddedPrice?: string | null;
+    /**
+     * Optional image displayed alongside a ONE_COLOR choice in the storefront.
+     * Only valid for ONE_COLOR choices; not populated for other choice types.
+     */
+    displayImage?: string;
+    /**
+     * IDs of the primary choices this choice is grouped under.
+     *
+     * 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
+     */
+    primaryChoiceIds?: string[];
 }
 /** @oneof */
 interface ChoiceValueOneOf {
@@ -425,10 +442,15 @@ interface GetCustomizationRequest {
 }
 declare enum RequestedFields {
     /** Assigned products count. */
-    ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
+    ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT",
+    /**
+     * Returns display images for choices.
+     * @documentationMaturity preview
+     */
+    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;
@@ -783,7 +805,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
@@ -792,20 +814,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 {
@@ -1840,6 +1862,29 @@ interface RemoveCustomizationChoicesOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
+/**
+ * Updates properties of existing choices in a customization.
+ * Choices are identified by their IDs. Only the fields specified in `fieldMask` are updated.
+ *
+ * Currently supports updating `primaryChoiceIds`.
+ * @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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField customizationId
+ * @requiredField options.choices
+ * @requiredField options.choices.choice
+ * @requiredField revision
+ * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomizationChoices
+ */
+declare function updateCustomizationChoices(customizationId: string, revision: string, options?: NonNullablePaths<UpdateCustomizationChoicesOptions, `choices` | `choices.${number}.choice`, 4>): Promise<NonNullablePaths<UpdateCustomizationChoicesResponse, `customization.freeTextInput.minCharCount` | `customization.freeTextInput.maxCharCount` | `customization.freeTextInput.title` | `customization.choicesSettings.choices` | `customization.choicesSettings.choices.${number}.colorCode` | `customization.choicesSettings.choices.${number}._id` | `customization.choicesSettings.choices.${number}.choiceType` | `customization.choicesSettings.choices.${number}.name` | `customization.name` | `customization.customizationType` | `customization.customizationRenderType`, 6> & {
+    __applicationErrorsType?: UpdateCustomizationChoicesApplicationErrors;
+    __validationErrorsType?: UpdateCustomizationChoicesValidationErrors;
+}>;
 interface UpdateCustomizationChoicesOptions {
     /**
      * Choices to update. Each item must include a `choice` with a valid `id` matching an existing choice in the customization.
@@ -1855,9 +1900,31 @@ interface UpdateCustomizationChoicesOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
+/**
+ * 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 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField customizationId
+ * @requiredField options.choiceIds
+ * @requiredField revision
+ * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.stores.catalog.customization.v3.CustomizationService.ReorderCustomizationChoices
+ */
+declare function reorderCustomizationChoices(customizationId: string, revision: string, options?: NonNullablePaths<ReorderCustomizationChoicesOptions, `choiceIds`, 2>): Promise<NonNullablePaths<ReorderCustomizationChoicesResponse, `customization.freeTextInput.minCharCount` | `customization.freeTextInput.maxCharCount` | `customization.freeTextInput.title` | `customization.choicesSettings.choices` | `customization.choicesSettings.choices.${number}.colorCode` | `customization.choicesSettings.choices.${number}._id` | `customization.choicesSettings.choices.${number}.choiceType` | `customization.choicesSettings.choices.${number}.name` | `customization.name` | `customization.customizationType` | `customization.customizationRenderType`, 6> & {
+    __applicationErrorsType?: ReorderCustomizationChoicesApplicationErrors;
+}>;
 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
@@ -1866,7 +1933,7 @@ interface ReorderCustomizationChoicesOptions {
     /**
      * Fields to include in the response.
      *
-     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`.
      * @maxSize 100
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -1934,4 +2001,4 @@ interface BulkUpdateCustomizationsOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddCustomizationChoicesApplicationErrors, type AddCustomizationChoicesOptions, type AddCustomizationChoicesRequest, type AddCustomizationChoicesResponse, type AddCustomizationChoicesValidationErrors, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAddCustomizationChoicesApplicationErrors, type BulkAddCustomizationChoicesOptions, type BulkAddCustomizationChoicesRequest, type BulkAddCustomizationChoicesResponse, type BulkAddCustomizationChoicesValidationErrors, type BulkCreateCustomizationsApplicationErrors, type BulkCreateCustomizationsForMigrationRequest, type BulkCreateCustomizationsForMigrationResponse, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type CatalogRollbackRequested, type Choice, type ChoiceIdsMismatchData, ChoiceSortStrategy, type ChoiceSortStrategyWithLiterals, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CommonQueryWithEntityContext, type CreateCustomizationApplicationErrors, type CreateCustomizationRequest, type CreateCustomizationResponse, type CreateCustomizationValidationErrors, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type Customization, type CustomizationChoices, type CustomizationCreatedEnvelope, type CustomizationCustomizationSettingsOneOf, type CustomizationDeletedEnvelope, type CustomizationIdsWrapper, type CustomizationQuery, type CustomizationQuerySpec, CustomizationRenderType, type CustomizationRenderTypeWithLiterals, CustomizationType, type CustomizationTypeWithLiterals, type CustomizationUpdatedEnvelope, type CustomizationsQueryBuilder, type CustomizationsQueryResult, type DeleteCustomizationRequest, type DeleteCustomizationResponse, type DeleteCustomizationValidationErrors, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type FocalPoint, type FreeTextSettings, type GetCustomizationOptions, type GetCustomizationRequest, type GetCustomizationResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type MaskedChoice, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type Pages, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RecloneSiteRequest, type RecloneSiteResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, type ReorderCustomizationChoicesApplicationErrors, type ReorderCustomizationChoicesOptions, type ReorderCustomizationChoicesRequest, type ReorderCustomizationChoicesResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type URIs, type UpdateCustomization, type UpdateCustomizationChoicesApplicationErrors, type UpdateCustomizationChoicesOptions, type UpdateCustomizationChoicesRequest, type UpdateCustomizationChoicesResponse, type UpdateCustomizationChoicesValidationErrors, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddCustomizationChoicesApplicationErrors, type AddCustomizationChoicesOptions, type AddCustomizationChoicesRequest, type AddCustomizationChoicesResponse, type AddCustomizationChoicesValidationErrors, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAddCustomizationChoicesApplicationErrors, type BulkAddCustomizationChoicesOptions, type BulkAddCustomizationChoicesRequest, type BulkAddCustomizationChoicesResponse, type BulkAddCustomizationChoicesValidationErrors, type BulkCreateCustomizationsApplicationErrors, type BulkCreateCustomizationsForMigrationRequest, type BulkCreateCustomizationsForMigrationResponse, type BulkCreateCustomizationsOptions, type BulkCreateCustomizationsRequest, type BulkCreateCustomizationsResponse, type BulkCreateCustomizationsValidationErrors, type BulkCustomizationResult, type BulkUpdateCustomizationsOptions, type BulkUpdateCustomizationsRequest, type BulkUpdateCustomizationsResponse, type CatalogRollbackRequested, type Choice, type ChoiceIdsMismatchData, ChoiceSortStrategy, type ChoiceSortStrategyWithLiterals, ChoiceType, type ChoiceTypeWithLiterals, type ChoiceValueOneOf, type ChoicesSettings, type CommonQueryWithEntityContext, type CreateCustomizationApplicationErrors, type CreateCustomizationRequest, type CreateCustomizationResponse, type CreateCustomizationValidationErrors, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type Customization, type CustomizationChoices, type CustomizationCreatedEnvelope, type CustomizationCustomizationSettingsOneOf, type CustomizationDeletedEnvelope, type CustomizationIdsWrapper, type CustomizationQuery, type CustomizationQuerySpec, CustomizationRenderType, type CustomizationRenderTypeWithLiterals, CustomizationType, type CustomizationTypeWithLiterals, type CustomizationUpdatedEnvelope, type CustomizationsQueryBuilder, type CustomizationsQueryResult, type DeleteCustomizationRequest, type DeleteCustomizationResponse, type DeleteCustomizationValidationErrors, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type File, type FocalPoint, type FreeTextSettings, type GetCustomizationOptions, type GetCustomizationRequest, type GetCustomizationResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type MaskedChoice, type MaskedCustomization, type MessageEnvelope, type MultipleColors, type Page, type Pages, type QueryCustomizationsOptions, type QueryCustomizationsRequest, type QueryCustomizationsResponse, type RecloneSiteRequest, type RecloneSiteResponse, type RemoveCustomizationChoicesApplicationErrors, type RemoveCustomizationChoicesOptions, type RemoveCustomizationChoicesRequest, type RemoveCustomizationChoicesResponse, type RemoveCustomizationChoicesValidationErrors, type ReorderCustomizationChoicesApplicationErrors, type ReorderCustomizationChoicesOptions, type ReorderCustomizationChoicesRequest, type ReorderCustomizationChoicesResponse, RequestedFields, type RequestedFieldsWithLiterals, type RestoreInfo, type SetCustomizationChoicesApplicationErrors, type SetCustomizationChoicesOptions, type SetCustomizationChoicesRequest, type SetCustomizationChoicesResponse, type SetCustomizationChoicesValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, type URI, type URIs, type UpdateCustomization, type UpdateCustomizationChoicesApplicationErrors, type UpdateCustomizationChoicesOptions, type UpdateCustomizationChoicesRequest, type UpdateCustomizationChoicesResponse, type UpdateCustomizationChoicesValidationErrors, type UpdateCustomizationOptions, type UpdateCustomizationRequest, type UpdateCustomizationResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, reorderCustomizationChoices, setCustomizationChoices, typedQueryCustomizations, updateCustomization, updateCustomizationChoices, utils };