@wix/auto_sdk_stores_customizations-v-3 1.0.80 → 1.0.82

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { Customization, CreateCustomizationApplicationErrors, CreateCustomizationValidationErrors, GetCustomizationOptions, UpdateCustomization, UpdateCustomizationOptions, DeleteCustomizationValidationErrors, BulkCreateCustomizationsOptions, BulkCreateCustomizationsResponse, BulkCreateCustomizationsApplicationErrors, BulkCreateCustomizationsValidationErrors, Choice, AddCustomizationChoicesOptions, AddCustomizationChoicesResponse, AddCustomizationChoicesApplicationErrors, AddCustomizationChoicesValidationErrors, SetCustomizationChoicesOptions, SetCustomizationChoicesResponse, SetCustomizationChoicesApplicationErrors, SetCustomizationChoicesValidationErrors, RemoveCustomizationChoicesOptions, RemoveCustomizationChoicesResponse, RemoveCustomizationChoicesApplicationErrors, RemoveCustomizationChoicesValidationErrors, CustomizationChoices, BulkAddCustomizationChoicesOptions, BulkAddCustomizationChoicesResponse, BulkAddCustomizationChoicesApplicationErrors, BulkAddCustomizationChoicesValidationErrors, MaskedCustomization, BulkUpdateCustomizationsOptions, BulkUpdateCustomizationsResponse, CustomizationCreatedEnvelope, CustomizationDeletedEnvelope, CustomizationUpdatedEnvelope, CustomizationQuery, QueryCustomizationsOptions, typedQueryCustomizations, CustomizationsQueryBuilder } from './index.typings.js';
-export { AccountInfo, AccountInfoMetadata, ActionEvent, AddCustomizationChoicesRequest, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAddCustomizationChoicesRequest, BulkCreateCustomizationsForMigrationRequest, BulkCreateCustomizationsForMigrationResponse, BulkCreateCustomizationsRequest, BulkCustomizationResult, BulkUpdateCustomizationsRequest, CatalogRollbackRequested, ChoiceIdsMismatchData, ChoiceSortStrategy, ChoiceSortStrategyWithLiterals, ChoiceType, ChoiceTypeWithLiterals, ChoiceValueOneOf, ChoicesSettings, CommonQueryWithEntityContext, CreateCustomizationRequest, CreateCustomizationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, CustomizationCustomizationSettingsOneOf, CustomizationIdsWrapper, CustomizationQuerySpec, CustomizationRenderType, CustomizationRenderTypeWithLiterals, CustomizationType, CustomizationTypeWithLiterals, CustomizationsQueryResult, DeleteCustomizationRequest, DeleteCustomizationResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, FocalPoint, FreeTextSettings, GetCustomizationRequest, GetCustomizationResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MaskedChoice, MessageEnvelope, MultipleColors, Page, Pages, QueryCustomizationsRequest, QueryCustomizationsResponse, RecloneSiteRequest, RecloneSiteResponse, RemoveCustomizationChoicesRequest, ReorderCustomizationChoicesApplicationErrors, ReorderCustomizationChoicesOptions, ReorderCustomizationChoicesRequest, ReorderCustomizationChoicesResponse, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, SetCustomizationChoicesRequest, SortOrder, SortOrderWithLiterals, Sorting, URI, URIs, UpdateCustomizationChoicesApplicationErrors, UpdateCustomizationChoicesOptions, UpdateCustomizationChoicesRequest, UpdateCustomizationChoicesResponse, UpdateCustomizationChoicesValidationErrors, UpdateCustomizationRequest, UpdateCustomizationResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+import { Customization, CreateCustomizationApplicationErrors, CreateCustomizationValidationErrors, GetCustomizationOptions, UpdateCustomization, UpdateCustomizationOptions, DeleteCustomizationValidationErrors, BulkCreateCustomizationsOptions, BulkCreateCustomizationsResponse, BulkCreateCustomizationsApplicationErrors, BulkCreateCustomizationsValidationErrors, Choice, AddCustomizationChoicesOptions, AddCustomizationChoicesResponse, AddCustomizationChoicesApplicationErrors, AddCustomizationChoicesValidationErrors, SetCustomizationChoicesOptions, SetCustomizationChoicesResponse, SetCustomizationChoicesApplicationErrors, SetCustomizationChoicesValidationErrors, RemoveCustomizationChoicesOptions, RemoveCustomizationChoicesResponse, RemoveCustomizationChoicesApplicationErrors, RemoveCustomizationChoicesValidationErrors, UpdateCustomizationChoicesOptions, UpdateCustomizationChoicesResponse, UpdateCustomizationChoicesApplicationErrors, UpdateCustomizationChoicesValidationErrors, ReorderCustomizationChoicesOptions, ReorderCustomizationChoicesResponse, ReorderCustomizationChoicesApplicationErrors, CustomizationChoices, BulkAddCustomizationChoicesOptions, BulkAddCustomizationChoicesResponse, BulkAddCustomizationChoicesApplicationErrors, BulkAddCustomizationChoicesValidationErrors, MaskedCustomization, BulkUpdateCustomizationsOptions, BulkUpdateCustomizationsResponse, CustomizationCreatedEnvelope, CustomizationDeletedEnvelope, CustomizationUpdatedEnvelope, CustomizationQuery, QueryCustomizationsOptions, typedQueryCustomizations, CustomizationsQueryBuilder } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, AddCustomizationChoicesRequest, App, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAddCustomizationChoicesRequest, BulkCreateCustomizationsForMigrationRequest, BulkCreateCustomizationsForMigrationResponse, BulkCreateCustomizationsRequest, BulkCustomizationResult, BulkUpdateCustomizationsRequest, CatalogRollbackRequested, ChoiceIdsMismatchData, ChoiceSortStrategy, ChoiceSortStrategyWithLiterals, ChoiceType, ChoiceTypeWithLiterals, ChoiceValueOneOf, ChoicesSettings, CommonQueryWithEntityContext, CreateCustomizationRequest, CreateCustomizationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomTag, CustomizationCustomizationSettingsOneOf, CustomizationIdsWrapper, CustomizationQuerySpec, CustomizationRenderType, CustomizationRenderTypeWithLiterals, CustomizationType, CustomizationTypeWithLiterals, CustomizationsQueryResult, DeleteCustomizationRequest, DeleteCustomizationResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, File, FocalPoint, FreeTextSettings, GetCustomizationRequest, GetCustomizationResponse, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ItemMetadata, MaskedChoice, MessageEnvelope, MultipleColors, Page, Pages, QueryCustomizationsRequest, QueryCustomizationsResponse, RecloneSiteRequest, RecloneSiteResponse, RemoveCustomizationChoicesRequest, ReorderCustomizationChoicesRequest, RequestedFields, RequestedFieldsWithLiterals, RestoreInfo, SetCustomizationChoicesRequest, SortOrder, SortOrderWithLiterals, Sorting, URI, URIs, UpdateCustomizationChoicesRequest, UpdateCustomizationRequest, UpdateCustomizationResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
 declare function createCustomization$1(httpClient: HttpClient): CreateCustomizationSignature;
 interface CreateCustomizationSignature {
@@ -101,6 +101,40 @@ interface RemoveCustomizationChoicesSignature {
         __validationErrorsType?: RemoveCustomizationChoicesValidationErrors;
     }>;
 }
+declare function updateCustomizationChoices$1(httpClient: HttpClient): UpdateCustomizationChoicesSignature;
+interface UpdateCustomizationChoicesSignature {
+    /**
+     * 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 - Customization ID.
+     * @param - 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.
+     */
+    (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;
+    }>;
+}
+declare function reorderCustomizationChoices$1(httpClient: HttpClient): ReorderCustomizationChoicesSignature;
+interface ReorderCustomizationChoicesSignature {
+    /**
+     * 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 - Customization ID.
+     * @param - 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.
+     */
+    (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;
+    }>;
+}
 declare function bulkAddCustomizationChoices$1(httpClient: HttpClient): BulkAddCustomizationChoicesSignature;
 interface BulkAddCustomizationChoicesSignature {
     /**
@@ -140,6 +174,8 @@ declare const bulkCreateCustomizations: MaybeContext<BuildRESTFunction<typeof bu
 declare const addCustomizationChoices: MaybeContext<BuildRESTFunction<typeof addCustomizationChoices$1> & typeof addCustomizationChoices$1>;
 declare const setCustomizationChoices: MaybeContext<BuildRESTFunction<typeof setCustomizationChoices$1> & typeof setCustomizationChoices$1>;
 declare const removeCustomizationChoices: MaybeContext<BuildRESTFunction<typeof removeCustomizationChoices$1> & typeof removeCustomizationChoices$1>;
+declare const updateCustomizationChoices: MaybeContext<BuildRESTFunction<typeof updateCustomizationChoices$1> & typeof updateCustomizationChoices$1>;
+declare const reorderCustomizationChoices: MaybeContext<BuildRESTFunction<typeof reorderCustomizationChoices$1> & typeof reorderCustomizationChoices$1>;
 declare const bulkAddCustomizationChoices: MaybeContext<BuildRESTFunction<typeof bulkAddCustomizationChoices$1> & typeof bulkAddCustomizationChoices$1>;
 declare const bulkUpdateCustomizations: MaybeContext<BuildRESTFunction<typeof bulkUpdateCustomizations$1> & typeof bulkUpdateCustomizations$1>;
 declare const queryCustomizations: MaybeContext<BuildRESTFunction<typeof customQueryCustomizations> & typeof customQueryCustomizations>;
@@ -156,4 +192,4 @@ declare const onCustomizationDeleted: BuildEventDefinition<typeof onCustomizatio
  */
 declare const onCustomizationUpdated: BuildEventDefinition<typeof onCustomizationUpdated$1> & typeof onCustomizationUpdated$1;
 
-export { AddCustomizationChoicesApplicationErrors, AddCustomizationChoicesOptions, AddCustomizationChoicesResponse, AddCustomizationChoicesValidationErrors, BulkAddCustomizationChoicesApplicationErrors, BulkAddCustomizationChoicesOptions, BulkAddCustomizationChoicesResponse, BulkAddCustomizationChoicesValidationErrors, BulkCreateCustomizationsApplicationErrors, BulkCreateCustomizationsOptions, BulkCreateCustomizationsResponse, BulkCreateCustomizationsValidationErrors, BulkUpdateCustomizationsOptions, BulkUpdateCustomizationsResponse, Choice, CreateCustomizationApplicationErrors, CreateCustomizationValidationErrors, Customization, CustomizationChoices, CustomizationCreatedEnvelope, CustomizationDeletedEnvelope, CustomizationQuery, CustomizationUpdatedEnvelope, CustomizationsQueryBuilder, DeleteCustomizationValidationErrors, GetCustomizationOptions, MaskedCustomization, QueryCustomizationsOptions, RemoveCustomizationChoicesApplicationErrors, RemoveCustomizationChoicesOptions, RemoveCustomizationChoicesResponse, RemoveCustomizationChoicesValidationErrors, SetCustomizationChoicesApplicationErrors, SetCustomizationChoicesOptions, SetCustomizationChoicesResponse, SetCustomizationChoicesValidationErrors, UpdateCustomization, UpdateCustomizationOptions, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, setCustomizationChoices, updateCustomization };
+export { AddCustomizationChoicesApplicationErrors, AddCustomizationChoicesOptions, AddCustomizationChoicesResponse, AddCustomizationChoicesValidationErrors, BulkAddCustomizationChoicesApplicationErrors, BulkAddCustomizationChoicesOptions, BulkAddCustomizationChoicesResponse, BulkAddCustomizationChoicesValidationErrors, BulkCreateCustomizationsApplicationErrors, BulkCreateCustomizationsOptions, BulkCreateCustomizationsResponse, BulkCreateCustomizationsValidationErrors, BulkUpdateCustomizationsOptions, BulkUpdateCustomizationsResponse, Choice, CreateCustomizationApplicationErrors, CreateCustomizationValidationErrors, Customization, CustomizationChoices, CustomizationCreatedEnvelope, CustomizationDeletedEnvelope, CustomizationQuery, CustomizationUpdatedEnvelope, CustomizationsQueryBuilder, DeleteCustomizationValidationErrors, GetCustomizationOptions, MaskedCustomization, QueryCustomizationsOptions, RemoveCustomizationChoicesApplicationErrors, RemoveCustomizationChoicesOptions, RemoveCustomizationChoicesResponse, RemoveCustomizationChoicesValidationErrors, ReorderCustomizationChoicesApplicationErrors, ReorderCustomizationChoicesOptions, ReorderCustomizationChoicesResponse, SetCustomizationChoicesApplicationErrors, SetCustomizationChoicesOptions, SetCustomizationChoicesResponse, SetCustomizationChoicesValidationErrors, UpdateCustomization, UpdateCustomizationChoicesApplicationErrors, UpdateCustomizationChoicesOptions, UpdateCustomizationChoicesResponse, UpdateCustomizationChoicesValidationErrors, UpdateCustomizationOptions, addCustomizationChoices, bulkAddCustomizationChoices, bulkCreateCustomizations, bulkUpdateCustomizations, createCustomization, deleteCustomization, getCustomization, onCustomizationCreated, onCustomizationDeleted, onCustomizationUpdated, queryCustomizations, removeCustomizationChoices, reorderCustomizationChoices, setCustomizationChoices, updateCustomization, updateCustomizationChoices };