@wix/auto_sdk_stores_customizations-v-3 1.0.26 → 1.0.28

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

@@ -1047,7 +1047,6 @@ interface CustomizationCreatedEnvelope {
  * @eventType wix.stores.catalog.v3.customization_created
  * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
  * @slug created
- * @documentationMaturity preview
  */
 declare function onCustomizationCreated(handler: (event: CustomizationCreatedEnvelope) => void | Promise<void>): void;
 interface CustomizationDeletedEnvelope {
@@ -1083,7 +1082,6 @@ interface CustomizationDeletedEnvelope {
  * @eventType wix.stores.catalog.v3.customization_deleted
  * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
  * @slug deleted
- * @documentationMaturity preview
  */
 declare function onCustomizationDeleted(handler: (event: CustomizationDeletedEnvelope) => void | Promise<void>): void;
 interface CustomizationUpdatedEnvelope {
@@ -1119,15 +1117,12 @@ interface CustomizationUpdatedEnvelope {
  * @eventType wix.stores.catalog.v3.customization_updated
  * @serviceIdentifier wix.stores.catalog.customization.v3.CustomizationService
  * @slug updated
- * @documentationMaturity preview
  */
 declare function onCustomizationUpdated(handler: (event: CustomizationUpdatedEnvelope) => void | Promise<void>): void;
-type CustomizationNonNullablePaths = `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`;
 /**
  * Creates a customization.
  * @param customization - Customization to create.
  * @public
- * @documentationMaturity preview
  * @requiredField customization
  * @requiredField customization.choicesSettings.choices
  * @requiredField customization.customizationRenderType
@@ -1139,7 +1134,7 @@ type CustomizationNonNullablePaths = `freeTextInput.minCharCount` | `freeTextInp
  * @returns Created customization.
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.CreateCustomization
  */
-declare function createCustomization(customization: NonNullablePaths<Customization, `choicesSettings.choices` | `customizationRenderType` | `customizationType` | `freeTextInput.title` | `name`>): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths> & {
+declare function createCustomization(customization: NonNullablePaths<Customization, `choicesSettings.choices` | `customizationRenderType` | `customizationType` | `freeTextInput.title` | `name`>): Promise<NonNullablePaths<Customization, `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`> & {
     __applicationErrorsType?: CreateCustomizationApplicationErrors;
     __validationErrorsType?: CreateCustomizationValidationErrors;
 }>;
@@ -1147,7 +1142,6 @@ declare function createCustomization(customization: NonNullablePaths<Customizati
  * Retrieves a customization.
  * @param customizationId - Customization ID.
  * @public
- * @documentationMaturity preview
  * @requiredField customizationId
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
  * @applicableIdentity APP
@@ -1155,7 +1149,7 @@ declare function createCustomization(customization: NonNullablePaths<Customizati
  * @returns Customization.
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.GetCustomization
  */
-declare function getCustomization(customizationId: string, options?: GetCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
+declare function getCustomization(customizationId: string, options?: GetCustomizationOptions): Promise<NonNullablePaths<Customization, `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`>>;
 interface GetCustomizationOptions {
     /**
      * Fields to include in the response.
@@ -1173,7 +1167,6 @@ interface GetCustomizationOptions {
  * This ensures you're working with the latest customization and prevents unintended overwrites.
  * @param _id - Customization ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField customization
  * @requiredField customization.revision
@@ -1182,7 +1175,7 @@ interface GetCustomizationOptions {
  * @returns Updated customization.
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.UpdateCustomization
  */
-declare function updateCustomization(_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, CustomizationNonNullablePaths>>;
+declare function updateCustomization(_id: string, customization: NonNullablePaths<UpdateCustomization, `revision`>, options?: UpdateCustomizationOptions): Promise<NonNullablePaths<Customization, `freeTextInput.minCharCount` | `freeTextInput.maxCharCount` | `freeTextInput.title` | `choicesSettings.choices` | `choicesSettings.choices.${number}.colorCode` | `choicesSettings.choices.${number}._id` | `choicesSettings.choices.${number}.choiceType` | `choicesSettings.choices.${number}.name` | `choicesSettings.choices.${number}.assignedProductsCount` | `name` | `customizationType` | `customizationRenderType`>>;
 interface UpdateCustomization {
     /**
      * Free text input settings.
@@ -1263,7 +1256,6 @@ interface UpdateCustomizationOptions {
  * > **Note:** A customization cannot be deleted if it is assigned to one or more products.
  * @param customizationId - Customization ID.
  * @public
- * @documentationMaturity preview
  * @requiredField customizationId
  * @permissionId WIX_STORES.CUSTOMIZATION_DELETE
  * @applicableIdentity APP
@@ -1289,7 +1281,6 @@ declare function deleteCustomization(customizationId: string): Promise<void & {
  * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
  * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
  * @public
- * @documentationMaturity preview
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
@@ -1321,80 +1312,58 @@ interface CustomizationsQueryResult extends QueryCursorResult {
 interface CustomizationsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name', value: any) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id' | 'name', value: string) => CustomizationsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any[]) => CustomizationsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: any) => CustomizationsQueryBuilder;
-    /** @documentationMaturity preview */
     exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'customizationType' | 'customizationRenderType', value: boolean) => CustomizationsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name'>) => CustomizationsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => CustomizationsQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => CustomizationsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<CustomizationsQueryResult>;
 }
 /**
  * Creates multiple brands.
  * @param customizations - Customizations to create.
  * @public
- * @documentationMaturity preview
  * @requiredField customizations
  * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkCreateCustomizations
  */
-declare function bulkCreateCustomizations(customizations: Customization[], options?: BulkCreateCustomizationsOptions): Promise<NonNullablePaths<BulkCreateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
-}[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+declare function bulkCreateCustomizations(customizations: Customization[], options?: BulkCreateCustomizationsOptions): Promise<NonNullablePaths<BulkCreateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.customization.freeTextInput.minCharCount` | `results.${number}.customization.freeTextInput.maxCharCount` | `results.${number}.customization.freeTextInput.title` | `results.${number}.customization.name` | `results.${number}.customization.customizationType` | `results.${number}.customization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
     __applicationErrorsType?: BulkCreateCustomizationsApplicationErrors;
     __validationErrorsType?: BulkCreateCustomizationsValidationErrors;
 }>;
@@ -1411,16 +1380,13 @@ interface BulkCreateCustomizationsOptions {
  * @param customizationId - Customization ID.
  * @param choices - Choices to add.
  * @public
- * @documentationMaturity preview
  * @requiredField choices
  * @requiredField customizationId
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.AddCustomizationChoices
  */
-declare function addCustomizationChoices(customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions): Promise<NonNullablePaths<AddCustomizationChoicesResponse, {
-    [P in CustomizationNonNullablePaths]: `customization.${P}`;
-}[CustomizationNonNullablePaths]> & {
+declare function addCustomizationChoices(customizationId: string, choices: Choice[], options?: AddCustomizationChoicesOptions): Promise<NonNullablePaths<AddCustomizationChoicesResponse, `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.choicesSettings.choices.${number}.assignedProductsCount` | `customization.name` | `customization.customizationType` | `customization.customizationRenderType`> & {
     __applicationErrorsType?: AddCustomizationChoicesApplicationErrors;
     __validationErrorsType?: AddCustomizationChoicesValidationErrors;
 }>;
@@ -1440,16 +1406,13 @@ interface AddCustomizationChoicesOptions {
  * @param customizationId - Customization ID.
  * @param choices - Choices to set.
  * @public
- * @documentationMaturity preview
  * @requiredField choices
  * @requiredField customizationId
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.SetCustomizationChoices
  */
-declare function setCustomizationChoices(customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions): Promise<NonNullablePaths<SetCustomizationChoicesResponse, {
-    [P in CustomizationNonNullablePaths]: `customization.${P}`;
-}[CustomizationNonNullablePaths]> & {
+declare function setCustomizationChoices(customizationId: string, choices: Choice[], options?: SetCustomizationChoicesOptions): Promise<NonNullablePaths<SetCustomizationChoicesResponse, `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.choicesSettings.choices.${number}.assignedProductsCount` | `customization.name` | `customization.customizationType` | `customization.customizationRenderType`> & {
     __applicationErrorsType?: SetCustomizationChoicesApplicationErrors;
     __validationErrorsType?: SetCustomizationChoicesValidationErrors;
 }>;
@@ -1469,16 +1432,13 @@ interface SetCustomizationChoicesOptions {
  * @param customizationId - Customization ID.
  * @param choiceIds - IDs of choices to remove.
  * @public
- * @documentationMaturity preview
  * @requiredField choiceIds
  * @requiredField customizationId
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.RemoveCustomizationChoices
  */
-declare function removeCustomizationChoices(customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions): Promise<NonNullablePaths<RemoveCustomizationChoicesResponse, {
-    [P in CustomizationNonNullablePaths]: `customization.${P}`;
-}[CustomizationNonNullablePaths]> & {
+declare function removeCustomizationChoices(customizationId: string, choiceIds: string[], options?: RemoveCustomizationChoicesOptions): Promise<NonNullablePaths<RemoveCustomizationChoicesResponse, `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.choicesSettings.choices.${number}.assignedProductsCount` | `customization.name` | `customization.customizationType` | `customization.customizationRenderType`> & {
     __applicationErrorsType?: RemoveCustomizationChoicesApplicationErrors;
     __validationErrorsType?: RemoveCustomizationChoicesValidationErrors;
 }>;
@@ -1497,7 +1457,6 @@ interface RemoveCustomizationChoicesOptions {
  * Adds choices to multiple customizations.
  * @param customizationsChoices - List of customization IDs and choices.
  * @public
- * @documentationMaturity preview
  * @requiredField customizationsChoices
  * @requiredField customizationsChoices.choices
  * @requiredField customizationsChoices.customizationId
@@ -1505,9 +1464,7 @@ interface RemoveCustomizationChoicesOptions {
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkAddCustomizationChoices
  */
-declare function bulkAddCustomizationChoices(customizationsChoices: NonNullablePaths<CustomizationChoices, `choices` | `customizationId`>[], options?: BulkAddCustomizationChoicesOptions): Promise<NonNullablePaths<BulkAddCustomizationChoicesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
-}[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
+declare function bulkAddCustomizationChoices(customizationsChoices: NonNullablePaths<CustomizationChoices, `choices` | `customizationId`>[], options?: BulkAddCustomizationChoicesOptions): Promise<NonNullablePaths<BulkAddCustomizationChoicesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.customization.freeTextInput.minCharCount` | `results.${number}.customization.freeTextInput.maxCharCount` | `results.${number}.customization.freeTextInput.title` | `results.${number}.customization.name` | `results.${number}.customization.customizationType` | `results.${number}.customization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
     __applicationErrorsType?: BulkAddCustomizationChoicesApplicationErrors;
     __validationErrorsType?: BulkAddCustomizationChoicesValidationErrors;
 }>;
@@ -1534,7 +1491,6 @@ interface BulkAddCustomizationChoicesOptions {
  * This ensures you're working with the latest customization and prevents unintended overwrites.
  * @param customizations - List of customizations to update.
  * @public
- * @documentationMaturity preview
  * @requiredField customizations
  * @requiredField customizations.customization._id
  * @requiredField customizations.customization.name
@@ -1543,9 +1499,7 @@ interface BulkAddCustomizationChoicesOptions {
  * @applicableIdentity APP
  * @fqn wix.stores.catalog.customization.v3.CustomizationService.BulkUpdateCustomizations
  */
-declare function bulkUpdateCustomizations(customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in CustomizationNonNullablePaths]: `results.${number}.customization.${P}`;
-}[CustomizationNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+declare function bulkUpdateCustomizations(customizations: NonNullablePaths<MaskedCustomization, `customization._id` | `customization.name` | `customization.revision`>[], options?: BulkUpdateCustomizationsOptions): Promise<NonNullablePaths<BulkUpdateCustomizationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.customization.freeTextInput.minCharCount` | `results.${number}.customization.freeTextInput.maxCharCount` | `results.${number}.customization.freeTextInput.title` | `results.${number}.customization.name` | `results.${number}.customization.customizationType` | `results.${number}.customization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 interface BulkUpdateCustomizationsOptions {
     /**
      * Whether to return the full customization entities in the response.