@wix/data 1.0.174 → 1.0.176

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/data",
3
- "version": "1.0.174",
3
+ "version": "1.0.176",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -22,7 +22,7 @@
22
22
  "service-plugins"
23
23
  ],
24
24
  "dependencies": {
25
- "@wix/data_collections": "1.0.60",
25
+ "@wix/data_collections": "1.0.62",
26
26
  "@wix/data_external-database": "1.0.27",
27
27
  "@wix/data_external-database-connections": "1.0.49",
28
28
  "@wix/data_indexes": "1.0.44",
@@ -51,5 +51,5 @@
51
51
  "fqdn": ""
52
52
  }
53
53
  },
54
- "falconPackageHash": "21ec79335f5f9407daa9f5f93bfe7a42dada475b1fa364b9b6318b38"
54
+ "falconPackageHash": "1418048968a1f04acac2ba30fb27b66efe016a8aa45757d2e3f841e8"
55
55
  }
@@ -1035,12 +1035,12 @@ interface DataCollection {
1035
1035
  /** Collection ID. For example, `my-first-collection`. May include a namespace. */
1036
1036
  _id?: string;
1037
1037
  /**
1038
- * Collection type. Indicates how the collection was created and is stored.
1038
+ * Collection type. Indicates how the collection was created and how it is stored.
1039
1039
  * @readonly
1040
1040
  */
1041
1041
  collectionType?: CollectionType;
1042
1042
  /**
1043
- * ID of the app that defined this collection. For user-defined collections, this value is null.
1043
+ * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
1044
1044
  * @readonly
1045
1045
  */
1046
1046
  ownerAppId?: string | null;
@@ -1054,17 +1054,17 @@ interface DataCollection {
1054
1054
  /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
1055
1055
  displayName?: string | null;
1056
1056
  /**
1057
- * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
1057
+ * Default item sorting order when a query doesn't specify one.
1058
1058
  * @readonly
1059
1059
  */
1060
1060
  defaultDisplayOrder?: Sort;
1061
1061
  /**
1062
1062
  * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
1063
- * Empty for all data collections not owned by internal Wix apps.
1063
+ * Empty for all data collections not owned by Wix apps.
1064
1064
  * @readonly
1065
1065
  */
1066
1066
  displayNamespace?: string | null;
1067
- /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1067
+ /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1068
1068
  displayField?: string | null;
1069
1069
  /**
1070
1070
  * Capabilities the collection supports.
@@ -1076,14 +1076,14 @@ interface DataCollection {
1076
1076
  /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
1077
1077
  permissions?: Permissions;
1078
1078
  /**
1079
- * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
1079
+ * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
1080
1080
  * @readonly
1081
1081
  */
1082
1082
  revision?: string | null;
1083
- /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1083
+ /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1084
1084
  plugins?: Plugin[];
1085
1085
  /**
1086
- * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
1086
+ * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
1087
1087
  * @readonly
1088
1088
  */
1089
1089
  pagingModes?: PagingMode[];
@@ -1123,7 +1123,11 @@ declare enum Direction {
1123
1123
  DESC = "DESC"
1124
1124
  }
1125
1125
  interface CollectionCapabilities {
1126
- /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
1126
+ /**
1127
+ * Data operations the collection supports. The listed operations can be performed on data the collection contains.
1128
+ *
1129
+ * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
1130
+ */
1127
1131
  dataOperations?: DataOperation[];
1128
1132
  /** Collection operations supported. The listed operations can be performed on the collection itself. */
1129
1133
  collectionOperations?: CollectionOperation[];
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
1176
1180
  arraySizeRange?: ArraySizeRange;
1177
1181
  /** Unique identifier for the field. For example, `firstName`. */
1178
1182
  key?: string;
1179
- /** Field's display name when shown in the CMS. For example, `First Name`. */
1183
+ /** Field's display name when displayed in the CMS. For example, `First Name`. */
1180
1184
  displayName?: string | null;
1181
1185
  /** Field's data type. */
1182
1186
  type?: Type;
1183
1187
  /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
1184
1188
  typeMetadata?: TypeMetadata;
1185
1189
  /**
1186
- * Whether the field is a system field (created automatically).
1190
+ * Whether the field is a system field.
1187
1191
  * @readonly
1188
1192
  */
1189
1193
  systemField?: boolean;
@@ -1192,9 +1196,9 @@ interface Field$1 extends FieldRangeValidationsOneOf {
1192
1196
  * @readonly
1193
1197
  */
1194
1198
  capabilities?: FieldCapabilities;
1195
- /** Indicates if field is encrypted. */
1199
+ /** Whether the field is encrypted. */
1196
1200
  encrypted?: boolean;
1197
- /** Description of the field. */
1201
+ /** Field description. */
1198
1202
  description?: string | null;
1199
1203
  plugin?: string | null;
1200
1204
  /**
@@ -1300,11 +1304,7 @@ interface FieldCapabilities {
1300
1304
  * Default: `false`
1301
1305
  */
1302
1306
  sortable?: boolean;
1303
- /**
1304
- * Query operators that can be used for this field.
1305
- *
1306
- * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
1307
- */
1307
+ /** Query operators that can be used for this field. */
1308
1308
  queryOperators?: QueryOperator[];
1309
1309
  }
1310
1310
  declare enum QueryOperator {
@@ -1619,9 +1619,9 @@ interface AllowedDataPermissions {
1619
1619
  itemRemove?: boolean;
1620
1620
  }
1621
1621
  interface DataCollectionClonedEvent {
1622
- /** original instance collection is cloned from */
1622
+ /** Instance ID of the collection from which the data is cloned. */
1623
1623
  originInstanceId?: string;
1624
- /** original collection ID, may be same as current one */
1624
+ /** ID of the collection from which the data is cloned. */
1625
1625
  originId?: string;
1626
1626
  }
1627
1627
  interface DataCollectionChangedEvent {
@@ -1798,6 +1798,14 @@ interface DeleteDataCollectionRequest {
1798
1798
  }
1799
1799
  interface DeleteDataCollectionResponse {
1800
1800
  }
1801
+ interface RestoreDataCollectionRequest {
1802
+ /** Data Collection ID to restore */
1803
+ dataCollectionId?: string;
1804
+ }
1805
+ interface RestoreDataCollectionResponse {
1806
+ /** Restored data collection */
1807
+ dataCollection?: DataCollection;
1808
+ }
1801
1809
  interface CreateDataCollectionFieldRequest {
1802
1810
  /** ID of data collection to update */
1803
1811
  dataCollectionId?: string;
@@ -2332,14 +2340,14 @@ interface UpdateDataCollectionSignature {
2332
2340
  /**
2333
2341
  * Updates a data collection.
2334
2342
  *
2335
- * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
2343
+ * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
2336
2344
  * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
2337
2345
  * Otherwise, the request fails.
2338
2346
  *
2339
- * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
2347
+ * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
2340
2348
  *
2341
2349
  * > **Note:**
2342
- * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
2350
+ * > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
2343
2351
  * > aren't included in the updated collection details, their values are lost.
2344
2352
  * @param - Updated collection details. The existing collection is replaced with this version.
2345
2353
  * @param - Options for updating a data collection.
@@ -2353,7 +2361,7 @@ interface DeleteDataCollectionSignature {
2353
2361
  * Deletes a data collection.
2354
2362
  *
2355
2363
  * > **Note:**
2356
- * > Once a collection is deleted, it can't be restored.
2364
+ * > Once a collection is deleted, it can only be restored for limited amount of time.
2357
2365
  * @param - ID of the collection to delete.
2358
2366
  */
2359
2367
  (dataCollectionId: string): Promise<void>;
@@ -2446,6 +2454,8 @@ type context$2_QueryOperator = QueryOperator;
2446
2454
  declare const context$2_QueryOperator: typeof QueryOperator;
2447
2455
  type context$2_Reference = Reference;
2448
2456
  type context$2_RestorationCollection = RestorationCollection;
2457
+ type context$2_RestoreDataCollectionRequest = RestoreDataCollectionRequest;
2458
+ type context$2_RestoreDataCollectionResponse = RestoreDataCollectionResponse;
2449
2459
  type context$2_RestoreDataCollectionsFromSnapshotRequest = RestoreDataCollectionsFromSnapshotRequest;
2450
2460
  type context$2_RestoreDataCollectionsFromSnapshotResponse = RestoreDataCollectionsFromSnapshotResponse;
2451
2461
  type context$2_Role = Role;
@@ -2478,7 +2488,7 @@ declare const context$2_getDataCollection: typeof getDataCollection;
2478
2488
  declare const context$2_listDataCollections: typeof listDataCollections;
2479
2489
  declare const context$2_updateDataCollection: typeof updateDataCollection;
2480
2490
  declare namespace context$2 {
2481
- export { context$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type context$2_AllowedDataPermissions as AllowedDataPermissions, type context$2_ArraySizeRange as ArraySizeRange, type context$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type context$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type context$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type context$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type context$2_Calculator as Calculator, type context$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type context$2_CmsOptions as CmsOptions, type context$2_CollectionCapabilities as CollectionCapabilities, context$2_CollectionOperation as CollectionOperation, context$2_CollectionType as CollectionType, type context$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type context$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type context$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type context$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type context$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type context$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type context$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type context$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type context$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type context$2_DataCollection as DataCollection, type context$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, context$2_DataOperation as DataOperation, type context$2_DataPermissions as DataPermissions, type context$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type context$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type context$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type context$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type context$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type context$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, type context$2_Destination as Destination, context$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type Failure$1 as Failure, type Field$1 as Field, type context$2_FieldCapabilities as FieldCapabilities, type context$2_FieldPlugin as FieldPlugin, type context$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, context$2_FieldPluginType as FieldPluginType, type context$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type context$2_FieldsPattern as FieldsPattern, context$2_Format as Format, type context$2_GetDataCollectionOptions as GetDataCollectionOptions, type context$2_GetDataCollectionRequest as GetDataCollectionRequest, type context$2_GetDataCollectionResponse as GetDataCollectionResponse, type context$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type context$2_IndexField as IndexField, type context$2_IndexLimits as IndexLimits, context$2_IndexStatus as IndexStatus, type context$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type context$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type context$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type context$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$2_MultiReference as MultiReference, type context$2_MultilingualOptions as MultilingualOptions, type context$2_NumberRange as NumberRange, type context$2_ObjectField as ObjectField, Order$1 as Order, type context$2_PageLink as PageLink, type context$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, context$2_PagingMode as PagingMode, type context$2_Permissions as Permissions, type context$2_Plugin as Plugin, type context$2_PluginCmsOptions as PluginCmsOptions, type context$2_PluginOptionsOneOf as PluginOptionsOneOf, context$2_PluginType as PluginType, type context$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, context$2_QueryOperator as QueryOperator, type context$2_Reference as Reference, type context$2_RestorationCollection as RestorationCollection, type context$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, context$2_Role as Role, context$2_Segment as Segment, type context$2_SingleItemPluginOptions as SingleItemPluginOptions, type context$2_SiteSort as SiteSort, type context$2_SnapshotCollection as SnapshotCollection, type context$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type context$2_StringLengthRange as StringLengthRange, context$2_Type as Type, type context$2_TypeMetadata as TypeMetadata, type context$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type context$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type context$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type context$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type context$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type context$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type context$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type context$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type context$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type context$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type context$2__Array as _Array, type context$2__Object as _Object, context$2_createDataCollection as createDataCollection, context$2_deleteDataCollection as deleteDataCollection, context$2_getDataCollection as getDataCollection, context$2_listDataCollections as listDataCollections, context$2_updateDataCollection as updateDataCollection };
2491
+ export { context$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type context$2_AllowedDataPermissions as AllowedDataPermissions, type context$2_ArraySizeRange as ArraySizeRange, type context$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type context$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type context$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type context$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type context$2_Calculator as Calculator, type context$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type context$2_CmsOptions as CmsOptions, type context$2_CollectionCapabilities as CollectionCapabilities, context$2_CollectionOperation as CollectionOperation, context$2_CollectionType as CollectionType, type context$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type context$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type context$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type context$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type context$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type context$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type context$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type context$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type context$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type context$2_DataCollection as DataCollection, type context$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, context$2_DataOperation as DataOperation, type context$2_DataPermissions as DataPermissions, type context$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type context$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type context$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type context$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type context$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type context$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, type context$2_Destination as Destination, context$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type Failure$1 as Failure, type Field$1 as Field, type context$2_FieldCapabilities as FieldCapabilities, type context$2_FieldPlugin as FieldPlugin, type context$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, context$2_FieldPluginType as FieldPluginType, type context$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type context$2_FieldsPattern as FieldsPattern, context$2_Format as Format, type context$2_GetDataCollectionOptions as GetDataCollectionOptions, type context$2_GetDataCollectionRequest as GetDataCollectionRequest, type context$2_GetDataCollectionResponse as GetDataCollectionResponse, type context$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type context$2_IndexField as IndexField, type context$2_IndexLimits as IndexLimits, context$2_IndexStatus as IndexStatus, type context$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type context$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type context$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type context$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$2_MultiReference as MultiReference, type context$2_MultilingualOptions as MultilingualOptions, type context$2_NumberRange as NumberRange, type context$2_ObjectField as ObjectField, Order$1 as Order, type context$2_PageLink as PageLink, type context$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, context$2_PagingMode as PagingMode, type context$2_Permissions as Permissions, type context$2_Plugin as Plugin, type context$2_PluginCmsOptions as PluginCmsOptions, type context$2_PluginOptionsOneOf as PluginOptionsOneOf, context$2_PluginType as PluginType, type context$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, context$2_QueryOperator as QueryOperator, type context$2_Reference as Reference, type context$2_RestorationCollection as RestorationCollection, type context$2_RestoreDataCollectionRequest as RestoreDataCollectionRequest, type context$2_RestoreDataCollectionResponse as RestoreDataCollectionResponse, type context$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, context$2_Role as Role, context$2_Segment as Segment, type context$2_SingleItemPluginOptions as SingleItemPluginOptions, type context$2_SiteSort as SiteSort, type context$2_SnapshotCollection as SnapshotCollection, type context$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type context$2_StringLengthRange as StringLengthRange, context$2_Type as Type, type context$2_TypeMetadata as TypeMetadata, type context$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type context$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type context$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type context$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type context$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type context$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type context$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type context$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type context$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type context$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type context$2__Array as _Array, type context$2__Object as _Object, context$2_createDataCollection as createDataCollection, context$2_deleteDataCollection as deleteDataCollection, context$2_getDataCollection as getDataCollection, context$2_listDataCollections as listDataCollections, context$2_updateDataCollection as updateDataCollection };
2482
2492
  }
2483
2493
 
2484
2494
  interface DataItem {
@@ -1035,12 +1035,12 @@ interface DataCollection {
1035
1035
  /** Collection ID. For example, `my-first-collection`. May include a namespace. */
1036
1036
  _id?: string;
1037
1037
  /**
1038
- * Collection type. Indicates how the collection was created and is stored.
1038
+ * Collection type. Indicates how the collection was created and how it is stored.
1039
1039
  * @readonly
1040
1040
  */
1041
1041
  collectionType?: CollectionType;
1042
1042
  /**
1043
- * ID of the app that defined this collection. For user-defined collections, this value is null.
1043
+ * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
1044
1044
  * @readonly
1045
1045
  */
1046
1046
  ownerAppId?: string | null;
@@ -1054,17 +1054,17 @@ interface DataCollection {
1054
1054
  /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
1055
1055
  displayName?: string | null;
1056
1056
  /**
1057
- * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
1057
+ * Default item sorting order when a query doesn't specify one.
1058
1058
  * @readonly
1059
1059
  */
1060
1060
  defaultDisplayOrder?: Sort;
1061
1061
  /**
1062
1062
  * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
1063
- * Empty for all data collections not owned by internal Wix apps.
1063
+ * Empty for all data collections not owned by Wix apps.
1064
1064
  * @readonly
1065
1065
  */
1066
1066
  displayNamespace?: string | null;
1067
- /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1067
+ /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1068
1068
  displayField?: string | null;
1069
1069
  /**
1070
1070
  * Capabilities the collection supports.
@@ -1076,14 +1076,14 @@ interface DataCollection {
1076
1076
  /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
1077
1077
  permissions?: Permissions;
1078
1078
  /**
1079
- * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
1079
+ * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
1080
1080
  * @readonly
1081
1081
  */
1082
1082
  revision?: string | null;
1083
- /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1083
+ /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1084
1084
  plugins?: Plugin[];
1085
1085
  /**
1086
- * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
1086
+ * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
1087
1087
  * @readonly
1088
1088
  */
1089
1089
  pagingModes?: PagingMode[];
@@ -1123,7 +1123,11 @@ declare enum Direction {
1123
1123
  DESC = "DESC"
1124
1124
  }
1125
1125
  interface CollectionCapabilities {
1126
- /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
1126
+ /**
1127
+ * Data operations the collection supports. The listed operations can be performed on data the collection contains.
1128
+ *
1129
+ * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
1130
+ */
1127
1131
  dataOperations?: DataOperation[];
1128
1132
  /** Collection operations supported. The listed operations can be performed on the collection itself. */
1129
1133
  collectionOperations?: CollectionOperation[];
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
1176
1180
  arraySizeRange?: ArraySizeRange;
1177
1181
  /** Unique identifier for the field. For example, `firstName`. */
1178
1182
  key?: string;
1179
- /** Field's display name when shown in the CMS. For example, `First Name`. */
1183
+ /** Field's display name when displayed in the CMS. For example, `First Name`. */
1180
1184
  displayName?: string | null;
1181
1185
  /** Field's data type. */
1182
1186
  type?: Type;
1183
1187
  /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
1184
1188
  typeMetadata?: TypeMetadata;
1185
1189
  /**
1186
- * Whether the field is a system field (created automatically).
1190
+ * Whether the field is a system field.
1187
1191
  * @readonly
1188
1192
  */
1189
1193
  systemField?: boolean;
@@ -1192,9 +1196,9 @@ interface Field$1 extends FieldRangeValidationsOneOf {
1192
1196
  * @readonly
1193
1197
  */
1194
1198
  capabilities?: FieldCapabilities;
1195
- /** Indicates if field is encrypted. */
1199
+ /** Whether the field is encrypted. */
1196
1200
  encrypted?: boolean;
1197
- /** Description of the field. */
1201
+ /** Field description. */
1198
1202
  description?: string | null;
1199
1203
  plugin?: string | null;
1200
1204
  /**
@@ -1300,11 +1304,7 @@ interface FieldCapabilities {
1300
1304
  * Default: `false`
1301
1305
  */
1302
1306
  sortable?: boolean;
1303
- /**
1304
- * Query operators that can be used for this field.
1305
- *
1306
- * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
1307
- */
1307
+ /** Query operators that can be used for this field. */
1308
1308
  queryOperators?: QueryOperator[];
1309
1309
  }
1310
1310
  declare enum QueryOperator {
@@ -1619,9 +1619,9 @@ interface AllowedDataPermissions {
1619
1619
  itemRemove?: boolean;
1620
1620
  }
1621
1621
  interface DataCollectionClonedEvent {
1622
- /** original instance collection is cloned from */
1622
+ /** Instance ID of the collection from which the data is cloned. */
1623
1623
  originInstanceId?: string;
1624
- /** original collection ID, may be same as current one */
1624
+ /** ID of the collection from which the data is cloned. */
1625
1625
  originId?: string;
1626
1626
  }
1627
1627
  interface DataCollectionChangedEvent {
@@ -1798,6 +1798,14 @@ interface DeleteDataCollectionRequest {
1798
1798
  }
1799
1799
  interface DeleteDataCollectionResponse {
1800
1800
  }
1801
+ interface RestoreDataCollectionRequest {
1802
+ /** Data Collection ID to restore */
1803
+ dataCollectionId?: string;
1804
+ }
1805
+ interface RestoreDataCollectionResponse {
1806
+ /** Restored data collection */
1807
+ dataCollection?: DataCollection;
1808
+ }
1801
1809
  interface CreateDataCollectionFieldRequest {
1802
1810
  /** ID of data collection to update */
1803
1811
  dataCollectionId?: string;
@@ -2332,14 +2340,14 @@ interface UpdateDataCollectionSignature {
2332
2340
  /**
2333
2341
  * Updates a data collection.
2334
2342
  *
2335
- * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
2343
+ * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
2336
2344
  * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
2337
2345
  * Otherwise, the request fails.
2338
2346
  *
2339
- * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
2347
+ * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
2340
2348
  *
2341
2349
  * > **Note:**
2342
- * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
2350
+ * > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
2343
2351
  * > aren't included in the updated collection details, their values are lost.
2344
2352
  * @param - Updated collection details. The existing collection is replaced with this version.
2345
2353
  * @param - Options for updating a data collection.
@@ -2353,7 +2361,7 @@ interface DeleteDataCollectionSignature {
2353
2361
  * Deletes a data collection.
2354
2362
  *
2355
2363
  * > **Note:**
2356
- * > Once a collection is deleted, it can't be restored.
2364
+ * > Once a collection is deleted, it can only be restored for limited amount of time.
2357
2365
  * @param - ID of the collection to delete.
2358
2366
  */
2359
2367
  (dataCollectionId: string): Promise<void>;
@@ -2446,6 +2454,8 @@ type index_d$2_QueryOperator = QueryOperator;
2446
2454
  declare const index_d$2_QueryOperator: typeof QueryOperator;
2447
2455
  type index_d$2_Reference = Reference;
2448
2456
  type index_d$2_RestorationCollection = RestorationCollection;
2457
+ type index_d$2_RestoreDataCollectionRequest = RestoreDataCollectionRequest;
2458
+ type index_d$2_RestoreDataCollectionResponse = RestoreDataCollectionResponse;
2449
2459
  type index_d$2_RestoreDataCollectionsFromSnapshotRequest = RestoreDataCollectionsFromSnapshotRequest;
2450
2460
  type index_d$2_RestoreDataCollectionsFromSnapshotResponse = RestoreDataCollectionsFromSnapshotResponse;
2451
2461
  type index_d$2_Role = Role;
@@ -2478,7 +2488,7 @@ declare const index_d$2_getDataCollection: typeof getDataCollection;
2478
2488
  declare const index_d$2_listDataCollections: typeof listDataCollections;
2479
2489
  declare const index_d$2_updateDataCollection: typeof updateDataCollection;
2480
2490
  declare namespace index_d$2 {
2481
- export { index_d$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type index_d$2_AllowedDataPermissions as AllowedDataPermissions, type index_d$2_ArraySizeRange as ArraySizeRange, type index_d$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type index_d$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type index_d$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type index_d$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type index_d$2_Calculator as Calculator, type index_d$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type index_d$2_CmsOptions as CmsOptions, type index_d$2_CollectionCapabilities as CollectionCapabilities, index_d$2_CollectionOperation as CollectionOperation, index_d$2_CollectionType as CollectionType, type index_d$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type index_d$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type index_d$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type index_d$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type index_d$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type index_d$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type index_d$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type index_d$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type index_d$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type index_d$2_DataCollection as DataCollection, type index_d$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type index_d$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type index_d$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, index_d$2_DataOperation as DataOperation, type index_d$2_DataPermissions as DataPermissions, type index_d$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type index_d$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type index_d$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type index_d$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type index_d$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type index_d$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, type index_d$2_Destination as Destination, index_d$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type Failure$1 as Failure, type Field$1 as Field, type index_d$2_FieldCapabilities as FieldCapabilities, type index_d$2_FieldPlugin as FieldPlugin, type index_d$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, index_d$2_FieldPluginType as FieldPluginType, type index_d$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type index_d$2_FieldsPattern as FieldsPattern, index_d$2_Format as Format, type index_d$2_GetDataCollectionOptions as GetDataCollectionOptions, type index_d$2_GetDataCollectionRequest as GetDataCollectionRequest, type index_d$2_GetDataCollectionResponse as GetDataCollectionResponse, type index_d$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type index_d$2_IndexField as IndexField, type index_d$2_IndexLimits as IndexLimits, index_d$2_IndexStatus as IndexStatus, type index_d$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type index_d$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type index_d$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type index_d$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type index_d$2_MultiReference as MultiReference, type index_d$2_MultilingualOptions as MultilingualOptions, type index_d$2_NumberRange as NumberRange, type index_d$2_ObjectField as ObjectField, Order$1 as Order, type index_d$2_PageLink as PageLink, type index_d$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, index_d$2_PagingMode as PagingMode, type index_d$2_Permissions as Permissions, type index_d$2_Plugin as Plugin, type index_d$2_PluginCmsOptions as PluginCmsOptions, type index_d$2_PluginOptionsOneOf as PluginOptionsOneOf, index_d$2_PluginType as PluginType, type index_d$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, index_d$2_QueryOperator as QueryOperator, type index_d$2_Reference as Reference, type index_d$2_RestorationCollection as RestorationCollection, type index_d$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type index_d$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, index_d$2_Role as Role, index_d$2_Segment as Segment, type index_d$2_SingleItemPluginOptions as SingleItemPluginOptions, type index_d$2_SiteSort as SiteSort, type index_d$2_SnapshotCollection as SnapshotCollection, type index_d$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type index_d$2_StringLengthRange as StringLengthRange, index_d$2_Type as Type, type index_d$2_TypeMetadata as TypeMetadata, type index_d$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type index_d$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type index_d$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type index_d$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type index_d$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type index_d$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type index_d$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type index_d$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type index_d$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type index_d$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type index_d$2__Array as _Array, type index_d$2__Object as _Object, index_d$2_createDataCollection as createDataCollection, index_d$2_deleteDataCollection as deleteDataCollection, index_d$2_getDataCollection as getDataCollection, index_d$2_listDataCollections as listDataCollections, index_d$2_updateDataCollection as updateDataCollection };
2491
+ export { index_d$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type index_d$2_AllowedDataPermissions as AllowedDataPermissions, type index_d$2_ArraySizeRange as ArraySizeRange, type index_d$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type index_d$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type index_d$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type index_d$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type index_d$2_Calculator as Calculator, type index_d$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type index_d$2_CmsOptions as CmsOptions, type index_d$2_CollectionCapabilities as CollectionCapabilities, index_d$2_CollectionOperation as CollectionOperation, index_d$2_CollectionType as CollectionType, type index_d$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type index_d$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type index_d$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type index_d$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type index_d$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type index_d$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type index_d$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type index_d$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type index_d$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type index_d$2_DataCollection as DataCollection, type index_d$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type index_d$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type index_d$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, index_d$2_DataOperation as DataOperation, type index_d$2_DataPermissions as DataPermissions, type index_d$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type index_d$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type index_d$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type index_d$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type index_d$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type index_d$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, type index_d$2_Destination as Destination, index_d$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type Failure$1 as Failure, type Field$1 as Field, type index_d$2_FieldCapabilities as FieldCapabilities, type index_d$2_FieldPlugin as FieldPlugin, type index_d$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, index_d$2_FieldPluginType as FieldPluginType, type index_d$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type index_d$2_FieldsPattern as FieldsPattern, index_d$2_Format as Format, type index_d$2_GetDataCollectionOptions as GetDataCollectionOptions, type index_d$2_GetDataCollectionRequest as GetDataCollectionRequest, type index_d$2_GetDataCollectionResponse as GetDataCollectionResponse, type index_d$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type index_d$2_IndexField as IndexField, type index_d$2_IndexLimits as IndexLimits, index_d$2_IndexStatus as IndexStatus, type index_d$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type index_d$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type index_d$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type index_d$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type index_d$2_MultiReference as MultiReference, type index_d$2_MultilingualOptions as MultilingualOptions, type index_d$2_NumberRange as NumberRange, type index_d$2_ObjectField as ObjectField, Order$1 as Order, type index_d$2_PageLink as PageLink, type index_d$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, index_d$2_PagingMode as PagingMode, type index_d$2_Permissions as Permissions, type index_d$2_Plugin as Plugin, type index_d$2_PluginCmsOptions as PluginCmsOptions, type index_d$2_PluginOptionsOneOf as PluginOptionsOneOf, index_d$2_PluginType as PluginType, type index_d$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, index_d$2_QueryOperator as QueryOperator, type index_d$2_Reference as Reference, type index_d$2_RestorationCollection as RestorationCollection, type index_d$2_RestoreDataCollectionRequest as RestoreDataCollectionRequest, type index_d$2_RestoreDataCollectionResponse as RestoreDataCollectionResponse, type index_d$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type index_d$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, index_d$2_Role as Role, index_d$2_Segment as Segment, type index_d$2_SingleItemPluginOptions as SingleItemPluginOptions, type index_d$2_SiteSort as SiteSort, type index_d$2_SnapshotCollection as SnapshotCollection, type index_d$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type index_d$2_StringLengthRange as StringLengthRange, index_d$2_Type as Type, type index_d$2_TypeMetadata as TypeMetadata, type index_d$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type index_d$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type index_d$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type index_d$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type index_d$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type index_d$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type index_d$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type index_d$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type index_d$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type index_d$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type index_d$2__Array as _Array, type index_d$2__Object as _Object, index_d$2_createDataCollection as createDataCollection, index_d$2_deleteDataCollection as deleteDataCollection, index_d$2_getDataCollection as getDataCollection, index_d$2_listDataCollections as listDataCollections, index_d$2_updateDataCollection as updateDataCollection };
2482
2492
  }
2483
2493
 
2484
2494
  interface DataItem {
@@ -478,12 +478,12 @@ interface DataCollection$1 {
478
478
  /** Collection ID. For example, `my-first-collection`. May include a namespace. */
479
479
  id?: string;
480
480
  /**
481
- * Collection type. Indicates how the collection was created and is stored.
481
+ * Collection type. Indicates how the collection was created and how it is stored.
482
482
  * @readonly
483
483
  */
484
484
  collectionType?: CollectionType$1;
485
485
  /**
486
- * ID of the app that defined this collection. For user-defined collections, this value is null.
486
+ * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
487
487
  * @readonly
488
488
  */
489
489
  ownerAppId?: string | null;
@@ -497,17 +497,17 @@ interface DataCollection$1 {
497
497
  /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
498
498
  displayName?: string | null;
499
499
  /**
500
- * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
500
+ * Default item sorting order when a query doesn't specify one.
501
501
  * @readonly
502
502
  */
503
503
  defaultDisplayOrder?: Sort$1;
504
504
  /**
505
505
  * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
506
- * Empty for all data collections not owned by internal Wix apps.
506
+ * Empty for all data collections not owned by Wix apps.
507
507
  * @readonly
508
508
  */
509
509
  displayNamespace?: string | null;
510
- /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
510
+ /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
511
511
  displayField?: string | null;
512
512
  /**
513
513
  * Capabilities the collection supports.
@@ -519,14 +519,14 @@ interface DataCollection$1 {
519
519
  /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
520
520
  permissions?: Permissions$1;
521
521
  /**
522
- * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
522
+ * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
523
523
  * @readonly
524
524
  */
525
525
  revision?: string | null;
526
- /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
526
+ /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
527
527
  plugins?: Plugin$1[];
528
528
  /**
529
- * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
529
+ * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
530
530
  * @readonly
531
531
  */
532
532
  pagingModes?: PagingMode$1[];
@@ -623,14 +623,14 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
623
623
  arraySizeRange?: ArraySizeRange$1;
624
624
  /** Unique identifier for the field. For example, `firstName`. */
625
625
  key?: string;
626
- /** Field's display name when shown in the CMS. For example, `First Name`. */
626
+ /** Field's display name when displayed in the CMS. For example, `First Name`. */
627
627
  displayName?: string | null;
628
628
  /** Field's data type. */
629
629
  type?: Type$1;
630
630
  /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
631
631
  typeMetadata?: TypeMetadata$1;
632
632
  /**
633
- * Whether the field is a system field (created automatically).
633
+ * Whether the field is a system field.
634
634
  * @readonly
635
635
  */
636
636
  systemField?: boolean;
@@ -639,9 +639,9 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
639
639
  * @readonly
640
640
  */
641
641
  capabilities?: FieldCapabilities$1;
642
- /** Indicates if field is encrypted. */
642
+ /** Whether the field is encrypted. */
643
643
  encrypted?: boolean;
644
- /** Description of the field. */
644
+ /** Field description. */
645
645
  description?: string | null;
646
646
  plugin?: string | null;
647
647
  /**
@@ -1299,12 +1299,12 @@ interface DataCollection {
1299
1299
  /** Collection ID. For example, `my-first-collection`. May include a namespace. */
1300
1300
  _id?: string;
1301
1301
  /**
1302
- * Collection type. Indicates how the collection was created and is stored.
1302
+ * Collection type. Indicates how the collection was created and how it is stored.
1303
1303
  * @readonly
1304
1304
  */
1305
1305
  collectionType?: CollectionType;
1306
1306
  /**
1307
- * ID of the app that defined this collection. For user-defined collections, this value is null.
1307
+ * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
1308
1308
  * @readonly
1309
1309
  */
1310
1310
  ownerAppId?: string | null;
@@ -1318,17 +1318,17 @@ interface DataCollection {
1318
1318
  /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
1319
1319
  displayName?: string | null;
1320
1320
  /**
1321
- * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
1321
+ * Default item sorting order when a query doesn't specify one.
1322
1322
  * @readonly
1323
1323
  */
1324
1324
  defaultDisplayOrder?: Sort;
1325
1325
  /**
1326
1326
  * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
1327
- * Empty for all data collections not owned by internal Wix apps.
1327
+ * Empty for all data collections not owned by Wix apps.
1328
1328
  * @readonly
1329
1329
  */
1330
1330
  displayNamespace?: string | null;
1331
- /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1331
+ /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
1332
1332
  displayField?: string | null;
1333
1333
  /**
1334
1334
  * Capabilities the collection supports.
@@ -1340,14 +1340,14 @@ interface DataCollection {
1340
1340
  /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
1341
1341
  permissions?: Permissions;
1342
1342
  /**
1343
- * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
1343
+ * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
1344
1344
  * @readonly
1345
1345
  */
1346
1346
  revision?: string | null;
1347
- /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1347
+ /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
1348
1348
  plugins?: Plugin[];
1349
1349
  /**
1350
- * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
1350
+ * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
1351
1351
  * @readonly
1352
1352
  */
1353
1353
  pagingModes?: PagingMode[];
@@ -1387,7 +1387,11 @@ declare enum Direction {
1387
1387
  DESC = "DESC"
1388
1388
  }
1389
1389
  interface CollectionCapabilities {
1390
- /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
1390
+ /**
1391
+ * Data operations the collection supports. The listed operations can be performed on data the collection contains.
1392
+ *
1393
+ * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
1394
+ */
1391
1395
  dataOperations?: DataOperation[];
1392
1396
  /** Collection operations supported. The listed operations can be performed on the collection itself. */
1393
1397
  collectionOperations?: CollectionOperation[];
@@ -1440,14 +1444,14 @@ interface Field$2 extends FieldRangeValidationsOneOf {
1440
1444
  arraySizeRange?: ArraySizeRange;
1441
1445
  /** Unique identifier for the field. For example, `firstName`. */
1442
1446
  key?: string;
1443
- /** Field's display name when shown in the CMS. For example, `First Name`. */
1447
+ /** Field's display name when displayed in the CMS. For example, `First Name`. */
1444
1448
  displayName?: string | null;
1445
1449
  /** Field's data type. */
1446
1450
  type?: Type;
1447
1451
  /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
1448
1452
  typeMetadata?: TypeMetadata;
1449
1453
  /**
1450
- * Whether the field is a system field (created automatically).
1454
+ * Whether the field is a system field.
1451
1455
  * @readonly
1452
1456
  */
1453
1457
  systemField?: boolean;
@@ -1456,9 +1460,9 @@ interface Field$2 extends FieldRangeValidationsOneOf {
1456
1460
  * @readonly
1457
1461
  */
1458
1462
  capabilities?: FieldCapabilities;
1459
- /** Indicates if field is encrypted. */
1463
+ /** Whether the field is encrypted. */
1460
1464
  encrypted?: boolean;
1461
- /** Description of the field. */
1465
+ /** Field description. */
1462
1466
  description?: string | null;
1463
1467
  plugin?: string | null;
1464
1468
  /**
@@ -1564,11 +1568,7 @@ interface FieldCapabilities {
1564
1568
  * Default: `false`
1565
1569
  */
1566
1570
  sortable?: boolean;
1567
- /**
1568
- * Query operators that can be used for this field.
1569
- *
1570
- * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
1571
- */
1571
+ /** Query operators that can be used for this field. */
1572
1572
  queryOperators?: QueryOperator[];
1573
1573
  }
1574
1574
  declare enum QueryOperator {