@wix/auto_sdk_data_collections 1.0.82 → 1.0.84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -646,7 +646,10 @@ interface Document {
646
646
  defaultValue?: string | null;
647
647
  }
648
648
  interface Url {
649
- /** @format URI */
649
+ /**
650
+ * @minLength 1
651
+ * @maxLength 2048
652
+ */
650
653
  defaultValue?: string | null;
651
654
  textValidation?: TextValidation;
652
655
  }
@@ -975,53 +978,133 @@ interface CatalogOptions {
975
978
  /**
976
979
  * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
977
980
  * @maxLength 1000
981
+ * @deprecated
982
+ * @replacedBy name_field_key
983
+ * @targetRemovalDate 2026-07-01
978
984
  */
979
985
  name?: string;
980
986
  /**
981
987
  * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
982
988
  * @maxLength 1000
989
+ * @deprecated
990
+ * @replacedBy price_field_key
991
+ * @targetRemovalDate 2026-07-01
983
992
  */
984
993
  price?: string;
985
994
  /**
986
995
  * the field key that contains the catalog item URL - field must be of type URL.
987
996
  * @maxLength 1000
997
+ * @deprecated
998
+ * @replacedBy url_field_key
999
+ * @targetRemovalDate 2026-07-01
988
1000
  */
989
1001
  url?: string | null;
990
1002
  /**
991
1003
  * the field key that contains the catalog item description - field must be of type TEXT.
992
1004
  * @maxLength 1000
1005
+ * @deprecated
1006
+ * @replacedBy description_field_key
1007
+ * @targetRemovalDate 2026-07-01
993
1008
  */
994
1009
  description?: string | null;
995
1010
  /**
996
1011
  * the field key that contains the catalog item image - field must be of type IMAGE.
997
1012
  * @maxLength 1000
1013
+ * @deprecated
1014
+ * @replacedBy image_field_key
1015
+ * @targetRemovalDate 2026-07-01
998
1016
  */
999
1017
  image?: string | null;
1000
1018
  /**
1001
1019
  * the field key that contains the catalog item quantity - field must be of type NUMBER.
1002
1020
  * @maxLength 1000
1021
+ * @deprecated
1022
+ * @replacedBy quantity_field_key
1023
+ * @targetRemovalDate 2026-07-01
1003
1024
  */
1004
1025
  quantity?: string | null;
1005
1026
  /**
1006
1027
  * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
1007
1028
  * @maxLength 1000
1029
+ * @deprecated
1030
+ * @replacedBy digital_file_field_key
1031
+ * @targetRemovalDate 2026-07-01
1008
1032
  */
1009
1033
  digitalFile?: string | null;
1010
1034
  /**
1011
1035
  * the field key that contains the catalog item weight - field must be of type NUMBER.
1012
1036
  * @maxLength 1000
1037
+ * @deprecated
1038
+ * @replacedBy weight_field_key
1039
+ * @targetRemovalDate 2026-07-01
1013
1040
  */
1014
1041
  weight?: string | null;
1015
1042
  /**
1016
1043
  * the field key that contains the catalog item SKU - field must be of type TEXT.
1017
1044
  * @maxLength 1000
1045
+ * @deprecated
1046
+ * @replacedBy sku_field_key
1047
+ * @targetRemovalDate 2026-07-01
1018
1048
  */
1019
1049
  sku?: string | null;
1020
1050
  /**
1021
1051
  * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
1022
1052
  * @maxLength 1000
1053
+ * @deprecated
1054
+ * @replacedBy shippable_field_key
1055
+ * @targetRemovalDate 2026-07-01
1023
1056
  */
1024
1057
  shippable?: string | null;
1058
+ /**
1059
+ * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
1060
+ * @maxLength 1000
1061
+ */
1062
+ nameFieldKey?: string;
1063
+ /**
1064
+ * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
1065
+ * @maxLength 1000
1066
+ */
1067
+ priceFieldKey?: string;
1068
+ /**
1069
+ * the field key that contains the catalog item URL - field must be of type URL.
1070
+ * @maxLength 1000
1071
+ */
1072
+ urlFieldKey?: string | null;
1073
+ /**
1074
+ * the field key that contains the catalog item description - field must be of type TEXT.
1075
+ * @maxLength 1000
1076
+ */
1077
+ descriptionFieldKey?: string | null;
1078
+ /**
1079
+ * the field key that contains the catalog item image - field must be of type IMAGE.
1080
+ * @maxLength 1000
1081
+ */
1082
+ imageFieldKey?: string | null;
1083
+ /**
1084
+ * the field key that contains the catalog item quantity - field must be of type NUMBER.
1085
+ * @maxLength 1000
1086
+ */
1087
+ quantityFieldKey?: string | null;
1088
+ /**
1089
+ * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
1090
+ * @maxLength 1000
1091
+ */
1092
+ digitalFileFieldKey?: string | null;
1093
+ /**
1094
+ * the field key that contains the catalog item weight - field must be of type NUMBER.
1095
+ * @maxLength 1000
1096
+ */
1097
+ weightFieldKey?: string | null;
1098
+ /**
1099
+ * the field key that contains the catalog item SKU - field must be of type TEXT.
1100
+ * @maxLength 1000
1101
+ */
1102
+ skuFieldKey?: string | null;
1103
+ /**
1104
+ * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
1105
+ * @maxLength 1000
1106
+ */
1107
+ shippableFieldKey?: string | null;
1025
1108
  }
1026
1109
  interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectionOneOf {
1027
1110
  /**
@@ -2153,7 +2236,6 @@ declare function restoreDataCollection(dataCollectionId: string): Promise<NonNul
2153
2236
  * @param _id - [Collection ID](https://dev.wix.com/docs/develop-websites-sdk/code-your-site/work-with-data/introduction/about-collections#collection-ids). For example, `my-first-collection`.
2154
2237
  * For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
2155
2238
  * @public
2156
- * @documentationMaturity preview
2157
2239
  * @requiredField _id
2158
2240
  * @requiredField dataCollection
2159
2241
  * @permissionId WIX_DATA.UPDATE_COLLECTION
@@ -2339,7 +2421,6 @@ interface DeleteDataCollectionFieldOptions {
2339
2421
  * If a plugin of the same type already exists in the collection, this operation fails.
2340
2422
  * @param dataCollectionId - ID of the data collection to update.
2341
2423
  * @public
2342
- * @documentationMaturity preview
2343
2424
  * @requiredField dataCollectionId
2344
2425
  * @requiredField options
2345
2426
  * @requiredField options.plugin
@@ -2362,7 +2443,6 @@ interface AddDataCollectionPluginOptions {
2362
2443
  * Removing a plugin disables its functionality for the collection.
2363
2444
  * @param dataCollectionId - ID of the data collection to update.
2364
2445
  * @public
2365
- * @documentationMaturity preview
2366
2446
  * @requiredField dataCollectionId
2367
2447
  * @requiredField options
2368
2448
  * @requiredField options.pluginType
@@ -2384,7 +2464,6 @@ interface DeleteDataCollectionPluginOptions {
2384
2464
  * @param dataCollectionId - ID of the data collection to update.
2385
2465
  * @param field - Field to update.
2386
2466
  * @public
2387
- * @documentationMaturity preview
2388
2467
  * @requiredField dataCollectionId
2389
2468
  * @requiredField field
2390
2469
  * @permissionId WIX_DATA.UPDATE_COLLECTION_FIELD