@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.
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +84 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +84 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +84 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +84 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +84 -5
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +84 -1
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +84 -5
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +84 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -606,7 +606,10 @@ interface Document {
|
|
|
606
606
|
defaultValue?: string | null;
|
|
607
607
|
}
|
|
608
608
|
interface Url {
|
|
609
|
-
/**
|
|
609
|
+
/**
|
|
610
|
+
* @minLength 1
|
|
611
|
+
* @maxLength 2048
|
|
612
|
+
*/
|
|
610
613
|
defaultValue?: string | null;
|
|
611
614
|
textValidation?: TextValidation;
|
|
612
615
|
}
|
|
@@ -935,53 +938,133 @@ interface CatalogOptions {
|
|
|
935
938
|
/**
|
|
936
939
|
* *Required** - the field key that contains the catalog item name - field must be of type TEXT.
|
|
937
940
|
* @maxLength 1000
|
|
941
|
+
* @deprecated
|
|
942
|
+
* @replacedBy name_field_key
|
|
943
|
+
* @targetRemovalDate 2026-07-01
|
|
938
944
|
*/
|
|
939
945
|
name?: string;
|
|
940
946
|
/**
|
|
941
947
|
* *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
|
|
942
948
|
* @maxLength 1000
|
|
949
|
+
* @deprecated
|
|
950
|
+
* @replacedBy price_field_key
|
|
951
|
+
* @targetRemovalDate 2026-07-01
|
|
943
952
|
*/
|
|
944
953
|
price?: string;
|
|
945
954
|
/**
|
|
946
955
|
* the field key that contains the catalog item URL - field must be of type URL.
|
|
947
956
|
* @maxLength 1000
|
|
957
|
+
* @deprecated
|
|
958
|
+
* @replacedBy url_field_key
|
|
959
|
+
* @targetRemovalDate 2026-07-01
|
|
948
960
|
*/
|
|
949
961
|
url?: string | null;
|
|
950
962
|
/**
|
|
951
963
|
* the field key that contains the catalog item description - field must be of type TEXT.
|
|
952
964
|
* @maxLength 1000
|
|
965
|
+
* @deprecated
|
|
966
|
+
* @replacedBy description_field_key
|
|
967
|
+
* @targetRemovalDate 2026-07-01
|
|
953
968
|
*/
|
|
954
969
|
description?: string | null;
|
|
955
970
|
/**
|
|
956
971
|
* the field key that contains the catalog item image - field must be of type IMAGE.
|
|
957
972
|
* @maxLength 1000
|
|
973
|
+
* @deprecated
|
|
974
|
+
* @replacedBy image_field_key
|
|
975
|
+
* @targetRemovalDate 2026-07-01
|
|
958
976
|
*/
|
|
959
977
|
image?: string | null;
|
|
960
978
|
/**
|
|
961
979
|
* the field key that contains the catalog item quantity - field must be of type NUMBER.
|
|
962
980
|
* @maxLength 1000
|
|
981
|
+
* @deprecated
|
|
982
|
+
* @replacedBy quantity_field_key
|
|
983
|
+
* @targetRemovalDate 2026-07-01
|
|
963
984
|
*/
|
|
964
985
|
quantity?: string | null;
|
|
965
986
|
/**
|
|
966
987
|
* the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
|
|
967
988
|
* @maxLength 1000
|
|
989
|
+
* @deprecated
|
|
990
|
+
* @replacedBy digital_file_field_key
|
|
991
|
+
* @targetRemovalDate 2026-07-01
|
|
968
992
|
*/
|
|
969
993
|
digitalFile?: string | null;
|
|
970
994
|
/**
|
|
971
995
|
* the field key that contains the catalog item weight - field must be of type NUMBER.
|
|
972
996
|
* @maxLength 1000
|
|
997
|
+
* @deprecated
|
|
998
|
+
* @replacedBy weight_field_key
|
|
999
|
+
* @targetRemovalDate 2026-07-01
|
|
973
1000
|
*/
|
|
974
1001
|
weight?: string | null;
|
|
975
1002
|
/**
|
|
976
1003
|
* the field key that contains the catalog item SKU - field must be of type TEXT.
|
|
977
1004
|
* @maxLength 1000
|
|
1005
|
+
* @deprecated
|
|
1006
|
+
* @replacedBy sku_field_key
|
|
1007
|
+
* @targetRemovalDate 2026-07-01
|
|
978
1008
|
*/
|
|
979
1009
|
sku?: string | null;
|
|
980
1010
|
/**
|
|
981
1011
|
* the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
|
|
982
1012
|
* @maxLength 1000
|
|
1013
|
+
* @deprecated
|
|
1014
|
+
* @replacedBy shippable_field_key
|
|
1015
|
+
* @targetRemovalDate 2026-07-01
|
|
983
1016
|
*/
|
|
984
1017
|
shippable?: string | null;
|
|
1018
|
+
/**
|
|
1019
|
+
* *Required** - the field key that contains the catalog item name - field must be of type TEXT.
|
|
1020
|
+
* @maxLength 1000
|
|
1021
|
+
*/
|
|
1022
|
+
nameFieldKey?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
|
|
1025
|
+
* @maxLength 1000
|
|
1026
|
+
*/
|
|
1027
|
+
priceFieldKey?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* the field key that contains the catalog item URL - field must be of type URL.
|
|
1030
|
+
* @maxLength 1000
|
|
1031
|
+
*/
|
|
1032
|
+
urlFieldKey?: string | null;
|
|
1033
|
+
/**
|
|
1034
|
+
* the field key that contains the catalog item description - field must be of type TEXT.
|
|
1035
|
+
* @maxLength 1000
|
|
1036
|
+
*/
|
|
1037
|
+
descriptionFieldKey?: string | null;
|
|
1038
|
+
/**
|
|
1039
|
+
* the field key that contains the catalog item image - field must be of type IMAGE.
|
|
1040
|
+
* @maxLength 1000
|
|
1041
|
+
*/
|
|
1042
|
+
imageFieldKey?: string | null;
|
|
1043
|
+
/**
|
|
1044
|
+
* the field key that contains the catalog item quantity - field must be of type NUMBER.
|
|
1045
|
+
* @maxLength 1000
|
|
1046
|
+
*/
|
|
1047
|
+
quantityFieldKey?: string | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
|
|
1050
|
+
* @maxLength 1000
|
|
1051
|
+
*/
|
|
1052
|
+
digitalFileFieldKey?: string | null;
|
|
1053
|
+
/**
|
|
1054
|
+
* the field key that contains the catalog item weight - field must be of type NUMBER.
|
|
1055
|
+
* @maxLength 1000
|
|
1056
|
+
*/
|
|
1057
|
+
weightFieldKey?: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* the field key that contains the catalog item SKU - field must be of type TEXT.
|
|
1060
|
+
* @maxLength 1000
|
|
1061
|
+
*/
|
|
1062
|
+
skuFieldKey?: string | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
|
|
1065
|
+
* @maxLength 1000
|
|
1066
|
+
*/
|
|
1067
|
+
shippableFieldKey?: string | null;
|
|
985
1068
|
}
|
|
986
1069
|
interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectionOneOf {
|
|
987
1070
|
/**
|
|
@@ -2075,7 +2158,6 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
|
|
|
2075
2158
|
* @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`.
|
|
2076
2159
|
* For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
|
|
2077
2160
|
* @public
|
|
2078
|
-
* @documentationMaturity preview
|
|
2079
2161
|
* @requiredField _id
|
|
2080
2162
|
* @requiredField dataCollection
|
|
2081
2163
|
* @permissionId WIX_DATA.UPDATE_COLLECTION
|
|
@@ -2244,7 +2326,6 @@ interface DeleteDataCollectionFieldOptions {
|
|
|
2244
2326
|
* If a plugin of the same type already exists in the collection, this operation fails.
|
|
2245
2327
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2246
2328
|
* @public
|
|
2247
|
-
* @documentationMaturity preview
|
|
2248
2329
|
* @requiredField dataCollectionId
|
|
2249
2330
|
* @requiredField options
|
|
2250
2331
|
* @requiredField options.plugin
|
|
@@ -2267,7 +2348,6 @@ interface AddDataCollectionPluginOptions {
|
|
|
2267
2348
|
* Removing a plugin disables its functionality for the collection.
|
|
2268
2349
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2269
2350
|
* @public
|
|
2270
|
-
* @documentationMaturity preview
|
|
2271
2351
|
* @requiredField dataCollectionId
|
|
2272
2352
|
* @requiredField options
|
|
2273
2353
|
* @requiredField options.pluginType
|
|
@@ -2289,7 +2369,6 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2289
2369
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2290
2370
|
* @param field - Field to update.
|
|
2291
2371
|
* @public
|
|
2292
|
-
* @documentationMaturity preview
|
|
2293
2372
|
* @requiredField dataCollectionId
|
|
2294
2373
|
* @requiredField field
|
|
2295
2374
|
* @permissionId WIX_DATA.UPDATE_COLLECTION_FIELD
|