@wix/auto_sdk_stores_customizations-v-3 1.0.68 → 1.0.70

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

@@ -142,6 +142,7 @@ interface FreeTextSettings {
      */
     key?: string | null;
 }
+/** Settings for choice-based customizations. */
 interface ChoicesSettings {
     /**
      * List of choices.
@@ -234,6 +235,19 @@ interface FocalPoint {
     /** crop by width */
     width?: number | null;
 }
+declare enum ChoiceSortStrategy {
+    UNKNOWN_CHOICE_SORT_STRATEGY = "UNKNOWN_CHOICE_SORT_STRATEGY",
+    /** Default. Text choices are sorted by name, swatch choices are sorted by product count. */
+    DEFAULT = "DEFAULT",
+    /** Alphabetically by name, case-insensitive. Numeric values are sorted first. */
+    BY_NAME = "BY_NAME",
+    /** By the number of products assigned to each choice, in descending order. */
+    BY_PRODUCT_COUNT = "BY_PRODUCT_COUNT",
+    /** 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';
 interface InvalidateCache extends InvalidateCacheGetByOneOf {
     /**
      * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
@@ -766,6 +780,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.
@@ -1166,6 +1214,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;
@@ -1790,6 +1848,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.
@@ -1853,4 +1927,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, 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/cjs/index.typings.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // index.typings.ts
 var index_typings_exports = {};
 __export(index_typings_exports, {
+  ChoiceSortStrategy: () => ChoiceSortStrategy,
   ChoiceType: () => ChoiceType,
   CustomizationRenderType: () => CustomizationRenderType,
   CustomizationType: () => CustomizationType,
@@ -35,6 +36,7 @@ __export(index_typings_exports, {
   getCustomization: () => getCustomization2,
   queryCustomizations: () => queryCustomizations2,
   removeCustomizationChoices: () => removeCustomizationChoices2,
+  reorderCustomizationChoices: () => reorderCustomizationChoices2,
   setCustomizationChoices: () => setCustomizationChoices2,
   typedQueryCustomizations: () => typedQueryCustomizations,
   updateCustomization: () => updateCustomization2,
@@ -641,6 +643,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) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "customization.createdDate" },
+            { path: "customization.updatedDate" },
+            {
+              path: "customization.choicesSettings.choices.image.urlExpirationDate"
+            }
+          ]
+        },
+        {
+          transformFn: import_float2.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 = (0, import_transform_paths.transformPaths)(payload, [
@@ -796,6 +842,14 @@ var ChoiceType = /* @__PURE__ */ ((ChoiceType2) => {
   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";
+  ChoiceSortStrategy2["MANUAL"] = "MANUAL";
+  return ChoiceSortStrategy2;
+})(ChoiceSortStrategy || {});
 var RequestedFields = /* @__PURE__ */ ((RequestedFields2) => {
   RequestedFields2["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
   RequestedFields2["ASSIGNED_PRODUCTS_COUNT"] = "ASSIGNED_PRODUCTS_COUNT";
@@ -1278,6 +1332,48 @@ async function updateCustomizationChoices2(customizationId, revision, options) {
     throw transformedError;
   }
 }
+async function reorderCustomizationChoices2(customizationId, revision, options) {
+  const { httpClient, sideEffects } = arguments[3];
+  const payload = (0, import_rename_all_nested_keys.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 (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
+      (0, import_transform_paths2.transformPaths)(result.data, [
+        {
+          transformFn: import_image2.transformRESTImageToSDKImage,
+          paths: [{ path: "customization.choicesSettings.choices.image" }]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      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 = (0, import_transform_paths2.transformPaths)(
@@ -1382,6 +1478,7 @@ async function bulkUpdateCustomizations2(customizations, options) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ChoiceSortStrategy,
   ChoiceType,
   CustomizationRenderType,
   CustomizationType,
@@ -1397,6 +1494,7 @@ async function bulkUpdateCustomizations2(customizations, options) {
   getCustomization,
   queryCustomizations,
   removeCustomizationChoices,
+  reorderCustomizationChoices,
   setCustomizationChoices,
   typedQueryCustomizations,
   updateCustomization,