@wix/auto_sdk_data_collections 1.0.108 → 1.0.110

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.
@@ -1,6 +1,9 @@
1
1
  import { NonNullablePaths } from '@wix/sdk-types';
2
2
 
3
- /** A data collection determines the structure of data to be stored in a database. */
3
+ /**
4
+ * A data collection defines the fields, data types, item permissions, and plugins for a set of data items.
5
+ * Use the Data Items API to store and retrieve the items themselves.
6
+ */
4
7
  interface DataCollection {
5
8
  /**
6
9
  * [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`.
@@ -30,6 +33,8 @@ interface DataCollection {
30
33
  maxPageSize?: number | null;
31
34
  /**
32
35
  * Collection's display name as shown in the CMS. For example, `My First Collection`.
36
+ *
37
+ * Default: The collection ID.
33
38
  * @maxLength 1000
34
39
  */
35
40
  displayName?: string | null;
@@ -47,6 +52,8 @@ interface DataCollection {
47
52
  displayNamespace?: string | null;
48
53
  /**
49
54
  * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
55
+ *
56
+ * Default: The first field in the request, or `title` if no fields are specified.
50
57
  * @maxLength 1000
51
58
  */
52
59
  displayField?: string | null;
@@ -95,7 +102,7 @@ interface DataCollection {
95
102
  */
96
103
  dataPermissions?: DataPermissions;
97
104
  /**
98
- * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
105
+ * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
99
106
  * @internal
100
107
  * @readonly
101
108
  */
@@ -247,7 +254,7 @@ interface Field extends FieldRangeValidationsOneOf {
247
254
  * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
248
255
  */
249
256
  type?: TypeWithLiterals;
250
- /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
257
+ /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
251
258
  typeMetadata?: TypeMetadata;
252
259
  /**
253
260
  * Whether the field is a system field.
@@ -267,6 +274,7 @@ interface Field extends FieldRangeValidationsOneOf {
267
274
  */
268
275
  description?: string | null;
269
276
  /**
277
+ * Plugin that manages this field.
270
278
  * @internal
271
279
  * @maxLength 100
272
280
  */
@@ -278,7 +286,7 @@ interface Field extends FieldRangeValidationsOneOf {
278
286
  */
279
287
  readOnly?: boolean | null;
280
288
  /**
281
- * Whether the field is immutable. An immutable field can be set once, but then cannot be updated.
289
+ * Whether the field is immutable. An immutable field can be set once, but then can't be updated.
282
290
  *
283
291
  * Default: `false`
284
292
  */
@@ -301,7 +309,7 @@ interface Field extends FieldRangeValidationsOneOf {
301
309
  */
302
310
  deleted?: boolean | null;
303
311
  /**
304
- * This indicates that this fields is conditional and is not retrieved by default.
312
+ * Conditions that control whether this field is included when retrieving data items.
305
313
  * @readonly
306
314
  */
307
315
  condition?: FieldCondition;
@@ -710,7 +718,7 @@ interface ObjectField {
710
718
  * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
711
719
  */
712
720
  type?: TypeWithLiterals;
713
- /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
721
+ /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
714
722
  typeMetadata?: TypeMetadata;
715
723
  /**
716
724
  * Capabilities the object field supports.
@@ -719,12 +727,19 @@ interface ObjectField {
719
727
  capabilities?: FieldCapabilities;
720
728
  }
721
729
  interface FieldsPattern {
722
- /** @maxLength 1000 */
730
+ /**
731
+ * Pattern used to generate the field value from item properties.
732
+ * @maxLength 1000
733
+ */
723
734
  pattern?: string;
735
+ /** Whether to convert the generated value to lowercase. Default: `false`. */
724
736
  lowercase?: boolean;
725
737
  }
726
738
  interface UrlizedOnlyPattern {
727
- /** @maxLength 1000 */
739
+ /**
740
+ * Pattern used to generate the field value from item properties.
741
+ * @maxLength 1000
742
+ */
728
743
  pattern?: string;
729
744
  }
730
745
  interface Calculator extends CalculatorPatternOneOf {
@@ -789,13 +804,16 @@ interface _Object {
789
804
  * @maxSize 1000
790
805
  */
791
806
  fields?: ObjectField[];
792
- /** @internal */
807
+ /**
808
+ * Value assigned when a data item omits this field.
809
+ * @internal
810
+ */
793
811
  defaultValue?: Record<string, any> | null;
794
812
  }
795
813
  interface _Array {
796
814
  /** Element's data type. */
797
815
  elementType?: TypeWithLiterals;
798
- /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
816
+ /** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
799
817
  typeMetadata?: TypeMetadata;
800
818
  /**
801
819
  * Minimum permitted number of items in an array field.
@@ -811,6 +829,7 @@ interface _Array {
811
829
  defaultValue?: any[];
812
830
  }
813
831
  interface PageLink {
832
+ /** Calculation pattern used to generate the page link. Required for page link fields. */
814
833
  calculator?: Calculator;
815
834
  /**
816
835
  * Defines reference to router pattern in the site document.
@@ -825,6 +844,7 @@ interface PageLink {
825
844
  }
826
845
  interface Slug {
827
846
  /**
847
+ * Pattern used to generate the field value from item properties.
828
848
  * @minLength 1
829
849
  * @maxLength 1000
830
850
  */
@@ -843,16 +863,21 @@ interface Slug {
843
863
  defaultValue?: string | null;
844
864
  }
845
865
  interface Text extends TextValidationOneOf {
866
+ /** Length and pattern constraints for the text value. */
846
867
  textValidation?: TextValidation;
868
+ /** Allowed text values. */
847
869
  enumValues?: EnumValues;
848
870
  defaultValue?: string | null;
849
871
  }
850
872
  /** @oneof */
851
873
  interface TextValidationOneOf {
874
+ /** Length and pattern constraints for the text value. */
852
875
  textValidation?: TextValidation;
876
+ /** Allowed text values. */
853
877
  enumValues?: EnumValues;
854
878
  }
855
879
  interface _Number {
880
+ /** Value assigned when a data item omits this field. */
856
881
  defaultValue?: number | null;
857
882
  /** Minimum permitted value for a numerical field. */
858
883
  min?: number | null;
@@ -860,48 +885,68 @@ interface _Number {
860
885
  max?: number | null;
861
886
  }
862
887
  interface _Date extends _DateDefaultValueOneOf, _DateMinDateOneOf, _DateMaxDateOneOf {
888
+ /** Fixed date and time used as the default value. */
863
889
  defaultValueFixed?: Date | null;
890
+ /** Offset from the current date, in days, used as the default value. */
864
891
  defaultValueOffsetFromNowInDays?: number | null;
892
+ /** Earliest permitted date and time. */
865
893
  minDateFixed?: Date | null;
894
+ /** Offset from the current date, in days, used as the earliest permitted date. */
866
895
  minValueOffsetFromNowInDays?: number | null;
896
+ /** Latest permitted date and time. */
867
897
  maxDateFixed?: Date | null;
898
+ /** Offset from the current date, in days, used as the latest permitted date. */
868
899
  maxValueOffsetFromNowInDays?: number | null;
869
900
  }
870
901
  /** @oneof */
871
902
  interface _DateDefaultValueOneOf {
903
+ /** Fixed date and time used as the default value. */
872
904
  defaultValueFixed?: Date | null;
905
+ /** Offset from the current date, in days, used as the default value. */
873
906
  defaultValueOffsetFromNowInDays?: number | null;
874
907
  }
875
908
  /** @oneof */
876
909
  interface _DateMinDateOneOf {
910
+ /** Earliest permitted date and time. */
877
911
  minDateFixed?: Date | null;
912
+ /** Offset from the current date, in days, used as the earliest permitted date. */
878
913
  minValueOffsetFromNowInDays?: number | null;
879
914
  }
880
915
  /** @oneof */
881
916
  interface _DateMaxDateOneOf {
917
+ /** Latest permitted date and time. */
882
918
  maxDateFixed?: Date | null;
919
+ /** Offset from the current date, in days, used as the latest permitted date. */
883
920
  maxValueOffsetFromNowInDays?: number | null;
884
921
  }
885
922
  interface Datetime extends DatetimeDefaultValueOneOf, DatetimeMinDateOneOf, DatetimeMaxDateOneOf {
923
+ /** Fixed date and time used as the default value. */
886
924
  defaultValueFixed?: Date | null;
925
+ /** Offset from the current time, in seconds, used as the default value. */
887
926
  defaultValueOffsetFromNowInSeconds?: number | null;
927
+ /** Earliest permitted date and time. */
888
928
  minDateFixed?: Date | null;
889
929
  minDateOffsetFromNowInSeconds?: number | null;
930
+ /** Latest permitted date and time. */
890
931
  maxDateFixed?: Date | null;
891
932
  maxDateOffsetFromNowInSeconds?: number | null;
892
933
  }
893
934
  /** @oneof */
894
935
  interface DatetimeDefaultValueOneOf {
936
+ /** Fixed date and time used as the default value. */
895
937
  defaultValueFixed?: Date | null;
938
+ /** Offset from the current time, in seconds, used as the default value. */
896
939
  defaultValueOffsetFromNowInSeconds?: number | null;
897
940
  }
898
941
  /** @oneof */
899
942
  interface DatetimeMinDateOneOf {
943
+ /** Earliest permitted date and time. */
900
944
  minDateFixed?: Date | null;
901
945
  minDateOffsetFromNowInSeconds?: number | null;
902
946
  }
903
947
  /** @oneof */
904
948
  interface DatetimeMaxDateOneOf {
949
+ /** Latest permitted date and time. */
905
950
  maxDateFixed?: Date | null;
906
951
  maxDateOffsetFromNowInSeconds?: number | null;
907
952
  }
@@ -909,6 +954,7 @@ interface Image {
909
954
  defaultValue?: string | null;
910
955
  }
911
956
  interface _Boolean {
957
+ /** Value assigned when a data item omits this field. */
912
958
  defaultValue?: boolean | null;
913
959
  }
914
960
  interface Document {
@@ -916,10 +962,12 @@ interface Document {
916
962
  }
917
963
  interface Url {
918
964
  /**
965
+ * Value assigned when a data item omits this field.
919
966
  * @minLength 1
920
967
  * @maxLength 2048
921
968
  */
922
969
  defaultValue?: string | null;
970
+ /** Length and pattern constraints for the text value. */
923
971
  textValidation?: TextValidation;
924
972
  }
925
973
  interface RichText {
@@ -976,16 +1024,21 @@ interface Time {
976
1024
  maxTime?: string | null;
977
1025
  }
978
1026
  interface RichContent {
1027
+ /** Value assigned when a data item omits this field. */
979
1028
  defaultValue?: Record<string, any> | null;
980
1029
  }
981
1030
  interface MediaGallery {
982
1031
  defaultValue?: Record<string, any>[] | null;
983
1032
  }
984
1033
  interface Address {
1034
+ /** Value assigned when a data item omits this field. */
985
1035
  defaultValue?: Record<string, any> | null;
986
1036
  }
987
1037
  interface Email {
988
- /** @format EMAIL */
1038
+ /**
1039
+ * Value assigned when a data item omits this field.
1040
+ * @format EMAIL
1041
+ */
989
1042
  defaultValue?: string | null;
990
1043
  }
991
1044
  interface LegacyColor {
@@ -1037,12 +1090,13 @@ interface ArraySizeRange {
1037
1090
  */
1038
1091
  maxSize?: number | null;
1039
1092
  }
1040
- /** Optional plug-in aspects for fields */
1093
+ /** Plugins that extend a field's behavior. */
1041
1094
  interface FieldPlugin extends FieldPluginOptionsOneOf {
1042
1095
  /** Options for the CMS plugin. */
1043
1096
  cmsOptions?: CmsOptions;
1044
1097
  /** Options for the CATEGORY_FIELD plugin. */
1045
1098
  categoryFieldOptions?: CategoryFieldOptions;
1099
+ /** Field plugin type. */
1046
1100
  type?: FieldPluginTypeWithLiterals;
1047
1101
  }
1048
1102
  /** @oneof */
@@ -1053,9 +1107,9 @@ interface FieldPluginOptionsOneOf {
1053
1107
  categoryFieldOptions?: CategoryFieldOptions;
1054
1108
  }
1055
1109
  declare enum FieldPluginType {
1056
- /** Uknown plugin type. */
1110
+ /** Unknown plugin type. */
1057
1111
  UNKNOWN = "UNKNOWN",
1058
- /** CMS-related field attributes */
1112
+ /** CMS-related field attributes. */
1059
1113
  CMS = "CMS",
1060
1114
  /**
1061
1115
  * Marks a multi-reference field as a category field linking to a Category Group.
@@ -1100,7 +1154,7 @@ interface CategoryFieldOptions {
1100
1154
  }
1101
1155
  interface FieldCondition {
1102
1156
  /**
1103
- * If `group_name` is set, this field will not be present in query results. To retrieve this field, pass `group_name` value to `includeFieldGroups` parameter in query operations.
1157
+ * If `groupName` is set, this field will not be present in query results. To retrieve this field, pass `groupName` value to `includeFieldGroups` parameter in query operations.
1104
1158
  * @maxLength 100
1105
1159
  */
1106
1160
  groupName?: string | null;
@@ -1213,7 +1267,9 @@ interface PluginOptionsOneOf {
1213
1267
  draftItemsOptions?: DraftItemsPluginOptions;
1214
1268
  }
1215
1269
  declare enum Status {
1270
+ /** Items are published by default. */
1216
1271
  PUBLISHED = "PUBLISHED",
1272
+ /** Items are drafts by default. */
1217
1273
  DRAFT = "DRAFT"
1218
1274
  }
1219
1275
  /** @enumType */
@@ -1327,7 +1383,11 @@ declare enum PluginType {
1327
1383
  /** @enumType */
1328
1384
  type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
1329
1385
  interface PublishPluginOptions {
1330
- /** Default status. */
1386
+ /**
1387
+ * Publication status assigned to items that don't specify one.
1388
+ *
1389
+ * Default: `PUBLISHED`.
1390
+ */
1331
1391
  defaultStatus?: StatusWithLiterals;
1332
1392
  /**
1333
1393
  * Server-managed lifecycle status.
@@ -1344,7 +1404,11 @@ interface SingleItemPluginOptions {
1344
1404
  singleItemId?: string;
1345
1405
  }
1346
1406
  interface UrlizedPluginOptions {
1347
- /** Encoding method for generating a URL in ASCII characters. */
1407
+ /**
1408
+ * Encoding method for generating a URL in ASCII characters.
1409
+ *
1410
+ * Default: `ORIGINAL`.
1411
+ */
1348
1412
  format?: FormatWithLiterals;
1349
1413
  }
1350
1414
  interface MultilingualOptions {
@@ -1356,7 +1420,17 @@ interface MultilingualOptions {
1356
1420
  translatableFieldKeys?: string[];
1357
1421
  }
1358
1422
  interface PageLinkPluginOptions {
1423
+ /**
1424
+ * Whether page link values are stored with the items.
1425
+ *
1426
+ * Default: `false`.
1427
+ */
1359
1428
  isPersisted?: boolean;
1429
+ /**
1430
+ * Whether page link values can be updated.
1431
+ *
1432
+ * Default: `false`.
1433
+ */
1360
1434
  isMutable?: boolean;
1361
1435
  }
1362
1436
  interface PluginCmsOptions {
@@ -1365,7 +1439,9 @@ interface PluginCmsOptions {
1365
1439
  }
1366
1440
  interface CatalogOptions {
1367
1441
  /**
1368
- * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
1442
+ * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
1443
+ *
1444
+ * Use `nameFieldKey` instead. If both properties are specified, a non-empty `nameFieldKey` takes precedence.
1369
1445
  * @maxLength 1000
1370
1446
  * @deprecated
1371
1447
  * @replacedBy name_field_key
@@ -1373,7 +1449,9 @@ interface CatalogOptions {
1373
1449
  */
1374
1450
  name?: string;
1375
1451
  /**
1376
- * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
1452
+ * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
1453
+ *
1454
+ * Use `priceFieldKey` instead. If both properties are specified, a non-empty `priceFieldKey` takes precedence.
1377
1455
  * @maxLength 1000
1378
1456
  * @deprecated
1379
1457
  * @replacedBy price_field_key
@@ -1381,7 +1459,9 @@ interface CatalogOptions {
1381
1459
  */
1382
1460
  price?: string;
1383
1461
  /**
1384
- * the field key that contains the catalog item URL - field must be of type URL.
1462
+ * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
1463
+ *
1464
+ * Use `urlFieldKey` instead. If both properties are specified, a non-empty `urlFieldKey` takes precedence.
1385
1465
  * @maxLength 1000
1386
1466
  * @deprecated
1387
1467
  * @replacedBy url_field_key
@@ -1389,7 +1469,9 @@ interface CatalogOptions {
1389
1469
  */
1390
1470
  url?: string | null;
1391
1471
  /**
1392
- * the field key that contains the catalog item description - field must be of type TEXT.
1472
+ * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
1473
+ *
1474
+ * Use `descriptionFieldKey` instead. If both properties are specified, a non-empty `descriptionFieldKey` takes precedence.
1393
1475
  * @maxLength 1000
1394
1476
  * @deprecated
1395
1477
  * @replacedBy description_field_key
@@ -1397,7 +1479,9 @@ interface CatalogOptions {
1397
1479
  */
1398
1480
  description?: string | null;
1399
1481
  /**
1400
- * the field key that contains the catalog item image - field must be of type IMAGE.
1482
+ * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
1483
+ *
1484
+ * Use `imageFieldKey` instead. If both properties are specified, a non-empty `imageFieldKey` takes precedence.
1401
1485
  * @maxLength 1000
1402
1486
  * @deprecated
1403
1487
  * @replacedBy image_field_key
@@ -1405,7 +1489,9 @@ interface CatalogOptions {
1405
1489
  */
1406
1490
  image?: string | null;
1407
1491
  /**
1408
- * the field key that contains the catalog item quantity - field must be of type NUMBER.
1492
+ * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
1493
+ *
1494
+ * Use `quantityFieldKey` instead. If both properties are specified, a non-empty `quantityFieldKey` takes precedence.
1409
1495
  * @maxLength 1000
1410
1496
  * @deprecated
1411
1497
  * @replacedBy quantity_field_key
@@ -1413,7 +1499,9 @@ interface CatalogOptions {
1413
1499
  */
1414
1500
  quantity?: string | null;
1415
1501
  /**
1416
- * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
1502
+ * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
1503
+ *
1504
+ * Use `digitalFileFieldKey` instead. If both properties are specified, a non-empty `digitalFileFieldKey` takes precedence.
1417
1505
  * @maxLength 1000
1418
1506
  * @deprecated
1419
1507
  * @replacedBy digital_file_field_key
@@ -1421,7 +1509,9 @@ interface CatalogOptions {
1421
1509
  */
1422
1510
  digitalFile?: string | null;
1423
1511
  /**
1424
- * the field key that contains the catalog item weight - field must be of type NUMBER.
1512
+ * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
1513
+ *
1514
+ * Use `weightFieldKey` instead. If both properties are specified, a non-empty `weightFieldKey` takes precedence.
1425
1515
  * @maxLength 1000
1426
1516
  * @deprecated
1427
1517
  * @replacedBy weight_field_key
@@ -1429,7 +1519,9 @@ interface CatalogOptions {
1429
1519
  */
1430
1520
  weight?: string | null;
1431
1521
  /**
1432
- * the field key that contains the catalog item SKU - field must be of type TEXT.
1522
+ * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
1523
+ *
1524
+ * Use `skuFieldKey` instead. If both properties are specified, a non-empty `skuFieldKey` takes precedence.
1433
1525
  * @maxLength 1000
1434
1526
  * @deprecated
1435
1527
  * @replacedBy sku_field_key
@@ -1437,7 +1529,9 @@ interface CatalogOptions {
1437
1529
  */
1438
1530
  sku?: string | null;
1439
1531
  /**
1440
- * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
1532
+ * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
1533
+ *
1534
+ * Use `shippableFieldKey` instead. If both properties are specified, a non-empty `shippableFieldKey` takes precedence.
1441
1535
  * @maxLength 1000
1442
1536
  * @deprecated
1443
1537
  * @replacedBy shippable_field_key
@@ -1445,52 +1539,56 @@ interface CatalogOptions {
1445
1539
  */
1446
1540
  shippable?: string | null;
1447
1541
  /**
1448
- * *Required** - the field key that contains the catalog item name - field must be of type TEXT.
1542
+ * Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
1543
+ *
1544
+ * Required when configuring the Catalog plugin.
1449
1545
  * @maxLength 1000
1450
1546
  */
1451
1547
  nameFieldKey?: string;
1452
1548
  /**
1453
- * *Required** - the field key that contains the catalog item price - field must be of type NUMBER.
1549
+ * Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
1550
+ *
1551
+ * Required when configuring the Catalog plugin.
1454
1552
  * @maxLength 1000
1455
1553
  */
1456
1554
  priceFieldKey?: string;
1457
1555
  /**
1458
- * the field key that contains the catalog item URL - field must be of type URL.
1556
+ * Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
1459
1557
  * @maxLength 1000
1460
1558
  */
1461
1559
  urlFieldKey?: string | null;
1462
1560
  /**
1463
- * the field key that contains the catalog item description - field must be of type TEXT.
1561
+ * Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
1464
1562
  * @maxLength 1000
1465
1563
  */
1466
1564
  descriptionFieldKey?: string | null;
1467
1565
  /**
1468
- * the field key that contains the catalog item image - field must be of type IMAGE.
1566
+ * Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
1469
1567
  * @maxLength 1000
1470
1568
  */
1471
1569
  imageFieldKey?: string | null;
1472
1570
  /**
1473
- * the field key that contains the catalog item quantity - field must be of type NUMBER.
1571
+ * Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
1474
1572
  * @maxLength 1000
1475
1573
  */
1476
1574
  quantityFieldKey?: string | null;
1477
1575
  /**
1478
- * the field key that contains the catalog item digital file - field must be of type SECURED_MEDIA.
1576
+ * Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
1479
1577
  * @maxLength 1000
1480
1578
  */
1481
1579
  digitalFileFieldKey?: string | null;
1482
1580
  /**
1483
- * the field key that contains the catalog item weight - field must be of type NUMBER.
1581
+ * Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
1484
1582
  * @maxLength 1000
1485
1583
  */
1486
1584
  weightFieldKey?: string | null;
1487
1585
  /**
1488
- * the field key that contains the catalog item SKU - field must be of type TEXT.
1586
+ * Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
1489
1587
  * @maxLength 1000
1490
1588
  */
1491
1589
  skuFieldKey?: string | null;
1492
1590
  /**
1493
- * the field key that contains the catalog item shippable flag - field must be of type BOOLEAN.
1591
+ * Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
1494
1592
  * @maxLength 1000
1495
1593
  */
1496
1594
  shippableFieldKey?: string | null;
@@ -1508,10 +1606,13 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
1508
1606
  * @readonly
1509
1607
  */
1510
1608
  publishedCollectionId?: string;
1511
- /** @internal */
1609
+ /**
1610
+ * Access levels required to view and manage drafts and change publication status.
1611
+ * @internal
1612
+ */
1512
1613
  draftPermissions?: DraftPermissions;
1513
1614
  /**
1514
- * Actual draft management operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`.
1615
+ * Actual draft management operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`.
1515
1616
  * @internal
1516
1617
  * @readonly
1517
1618
  */
@@ -1607,32 +1708,32 @@ interface DataCollectionClonedEvent {
1607
1708
  }
1608
1709
  interface DataCollectionChangedEvent {
1609
1710
  /**
1610
- * list of new fields
1711
+ * Fields added to the collection.
1611
1712
  * @maxSize 1000
1612
1713
  */
1613
1714
  fieldsAdded?: Field[];
1614
1715
  /**
1615
- * list of changed fields
1716
+ * Fields whose definitions changed.
1616
1717
  * @maxSize 1000
1617
1718
  */
1618
1719
  fieldsUpdated?: FieldUpdate[];
1619
1720
  /**
1620
- * list of removed fields
1721
+ * Fields removed from the collection.
1621
1722
  * @maxSize 1000
1622
1723
  */
1623
1724
  fieldsRemoved?: Field[];
1624
1725
  /**
1625
- * list of new plugins
1726
+ * Plugins added to the collection.
1626
1727
  * @maxSize 100
1627
1728
  */
1628
1729
  pluginsAdded?: Plugin[];
1629
1730
  /**
1630
- * list of changed plugins
1731
+ * Plugins whose options changed.
1631
1732
  * @maxSize 100
1632
1733
  */
1633
1734
  pluginsUpdated?: PluginUpdate[];
1634
1735
  /**
1635
- * list of removed plugins
1736
+ * Plugins removed from the collection.
1636
1737
  * @maxSize 100
1637
1738
  */
1638
1739
  pluginsRemoved?: Plugin[];
@@ -1642,15 +1743,15 @@ interface DataCollectionChangedEvent {
1642
1743
  strictModeUpdated?: StrictModeUpdate;
1643
1744
  }
1644
1745
  interface FieldUpdate {
1645
- /** previous state of the field */
1746
+ /** Previous field definition. */
1646
1747
  previous?: Field;
1647
- /** current state of the field */
1748
+ /** Updated field definition. */
1648
1749
  current?: Field;
1649
1750
  }
1650
1751
  interface PluginUpdate {
1651
- /** previous state of the plugin */
1752
+ /** Previous plugin configuration. */
1652
1753
  previous?: Plugin;
1653
- /** current state of the plugin */
1754
+ /** Updated plugin configuration. */
1654
1755
  current?: Plugin;
1655
1756
  }
1656
1757
  interface PermissionsUpdate {
@@ -1678,7 +1779,7 @@ interface CreateDataCollectionRequest {
1678
1779
  collection: DataCollection;
1679
1780
  }
1680
1781
  interface CreateDataCollectionResponse {
1681
- /** Details of collection created. */
1782
+ /** Created collection. */
1682
1783
  collection?: DataCollection;
1683
1784
  }
1684
1785
  interface GetDataCollectionRequest {
@@ -1721,8 +1822,9 @@ interface GetDataCollectionRequest {
1721
1822
  */
1722
1823
  segment?: SegmentWithLiterals;
1723
1824
  /**
1724
- * List of specific field names to return, if empty all fields are returned.
1725
- * Affects all returned collections
1825
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
1826
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
1827
+ * An empty list returns all properties available to the caller.
1726
1828
  * @maxSize 100
1727
1829
  * @maxLength 1000
1728
1830
  */
@@ -1736,7 +1838,7 @@ declare enum Segment {
1736
1838
  /** @enumType */
1737
1839
  type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
1738
1840
  interface GetDataCollectionResponse {
1739
- /** Details of the collection requested. */
1841
+ /** Requested collection. */
1740
1842
  collection?: DataCollection;
1741
1843
  /**
1742
1844
  * Details of collections referenced by the collection requested.
@@ -1749,10 +1851,16 @@ interface ListDataCollectionsRequest {
1749
1851
  /**
1750
1852
  * Defines how collections in the response are sorted.
1751
1853
  *
1752
- * Default: Ordered by ID in ascending order.
1854
+ * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
1855
+ *
1856
+ * Default: `id` in ascending order.
1753
1857
  */
1754
1858
  sort?: Sorting;
1755
- /** Pagination information. */
1859
+ /**
1860
+ * Pagination information. The maximum page size is `1000`.
1861
+ *
1862
+ * Default: `limit` is `1000` and `offset` is `0`.
1863
+ */
1756
1864
  paging?: Paging;
1757
1865
  /**
1758
1866
  * Whether to retrieve data from the primary database instance.
@@ -1774,8 +1882,9 @@ interface ListDataCollectionsRequest {
1774
1882
  */
1775
1883
  segment?: SegmentWithLiterals;
1776
1884
  /**
1777
- * List of specific field names to return, if empty all fields are returned.
1778
- * Affects all returned collections
1885
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
1886
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
1887
+ * An empty list returns all properties available to the caller.
1779
1888
  * @maxSize 100
1780
1889
  * @maxLength 128
1781
1890
  */
@@ -1846,7 +1955,13 @@ interface BulkGetDataCollectionsRequest {
1846
1955
  * Default: `false`
1847
1956
  */
1848
1957
  includeReferencedCollections?: boolean;
1849
- /** Sorting preferences. */
1958
+ /**
1959
+ * Sorting preferences for active and deleted collections. Results aren't returned in request order.
1960
+ *
1961
+ * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
1962
+ *
1963
+ * Default: `id` in ascending order.
1964
+ */
1850
1965
  sort?: Sorting;
1851
1966
  /**
1852
1967
  * Whether to retrieve data from the primary database instance.
@@ -1868,8 +1983,9 @@ interface BulkGetDataCollectionsRequest {
1868
1983
  */
1869
1984
  segment?: SegmentWithLiterals;
1870
1985
  /**
1871
- * List of specific field names to return, if empty all fields are returned.
1872
- * Affects all returned collections
1986
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
1987
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
1988
+ * An empty list returns all properties available to the caller.
1873
1989
  * @maxSize 100
1874
1990
  * @maxLength 1000
1875
1991
  */
@@ -1878,12 +1994,12 @@ interface BulkGetDataCollectionsRequest {
1878
1994
  interface BulkGetDataCollectionsResponse {
1879
1995
  /**
1880
1996
  * List of requested collections.
1881
- * When `include_referenced_collections` is `true` in the request, referenced collections are included here.
1997
+ * When `includeReferencedCollections` is `true` in the request, referenced collections are included here.
1882
1998
  */
1883
1999
  activeCollections?: DataCollection[];
1884
2000
  /** List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request. */
1885
2001
  deletedCollections?: DataCollection[];
1886
- /** List of failed collections. */
2002
+ /** Collections that couldn't be loaded, with an error for each failure. */
1887
2003
  failedCollections?: FailedCollection[];
1888
2004
  }
1889
2005
  interface ApplicationError {
@@ -1896,7 +2012,7 @@ interface ApplicationError {
1896
2012
  }
1897
2013
  interface FailedCollection {
1898
2014
  /**
1899
- * IDs of the failed collection.
2015
+ * ID of the collection that couldn't be loaded.
1900
2016
  * @maxLength 255
1901
2017
  */
1902
2018
  collectionId?: string;
@@ -1922,13 +2038,13 @@ interface DeleteDataCollectionResponse {
1922
2038
  }
1923
2039
  interface RestoreDataCollectionRequest {
1924
2040
  /**
1925
- * Data Collection ID to restore
2041
+ * ID of the data collection to restore.
1926
2042
  * @maxLength 256
1927
2043
  */
1928
2044
  dataCollectionId?: string;
1929
2045
  }
1930
2046
  interface RestoreDataCollectionResponse {
1931
- /** Restored data collection */
2047
+ /** Restored data collection. */
1932
2048
  dataCollection?: DataCollection;
1933
2049
  }
1934
2050
  interface PatchDataCollectionRequest {
@@ -2028,7 +2144,11 @@ interface AddPublishPluginRequest {
2028
2144
  dataCollectionId: string;
2029
2145
  /** Publish plugin options. */
2030
2146
  publishOptions: PublishPluginOptions;
2031
- /** Action to take when the Draft Items plugin is already installed. */
2147
+ /**
2148
+ * Action to take when the Draft Items plugin is already installed.
2149
+ *
2150
+ * Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
2151
+ */
2032
2152
  draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
2033
2153
  }
2034
2154
  /** Behavior to apply when adding the Publish plugin to a collection that already has the Draft Items plugin. */
@@ -2065,7 +2185,10 @@ interface UpdatePublishPluginRequest {
2065
2185
  * @maxLength 256
2066
2186
  */
2067
2187
  dataCollectionId: string;
2068
- /** Updated Publish plugin options. Read-only fields are ignored. */
2188
+ /**
2189
+ * Replacement writable options for the Publish plugin. Omitted options use their defaults.
2190
+ * Server-managed lifecycle status is preserved.
2191
+ */
2069
2192
  publishOptions: PublishPluginOptions;
2070
2193
  }
2071
2194
  interface UpdatePublishPluginResponse {
@@ -2102,7 +2225,7 @@ interface UpdateUrlizedPluginRequest {
2102
2225
  * @maxLength 256
2103
2226
  */
2104
2227
  dataCollectionId: string;
2105
- /** Updated Urlized plugin options. */
2228
+ /** Replacement options for the Urlized plugin. Omitted options use their defaults. */
2106
2229
  urlizedOptions: UrlizedPluginOptions;
2107
2230
  }
2108
2231
  interface UpdateUrlizedPluginResponse {
@@ -2139,7 +2262,7 @@ interface UpdateMultilingualPluginRequest {
2139
2262
  * @maxLength 256
2140
2263
  */
2141
2264
  dataCollectionId: string;
2142
- /** Updated Multilingual plugin options. */
2265
+ /** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
2143
2266
  multilingualOptions: MultilingualOptions;
2144
2267
  }
2145
2268
  interface UpdateMultilingualPluginResponse {
@@ -2176,7 +2299,7 @@ interface UpdateCmsPluginRequest {
2176
2299
  * @maxLength 256
2177
2300
  */
2178
2301
  dataCollectionId: string;
2179
- /** Updated CMS plugin options. */
2302
+ /** Replacement options for the CMS plugin. Omitted options use their defaults. */
2180
2303
  cmsOptions: PluginCmsOptions;
2181
2304
  }
2182
2305
  interface UpdateCmsPluginResponse {
@@ -2213,7 +2336,7 @@ interface UpdateCatalogPluginRequest {
2213
2336
  * @maxLength 256
2214
2337
  */
2215
2338
  dataCollectionId: string;
2216
- /** Updated Catalog plugin options. */
2339
+ /** Replacement options for the Catalog plugin. Omitted options use their defaults. */
2217
2340
  catalogOptions: CatalogOptions;
2218
2341
  }
2219
2342
  interface UpdateCatalogPluginResponse {
@@ -2228,7 +2351,11 @@ interface AddDraftItemsPluginRequest {
2228
2351
  dataCollectionId: string;
2229
2352
  /** Draft Items plugin options. */
2230
2353
  draftItemsOptions: DraftItemsPluginOptions;
2231
- /** Action to take when the Publish plugin is already installed. */
2354
+ /**
2355
+ * Action to take when the Publish plugin is already installed.
2356
+ *
2357
+ * Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
2358
+ */
2232
2359
  publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
2233
2360
  }
2234
2361
  /** Behavior to apply when adding the Draft Items plugin to a collection that already has the Publish plugin. */
@@ -2250,7 +2377,11 @@ interface DeleteDraftItemsPluginRequest {
2250
2377
  * @maxLength 256
2251
2378
  */
2252
2379
  dataCollectionId: string;
2253
- /** Action to take for existing draft items. */
2380
+ /**
2381
+ * Action to take for existing draft items.
2382
+ *
2383
+ * Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
2384
+ */
2254
2385
  draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
2255
2386
  }
2256
2387
  /** Behavior to apply to existing draft items when removing the Draft Items plugin. */
@@ -2274,7 +2405,10 @@ interface UpdateDraftItemsPluginRequest {
2274
2405
  * @maxLength 256
2275
2406
  */
2276
2407
  dataCollectionId: string;
2277
- /** Updated Draft Items plugin options. Read-only fields are ignored. */
2408
+ /**
2409
+ * Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
2410
+ * Server-managed paired collection IDs are preserved.
2411
+ */
2278
2412
  draftItemsOptions: DraftItemsPluginOptions;
2279
2413
  }
2280
2414
  interface UpdateDraftItemsPluginResponse {
@@ -2287,12 +2421,13 @@ interface PatchDataCollectionFieldRequest {
2287
2421
  * @maxLength 256
2288
2422
  */
2289
2423
  dataCollectionId: string;
2290
- /** Field to update. */
2424
+ /** Field to update. Specify `key` to identify the existing field. */
2291
2425
  field: Field;
2292
2426
  /**
2293
2427
  * Field mask specifying which field properties to update.
2294
2428
  * Supported properties: `displayName`, `type`, `typeMetadata`, `encrypted`, `description`.
2295
2429
  * Attempting to update `key` or other unsupported properties results in an error.
2430
+ * Each masked property must have a value in `field`. To set `encrypted` to `false`, explicitly include it in the mask.
2296
2431
  * @internal
2297
2432
  */
2298
2433
  fieldMask?: string[];
@@ -2315,6 +2450,7 @@ interface UpdateDataPermissionsResponse {
2315
2450
  dataCollection?: DataCollection;
2316
2451
  }
2317
2452
  interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
2453
+ /** App whose collection snapshots to retrieve. */
2318
2454
  appOptions?: AppOptions;
2319
2455
  /**
2320
2456
  * Ids of schema snapshot
@@ -2333,6 +2469,7 @@ interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollec
2333
2469
  }
2334
2470
  /** @oneof */
2335
2471
  interface BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
2472
+ /** App whose collection snapshots to retrieve. */
2336
2473
  appOptions?: AppOptions;
2337
2474
  }
2338
2475
  declare enum TenantMode {
@@ -2620,15 +2757,27 @@ interface DeleteDataCollectionsSnapshotRequest {
2620
2757
  interface DeleteDataCollectionsSnapshotResponse {
2621
2758
  }
2622
2759
  interface CreateMigratedCollectionsSnapshotRequest {
2623
- /** @format GUID */
2760
+ /**
2761
+ * ID of the source snapshot.
2762
+ * @format GUID
2763
+ */
2624
2764
  existingSnapshotId?: string;
2625
- /** @maxLength 255 */
2765
+ /**
2766
+ * Namespace to assign to collections in the new snapshot.
2767
+ * @maxLength 255
2768
+ */
2626
2769
  newNamespace?: string;
2627
- /** @maxLength 255 */
2770
+ /**
2771
+ * Namespace to replace in the source snapshot.
2772
+ * @maxLength 255
2773
+ */
2628
2774
  existingNamespace?: string;
2629
2775
  }
2630
2776
  interface CreateMigratedCollectionsSnapshotResponse {
2631
- /** @format GUID */
2777
+ /**
2778
+ * ID of the created snapshot.
2779
+ * @format GUID
2780
+ */
2632
2781
  snapshotId?: string;
2633
2782
  }
2634
2783
  interface DomainEvent extends DomainEventBodyOneOf {
@@ -2785,7 +2934,7 @@ interface AccountInfo {
2785
2934
  siteId?: string | null;
2786
2935
  }
2787
2936
  /**
2788
- * Creates a new data collection.
2937
+ * Creates a data collection.
2789
2938
  *
2790
2939
  * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
2791
2940
  * @param collection - Collection details.
@@ -2801,25 +2950,26 @@ interface AccountInfo {
2801
2950
  * @param options - Options for creating a data collection.
2802
2951
  * @permissionId WIX_DATA.CREATE_COLLECTION
2803
2952
  * @applicableIdentity APP
2804
- * @returns Details of collection created.
2953
+ * @returns Created collection.
2805
2954
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
2806
2955
  */
2807
2956
  declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
2808
2957
  /**
2809
2958
  * Retrieves a data collection by ID.
2810
2959
  *
2811
- * Starting on August 3rd, 2026, when called with a visitor (unauthenticated) identity, the response contains only
2812
- * the collection details needed to display the collection's data: `id`, `displayName`, `displayField`, `plugins`,
2813
- * and for each field in `fields` its `key`, `displayName`, `type`, and `typeMetadata`. All other collection
2814
- * details, such as `permissions` and `capabilities`, are omitted. Calls made with any other identity return the
2815
- * full collection.
2960
+ * Calls made with a visitor (unauthenticated) identity return a limited collection view.
2961
+ * The response includes display information, plugins, paging information, and supported operations.
2962
+ * It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
2963
+ * Other identities return the full collection, subject to the requested field selection.
2964
+ *
2965
+ * To retrieve multiple collections in one call, use [Bulk Get Data Collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/bulk-get-data-collections).
2816
2966
  * @param dataCollectionId - ID of the collection to retrieve.
2817
2967
  * @public
2818
2968
  * @requiredField dataCollectionId
2819
2969
  * @param options - Options for retrieving a data collection.
2820
2970
  * @permissionId WIX_DATA.GET_COLLECTION
2821
2971
  * @applicableIdentity APP
2822
- * @returns Details of the collection requested.
2972
+ * @returns Requested collection.
2823
2973
  * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
2824
2974
  */
2825
2975
  declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
@@ -2838,17 +2988,20 @@ interface GetDataCollectionOptions {
2838
2988
  */
2839
2989
  includeAllowedDataPermissions?: boolean;
2840
2990
  /**
2841
- * List of specific field names to return, if empty all fields are returned.
2842
- * Affects all returned collections
2991
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
2992
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
2993
+ * An empty list returns all properties available to the caller.
2843
2994
  * @maxSize 100
2844
2995
  * @maxLength 1000
2845
2996
  */
2846
2997
  fields?: string[];
2847
2998
  }
2848
2999
  /**
2849
- * Retrieves a list of all data collections associated with the site or project.
3000
+ * Retrieves a page of data collections associated with the site or project.
2850
3001
  *
2851
- * By default, the list is ordered by ID in ascending order.
3002
+ * By default, results are sorted by `id` in ascending order, `paging.limit` is `1000`, and `paging.offset` is `0`.
3003
+ * The maximum page size is `1000`. Larger limits are reduced to `1000`.
3004
+ * To retrieve the next page, increase `paging.offset` by the number of collections returned.
2852
3005
  * @public
2853
3006
  * @param options - Options for retrieving a list of data collections.
2854
3007
  * @permissionId WIX_DATA.LIST_COLLECTIONS
@@ -2860,10 +3013,16 @@ interface ListDataCollectionsOptions {
2860
3013
  /**
2861
3014
  * Defines how collections in the response are sorted.
2862
3015
  *
2863
- * Default: Ordered by ID in ascending order.
3016
+ * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
3017
+ *
3018
+ * Default: `id` in ascending order.
2864
3019
  */
2865
3020
  sort?: Sorting;
2866
- /** Pagination information. */
3021
+ /**
3022
+ * Pagination information. The maximum page size is `1000`.
3023
+ *
3024
+ * Default: `limit` is `1000` and `offset` is `0`.
3025
+ */
2867
3026
  paging?: Paging;
2868
3027
  /**
2869
3028
  * Whether to retrieve data from the primary database instance.
@@ -2879,8 +3038,9 @@ interface ListDataCollectionsOptions {
2879
3038
  */
2880
3039
  includeAllowedDataPermissions?: boolean;
2881
3040
  /**
2882
- * List of specific field names to return, if empty all fields are returned.
2883
- * Affects all returned collections
3041
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
3042
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
3043
+ * An empty list returns all properties available to the caller.
2884
3044
  * @maxSize 100
2885
3045
  * @maxLength 128
2886
3046
  */
@@ -2889,11 +3049,16 @@ interface ListDataCollectionsOptions {
2889
3049
  /**
2890
3050
  * Retrieves multiple data collections by ID.
2891
3051
  *
2892
- * Starting on August 3rd, 2026, when called with a visitor (unauthenticated) identity, the returned collections
2893
- * contain only the details needed to display the collections' data: `id`, `displayName`, `displayField`,
2894
- * `plugins`, and for each field in `fields` its `key`, `displayName`, `type`, and `typeMetadata`. All other
2895
- * collection details, such as `permissions` and `capabilities`, are omitted. Calls made with any other identity
2896
- * return the full collections.
3052
+ * Calls made with a visitor (unauthenticated) identity return a limited collection view.
3053
+ * The response includes display information, plugins, paging information, and supported operations.
3054
+ * It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
3055
+ * Other identities return the full collection, subject to the requested field selection.
3056
+ *
3057
+ * Successful results are returned in `activeCollections` and, when requested, `deletedCollections`.
3058
+ * Collection loading failures are returned separately in `failedCollections`.
3059
+ * Results are sorted by `id` in ascending order unless `sort` specifies a different order.
3060
+ *
3061
+ * To retrieve a single collection, call [Get Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/get-data-collection).
2897
3062
  * @public
2898
3063
  * @documentationMaturity preview
2899
3064
  * @permissionId WIX_DATA.BULK_GET_COLLECTIONS
@@ -2921,7 +3086,13 @@ interface BulkGetDataCollectionsOptions {
2921
3086
  * Default: `false`
2922
3087
  */
2923
3088
  includeReferencedCollections?: boolean;
2924
- /** Sorting preferences. */
3089
+ /**
3090
+ * Sorting preferences for active and deleted collections. Results aren't returned in request order.
3091
+ *
3092
+ * Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
3093
+ *
3094
+ * Default: `id` in ascending order.
3095
+ */
2925
3096
  sort?: Sorting;
2926
3097
  /**
2927
3098
  * Whether to retrieve data from the primary database instance.
@@ -2937,8 +3108,9 @@ interface BulkGetDataCollectionsOptions {
2937
3108
  */
2938
3109
  includeAllowedDataPermissions?: boolean;
2939
3110
  /**
2940
- * List of specific field names to return, if empty all fields are returned.
2941
- * Affects all returned collections
3111
+ * Top-level collection properties to return, using camelCase names, such as `displayName`.
3112
+ * Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
3113
+ * An empty list returns all properties available to the caller.
2942
3114
  * @maxSize 100
2943
3115
  * @maxLength 1000
2944
3116
  */
@@ -2988,7 +3160,7 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
2988
3160
  *
2989
3161
  * Before deleting a collection:
2990
3162
  * - Make sure the collection isn't connected to any site pages or elements.
2991
- * - You can create a manual backup of a collections with the Backups API, in case you need to restore them later.
3163
+ * - You can create a manual backup of collections with the Backups API, in case you need to restore them later.
2992
3164
  * - You can also export a collection to a CSV file with the Data Movement Jobs API, if you want to save the data outside of Wix.
2993
3165
  *
2994
3166
  * > **Note:**
@@ -3002,10 +3174,10 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
3002
3174
  */
3003
3175
  declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
3004
3176
  /**
3005
- * Restores recently deleted collection.
3177
+ * Restores a recently deleted data collection.
3006
3178
  *
3007
3179
  * Fails with `WDE0025` if collection was deleted too long ago or has never existed.
3008
- * @param dataCollectionId - Data Collection ID to restore
3180
+ * @param dataCollectionId - ID of the data collection to restore.
3009
3181
  * @public
3010
3182
  * @documentationMaturity preview
3011
3183
  * @requiredField dataCollectionId
@@ -3062,6 +3234,8 @@ interface PatchDataCollection {
3062
3234
  maxPageSize?: number | null;
3063
3235
  /**
3064
3236
  * Collection's display name as shown in the CMS. For example, `My First Collection`.
3237
+ *
3238
+ * Default: The collection ID.
3065
3239
  * @maxLength 1000
3066
3240
  */
3067
3241
  displayName?: string | null;
@@ -3079,6 +3253,8 @@ interface PatchDataCollection {
3079
3253
  displayNamespace?: string | null;
3080
3254
  /**
3081
3255
  * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
3256
+ *
3257
+ * Default: The first field in the request, or `title` if no fields are specified.
3082
3258
  * @maxLength 1000
3083
3259
  */
3084
3260
  displayField?: string | null;
@@ -3127,7 +3303,7 @@ interface PatchDataCollection {
3127
3303
  */
3128
3304
  dataPermissions?: DataPermissions;
3129
3305
  /**
3130
- * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
3306
+ * Actual data operations permitted for the caller. Included only if requested by `includeAllowedDataPermissions`
3131
3307
  * @internal
3132
3308
  * @readonly
3133
3309
  */
@@ -3169,13 +3345,13 @@ interface CreateDataCollectionFieldOptions {
3169
3345
  field: Field;
3170
3346
  }
3171
3347
  /**
3172
- * Updates properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
3348
+ * Replaces the definition of a field in a data collection.
3173
3349
  *
3174
3350
  * <blockquote class="important">
3175
3351
  * <strong>Important:</strong>
3176
3352
  *
3177
- * After `fields` is updated, it only contains the properties included in the Update Data Collection Field request.
3178
- * If the existing `fields` array has properties with values and those properties aren't included in the updated details, their values are lost.<br/><br/>
3353
+ * The field identified by `field.key` is replaced with the supplied definition.
3354
+ * Properties omitted from that field definition aren't preserved. Other fields in the collection aren't replaced.<br/><br/>
3179
3355
  *
3180
3356
  * To update only specific properties in the array without affecting others, use [Patch Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection-field).
3181
3357
  * </blockquote>
@@ -3259,6 +3435,8 @@ interface DeleteDataCollectionPluginOptions {
3259
3435
  }
3260
3436
  /**
3261
3437
  * Adds the Publish plugin to a data collection.
3438
+ *
3439
+ * Fails if the collection already has this plugin.
3262
3440
  * @public
3263
3441
  * @documentationMaturity preview
3264
3442
  * @requiredField dataCollectionId
@@ -3274,11 +3452,17 @@ declare function addPublishPlugin(dataCollectionId: string, options?: NonNullabl
3274
3452
  interface AddPublishPluginOptions {
3275
3453
  /** Publish plugin options. */
3276
3454
  publishOptions: PublishPluginOptions;
3277
- /** Action to take when the Draft Items plugin is already installed. */
3455
+ /**
3456
+ * Action to take when the Draft Items plugin is already installed.
3457
+ *
3458
+ * Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
3459
+ */
3278
3460
  draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
3279
3461
  }
3280
3462
  /**
3281
3463
  * Removes the Publish plugin from a data collection.
3464
+ *
3465
+ * Fails if the collection doesn't have this plugin.
3282
3466
  * @param dataCollectionId - ID of the data collection to update.
3283
3467
  * @public
3284
3468
  * @documentationMaturity preview
@@ -3290,6 +3474,9 @@ interface AddPublishPluginOptions {
3290
3474
  declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3291
3475
  /**
3292
3476
  * Updates the Publish plugin options on a data collection.
3477
+ *
3478
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3479
+ * Server-managed properties are preserved, and other plugins aren't changed.
3293
3480
  * @param dataCollectionId - ID of the data collection to update.
3294
3481
  * @public
3295
3482
  * @documentationMaturity preview
@@ -3302,11 +3489,16 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
3302
3489
  */
3303
3490
  declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3304
3491
  interface UpdatePublishPluginOptions {
3305
- /** Updated Publish plugin options. Read-only fields are ignored. */
3492
+ /**
3493
+ * Replacement writable options for the Publish plugin. Omitted options use their defaults.
3494
+ * Server-managed lifecycle status is preserved.
3495
+ */
3306
3496
  publishOptions: PublishPluginOptions;
3307
3497
  }
3308
3498
  /**
3309
3499
  * Adds the Urlized plugin to a data collection.
3500
+ *
3501
+ * Fails if the collection already has this plugin.
3310
3502
  * @public
3311
3503
  * @documentationMaturity preview
3312
3504
  * @requiredField dataCollectionId
@@ -3325,6 +3517,8 @@ interface AddUrlizedPluginOptions {
3325
3517
  }
3326
3518
  /**
3327
3519
  * Removes the Urlized plugin from a data collection.
3520
+ *
3521
+ * Fails if the collection doesn't have this plugin.
3328
3522
  * @param dataCollectionId - ID of the data collection to update.
3329
3523
  * @public
3330
3524
  * @documentationMaturity preview
@@ -3336,6 +3530,9 @@ interface AddUrlizedPluginOptions {
3336
3530
  declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3337
3531
  /**
3338
3532
  * Updates the Urlized plugin options on a data collection.
3533
+ *
3534
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3535
+ * Server-managed properties are preserved, and other plugins aren't changed.
3339
3536
  * @param dataCollectionId - ID of the data collection to update.
3340
3537
  * @public
3341
3538
  * @documentationMaturity preview
@@ -3348,11 +3545,13 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
3348
3545
  */
3349
3546
  declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3350
3547
  interface UpdateUrlizedPluginOptions {
3351
- /** Updated Urlized plugin options. */
3548
+ /** Replacement options for the Urlized plugin. Omitted options use their defaults. */
3352
3549
  urlizedOptions: UrlizedPluginOptions;
3353
3550
  }
3354
3551
  /**
3355
3552
  * Adds the Multilingual plugin to a data collection.
3553
+ *
3554
+ * Fails if the collection already has this plugin.
3356
3555
  * @public
3357
3556
  * @documentationMaturity preview
3358
3557
  * @requiredField dataCollectionId
@@ -3371,6 +3570,8 @@ interface AddMultilingualPluginOptions {
3371
3570
  }
3372
3571
  /**
3373
3572
  * Removes the Multilingual plugin from a data collection.
3573
+ *
3574
+ * Fails if the collection doesn't have this plugin.
3374
3575
  * @param dataCollectionId - ID of the data collection to update.
3375
3576
  * @public
3376
3577
  * @documentationMaturity preview
@@ -3382,6 +3583,9 @@ interface AddMultilingualPluginOptions {
3382
3583
  declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3383
3584
  /**
3384
3585
  * Updates the Multilingual plugin options on a data collection.
3586
+ *
3587
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3588
+ * Server-managed properties are preserved, and other plugins aren't changed.
3385
3589
  * @param dataCollectionId - ID of the data collection to update.
3386
3590
  * @public
3387
3591
  * @documentationMaturity preview
@@ -3394,11 +3598,13 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
3394
3598
  */
3395
3599
  declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3396
3600
  interface UpdateMultilingualPluginOptions {
3397
- /** Updated Multilingual plugin options. */
3601
+ /** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
3398
3602
  multilingualOptions: MultilingualOptions;
3399
3603
  }
3400
3604
  /**
3401
3605
  * Adds the CMS plugin to a data collection.
3606
+ *
3607
+ * Fails if the collection already has this plugin.
3402
3608
  * @public
3403
3609
  * @documentationMaturity preview
3404
3610
  * @requiredField dataCollectionId
@@ -3417,6 +3623,8 @@ interface AddCmsPluginOptions {
3417
3623
  }
3418
3624
  /**
3419
3625
  * Removes the CMS plugin from a data collection.
3626
+ *
3627
+ * Fails if the collection doesn't have this plugin.
3420
3628
  * @param dataCollectionId - ID of the data collection to update.
3421
3629
  * @public
3422
3630
  * @documentationMaturity preview
@@ -3428,6 +3636,9 @@ interface AddCmsPluginOptions {
3428
3636
  declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3429
3637
  /**
3430
3638
  * Updates the CMS plugin options on a data collection.
3639
+ *
3640
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3641
+ * Server-managed properties are preserved, and other plugins aren't changed.
3431
3642
  * @param dataCollectionId - ID of the data collection to update.
3432
3643
  * @public
3433
3644
  * @documentationMaturity preview
@@ -3440,11 +3651,13 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
3440
3651
  */
3441
3652
  declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3442
3653
  interface UpdateCmsPluginOptions {
3443
- /** Updated CMS plugin options. */
3654
+ /** Replacement options for the CMS plugin. Omitted options use their defaults. */
3444
3655
  cmsOptions: PluginCmsOptions;
3445
3656
  }
3446
3657
  /**
3447
3658
  * Adds the Catalog plugin to a data collection.
3659
+ *
3660
+ * Fails if the collection already has this plugin.
3448
3661
  * @public
3449
3662
  * @documentationMaturity preview
3450
3663
  * @requiredField dataCollectionId
@@ -3463,6 +3676,8 @@ interface AddCatalogPluginOptions {
3463
3676
  }
3464
3677
  /**
3465
3678
  * Removes the Catalog plugin from a data collection.
3679
+ *
3680
+ * Fails if the collection doesn't have this plugin.
3466
3681
  * @param dataCollectionId - ID of the data collection to update.
3467
3682
  * @public
3468
3683
  * @documentationMaturity preview
@@ -3474,6 +3689,9 @@ interface AddCatalogPluginOptions {
3474
3689
  declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3475
3690
  /**
3476
3691
  * Updates the Catalog plugin options on a data collection.
3692
+ *
3693
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3694
+ * Server-managed properties are preserved, and other plugins aren't changed.
3477
3695
  * @param dataCollectionId - ID of the data collection to update.
3478
3696
  * @public
3479
3697
  * @documentationMaturity preview
@@ -3486,11 +3704,13 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
3486
3704
  */
3487
3705
  declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3488
3706
  interface UpdateCatalogPluginOptions {
3489
- /** Updated Catalog plugin options. */
3707
+ /** Replacement options for the Catalog plugin. Omitted options use their defaults. */
3490
3708
  catalogOptions: CatalogOptions;
3491
3709
  }
3492
3710
  /**
3493
3711
  * Adds the Draft Items plugin to a data collection.
3712
+ *
3713
+ * Fails if the collection already has this plugin.
3494
3714
  * @public
3495
3715
  * @documentationMaturity preview
3496
3716
  * @requiredField dataCollectionId
@@ -3506,11 +3726,17 @@ declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNull
3506
3726
  interface AddDraftItemsPluginOptions {
3507
3727
  /** Draft Items plugin options. */
3508
3728
  draftItemsOptions: DraftItemsPluginOptions;
3509
- /** Action to take when the Publish plugin is already installed. */
3729
+ /**
3730
+ * Action to take when the Publish plugin is already installed.
3731
+ *
3732
+ * Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
3733
+ */
3510
3734
  publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
3511
3735
  }
3512
3736
  /**
3513
3737
  * Removes the Draft Items plugin from a data collection.
3738
+ *
3739
+ * Fails if the collection doesn't have this plugin.
3514
3740
  * @param dataCollectionId - ID of the data collection to update.
3515
3741
  * @public
3516
3742
  * @documentationMaturity preview
@@ -3522,11 +3748,18 @@ interface AddDraftItemsPluginOptions {
3522
3748
  */
3523
3749
  declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3524
3750
  interface DeleteDraftItemsPluginOptions {
3525
- /** Action to take for existing draft items. */
3751
+ /**
3752
+ * Action to take for existing draft items.
3753
+ *
3754
+ * Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
3755
+ */
3526
3756
  draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
3527
3757
  }
3528
3758
  /**
3529
3759
  * Updates the Draft Items plugin options on a data collection.
3760
+ *
3761
+ * The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
3762
+ * Server-managed properties are preserved, and other plugins aren't changed.
3530
3763
  * @param dataCollectionId - ID of the data collection to update.
3531
3764
  * @public
3532
3765
  * @documentationMaturity preview
@@ -3539,17 +3772,20 @@ interface DeleteDraftItemsPluginOptions {
3539
3772
  */
3540
3773
  declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
3541
3774
  interface UpdateDraftItemsPluginOptions {
3542
- /** Updated Draft Items plugin options. Read-only fields are ignored. */
3775
+ /**
3776
+ * Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
3777
+ * Server-managed paired collection IDs are preserved.
3778
+ */
3543
3779
  draftItemsOptions: DraftItemsPluginOptions;
3544
3780
  }
3545
3781
  /**
3546
- * Updates specified properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
3782
+ * Updates specified properties of a field in a data collection.
3547
3783
  *
3548
3784
  * When you change a field's type, existing values aren't migrated. Use [Bulk Update Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-update-data-items) or [Bulk Patch Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-patch-data-items) to update item values to match the new type.
3549
3785
  *
3550
3786
  * To update properties in a data collection other than `fields`, use [Patch Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection).
3551
3787
  * @param dataCollectionId - ID of the data collection to update.
3552
- * @param field - Field to update.
3788
+ * @param field - Field to update. Specify `key` to identify the existing field.
3553
3789
  * @public
3554
3790
  * @requiredField dataCollectionId
3555
3791
  * @requiredField field