@wix/auto_sdk_stores_customizations-v-3 1.0.69 → 1.0.71

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

@@ -96,14 +96,12 @@ interface CustomizationCustomizationSettingsOneOf {
     choicesSettings?: ChoicesSettings;
 }
 declare enum CustomizationType {
-    UNKNOWN_CUSTOMIZATION_TYPE = "UNKNOWN_CUSTOMIZATION_TYPE",
     PRODUCT_OPTION = "PRODUCT_OPTION",
     MODIFIER = "MODIFIER"
 }
 /** @enumType */
-type CustomizationTypeWithLiterals = CustomizationType | 'UNKNOWN_CUSTOMIZATION_TYPE' | 'PRODUCT_OPTION' | 'MODIFIER';
+type CustomizationTypeWithLiterals = CustomizationType | 'PRODUCT_OPTION' | 'MODIFIER';
 declare enum CustomizationRenderType {
-    UNKNOWN_CUSTOMIZATION_RENDER_TYPE = "UNKNOWN_CUSTOMIZATION_RENDER_TYPE",
     /** Customization by free text input. */
     FREE_TEXT = "FREE_TEXT",
     /** Customization by selection of text choices. */
@@ -112,7 +110,7 @@ declare enum CustomizationRenderType {
     SWATCH_CHOICES = "SWATCH_CHOICES"
 }
 /** @enumType */
-type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'UNKNOWN_CUSTOMIZATION_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
+type CustomizationRenderTypeWithLiterals = CustomizationRenderType | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
 interface FreeTextSettings {
     /** Minimum text character length. */
     minCharCount?: number;
@@ -207,14 +205,13 @@ interface ChoiceValueOneOf {
     colorCode?: string;
 }
 declare enum ChoiceType {
-    UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
     /** For a `customizationRenderType` of `TEXT_CHOICES`. */
     CHOICE_TEXT = "CHOICE_TEXT",
     /** For `customizationRenderType: SWATCH_CHOICES`. */
     ONE_COLOR = "ONE_COLOR"
 }
 /** @enumType */
-type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR';
+type ChoiceTypeWithLiterals = ChoiceType | 'CHOICE_TEXT' | 'ONE_COLOR';
 interface MultipleColors {
     /**
      * A list of color codes.
@@ -236,18 +233,17 @@ interface FocalPoint {
     width?: number | null;
 }
 declare enum ChoiceSortStrategy {
-    UNKNOWN_CHOICE_SORT_STRATEGY = "UNKNOWN_CHOICE_SORT_STRATEGY",
-    /** Text choices are sorted by name, and swatch choices are sorted by the number of matching products. */
+    /** Default. Text choices are sorted by name, swatch choices are sorted by product count. */
     DEFAULT = "DEFAULT",
-    /** Sort choices alphabetically by name, case-insensitive, with numeric values first. */
+    /** Alphabetically by name, case-insensitive. Numeric values are sorted first. */
     BY_NAME = "BY_NAME",
-    /** Sort choices by the number of products assigned to each choice, in descending order. */
+    /** By the number of products assigned to each choice, in descending order. */
     BY_PRODUCT_COUNT = "BY_PRODUCT_COUNT",
-    /** Sort choices by their order in the choices list. */
+    /** By the order of the choices list. Use [Reorder Customization Choices](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/reorder-customization-choices) to set the order. */
     MANUAL = "MANUAL"
 }
 /** @enumType */
-type ChoiceSortStrategyWithLiterals = ChoiceSortStrategy | 'UNKNOWN_CHOICE_SORT_STRATEGY' | 'DEFAULT' | 'BY_NAME' | 'BY_PRODUCT_COUNT' | 'MANUAL';
+type ChoiceSortStrategyWithLiterals = ChoiceSortStrategy | 'DEFAULT' | 'BY_NAME' | 'BY_PRODUCT_COUNT' | 'MANUAL';
 interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /**
      * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
@@ -428,13 +424,11 @@ interface GetCustomizationRequest {
     fields?: RequestedFieldsWithLiterals[];
 }
 declare enum RequestedFields {
-    /** Unknown requested field. */
-    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     /** Assigned products count. */
     ASSIGNED_PRODUCTS_COUNT = "ASSIGNED_PRODUCTS_COUNT"
 }
 /** @enumType */
-type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'ASSIGNED_PRODUCTS_COUNT';
+type RequestedFieldsWithLiterals = RequestedFields | 'ASSIGNED_PRODUCTS_COUNT';
 interface GetCustomizationResponse {
     /** Customization. */
     customization?: Customization;
@@ -780,6 +774,40 @@ interface UpdateCustomizationChoicesResponse {
     /** Updated customization. */
     customization?: Customization;
 }
+interface ReorderCustomizationChoicesRequest {
+    /**
+     * Customization ID.
+     * @format GUID
+     */
+    customizationId: string;
+    /** 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.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 200
+     */
+    choiceIds: string[];
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface ReorderCustomizationChoicesResponse {
+    /** Updated customization. */
+    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. */
+    missingIds?: string[];
+    /** Choice IDs included in the request that don't exist in the customization. */
+    extraIds?: string[];
+}
 interface BulkAddCustomizationChoicesRequest {
     /**
      * List of customization IDs and choices.
@@ -1180,6 +1208,16 @@ type UpdateCustomizationChoicesValidationErrors = {
     ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
+type ReorderCustomizationChoicesApplicationErrors = {
+    code?: 'DOESNT_SUPPORT_CHOICES';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CHOICE_IDS_MISMATCH';
+    description?: string;
+    data?: ChoiceIdsMismatchData;
+};
+/** @docsIgnore */
 type BulkAddCustomizationChoicesApplicationErrors = {
     code?: 'CHOICES_LIMIT_EXCEEDED';
     description?: string;
@@ -1804,6 +1842,22 @@ interface UpdateCustomizationChoicesOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
+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.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 200
+     */
+    choiceIds: string[];
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
 /**
  * Adds choices to multiple customizations.
  * @param customizationsChoices - List of customization IDs and choices.
@@ -1867,4 +1921,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 Choice, 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, 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 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 };

package/build/es/index.typings.mjs

@@ -599,6 +599,50 @@ function updateCustomizationChoices(payload) {
   }
   return __updateCustomizationChoices;
 }
+function reorderCustomizationChoices(payload) {
+  function __reorderCustomizationChoices({ host }) {
+    const metadata = {
+      entityFqdn: "wix.stores.catalog.v3.customization",
+      method: "POST",
+      methodFqn: "wix.stores.catalog.customization.v3.CustomizationService.ReorderCustomizationChoices",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixStoresCatalogCustomizationV3CustomizationServiceUrl({
+        protoPath: "/v3/customizations/{customizationId}/reorder-choices",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "customization.createdDate" },
+            { path: "customization.updatedDate" },
+            {
+              path: "customization.choicesSettings.choices.image.urlExpirationDate"
+            }
+          ]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            {
+              path: "customization.choicesSettings.choices.image.focalPoint.x"
+            },
+            {
+              path: "customization.choicesSettings.choices.image.focalPoint.y"
+            }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __reorderCustomizationChoices;
+}
 function bulkAddCustomizationChoices(payload) {
   function __bulkAddCustomizationChoices({ host }) {
     const serializedData = transformPaths(payload, [
@@ -736,26 +780,22 @@ import { transformRESTImageToSDKImage } from "@wix/sdk-runtime/transformations/i
 import { transformPaths as transformPaths2 } from "@wix/sdk-runtime/transformations/transform-paths";
 import { createQueryUtils } from "@wix/sdk-runtime/query-builder-utils";
 var CustomizationType = /* @__PURE__ */ ((CustomizationType2) => {
-  CustomizationType2["UNKNOWN_CUSTOMIZATION_TYPE"] = "UNKNOWN_CUSTOMIZATION_TYPE";
   CustomizationType2["PRODUCT_OPTION"] = "PRODUCT_OPTION";
   CustomizationType2["MODIFIER"] = "MODIFIER";
   return CustomizationType2;
 })(CustomizationType || {});
 var CustomizationRenderType = /* @__PURE__ */ ((CustomizationRenderType2) => {
-  CustomizationRenderType2["UNKNOWN_CUSTOMIZATION_RENDER_TYPE"] = "UNKNOWN_CUSTOMIZATION_RENDER_TYPE";
   CustomizationRenderType2["FREE_TEXT"] = "FREE_TEXT";
   CustomizationRenderType2["TEXT_CHOICES"] = "TEXT_CHOICES";
   CustomizationRenderType2["SWATCH_CHOICES"] = "SWATCH_CHOICES";
   return CustomizationRenderType2;
 })(CustomizationRenderType || {});
 var ChoiceType = /* @__PURE__ */ ((ChoiceType2) => {
-  ChoiceType2["UNKNOWN_CHOICE_TYPE"] = "UNKNOWN_CHOICE_TYPE";
   ChoiceType2["CHOICE_TEXT"] = "CHOICE_TEXT";
   ChoiceType2["ONE_COLOR"] = "ONE_COLOR";
   return ChoiceType2;
 })(ChoiceType || {});
 var ChoiceSortStrategy = /* @__PURE__ */ ((ChoiceSortStrategy2) => {
-  ChoiceSortStrategy2["UNKNOWN_CHOICE_SORT_STRATEGY"] = "UNKNOWN_CHOICE_SORT_STRATEGY";
   ChoiceSortStrategy2["DEFAULT"] = "DEFAULT";
   ChoiceSortStrategy2["BY_NAME"] = "BY_NAME";
   ChoiceSortStrategy2["BY_PRODUCT_COUNT"] = "BY_PRODUCT_COUNT";
@@ -763,7 +803,6 @@ var ChoiceSortStrategy = /* @__PURE__ */ ((ChoiceSortStrategy2) => {
   return ChoiceSortStrategy2;
 })(ChoiceSortStrategy || {});
 var RequestedFields = /* @__PURE__ */ ((RequestedFields2) => {
-  RequestedFields2["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
   RequestedFields2["ASSIGNED_PRODUCTS_COUNT"] = "ASSIGNED_PRODUCTS_COUNT";
   return RequestedFields2;
 })(RequestedFields || {});
@@ -1244,6 +1283,48 @@ async function updateCustomizationChoices2(customizationId, revision, options) {
     throw transformedError;
   }
 }
+async function reorderCustomizationChoices2(customizationId, revision, options) {
+  const { httpClient, sideEffects } = arguments[3];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    customizationId,
+    revision,
+    choiceIds: options?.choiceIds,
+    fields: options?.fields
+  });
+  const reqOpts = reorderCustomizationChoices(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(
+      transformPaths2(result.data, [
+        {
+          transformFn: transformRESTImageToSDKImage,
+          paths: [{ path: "customization.choicesSettings.choices.image" }]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          customizationId: "$[0]",
+          revision: "$[1]",
+          choiceIds: "$[2].choiceIds",
+          fields: "$[2].fields"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["customizationId", "revision", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function bulkAddCustomizationChoices2(customizationsChoices, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = transformPaths2(
@@ -1363,6 +1444,7 @@ export {
   getCustomization2 as getCustomization,
   queryCustomizations2 as queryCustomizations,
   removeCustomizationChoices2 as removeCustomizationChoices,
+  reorderCustomizationChoices2 as reorderCustomizationChoices,
   setCustomizationChoices2 as setCustomizationChoices,
   typedQueryCustomizations,
   updateCustomization2 as updateCustomization,