@wix/auto_sdk_data_collections 1.0.109 → 1.0.111

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

@@ -1067,7 +1067,9 @@ interface PluginCmsOptions {
 }
 interface CatalogOptions {
     /**
-     * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
+     *
+     * Use `nameFieldKey` instead. If both properties are specified, a non-empty `nameFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy name_field_key
@@ -1075,7 +1077,9 @@ interface CatalogOptions {
      */
     name?: string;
     /**
-     * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
+     *
+     * Use `priceFieldKey` instead. If both properties are specified, a non-empty `priceFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy price_field_key
@@ -1083,7 +1087,9 @@ interface CatalogOptions {
      */
     price?: string;
     /**
-     * the field key that contains the catalog item URL - field must be of type URL.
+     * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
+     *
+     * Use `urlFieldKey` instead. If both properties are specified, a non-empty `urlFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy url_field_key
@@ -1091,7 +1097,9 @@ interface CatalogOptions {
      */
     url?: string | null;
     /**
-     * the field key that contains the catalog item description - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
+     *
+     * Use `descriptionFieldKey` instead. If both properties are specified, a non-empty `descriptionFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy description_field_key
@@ -1099,7 +1107,9 @@ interface CatalogOptions {
      */
     description?: string | null;
     /**
-     * the field key that contains the catalog item image - field must be of type IMAGE.
+     * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
+     *
+     * Use `imageFieldKey` instead. If both properties are specified, a non-empty `imageFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy image_field_key
@@ -1107,7 +1117,9 @@ interface CatalogOptions {
      */
     image?: string | null;
     /**
-     * the field key that contains the catalog item quantity - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
+     *
+     * Use `quantityFieldKey` instead. If both properties are specified, a non-empty `quantityFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy quantity_field_key
@@ -1115,7 +1127,9 @@ interface CatalogOptions {
      */
     quantity?: string | null;
     /**
-     * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
+     * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
+     *
+     * Use `digitalFileFieldKey` instead. If both properties are specified, a non-empty `digitalFileFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy digital_file_field_key
@@ -1123,7 +1137,9 @@ interface CatalogOptions {
      */
     digitalFile?: string | null;
     /**
-     * the field key that contains the catalog item weight - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
+     *
+     * Use `weightFieldKey` instead. If both properties are specified, a non-empty `weightFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy weight_field_key
@@ -1131,7 +1147,9 @@ interface CatalogOptions {
      */
     weight?: string | null;
     /**
-     * the field key that contains the catalog item SKU - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
+     *
+     * Use `skuFieldKey` instead. If both properties are specified, a non-empty `skuFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy sku_field_key
@@ -1139,7 +1157,9 @@ interface CatalogOptions {
      */
     sku?: string | null;
     /**
-     * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
+     * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
+     *
+     * Use `shippableFieldKey` instead. If both properties are specified, a non-empty `shippableFieldKey` takes precedence.
      * @maxLength 1000
      * @deprecated
      * @replacedBy shippable_field_key
@@ -1147,52 +1167,56 @@ interface CatalogOptions {
      */
     shippable?: string | null;
     /**
-     * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
+     *
+     * Required when configuring the Catalog plugin.
      * @maxLength 1000
      */
     nameFieldKey?: string;
     /**
-     * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
+     *
+     * Required when configuring the Catalog plugin.
      * @maxLength 1000
      */
     priceFieldKey?: string;
     /**
-     * the field key that contains the catalog item URL - field must be of type URL.
+     * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
      * @maxLength 1000
      */
     urlFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item description - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
      * @maxLength 1000
      */
     descriptionFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item image - field must be of type IMAGE.
+     * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
      * @maxLength 1000
      */
     imageFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item quantity - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
      * @maxLength 1000
      */
     quantityFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
+     * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
      * @maxLength 1000
      */
     digitalFileFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item weight - field must be of type NUMBER.
+     * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
      * @maxLength 1000
      */
     weightFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item SKU - field must be of type TEXT.
+     * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
      * @maxLength 1000
      */
     skuFieldKey?: string | null;
     /**
-     * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
+     * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
      * @maxLength 1000
      */
     shippableFieldKey?: string | null;