@wix/auto_sdk_stores_customizations-v-3 1.0.56 → 1.0.58

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

@@ -44,6 +44,15 @@ interface Customization extends CustomizationCustomizationSettingsOneOf {
      * @readonly
      */
     _updatedDate?: Date | null;
+    /**
+     * A read-only identifier generated from the customization name.
+     *
+     * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
+     * @readonly
+     * @minLength 1
+     * @maxLength 50
+     */
+    key?: string | null;
     /**
      * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
      * @minLength 1
@@ -122,6 +131,15 @@ interface FreeTextSettings {
      * @maxLength 100
      */
     title?: string;
+    /**
+     * A read-only identifier generated from the title.
+     *
+     * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
+     * @readonly
+     * @minLength 1
+     * @maxLength 150
+     */
+    key?: string | null;
 }
 interface ChoicesSettings {
     /**
@@ -156,7 +174,9 @@ interface Choice extends ChoiceValueOneOf {
      */
     choiceType?: ChoiceTypeWithLiterals;
     /**
-     * A read-only key generated based on choice name. Used for eCommerce integration.
+     * A read-only identifier generated from the choice name.
+     *
+     * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
      * @readonly
      * @minLength 1
      * @maxLength 50
@@ -1274,6 +1294,15 @@ interface UpdateCustomization {
      * @readonly
      */
     _updatedDate?: Date | null;
+    /**
+     * A read-only identifier generated from the customization name.
+     *
+     * Use `key` in the `catalogReference.options` object when [integrating Catalog V3 with eCommerce APIs](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration).
+     * @readonly
+     * @minLength 1
+     * @maxLength 50
+     */
+    key?: string | null;
     /**
      * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
      * @minLength 1
@@ -1334,9 +1363,6 @@ declare function deleteCustomization(customizationId: string): Promise<void & {
  * - `createdDate` is sorted in `DESC` order
  * - `cursorPaging.limit` is `100`
  *
- * For field support for filters and sorting,
- * see [Customizations: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/customizations-v3/supported-filters-and-sorting).
- *
  * To learn about working with _Query_ endpoints, see
  * [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
  * and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).