@wix/auto_sdk_data_collections 1.0.11 → 1.0.12

package/build/internal/{cjs/src/data-v2-data-collection-collections.types.d.ts → data-v2-data-collection-collections.universal-DZ3_N2Cv.d.mts}

@@ -1,11 +1,11 @@
 /** A data collection determines the structure of data to be stored in a database. */
-export interface DataCollection {
+interface DataCollection {
     /**
      * Collection ID. For example, `my-first-collection`. May include a namespace.
      * @immutable
      * @maxLength 256
      */
-    id?: string;
+    _id?: string;
     /**
      * Collection type. Indicates how the collection was created and how it is stored.
      * @readonly
@@ -78,14 +78,25 @@ export interface DataCollection {
      * Date the collection was created.
      * @readonly
      */
-    createdDate?: Date | null;
+    _createdDate?: Date | null;
     /**
      * Date the collection was last updated.
      * @readonly
      */
-    updatedDate?: Date | null;
+    _updatedDate?: Date | null;
+    /**
+     * Levels of permission for accessing and modifying data.
+     * @internal
+     */
+    dataPermissions?: DataPermissions;
+    /**
+     * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
+     * @internal
+     * @readonly
+     */
+    allowedDataPermissions?: AllowedDataPermissions;
 }
-export declare enum CollectionType {
+declare enum CollectionType {
     /** User-created collection. */
     NATIVE = "NATIVE",
     /** [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app when it is installed. This type of collection can be modified dynamically by that app (for example, Wix Forms). */
@@ -96,8 +107,8 @@ export declare enum CollectionType {
     EXTERNAL = "EXTERNAL"
 }
 /** @enumType */
-export type CollectionTypeWithLiterals = CollectionType | 'NATIVE' | 'WIX_APP' | 'BLOCKS_APP' | 'EXTERNAL';
-export interface Sort {
+type CollectionTypeWithLiterals = CollectionType | 'NATIVE' | 'WIX_APP' | 'BLOCKS_APP' | 'EXTERNAL';
+interface Sort {
     /**
      * Field to sort by.
      * @maxLength 1000
@@ -110,13 +121,13 @@ export interface Sort {
      */
     direction?: DirectionWithLiterals;
 }
-export declare enum Direction {
+declare enum Direction {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type DirectionWithLiterals = Direction | 'ASC' | 'DESC';
-export interface CollectionCapabilities {
+type DirectionWithLiterals = Direction | 'ASC' | 'DESC';
+interface CollectionCapabilities {
     /**
      * Data operations the collection supports. The listed operations can be performed on data the collection contains.
      *
@@ -131,8 +142,13 @@ export interface CollectionCapabilities {
     collectionOperations?: CollectionOperationWithLiterals[];
     /** Maximum number of indexes for the collection. */
     indexLimits?: IndexLimits;
+    /**
+     * Maximum number of indexes for the collection.
+     * @internal
+     */
+    indexQuotaLimits?: IndexQuotaLimits;
 }
-export declare enum DataOperation {
+declare enum DataOperation {
     AGGREGATE = "AGGREGATE",
     BULK_INSERT = "BULK_INSERT",
     BULK_REMOVE = "BULK_REMOVE",
@@ -156,16 +172,16 @@ export declare enum DataOperation {
     BULK_PATCH = "BULK_PATCH"
 }
 /** @enumType */
-export type DataOperationWithLiterals = DataOperation | 'AGGREGATE' | 'BULK_INSERT' | 'BULK_REMOVE' | 'BULK_SAVE' | 'BULK_UPDATE' | 'COUNT' | 'DISTINCT' | 'FIND' | 'GET' | 'INSERT' | 'INSERT_REFERENCE' | 'IS_REFERENCED' | 'QUERY_REFERENCED' | 'REMOVE' | 'REMOVE_REFERENCE' | 'REPLACE_REFERENCES' | 'SAVE' | 'TRUNCATE' | 'UPDATE' | 'PATCH' | 'BULK_PATCH';
-export declare enum CollectionOperation {
+type DataOperationWithLiterals = DataOperation | 'AGGREGATE' | 'BULK_INSERT' | 'BULK_REMOVE' | 'BULK_SAVE' | 'BULK_UPDATE' | 'COUNT' | 'DISTINCT' | 'FIND' | 'GET' | 'INSERT' | 'INSERT_REFERENCE' | 'IS_REFERENCED' | 'QUERY_REFERENCED' | 'REMOVE' | 'REMOVE_REFERENCE' | 'REPLACE_REFERENCES' | 'SAVE' | 'TRUNCATE' | 'UPDATE' | 'PATCH' | 'BULK_PATCH';
+declare enum CollectionOperation {
     /** Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed. */
     UPDATE = "UPDATE",
     /** Allows deleting the entire collection. If not included, the collection can't be deleted. */
     REMOVE = "REMOVE"
 }
 /** @enumType */
-export type CollectionOperationWithLiterals = CollectionOperation | 'UPDATE' | 'REMOVE';
-export interface IndexLimits {
+type CollectionOperationWithLiterals = CollectionOperation | 'UPDATE' | 'REMOVE';
+interface IndexLimits {
     /** Maximum number of regular (non-unique) indexes allowed for this collection. */
     regular?: number;
     /** Maximum number of unique indexes allowed for this collection. */
@@ -173,7 +189,7 @@ export interface IndexLimits {
     /** Maximum number of regular and unique indexes allowed for this collection. */
     total?: number;
 }
-export interface IndexQuotaLimits {
+interface IndexQuotaLimits {
     /**
      * limit of regular single-field indexes, even if 0 1-field indices may be created using
      * 3-field quota (if available)
@@ -186,7 +202,7 @@ export interface IndexQuotaLimits {
     /** Maximum number of regular and unique indexes allowed for this collection. */
     total?: number;
 }
-export interface Field extends FieldRangeValidationsOneOf {
+interface Field extends FieldRangeValidationsOneOf {
     /** Range of possible values for a numerical field. */
     numberRange?: NumberRange;
     /** Length range permitted for a text field. Relevant for fields that hold strings, such as those of type `TEXT` or `RICH_TEXT`. */
@@ -253,7 +269,7 @@ export interface Field extends FieldRangeValidationsOneOf {
     plugins?: FieldPlugin[];
 }
 /** @oneof */
-export interface FieldRangeValidationsOneOf {
+interface FieldRangeValidationsOneOf {
     /** Range of possible values for a numerical field. */
     numberRange?: NumberRange;
     /** Length range permitted for a text field. Relevant for fields that hold strings, such as those of type `TEXT` or `RICH_TEXT`. */
@@ -261,7 +277,7 @@ export interface FieldRangeValidationsOneOf {
     /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */
     arraySizeRange?: ArraySizeRange;
 }
-export declare enum Type {
+declare enum Type {
     UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
     /** Plain-text string. */
     TEXT = "TEXT",
@@ -327,8 +343,8 @@ export declare enum Type {
     LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
 }
 /** @enumType */
-export type TypeWithLiterals = Type | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
-export interface TypeMetadata extends TypeMetadataMetadataOneOf {
+type TypeWithLiterals = Type | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
+interface TypeMetadata extends TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
     /** Metadata for a multi-reference field. */
@@ -341,7 +357,7 @@ export interface TypeMetadata extends TypeMetadataMetadataOneOf {
     pageLink?: PageLink;
 }
 /** @oneof */
-export interface TypeMetadataMetadataOneOf {
+interface TypeMetadataMetadataOneOf {
     /** Metadata for a reference field. */
     reference?: Reference;
     /** Metadata for a multi-reference field. */
@@ -353,7 +369,7 @@ export interface TypeMetadataMetadataOneOf {
     /** Metadata for a page link field. */
     pageLink?: PageLink;
 }
-export interface FieldCapabilities {
+interface FieldCapabilities {
     /**
      * Whether the collection can be sorted by this field.
      *
@@ -366,7 +382,7 @@ export interface FieldCapabilities {
      */
     queryOperators?: QueryOperatorWithLiterals[];
 }
-export declare enum QueryOperator {
+declare enum QueryOperator {
     EQ = "EQ",
     LT = "LT",
     GT = "GT",
@@ -382,8 +398,8 @@ export declare enum QueryOperator {
     URLIZED = "URLIZED"
 }
 /** @enumType */
-export type QueryOperatorWithLiterals = QueryOperator | 'EQ' | 'LT' | 'GT' | 'NE' | 'LTE' | 'GTE' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'HAS_SOME' | 'HAS_ALL' | 'EXISTS' | 'URLIZED';
-export interface ObjectField {
+type QueryOperatorWithLiterals = QueryOperator | 'EQ' | 'LT' | 'GT' | 'NE' | 'LTE' | 'GTE' | 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'HAS_SOME' | 'HAS_ALL' | 'EXISTS' | 'URLIZED';
+interface ObjectField {
     /**
      * Field ID.
      * @maxLength 1000
@@ -408,36 +424,36 @@ export interface ObjectField {
      */
     capabilities?: FieldCapabilities;
 }
-export interface FieldsPattern {
+interface FieldsPattern {
     /** @maxLength 1000 */
     pattern?: string;
     lowercase?: boolean;
 }
-export interface UrlizedOnlyPattern {
+interface UrlizedOnlyPattern {
     /** @maxLength 1000 */
     pattern?: string;
 }
-export interface Calculator extends CalculatorPatternOneOf {
+interface Calculator extends CalculatorPatternOneOf {
     /** Value is calculated according to pattern, whitespaces are replaced with dash [-]. */
     fieldsPattern?: FieldsPattern;
     /** Value is only URL encoded. */
     urlizedOnlyPattern?: UrlizedOnlyPattern;
 }
 /** @oneof */
-export interface CalculatorPatternOneOf {
+interface CalculatorPatternOneOf {
     /** Value is calculated according to pattern, whitespaces are replaced with dash [-]. */
     fieldsPattern?: FieldsPattern;
     /** Value is only URL encoded. */
     urlizedOnlyPattern?: UrlizedOnlyPattern;
 }
-export interface Reference {
+interface Reference {
     /**
      * Referenced collection ID.
      * @maxLength 256
      */
     referencedCollectionId?: string;
 }
-export interface MultiReference {
+interface MultiReference {
     /**
      * Referenced collection ID.
      * @maxLength 256
@@ -454,20 +470,20 @@ export interface MultiReference {
      */
     referencingDisplayName?: string;
 }
-export interface _Object {
+interface _Object {
     /**
      * Fields within the object.
      * @maxSize 1000
      */
     fields?: ObjectField[];
 }
-export interface _Array {
+interface _Array {
     /** Element's data type. */
     elementType?: TypeWithLiterals;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata;
 }
-export interface PageLink {
+interface PageLink {
     calculator?: Calculator;
     /**
      * Defines reference to router pattern in the site document.
@@ -475,7 +491,7 @@ export interface PageLink {
      */
     linkedRouterPage?: string | null;
 }
-export interface NumberRange {
+interface NumberRange {
     /**
      * Minimum permitted value for a numerical field.
      *
@@ -489,7 +505,7 @@ export interface NumberRange {
      */
     max?: number | null;
 }
-export interface StringLengthRange {
+interface StringLengthRange {
     /**
      * Minimum permitted length for a text field.
      *
@@ -503,7 +519,7 @@ export interface StringLengthRange {
      */
     maxLength?: number | null;
 }
-export interface ArraySizeRange {
+interface ArraySizeRange {
     /**
      * Minimum permitted number of items in an array field. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`.
      *
@@ -518,26 +534,26 @@ export interface ArraySizeRange {
     maxSize?: number | null;
 }
 /** Optional plug-in aspects for fields */
-export interface FieldPlugin extends FieldPluginOptionsOneOf {
+interface FieldPlugin extends FieldPluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: CmsOptions;
     type?: FieldPluginTypeWithLiterals;
 }
 /** @oneof */
-export interface FieldPluginOptionsOneOf {
+interface FieldPluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: CmsOptions;
 }
-export declare enum FieldPluginType {
+declare enum FieldPluginType {
     /** Uknown plugin type. */
     UNKNOWN = "UNKNOWN",
     /** CMS-related field attributes */
     CMS = "CMS"
 }
 /** @enumType */
-export type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
+type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
 /** Options for the CMS plugin. */
-export interface CmsOptions {
+interface CmsOptions {
     /**
      * Indicates an internal CMS field. The CMS does not display internal fields.
      *
@@ -546,7 +562,7 @@ export interface CmsOptions {
     internal?: boolean;
 }
 /** Permissions defined by the lowest role needed to perform each action. */
-export interface Permissions {
+interface Permissions {
     /** Lowest role needed to add a collection. */
     insert?: RoleWithLiterals;
     /** Lowest role needed to update a collection. */
@@ -556,7 +572,7 @@ export interface Permissions {
     /** Lowest role needed to read a collection. */
     read?: RoleWithLiterals;
 }
-export declare enum Role {
+declare enum Role {
     /** Unknown role. */
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
     /** Site administrator. */
@@ -569,8 +585,8 @@ export declare enum Role {
     ANYONE = "ANYONE"
 }
 /** @enumType */
-export type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'ADMIN' | 'SITE_MEMBER_AUTHOR' | 'SITE_MEMBER' | 'ANYONE';
-export interface Plugin extends PluginOptionsOneOf {
+type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'ADMIN' | 'SITE_MEMBER_AUTHOR' | 'SITE_MEMBER' | 'ANYONE';
+interface Plugin extends PluginOptionsOneOf {
     /**
      * Options for the Publish plugin.
      * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
@@ -590,7 +606,7 @@ export interface Plugin extends PluginOptionsOneOf {
     type?: PluginTypeWithLiterals;
 }
 /** @oneof */
-export interface PluginOptionsOneOf {
+interface PluginOptionsOneOf {
     /**
      * Options for the Publish plugin.
      * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
@@ -607,14 +623,14 @@ export interface PluginOptionsOneOf {
     /** Options for the CMS plugin. */
     cmsOptions?: PluginCmsOptions;
 }
-export declare enum Status {
+declare enum Status {
     UNKNOWN_PUBLISH_PLUGIN_STATUS = "UNKNOWN_PUBLISH_PLUGIN_STATUS",
     PUBLISHED = "PUBLISHED",
     DRAFT = "DRAFT"
 }
 /** @enumType */
-export type StatusWithLiterals = Status | 'UNKNOWN_PUBLISH_PLUGIN_STATUS' | 'PUBLISHED' | 'DRAFT';
-export declare enum Format {
+type StatusWithLiterals = Status | 'UNKNOWN_PUBLISH_PLUGIN_STATUS' | 'PUBLISHED' | 'DRAFT';
+declare enum Format {
     UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
     /** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
     ORIGINAL = "ORIGINAL",
@@ -622,16 +638,16 @@ export declare enum Format {
     PLAIN = "PLAIN"
 }
 /** @enumType */
-export type FormatWithLiterals = Format | 'UNKNOWN_URLIZED_PLUGIN_FORMAT' | 'ORIGINAL' | 'PLAIN';
+type FormatWithLiterals = Format | 'UNKNOWN_URLIZED_PLUGIN_FORMAT' | 'ORIGINAL' | 'PLAIN';
 /** if CMS-defined sort is enabled and should be used in site */
-export interface SiteSort {
+interface SiteSort {
     /**
      * Field and order for the site sort.
      * @maxSize 100
      */
     sort?: Sort[];
 }
-export declare enum PluginType {
+declare enum PluginType {
     /** Unknown plugin type. */
     UNKNOWN_PLUGIN_TYPE = "UNKNOWN_PLUGIN_TYPE",
     /** Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors. */
@@ -652,23 +668,23 @@ export declare enum PluginType {
     CMS = "CMS"
 }
 /** @enumType */
-export type PluginTypeWithLiterals = PluginType | 'UNKNOWN_PLUGIN_TYPE' | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
-export interface PublishPluginOptions {
+type PluginTypeWithLiterals = PluginType | 'UNKNOWN_PLUGIN_TYPE' | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
+interface PublishPluginOptions {
     /** Default status. */
     defaultStatus?: StatusWithLiterals;
 }
-export interface SingleItemPluginOptions {
+interface SingleItemPluginOptions {
     /**
      * ID of the single item in this collection. If you insert or update an item, its ID value is always changed to this.
      * @maxLength 16000
      */
     singleItemId?: string;
 }
-export interface UrlizedPluginOptions {
+interface UrlizedPluginOptions {
     /** Encoding method for generating a URL in ASCII characters. */
     format?: FormatWithLiterals;
 }
-export interface MultilingualOptions {
+interface MultilingualOptions {
     /**
      * IDs of fields to allow translation.
      * @maxSize 1000
@@ -676,24 +692,24 @@ export interface MultilingualOptions {
      */
     translatableFieldKeys?: string[];
 }
-export interface PageLinkPluginOptions {
+interface PageLinkPluginOptions {
     isPersisted?: boolean;
     isMutable?: boolean;
 }
-export interface PluginCmsOptions {
+interface PluginCmsOptions {
     /** CMS sort, applied when a collection is displayed on a site. */
     siteSort?: SiteSort;
 }
-export declare enum PagingMode {
+declare enum PagingMode {
     /** Offset-based paging. */
     OFFSET = "OFFSET",
     /** Cursor-based paging. */
     CURSOR = "CURSOR"
 }
 /** @enumType */
-export type PagingModeWithLiterals = PagingMode | 'OFFSET' | 'CURSOR';
+type PagingModeWithLiterals = PagingMode | 'OFFSET' | 'CURSOR';
 /** Data permissions defined by access level for each action. */
-export interface DataPermissions {
+interface DataPermissions {
     /** Access level for data items read */
     itemRead?: AccessLevelWithLiterals;
     /** Access level for data items insert */
@@ -707,7 +723,7 @@ export interface DataPermissions {
  * Describes who can perform certain action.
  * Each level includes all levels below it (except UNDEFINED).
  */
-export declare enum AccessLevel {
+declare enum AccessLevel {
     /** Not set. */
     UNDEFINED = "UNDEFINED",
     /** Any subject, including visitors. */
@@ -722,8 +738,8 @@ export declare enum AccessLevel {
     PRIVILEGED = "PRIVILEGED"
 }
 /** @enumType */
-export type AccessLevelWithLiterals = AccessLevel | 'UNDEFINED' | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
-export interface AllowedDataPermissions {
+type AccessLevelWithLiterals = AccessLevel | 'UNDEFINED' | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
+interface AllowedDataPermissions {
     /** If data items read permitted */
     itemRead?: boolean;
     /** If for data items insert permitted */
@@ -733,7 +749,7 @@ export interface AllowedDataPermissions {
     /** If data items removal permitted */
     itemRemove?: boolean;
 }
-export interface DataCollectionClonedEvent {
+interface DataCollectionClonedEvent {
     /**
      * Instance ID of the collection from which the data is cloned.
      * @format GUID
@@ -745,7 +761,7 @@ export interface DataCollectionClonedEvent {
      */
     originId?: string;
 }
-export interface DataCollectionChangedEvent {
+interface DataCollectionChangedEvent {
     /**
      * list of new fields
      * @maxSize 1000
@@ -777,35 +793,35 @@ export interface DataCollectionChangedEvent {
      */
     pluginsRemoved?: Plugin[];
 }
-export interface FieldUpdate {
+interface FieldUpdate {
     /** previous state of the field */
     previous?: Field;
     /** current state of the field */
     current?: Field;
 }
-export interface PluginUpdate {
+interface PluginUpdate {
     /** previous state of the plugin */
     previous?: Plugin;
     /** current state of the plugin */
     current?: Plugin;
 }
-export interface DataCollectionEvictedEvent {
+interface DataCollectionEvictedEvent {
     /**
      * ID of the collection that was permanently deleted.
      * @minLength 1
      * @maxLength 1000
      */
-    id?: string;
+    _id?: string;
 }
-export interface CreateDataCollectionRequest {
+interface CreateDataCollectionRequest {
     /** Collection details. */
     collection: DataCollection;
 }
-export interface CreateDataCollectionResponse {
+interface CreateDataCollectionResponse {
     /** Details of collection created. */
     collection?: DataCollection;
 }
-export interface GetDataCollectionRequest {
+interface GetDataCollectionRequest {
     /**
      * ID of the collection to retrieve.
      * @maxLength 256
@@ -819,6 +835,11 @@ export interface GetDataCollectionRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -827,14 +848,12 @@ export interface GetDataCollectionRequest {
      */
     fields?: string[];
 }
-export declare enum Segment {
+declare enum Segment {
     UNKNOWN_SEGMENT = "UNKNOWN_SEGMENT",
     PUBLIC = "PUBLIC",
     DEV = "DEV"
 }
-/** @enumType */
-export type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
-export interface GetDataCollectionResponse {
+interface GetDataCollectionResponse {
     /** Details of the collection requested. */
     collection?: DataCollection;
     /**
@@ -843,7 +862,7 @@ export interface GetDataCollectionResponse {
      */
     referencedCollections?: DataCollection[];
 }
-export interface ListDataCollectionsRequest {
+interface ListDataCollectionsRequest {
     /**
      * Defines how collections in the response are sorted.
      *
@@ -860,6 +879,11 @@ export interface ListDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -868,7 +892,7 @@ export interface ListDataCollectionsRequest {
      */
     fields?: string[];
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 1000
@@ -877,25 +901,25 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface Paging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface ListDataCollectionsResponse {
+interface ListDataCollectionsResponse {
     /** List of collections. */
     collections?: DataCollection[];
     /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -905,7 +929,7 @@ export interface PagingMetadataV2 {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
-export interface BulkGetDataCollectionsRequest {
+interface BulkGetDataCollectionsRequest {
     /**
      * IDs of the collections to retrieve.
      * @minSize 1
@@ -935,6 +959,11 @@ export interface BulkGetDataCollectionsRequest {
      * Default: `false`
      */
     consistentRead?: boolean;
+    /**
+     * If set allowed for caller data permissions would be included in the response
+     * @internal
+     */
+    includeAllowedDataPermissions?: boolean;
     /**
      * List of specific field names to return, if empty all fields are returned.
      * Affects all returned collections
@@ -943,7 +972,7 @@ export interface BulkGetDataCollectionsRequest {
      */
     fields?: string[];
 }
-export interface BulkGetDataCollectionsResponse {
+interface BulkGetDataCollectionsResponse {
     /**
      * List of requested collections.
      * When `include_referenced_collections` is `true` in the request, referenced collections are included here.
@@ -952,35 +981,35 @@ export interface BulkGetDataCollectionsResponse {
     /** List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request. */
     deletedCollections?: DataCollection[];
 }
-export interface UpdateDataCollectionRequest {
+interface UpdateDataCollectionRequest {
     /** Updated collection details. The existing collection is replaced with this version. */
     collection: DataCollection;
 }
-export interface UpdateDataCollectionResponse {
+interface UpdateDataCollectionResponse {
     /** Updated collection details. */
     collection?: DataCollection;
 }
-export interface DeleteDataCollectionRequest {
+interface DeleteDataCollectionRequest {
     /**
      * ID of the collection to delete.
      * @maxLength 256
      */
     dataCollectionId: string;
 }
-export interface DeleteDataCollectionResponse {
+interface DeleteDataCollectionResponse {
 }
-export interface RestoreDataCollectionRequest {
+interface RestoreDataCollectionRequest {
     /**
      * Data Collection ID to restore
      * @maxLength 256
      */
     dataCollectionId?: string;
 }
-export interface RestoreDataCollectionResponse {
+interface RestoreDataCollectionResponse {
     /** Restored data collection */
     dataCollection?: DataCollection;
 }
-export interface CreateDataCollectionFieldRequest {
+interface CreateDataCollectionFieldRequest {
     /**
      * ID of data collection to update
      * @maxLength 256
@@ -989,11 +1018,11 @@ export interface CreateDataCollectionFieldRequest {
     /** field to create */
     field: Field;
 }
-export interface CreateDataCollectionFieldResponse {
+interface CreateDataCollectionFieldResponse {
     /** updated data collection */
     dataCollection?: DataCollection;
 }
-export interface UpdateDataCollectionFieldRequest {
+interface UpdateDataCollectionFieldRequest {
     /**
      * ID of data collection to update
      * @maxLength 256
@@ -1002,11 +1031,11 @@ export interface UpdateDataCollectionFieldRequest {
     /** Field to update */
     field: Field;
 }
-export interface UpdateDataCollectionFieldResponse {
+interface UpdateDataCollectionFieldResponse {
     /** updated data collection */
     dataCollection?: DataCollection;
 }
-export interface DeleteDataCollectionFieldRequest {
+interface DeleteDataCollectionFieldRequest {
     /**
      * ID of data collection to update
      * @maxLength 256
@@ -1018,11 +1047,11 @@ export interface DeleteDataCollectionFieldRequest {
      */
     fieldKey: string;
 }
-export interface DeleteDataCollectionFieldResponse {
+interface DeleteDataCollectionFieldResponse {
     /** updated data collection */
     dataCollection?: DataCollection;
 }
-export interface UpdateDataPermissionsRequest {
+interface UpdateDataPermissionsRequest {
     /**
      * ID of data collections to update
      * @maxLength 256
@@ -1031,11 +1060,11 @@ export interface UpdateDataPermissionsRequest {
     /** Data permissions to set */
     dataPermissions?: DataPermissions;
 }
-export interface UpdateDataPermissionsResponse {
+interface UpdateDataPermissionsResponse {
     /** Updated data collection */
     dataCollection?: DataCollection;
 }
-export interface BulkGetDataCollectionsPageBySnapshotsRequest {
+interface BulkGetDataCollectionsPageBySnapshotsRequest {
     /**
      * Ids of schema snapshot
      * @format GUID
@@ -1046,13 +1075,13 @@ export interface BulkGetDataCollectionsPageBySnapshotsRequest {
     /** Pagination information. */
     paging?: Paging;
 }
-export interface BulkGetDataCollectionsPageBySnapshotsResponse {
+interface BulkGetDataCollectionsPageBySnapshotsResponse {
     /** List of snapshot collection map */
     snapshotCollections?: SnapshotCollection[];
     /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface SnapshotCollection {
+interface SnapshotCollection {
     /**
      * snapshot to which collection belongs
      * @format GUID
@@ -1067,7 +1096,7 @@ export interface SnapshotCollection {
     indexes?: Index[];
 }
 /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
-export interface Index {
+interface Index {
     /**
      * Name of the index.
      * @minLength 1
@@ -1112,13 +1141,13 @@ export interface Index {
  * Order determines how values are ordered in the index. This is important when
  * ordering and/or range querying by indexed fields.
  */
-export declare enum Order {
+declare enum Order {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type OrderWithLiterals = Order | 'ASC' | 'DESC';
-export interface IndexField {
+type OrderWithLiterals = Order | 'ASC' | 'DESC';
+interface IndexField {
     /**
      * Path of the field to index. For example: `title` or `options.price`.
      * @minLength 1
@@ -1132,7 +1161,7 @@ export interface IndexField {
      */
     order?: OrderWithLiterals;
 }
-export declare enum IndexStatus {
+declare enum IndexStatus {
     /** Place holder. Never returned by the service. */
     UNKNOWN = "UNKNOWN",
     /** Index creation is in progress. */
@@ -1149,8 +1178,8 @@ export declare enum IndexStatus {
     INVALID = "INVALID"
 }
 /** @enumType */
-export type IndexStatusWithLiterals = IndexStatus | 'UNKNOWN' | 'BUILDING' | 'ACTIVE' | 'DROPPING' | 'DROPPED' | 'FAILED' | 'INVALID';
-export interface Failure {
+type IndexStatusWithLiterals = IndexStatus | 'UNKNOWN' | 'BUILDING' | 'ACTIVE' | 'DROPPING' | 'DROPPED' | 'FAILED' | 'INVALID';
+interface Failure {
     /**
      * Error code.
      * - `WDE0112`: Unknown error while building collection index.
@@ -1171,7 +1200,7 @@ export interface Failure {
      */
     itemId?: string | null;
 }
-export declare enum IndexSource {
+declare enum IndexSource {
     /** Place holder. Never returned by the service. */
     UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
     /** Index is created by the system, present for all collections. */
@@ -1182,10 +1211,10 @@ export declare enum IndexSource {
     AUTO = "AUTO"
 }
 /** @enumType */
-export type IndexSourceWithLiterals = IndexSource | 'UNKNOWN_INDEX_SOURCE' | 'SYSTEM' | 'USER' | 'AUTO';
-export interface CreateDataCollectionsSnapshotRequest {
+type IndexSourceWithLiterals = IndexSource | 'UNKNOWN_INDEX_SOURCE' | 'SYSTEM' | 'USER' | 'AUTO';
+interface CreateDataCollectionsSnapshotRequest {
 }
-export interface CreateDataCollectionsSnapshotResponse {
+interface CreateDataCollectionsSnapshotResponse {
     /**
      * created snapshot ID
      * @format GUID
@@ -1194,7 +1223,7 @@ export interface CreateDataCollectionsSnapshotResponse {
     /** data collections in snapshot */
     snapshotCollections?: DataCollection[];
 }
-export interface RestoreDataCollectionsFromSnapshotRequest {
+interface RestoreDataCollectionsFromSnapshotRequest {
     /**
      * snapshot ID to restore
      * @format GUID
@@ -1215,7 +1244,7 @@ export interface RestoreDataCollectionsFromSnapshotRequest {
      */
     restorationCollections?: RestorationCollection[];
 }
-export interface Destination {
+interface Destination {
     /**
      * Collection id.
      * @minLength 1
@@ -1228,7 +1257,7 @@ export interface Destination {
      */
     displayName?: string | null;
 }
-export interface RestorationCollection {
+interface RestorationCollection {
     /**
      * Collection ID to restore
      * @minLength 1
@@ -1241,20 +1270,20 @@ export interface RestorationCollection {
      */
     destination?: Destination;
 }
-export interface RestoreDataCollectionsFromSnapshotResponse {
+interface RestoreDataCollectionsFromSnapshotResponse {
     /** restored collections */
     restoredCollections?: DataCollection[];
 }
-export interface DeleteDataCollectionsSnapshotRequest {
+interface DeleteDataCollectionsSnapshotRequest {
     /**
      * snapshot ID to delete
      * @format GUID
      */
     snapshotId?: string;
 }
-export interface DeleteDataCollectionsSnapshotResponse {
+interface DeleteDataCollectionsSnapshotResponse {
 }
-export interface CreateMigratedCollectionsSnapshotRequest {
+interface CreateMigratedCollectionsSnapshotRequest {
     /** @format GUID */
     existingSnapshotId?: string;
     /** @maxLength 255 */
@@ -1262,17 +1291,17 @@ export interface CreateMigratedCollectionsSnapshotRequest {
     /** @maxLength 255 */
     existingNamespace?: string;
 }
-export interface CreateMigratedCollectionsSnapshotResponse {
+interface CreateMigratedCollectionsSnapshotResponse {
     /** @format GUID */
     snapshotId?: string;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
+    _id?: string;
     /**
      * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
      * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -1301,36 +1330,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -1346,7 +1373,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -1371,7 +1398,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -1393,7 +1420,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -1401,4 +1428,63 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface GetDataCollectionOptions {
+    /**
+     * Whether to retrieve data from the primary database instance.
+     * This decreases performance but ensures data retrieved is up to date even immediately after an update.
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * List of specific field names to return, if empty all fields are returned.
+     * Affects all returned collections
+     * @maxSize 100
+     * @maxLength 1000
+     */
+    fields?: string[];
+}
+interface ListDataCollectionsOptions {
+    /**
+     * Defines how collections in the response are sorted.
+     *
+     * Default: Ordered by ID in ascending order.
+     */
+    sort?: Sorting;
+    /** Pagination information. */
+    paging?: Paging;
+    /**
+     * Whether to retrieve data from the primary database instance.
+     * This decreases performance but ensures data retrieved is up to date even immediately after an update.
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * List of specific field names to return, if empty all fields are returned.
+     * Affects all returned collections
+     * @maxSize 100
+     * @maxLength 128
+     */
+    fields?: string[];
+}
+interface CreateDataCollectionFieldOptions {
+    /** field to create */
+    field: Field;
+}
+interface UpdateDataCollectionFieldOptions {
+    /** Field to update */
+    field: Field;
+}
+interface DeleteDataCollectionFieldOptions {
+    /**
+     * Field ID to delete
+     * @maxLength 1000
+     */
+    fieldKey: string;
+}
+
+export { type FieldPluginOptionsOneOf as $, AccessLevel as A, type UrlizedOnlyPattern as B, type CreateDataCollectionFieldOptions as C, type DataCollection as D, type Calculator as E, FieldPluginType as F, type GetDataCollectionOptions as G, type CalculatorPatternOneOf as H, IndexStatus as I, type Reference as J, type _Array as K, type ListDataCollectionsOptions as L, type MultiReference as M, type PageLink as N, Order as O, PluginType as P, QueryOperator as Q, type RestoreDataCollectionResponse as R, Status as S, Type as T, type UpdateDataCollectionFieldOptions as U, type NumberRange as V, WebhookIdentityType as W, type StringLengthRange as X, type ArraySizeRange as Y, type FieldPlugin as Z, type _Object as _, type ListDataCollectionsResponse as a, type IdentificationDataIdOneOf as a$, type CmsOptions as a0, type Permissions as a1, type Plugin as a2, type PluginOptionsOneOf as a3, type SiteSort as a4, type PublishPluginOptions as a5, type SingleItemPluginOptions as a6, type UrlizedPluginOptions as a7, type MultilingualOptions as a8, type PageLinkPluginOptions as a9, type UpdateDataPermissionsRequest as aA, type UpdateDataPermissionsResponse as aB, type BulkGetDataCollectionsPageBySnapshotsRequest as aC, type BulkGetDataCollectionsPageBySnapshotsResponse as aD, type SnapshotCollection as aE, type Index as aF, type IndexField as aG, type Failure as aH, type CreateDataCollectionsSnapshotRequest as aI, type CreateDataCollectionsSnapshotResponse as aJ, type RestoreDataCollectionsFromSnapshotRequest as aK, type Destination as aL, type RestorationCollection as aM, type RestoreDataCollectionsFromSnapshotResponse as aN, type DeleteDataCollectionsSnapshotRequest as aO, type DeleteDataCollectionsSnapshotResponse as aP, type CreateMigratedCollectionsSnapshotRequest as aQ, type CreateMigratedCollectionsSnapshotResponse as aR, type DomainEvent as aS, type DomainEventBodyOneOf as aT, type EntityCreatedEvent as aU, type RestoreInfo as aV, type EntityUpdatedEvent as aW, type EntityDeletedEvent as aX, type ActionEvent as aY, type MessageEnvelope as aZ, type IdentificationData as a_, type PluginCmsOptions as aa, type DataPermissions as ab, type AllowedDataPermissions as ac, type DataCollectionClonedEvent as ad, type DataCollectionChangedEvent as ae, type FieldUpdate as af, type PluginUpdate as ag, type DataCollectionEvictedEvent as ah, type CreateDataCollectionRequest as ai, type CreateDataCollectionResponse as aj, type GetDataCollectionRequest as ak, type GetDataCollectionResponse as al, type ListDataCollectionsRequest as am, type Sorting as an, type Paging as ao, type PagingMetadataV2 as ap, type BulkGetDataCollectionsRequest as aq, type BulkGetDataCollectionsResponse as ar, type UpdateDataCollectionRequest as as, type UpdateDataCollectionResponse as at, type DeleteDataCollectionRequest as au, type DeleteDataCollectionResponse as av, type RestoreDataCollectionRequest as aw, type CreateDataCollectionFieldRequest as ax, type UpdateDataCollectionFieldRequest as ay, type DeleteDataCollectionFieldRequest as az, type CreateDataCollectionFieldResponse as b, type UpdateDataCollectionFieldResponse as c, type DeleteDataCollectionFieldOptions as d, type DeleteDataCollectionFieldResponse as e, CollectionType as f, Direction as g, DataOperation as h, CollectionOperation as i, Role as j, Format as k, PagingMode as l, Segment as m, SortOrder as n, IndexSource as o, type Sort as p, type CollectionCapabilities as q, type IndexLimits as r, type IndexQuotaLimits as s, type Field as t, type FieldRangeValidationsOneOf as u, type TypeMetadata as v, type TypeMetadataMetadataOneOf as w, type FieldCapabilities as x, type ObjectField as y, type FieldsPattern as z };