@wix/auto_sdk_stores_customizations-v-3 1.0.67 → 1.0.69

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",
+    /** Text choices are sorted by name, and swatch choices are sorted by the number of matching products. */
+    DEFAULT = "DEFAULT",
+    /** Sort choices alphabetically by name, case-insensitive, with numeric values first. */
+    BY_NAME = "BY_NAME",
+    /** Sort choices 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. */
+    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!
@@ -732,6 +746,40 @@ interface RemoveCustomizationChoicesResponse {
     /** Updated customization. */
     customization?: Customization;
 }
+interface UpdateCustomizationChoicesRequest {
+    /**
+     * 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;
+    /**
+     * Choices to update. Each item must include a `choice` with a valid `id` matching an existing choice in the customization.
+     * @minSize 1
+     * @maxSize 100
+     */
+    choices: MaskedChoice[];
+    /**
+     * Fields to include in the response.
+     *
+     * Supported values: `ASSIGNED_PRODUCTS_COUNT`
+     * @maxSize 100
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface MaskedChoice {
+    /** Choice to update. */
+    choice?: Choice;
+}
+interface UpdateCustomizationChoicesResponse {
+    /** Updated customization. */
+    customization?: Customization;
+}
 interface BulkAddCustomizationChoicesRequest {
     /**
      * List of customization IDs and choices.
@@ -1002,6 +1050,12 @@ type CreateCustomizationValidationErrors = {
     ruleName?: 'MIXED_CHOICE_IDS_CONSISTENCY';
 } | {
     ruleName?: 'ID_NOT_ALLOWED_IN_REQUEST';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
 type DeleteCustomizationValidationErrors = {
@@ -1040,6 +1094,12 @@ type BulkCreateCustomizationsValidationErrors = {
     ruleName?: 'MIXED_CHOICE_IDS_CONSISTENCY';
 } | {
     ruleName?: 'ID_NOT_ALLOWED_IN_REQUEST';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
 type AddCustomizationChoicesApplicationErrors = {
@@ -1058,6 +1118,12 @@ type AddCustomizationChoicesValidationErrors = {
     ruleName?: 'INVALID_CHOICE_VALUE';
 } | {
     ruleName?: 'DUPLICATE_CHOICE_NAME';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
 type SetCustomizationChoicesApplicationErrors = {
@@ -1078,6 +1144,12 @@ type SetCustomizationChoicesValidationErrors = {
     ruleName?: 'NOT_ALLOWED_DELETE_CHOICE_ASSIGNED_TO_PRODUCT';
 } | {
     ruleName?: 'DUPLICATE_CHOICE_NAME';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
 type RemoveCustomizationChoicesApplicationErrors = {
@@ -1088,6 +1160,24 @@ type RemoveCustomizationChoicesApplicationErrors = {
 /** @docsIgnore */
 type RemoveCustomizationChoicesValidationErrors = {
     ruleName?: 'NOT_ALLOWED_CUSTOMIZATION_WITHOUT_CHOICES';
+} | {
+    ruleName?: 'PARENT_CHOICE_DELETE_REFERENCED';
+};
+/** @docsIgnore */
+type UpdateCustomizationChoicesApplicationErrors = {
+    code?: 'CHOICE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type UpdateCustomizationChoicesValidationErrors = {
+    ruleName?: 'UNSUPPORTED_CHOICE_FIELD';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 /** @docsIgnore */
 type BulkAddCustomizationChoicesApplicationErrors = {
@@ -1104,6 +1194,12 @@ type BulkAddCustomizationChoicesValidationErrors = {
     ruleName?: 'INVALID_CHOICE_TYPE';
 } | {
     ruleName?: 'INVALID_CHOICE_VALUE';
+} | {
+    ruleName?: 'PARENT_CHOICE_SELF_REFERENCE';
+} | {
+    ruleName?: 'PARENT_CHOICE_NOT_FOUND';
+} | {
+    ruleName?: 'PARENT_CHOICE_HIERARCHY_VIOLATION';
 };
 interface BaseEventMetadata {
     /**
@@ -1693,6 +1789,21 @@ interface RemoveCustomizationChoicesOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
+interface UpdateCustomizationChoicesOptions {
+    /**
+     * Choices to update. Each item must include a `choice` with a valid `id` matching an existing choice in the customization.
+     * @minSize 1
+     * @maxSize 100
+     */
+    choices: MaskedChoice[];
+    /**
+     * 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.
@@ -1756,4 +1867,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 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 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, 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 };

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,
@@ -38,6 +39,7 @@ __export(index_typings_exports, {
   setCustomizationChoices: () => setCustomizationChoices2,
   typedQueryCustomizations: () => typedQueryCustomizations,
   updateCustomization: () => updateCustomization2,
+  updateCustomizationChoices: () => updateCustomizationChoices2,
   utils: () => utils
 });
 module.exports = __toCommonJS(index_typings_exports);
@@ -579,6 +581,67 @@ function removeCustomizationChoices(payload) {
   }
   return __removeCustomizationChoices;
 }
+function updateCustomizationChoices(payload) {
+  function __updateCustomizationChoices({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
+        paths: [{ path: "choices.fieldMask" }]
+      },
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "choices.choice.image.urlExpirationDate" }]
+      },
+      {
+        transformFn: import_float.transformSDKFloatToRESTFloat,
+        paths: [
+          { path: "choices.choice.image.focalPoint.x" },
+          { path: "choices.choice.image.focalPoint.y" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.stores.catalog.v3.customization",
+      method: "POST",
+      methodFqn: "wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomizationChoices",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixStoresCatalogCustomizationV3CustomizationServiceUrl({
+        protoPath: "/v3/customizations/{customizationId}/update-choices",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      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 __updateCustomizationChoices;
+}
 function bulkAddCustomizationChoices(payload) {
   function __bulkAddCustomizationChoices({ host }) {
     const serializedData = (0, import_transform_paths.transformPaths)(payload, [
@@ -734,6 +797,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";
@@ -1166,6 +1237,56 @@ async function removeCustomizationChoices2(customizationId, choiceIds, options)
     throw transformedError;
   }
 }
+async function updateCustomizationChoices2(customizationId, revision, options) {
+  const { httpClient, sideEffects } = arguments[3];
+  const payload = (0, import_transform_paths2.transformPaths)(
+    (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+      customizationId,
+      revision,
+      choices: options?.choices,
+      fields: options?.fields
+    }),
+    [
+      {
+        transformFn: import_image.transformSDKImageToRESTImage,
+        paths: [{ path: "choices.choice.image" }]
+      }
+    ]
+  );
+  const reqOpts = updateCustomizationChoices(
+    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]",
+          choices: "$[2].choices",
+          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)(
@@ -1270,6 +1391,7 @@ async function bulkUpdateCustomizations2(customizations, options) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ChoiceSortStrategy,
   ChoiceType,
   CustomizationRenderType,
   CustomizationType,
@@ -1288,6 +1410,7 @@ async function bulkUpdateCustomizations2(customizations, options) {
   setCustomizationChoices,
   typedQueryCustomizations,
   updateCustomization,
+  updateCustomizationChoices,
   utils
 });
 //# sourceMappingURL=index.typings.js.map