@wix/data 1.0.115 → 1.0.116

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,2840 @@
+/** An external database connection defines a connection between an external database and a Wix site or project. */
+interface ExternalDatabaseConnection {
+    /**
+     * Name of the external database connection.
+     * An external database connection may connect to one or more external data collections or tables.
+     * These are represented as `connectionName/dataCollectionId`.
+     */
+    name?: string;
+    /** Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`. */
+    endpoint?: string | null;
+    /**
+     * Settings passed to the external database connection as part of each request.
+     * These settings can relate to authentication, tenancy, or provide any other information needed for processing a request.
+     * Their content and structure depend on the specific requirements of the external database's API.
+     */
+    configuration?: Record<string, any> | null;
+    /**
+     * Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
+     * @readonly
+     */
+    connectionStatus?: ConnectionStatus;
+    /**
+     * The external database's capabilities.
+     * @readonly
+     */
+    capabilities?: Capabilities;
+}
+declare enum CauseOfFailure {
+    /** No connection failure. */
+    NONE = "NONE",
+    /** General communication failure. */
+    COMMUNICATION_FAILURE = "COMMUNICATION_FAILURE",
+    /** External database host is unreachable. */
+    DESTINATION_HOST_UNREACHABLE = "DESTINATION_HOST_UNREACHABLE",
+    /** Unauthorized to access the external database. */
+    UNAUTHORIZED = "UNAUTHORIZED",
+    /** `endpoint` is not set. */
+    DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
+}
+declare enum CollectionsFound {
+    UNKNOWN = "UNKNOWN",
+    YES = "YES",
+    NO = "NO"
+}
+declare enum FieldType {
+    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
+    TEXT = "TEXT",
+    NUMBER = "NUMBER",
+    DATE = "DATE",
+    DATETIME = "DATETIME",
+    IMAGE = "IMAGE",
+    BOOLEAN = "BOOLEAN",
+    DOCUMENT = "DOCUMENT",
+    URL = "URL",
+    RICH_TEXT = "RICH_TEXT",
+    VIDEO = "VIDEO",
+    ANY = "ANY",
+    ARRAY_STRING = "ARRAY_STRING",
+    ARRAY_DOCUMENT = "ARRAY_DOCUMENT",
+    AUDIO = "AUDIO",
+    TIME = "TIME",
+    LANGUAGE = "LANGUAGE",
+    RICH_CONTENT = "RICH_CONTENT",
+    MEDIA_GALLERY = "MEDIA_GALLERY",
+    ADDRESS = "ADDRESS",
+    PAGE_LINK = "PAGE_LINK",
+    REFERENCE = "REFERENCE",
+    MULTI_REFERENCE = "MULTI_REFERENCE",
+    OBJECT = "OBJECT",
+    ARRAY = "ARRAY",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_TIME = "LEGACY_TIME",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BOOK = "LEGACY_BOOK",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_URL = "LEGACY_EXTERNAL_URL",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BROKEN_REFERENCE = "LEGACY_BROKEN_REFERENCE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_IMAGE = "LEGACY_IMAGE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_COLOR = "LEGACY_COLOR",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
+}
+interface ConnectionStatus {
+    /** Whether the connection was established successfully. */
+    successful?: boolean;
+    /**
+     * If and why a connection attempt failed.
+     * + `NONE`: No connection failure.
+     * + `COMMUNICATION_FAILURE`: General communication failure.
+     * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
+     * + `UNAUTHORIZED`: Unauthorized to access external database.
+     * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
+     */
+    causeOfFailure?: CauseOfFailure;
+    /**
+     * Whether the external database has existing collections. Possible values are:
+     * + `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.
+     * + `NO`: External database does not have any existing collections.
+     * + `YES`: External database has existing collections.
+     * @readonly
+     */
+    hasCollections?: CollectionsFound;
+}
+interface Capabilities {
+    /** Whether the external database supports creating new collections, updating the structure of existing collections, or deleting them. */
+    collectionModificationsSupported?: boolean;
+    /**
+     * Field types the external database supports.
+     * This field only applies when `collectionModificationsSupported` is `true`.
+     */
+    fieldTypes?: FieldType[];
+}
+interface Paging$3 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface ListExternalDatabaseConnectionsResponse {
+    /** List of external database connections. */
+    externalDatabaseConnections?: ExternalDatabaseConnection[];
+    /** Paging metadata */
+    pagingMetadata?: PagingMetadata$1;
+}
+interface PagingMetadata$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+declare enum ConnectionType {
+    /** Unknown connection type. */
+    UNKNOWN_CONNECTION_TYPE = "UNKNOWN_CONNECTION_TYPE",
+    /**
+     * Connection to database adapter that implements legacy External Database Collections SPI (protocol version 1 or 2)
+     * https://www.wix.com/velo/reference/spis/external-database-collections/introduction
+     */
+    STANDALONE = "STANDALONE",
+    /**
+     * Connection to database adapter that implements External Database SPI (protocol version 3)
+     * https://dev.wix.com/docs/rest/internal-only/wix-data/external-database-spi/introduction
+     * https://dev.wix.com/docs/rest/articles/getting-started/service-provider-interface
+     */
+    WIX_SPI = "WIX_SPI"
+}
+interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType$2;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$2 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType$2 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ListExternalDatabaseConnectionsResponseNonNullableFields {
+    externalDatabaseConnections: {
+        name: string;
+        connectionStatus?: {
+            successful: boolean;
+            causeOfFailure: CauseOfFailure;
+            hasCollections: CollectionsFound;
+        };
+        capabilities?: {
+            collectionModificationsSupported: boolean;
+            fieldTypes: FieldType[];
+        };
+    }[];
+}
+interface BaseEventMetadata$2 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$2;
+}
+interface EventMetadata$2 extends BaseEventMetadata$2 {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface ExternalDatabaseConnectionCreatedEnvelope {
+    entity: ExternalDatabaseConnection;
+    metadata: EventMetadata$2;
+}
+interface ExternalDatabaseConnectionUpdatedEnvelope {
+    entity: ExternalDatabaseConnection;
+    metadata: EventMetadata$2;
+}
+interface ExternalDatabaseConnectionDeletedEnvelope {
+    metadata: EventMetadata$2;
+}
+interface ListExternalDatabaseConnectionsOptions {
+    /** Paging */
+    paging?: Paging$3;
+}
+interface CreateExternalDatabaseConnectionOptions {
+    /** Connection type. */
+    connectionType: ConnectionType;
+}
+interface UpdateExternalDatabaseConnection {
+    /** Base URL for provisioning and managing data in the external database. For example: `https://example.com/my-external-database`. */
+    endpoint?: string | null;
+    /**
+     * Settings passed to the external database connection as part of each request.
+     * These settings can relate to authentication, tenancy, or provide any other information needed for processing a request.
+     * Their content and structure depend on the specific requirements of the external database's API.
+     */
+    configuration?: Record<string, any> | null;
+    /**
+     * Status of the external database connection. Includes whether the connection was established successfully, and if not, the reason for the failure.
+     * @readonly
+     */
+    connectionStatus?: ConnectionStatus;
+    /**
+     * The external database's capabilities.
+     * @readonly
+     */
+    capabilities?: Capabilities;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare function getExternalDatabaseConnection$1(httpClient: HttpClient): (name: string) => Promise<ExternalDatabaseConnection & {
+    name: string;
+    connectionStatus?: {
+        successful: boolean;
+        causeOfFailure: CauseOfFailure;
+        hasCollections: CollectionsFound;
+    } | undefined;
+    capabilities?: {
+        collectionModificationsSupported: boolean;
+        fieldTypes: FieldType[];
+    } | undefined;
+}>;
+declare function listExternalDatabaseConnections$1(httpClient: HttpClient): (options?: ListExternalDatabaseConnectionsOptions) => Promise<ListExternalDatabaseConnectionsResponse & ListExternalDatabaseConnectionsResponseNonNullableFields>;
+declare function createExternalDatabaseConnection$1(httpClient: HttpClient): (externalDatabaseConnection: ExternalDatabaseConnection, options: CreateExternalDatabaseConnectionOptions) => Promise<ExternalDatabaseConnection & {
+    name: string;
+    connectionStatus?: {
+        successful: boolean;
+        causeOfFailure: CauseOfFailure;
+        hasCollections: CollectionsFound;
+    } | undefined;
+    capabilities?: {
+        collectionModificationsSupported: boolean;
+        fieldTypes: FieldType[];
+    } | undefined;
+}>;
+declare function updateExternalDatabaseConnection$1(httpClient: HttpClient): (name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection) => Promise<ExternalDatabaseConnection & {
+    name: string;
+    connectionStatus?: {
+        successful: boolean;
+        causeOfFailure: CauseOfFailure;
+        hasCollections: CollectionsFound;
+    } | undefined;
+    capabilities?: {
+        collectionModificationsSupported: boolean;
+        fieldTypes: FieldType[];
+    } | undefined;
+}>;
+declare function deleteExternalDatabaseConnection$1(httpClient: HttpClient): (name: string) => Promise<void>;
+declare const onExternalDatabaseConnectionCreated$1: EventDefinition<ExternalDatabaseConnectionCreatedEnvelope, "wix.data.v1.external_database_connection_created">;
+declare const onExternalDatabaseConnectionUpdated$1: EventDefinition<ExternalDatabaseConnectionUpdatedEnvelope, "wix.data.v1.external_database_connection_updated">;
+declare const onExternalDatabaseConnectionDeleted$1: EventDefinition<ExternalDatabaseConnectionDeletedEnvelope, "wix.data.v1.external_database_connection_deleted">;
+
+declare const getExternalDatabaseConnection: BuildRESTFunction<typeof getExternalDatabaseConnection$1>;
+declare const listExternalDatabaseConnections: BuildRESTFunction<typeof listExternalDatabaseConnections$1>;
+declare const createExternalDatabaseConnection: BuildRESTFunction<typeof createExternalDatabaseConnection$1>;
+declare const updateExternalDatabaseConnection: BuildRESTFunction<typeof updateExternalDatabaseConnection$1>;
+declare const deleteExternalDatabaseConnection: BuildRESTFunction<typeof deleteExternalDatabaseConnection$1>;
+declare const onExternalDatabaseConnectionCreated: BuildEventDefinition<typeof onExternalDatabaseConnectionCreated$1>;
+declare const onExternalDatabaseConnectionUpdated: BuildEventDefinition<typeof onExternalDatabaseConnectionUpdated$1>;
+declare const onExternalDatabaseConnectionDeleted: BuildEventDefinition<typeof onExternalDatabaseConnectionDeleted$1>;
+
+declare const context$3_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
+declare const context$3_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
+declare const context$3_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
+declare const context$3_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;
+declare const context$3_onExternalDatabaseConnectionCreated: typeof onExternalDatabaseConnectionCreated;
+declare const context$3_onExternalDatabaseConnectionDeleted: typeof onExternalDatabaseConnectionDeleted;
+declare const context$3_onExternalDatabaseConnectionUpdated: typeof onExternalDatabaseConnectionUpdated;
+declare const context$3_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
+declare namespace context$3 {
+  export { context$3_createExternalDatabaseConnection as createExternalDatabaseConnection, context$3_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, context$3_getExternalDatabaseConnection as getExternalDatabaseConnection, context$3_listExternalDatabaseConnections as listExternalDatabaseConnections, context$3_onExternalDatabaseConnectionCreated as onExternalDatabaseConnectionCreated, context$3_onExternalDatabaseConnectionDeleted as onExternalDatabaseConnectionDeleted, context$3_onExternalDatabaseConnectionUpdated as onExternalDatabaseConnectionUpdated, context$3_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
+}
+
+/** A data collection determines the structure of data to be stored in a database. */
+interface DataCollection {
+    /** Collection ID. For example, `my-first-collection`. May include a namespace. */
+    _id?: string;
+    /**
+     * Collection type. Indicates how the collection was created and is stored.
+     *
+     * * `NATIVE`: User-created collection.
+     * * `WIX_APP`: [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, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.
+     * * `BLOCKS_APP`: Collection created by a Wix Blocks app.
+     * * `EXTERNAL`: Collection located in externally connected storage.
+     * @readonly
+     */
+    collectionType?: CollectionType;
+    /**
+     * ID of the app that defined this collection. For user-defined collections, this value is null.
+     * @readonly
+     */
+    ownerAppId?: string | null;
+    /**
+     * Maximum number of items returned in a single query, based on the underlying storage.
+     * Native collections have a maximum page size of 1000 for offset-based queries or 100 for cursor-based queries.
+     * External collections' maximum page size defaults to 50, but an external provider can set any maximum value up to 1000.
+     * @readonly
+     */
+    maxPageSize?: number | null;
+    /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
+    displayName?: string | null;
+    /**
+     * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
+     * @readonly
+     */
+    defaultDisplayOrder?: Sort;
+    /**
+     * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
+     * Empty for all data collections not owned by internal Wix apps.
+     * @readonly
+     */
+    displayNamespace?: string | null;
+    /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    displayField?: string | null;
+    /**
+     * Capabilities the collection supports.
+     * @readonly
+     */
+    capabilities?: CollectionCapabilities;
+    /** Collection's field structure. */
+    fields?: Field$1[];
+    /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
+    permissions?: Permissions;
+    /**
+     * 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.
+     * @readonly
+     */
+    revision?: string | null;
+    /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    plugins?: Plugin[];
+    /**
+     * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * @readonly
+     */
+    pagingModes?: PagingMode[];
+    /**
+     * Date the collection was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date the collection was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+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). */
+    WIX_APP = "WIX_APP",
+    /** Collection created by a Wix Blocks app. */
+    BLOCKS_APP = "BLOCKS_APP",
+    /** Collection located in externally connected storage. */
+    EXTERNAL = "EXTERNAL"
+}
+interface Sort {
+    /** Field to sort by. */
+    fieldKey?: string;
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
+    direction?: Direction;
+}
+declare enum Direction {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface CollectionCapabilities {
+    /**
+     * Data operations the collection supports. The listed operations can be performed on data the collection contains.
+     *
+     * Supported values: `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`.
+     */
+    dataOperations?: DataOperation[];
+    /**
+     * Collection operations supported. The listed operations can be performed on the collection itself.
+     * + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.
+     * + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.
+     */
+    collectionOperations?: CollectionOperation[];
+    /** Maximum number of indexes for the collection. */
+    indexLimits?: IndexLimits;
+}
+declare enum DataOperation {
+    AGGREGATE = "AGGREGATE",
+    BULK_INSERT = "BULK_INSERT",
+    BULK_REMOVE = "BULK_REMOVE",
+    BULK_SAVE = "BULK_SAVE",
+    BULK_UPDATE = "BULK_UPDATE",
+    COUNT = "COUNT",
+    DISTINCT = "DISTINCT",
+    FIND = "FIND",
+    GET = "GET",
+    INSERT = "INSERT",
+    INSERT_REFERENCE = "INSERT_REFERENCE",
+    IS_REFERENCED = "IS_REFERENCED",
+    QUERY_REFERENCED = "QUERY_REFERENCED",
+    REMOVE = "REMOVE",
+    REMOVE_REFERENCE = "REMOVE_REFERENCE",
+    REPLACE_REFERENCES = "REPLACE_REFERENCES",
+    SAVE = "SAVE",
+    TRUNCATE = "TRUNCATE",
+    UPDATE = "UPDATE",
+    PATCH = "PATCH",
+    BULK_PATCH = "BULK_PATCH"
+}
+declare enum CollectionOperation {
+    /** Supports updating this collection. */
+    UPDATE = "UPDATE",
+    /** Supports removing this collections. */
+    REMOVE = "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. */
+    unique?: number;
+    /** Maximum number of regular and unique indexes allowed for this collection. */
+    total?: number;
+}
+interface Field$1 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`. */
+    stringLengthRange?: StringLengthRange;
+    /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */
+    arraySizeRange?: ArraySizeRange;
+    /** Unique identifier for the field. For example, `firstName`. */
+    key?: string;
+    /** Field's display name when shown in the CMS. For example, `First Name`. */
+    displayName?: string | null;
+    /** Field's data type. */
+    type?: Type;
+    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    typeMetadata?: TypeMetadata;
+    /**
+     * Whether the field is a system field (created automatically).
+     * @readonly
+     */
+    systemField?: boolean;
+    /**
+     * Capabilities the field supports.
+     * @readonly
+     */
+    capabilities?: FieldCapabilities;
+    /** Indicates if field is encrypted. */
+    encrypted?: boolean;
+    /** Description of the field. */
+    description?: string | null;
+    plugin?: string | null;
+    /**
+     * Whether the field is read-only. A read-only field can't be changed.
+     *
+     * Default: `false`
+     */
+    readOnly?: boolean | null;
+    /**
+     * Whether the field is immutable. An immutable field can be set once, but then cannot be updated.
+     *
+     * Default: `false`
+     */
+    immutable?: boolean | null;
+    /**
+     * Whether the field is required.
+     *
+     * Default: `false`
+     */
+    required?: boolean | null;
+    /** Additional optional plugins for the field. */
+    plugins?: FieldPlugin[];
+}
+/** @oneof */
+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`. */
+    stringLengthRange?: StringLengthRange;
+    /** Array size range permitted. Relevant for fields that hold arrays, such as those of type `ARRAY`, `ARRAY_STRING`, or `ARRAY_DOCUMENT`. */
+    arraySizeRange?: ArraySizeRange;
+}
+declare enum Type {
+    UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
+    TEXT = "TEXT",
+    NUMBER = "NUMBER",
+    DATE = "DATE",
+    DATETIME = "DATETIME",
+    IMAGE = "IMAGE",
+    BOOLEAN = "BOOLEAN",
+    DOCUMENT = "DOCUMENT",
+    URL = "URL",
+    RICH_TEXT = "RICH_TEXT",
+    VIDEO = "VIDEO",
+    ANY = "ANY",
+    ARRAY_STRING = "ARRAY_STRING",
+    ARRAY_DOCUMENT = "ARRAY_DOCUMENT",
+    AUDIO = "AUDIO",
+    TIME = "TIME",
+    LANGUAGE = "LANGUAGE",
+    RICH_CONTENT = "RICH_CONTENT",
+    MEDIA_GALLERY = "MEDIA_GALLERY",
+    ADDRESS = "ADDRESS",
+    PAGE_LINK = "PAGE_LINK",
+    REFERENCE = "REFERENCE",
+    MULTI_REFERENCE = "MULTI_REFERENCE",
+    OBJECT = "OBJECT",
+    ARRAY = "ARRAY",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_TIME = "LEGACY_TIME",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BOOK = "LEGACY_BOOK",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_URL = "LEGACY_EXTERNAL_URL",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_BROKEN_REFERENCE = "LEGACY_BROKEN_REFERENCE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_IMAGE = "LEGACY_IMAGE",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_COLOR = "LEGACY_COLOR",
+    /** Deprecated - can’t be added to collections. Can only appear in older collections. */
+    LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
+}
+interface TypeMetadata extends TypeMetadataMetadataOneOf {
+    /** Metadata for a reference field. */
+    reference?: Reference;
+    /** Metadata for a multi-reference field. */
+    multiReference?: MultiReference;
+    /** Metadata for an object field. */
+    object?: _Object;
+    /** Metadata for an array field. */
+    array?: _Array;
+    /** Metadata for a page link field. */
+    pageLink?: PageLink;
+}
+/** @oneof */
+interface TypeMetadataMetadataOneOf {
+    /** Metadata for a reference field. */
+    reference?: Reference;
+    /** Metadata for a multi-reference field. */
+    multiReference?: MultiReference;
+    /** Metadata for an object field. */
+    object?: _Object;
+    /** Metadata for an array field. */
+    array?: _Array;
+    /** Metadata for a page link field. */
+    pageLink?: PageLink;
+}
+interface FieldCapabilities {
+    /**
+     * Whether the collection can be sorted by this field.
+     *
+     * Default: `false`
+     */
+    sortable?: boolean;
+    /**
+     * Query operators that can be used for this field.
+     *
+     * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
+     */
+    queryOperators?: QueryOperator[];
+}
+declare enum QueryOperator {
+    EQ = "EQ",
+    LT = "LT",
+    GT = "GT",
+    NE = "NE",
+    LTE = "LTE",
+    GTE = "GTE",
+    STARTS_WITH = "STARTS_WITH",
+    ENDS_WITH = "ENDS_WITH",
+    CONTAINS = "CONTAINS",
+    HAS_SOME = "HAS_SOME",
+    HAS_ALL = "HAS_ALL",
+    EXISTS = "EXISTS",
+    URLIZED = "URLIZED"
+}
+interface ObjectField {
+    /** Field key. */
+    key?: string;
+    /** Display name for the field. */
+    displayName?: string | null;
+    /** Field type. */
+    type?: Type;
+    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    typeMetadata?: TypeMetadata;
+    /**
+     * Capabilities the object field supports.
+     * @readonly
+     */
+    capabilities?: FieldCapabilities;
+}
+interface FieldsPattern {
+    pattern?: string;
+    lowercase?: boolean;
+}
+interface UrlizedOnlyPattern {
+    pattern?: string;
+}
+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 */
+interface CalculatorPatternOneOf {
+    /** Value is calculated according to pattern, whitespaces are replaced with dash [-]. */
+    fieldsPattern?: FieldsPattern;
+    /** Value is only URL encoded. */
+    urlizedOnlyPattern?: UrlizedOnlyPattern;
+}
+interface Reference {
+    /** Referenced collection ID. */
+    referencedCollectionId?: string;
+}
+interface MultiReference {
+    /** Referenced collection ID. */
+    referencedCollectionId?: string;
+    /** Referencing field key. */
+    referencingFieldKey?: string;
+    /** Display name in the CMS for the referenced data. */
+    referencingDisplayName?: string;
+}
+interface _Object {
+    /** Fields within the object. */
+    fields?: ObjectField[];
+}
+interface _Array {
+    /** Element's data type. */
+    elementType?: Type;
+    /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
+    typeMetadata?: TypeMetadata;
+}
+interface PageLink {
+    calculator?: Calculator;
+    /** Defines reference to router pattern in the site document. */
+    linkedRouterPage?: string | null;
+}
+interface NumberRange {
+    /**
+     * Minimum permitted value for a numerical field.
+     *
+     * Default: No validation
+     */
+    min?: number | null;
+    /**
+     * Maximum permitted value for a numerical field.
+     *
+     * Default: No validation
+     */
+    max?: number | null;
+}
+interface StringLengthRange {
+    /**
+     * Minimum permitted length for a text field.
+     *
+     * Default: No validation
+     */
+    minLength?: number | null;
+    /**
+     * Maximum permitted length for a text field.
+     *
+     * Default: No validation
+     */
+    maxLength?: number | null;
+}
+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`.
+     *
+     * Default: No validation
+     */
+    minSize?: number | null;
+    /**
+     * Maximum 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`.
+     *
+     * Default: No validation
+     */
+    maxSize?: number | null;
+}
+/** Optional plug-in aspects for fields */
+interface FieldPlugin extends FieldPluginOptionsOneOf {
+    /** Options for the CMS plugin. */
+    cmsOptions?: CmsOptions;
+    type?: FieldPluginType;
+}
+/** @oneof */
+interface FieldPluginOptionsOneOf {
+    /** Options for the CMS plugin. */
+    cmsOptions?: CmsOptions;
+}
+declare enum FieldPluginType {
+    UNKNOWN = "UNKNOWN",
+    /** CMS-related field attributes */
+    CMS = "CMS"
+}
+/** Options for the CMS plugin. */
+interface CmsOptions {
+    /**
+     * Indicates an internal CMS field. The CMS does not display internal fields.
+     *
+     * Default: `false`
+     */
+    internal?: boolean;
+}
+/** Permissions defined by the lowest role needed to perform each action. */
+interface Permissions {
+    /** Lowest role needed to add a collection. */
+    insert?: Role;
+    /** Lowest role needed to update a collection. */
+    update?: Role;
+    /** Lowest role needed to remove a collection. */
+    remove?: Role;
+    /** Lowest role needed to read a collection. */
+    read?: Role;
+}
+declare enum Role {
+    /** Unknown. */
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Site administrator. */
+    ADMIN = "ADMIN",
+    /** Signed-in user who added content to this collection. */
+    SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
+    /** Any signed-in user. */
+    SITE_MEMBER = "SITE_MEMBER",
+    /** Any site visitor. */
+    ANYONE = "ANYONE"
+}
+interface Plugin extends PluginOptionsOneOf {
+    /** Options for the Publish plugin. */
+    publishOptions?: PublishPluginOptions;
+    /** Options for the Single Item plugin. */
+    singleItemOptions?: SingleItemPluginOptions;
+    /** Options for the Urlized plugin. */
+    urlizedOptions?: UrlizedPluginOptions;
+    /** Options for the Multilingual plugin. */
+    multilingualOptions?: MultilingualOptions;
+    /** Options for the PageLink plugin. */
+    editablePageLinkOptions?: PageLinkPluginOptions;
+    /** Options for the CMS plugin. */
+    cmsOptions?: PluginCmsOptions;
+    /**
+     * Plugin types. The following plugins are supported:
+     *
+     * * `PUBLISH`: 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.
+     * * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.
+     * * `URLIZED`: Generates item URLs for collections used by dynamic pages.
+     * * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     * * `CMS`: Contains CMS-related collection attributes
+     */
+    type?: PluginType;
+}
+/** @oneof */
+interface PluginOptionsOneOf {
+    /** Options for the Publish plugin. */
+    publishOptions?: PublishPluginOptions;
+    /** Options for the Single Item plugin. */
+    singleItemOptions?: SingleItemPluginOptions;
+    /** Options for the Urlized plugin. */
+    urlizedOptions?: UrlizedPluginOptions;
+    /** Options for the Multilingual plugin. */
+    multilingualOptions?: MultilingualOptions;
+    /** Options for the PageLink plugin. */
+    editablePageLinkOptions?: PageLinkPluginOptions;
+    /** Options for the CMS plugin. */
+    cmsOptions?: PluginCmsOptions;
+}
+declare enum Status$1 {
+    UNKNOWN_PUBLISH_PLUGIN_STATUS = "UNKNOWN_PUBLISH_PLUGIN_STATUS",
+    PUBLISHED = "PUBLISHED",
+    DRAFT = "DRAFT"
+}
+declare enum Format {
+    UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
+    ORIGINAL = "ORIGINAL",
+    PLAIN = "PLAIN"
+}
+/** if CMS-defined sort is enabled and should be used in site */
+interface SiteSort {
+    /** Field and order for the site sort. */
+    sort?: Sort[];
+}
+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. */
+    PUBLISH = "PUBLISH",
+    /** Ensures the collection can have one item at most. Can only be applied to a new collection. */
+    SINGLE_ITEM = "SINGLE_ITEM",
+    /** Generates item URLs for collections used by dynamic pages. */
+    URLIZED = "URLIZED",
+    /** Deprecated. Will be removed in the future. */
+    GRIDAPPLESS = "GRIDAPPLESS",
+    /** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */
+    MULTILINGUAL = "MULTILINGUAL",
+    /** Indicates that collection is shared with current site */
+    SHARED = "SHARED",
+    /** Indicates that page link fields are persisted and can be updated */
+    EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
+    /** CMS-specific collection properties */
+    CMS = "CMS"
+}
+interface PublishPluginOptions {
+    /** Default status. */
+    defaultStatus?: Status$1;
+}
+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. */
+    singleItemId?: string;
+}
+interface UrlizedPluginOptions {
+    /**
+     * Encoding method for generating a URL in ASCII characters.
+     *
+     * * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.
+     * * `PLAIN`: No changes are made before generating the encoded URL.
+     */
+    format?: Format;
+}
+interface MultilingualOptions {
+    /** IDs of fields to allow translation. */
+    translatableFieldKeys?: string[];
+}
+interface PageLinkPluginOptions {
+    isPersisted?: boolean;
+    isMutable?: boolean;
+}
+interface PluginCmsOptions {
+    /** CMS sort, applied when a collection is displayed on a site. */
+    siteSort?: SiteSort;
+}
+declare enum PagingMode {
+    /** Offset-based paging. */
+    OFFSET = "OFFSET",
+    /** Cursor-based paging. */
+    CURSOR = "CURSOR"
+}
+interface DataCollectionClonedEvent {
+    /** original instance collection is cloned from */
+    originInstanceId?: string;
+    /** original collection ID, may be same as current one */
+    originId?: string;
+}
+interface DataCollectionChangedEvent {
+    /** list of new fields */
+    fieldsAdded?: Field$1[];
+    /** list of changed fields */
+    fieldsUpdated?: FieldUpdate[];
+    /** list of removed fields */
+    fieldsRemoved?: Field$1[];
+    /** list of new plugins */
+    pluginsAdded?: Plugin[];
+    /** list of changed plugins */
+    pluginsUpdated?: PluginUpdate[];
+    /** list of removed plugins */
+    pluginsRemoved?: Plugin[];
+}
+interface FieldUpdate {
+    /** previous state of the field */
+    previous?: Field$1;
+    /** current state of the field */
+    current?: Field$1;
+}
+interface PluginUpdate {
+    /** previous state of the plugin */
+    previous?: Plugin;
+    /** current state of the plugin */
+    current?: Plugin;
+}
+interface Sorting$1 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$1;
+}
+declare enum SortOrder$1 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging$2 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface ListDataCollectionsResponse {
+    /** List of collections. */
+    collections?: DataCollection[];
+    /** Paging information. */
+    pagingMetadata?: PagingMetadataV2$1;
+}
+interface PagingMetadataV2$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType$1;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$1 {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ListDataCollectionsResponseNonNullableFields {
+    collections: {
+        _id: string;
+        collectionType: CollectionType;
+        defaultDisplayOrder?: {
+            fieldKey: string;
+            direction: Direction;
+        };
+        capabilities?: {
+            dataOperations: DataOperation[];
+            collectionOperations: CollectionOperation[];
+            indexLimits?: {
+                regular: number;
+                unique: number;
+                total: number;
+            };
+        };
+        fields: {
+            key: string;
+            type: Type;
+            typeMetadata?: {
+                reference?: {
+                    referencedCollectionId: string;
+                };
+                multiReference?: {
+                    referencedCollectionId: string;
+                    referencingFieldKey: string;
+                    referencingDisplayName: string;
+                };
+                object?: {
+                    fields: {
+                        key: string;
+                        type: Type;
+                        capabilities?: {
+                            sortable: boolean;
+                            queryOperators: QueryOperator[];
+                        };
+                    }[];
+                };
+                array?: {
+                    elementType: Type;
+                };
+                pageLink?: {
+                    calculator?: {
+                        fieldsPattern?: {
+                            pattern: string;
+                            lowercase: boolean;
+                        };
+                        urlizedOnlyPattern?: {
+                            pattern: string;
+                        };
+                    };
+                };
+            };
+            systemField: boolean;
+            capabilities?: {
+                sortable: boolean;
+                queryOperators: QueryOperator[];
+            };
+            encrypted: boolean;
+            plugins: {
+                cmsOptions?: {
+                    internal: boolean;
+                };
+                type: FieldPluginType;
+            }[];
+        }[];
+        permissions?: {
+            insert: Role;
+            update: Role;
+            remove: Role;
+            read: Role;
+        };
+        plugins: {
+            publishOptions?: {
+                defaultStatus: Status$1;
+            };
+            singleItemOptions?: {
+                singleItemId: string;
+            };
+            urlizedOptions?: {
+                format: Format;
+            };
+            multilingualOptions?: {
+                translatableFieldKeys: string[];
+            };
+            editablePageLinkOptions?: {
+                isPersisted: boolean;
+                isMutable: boolean;
+            };
+            cmsOptions?: {
+                siteSort?: {
+                    sort: {
+                        fieldKey: string;
+                        direction: Direction;
+                    }[];
+                };
+            };
+            type: PluginType;
+        }[];
+        pagingModes: PagingMode[];
+    }[];
+}
+interface BaseEventMetadata$1 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$1;
+}
+interface EventMetadata$1 extends BaseEventMetadata$1 {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface DataCollectionClonedEnvelope {
+    data: DataCollectionClonedEvent;
+    metadata: EventMetadata$1;
+}
+interface DataCollectionChangedEnvelope {
+    data: DataCollectionChangedEvent;
+    metadata: EventMetadata$1;
+}
+interface DataCollectionCreatedEnvelope {
+    entity: DataCollection;
+    metadata: EventMetadata$1;
+}
+interface DataCollectionUpdatedEnvelope {
+    entity: DataCollection;
+    metadata: EventMetadata$1;
+}
+interface DataCollectionDeletedEnvelope {
+    metadata: EventMetadata$1;
+}
+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;
+}
+interface ListDataCollectionsOptions {
+    /**
+     * Defines how collections in the response are sorted.
+     *
+     * Default: Ordered by ID in ascending order.
+     */
+    sort?: Sorting$1;
+    /** Pagination information. */
+    paging?: Paging$2;
+    /**
+     * 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;
+}
+
+declare function createDataCollection$1(httpClient: HttpClient): (collection: DataCollection) => Promise<DataCollection & {
+    _id: string;
+    collectionType: CollectionType;
+    defaultDisplayOrder?: {
+        fieldKey: string;
+        direction: Direction;
+    } | undefined;
+    capabilities?: {
+        dataOperations: DataOperation[];
+        collectionOperations: CollectionOperation[];
+        indexLimits?: {
+            regular: number;
+            unique: number;
+            total: number;
+        } | undefined;
+    } | undefined;
+    fields: {
+        key: string;
+        type: Type;
+        typeMetadata?: {
+            reference?: {
+                referencedCollectionId: string;
+            } | undefined;
+            multiReference?: {
+                referencedCollectionId: string;
+                referencingFieldKey: string;
+                referencingDisplayName: string;
+            } | undefined;
+            object?: {
+                fields: {
+                    key: string;
+                    type: Type;
+                    capabilities?: {
+                        sortable: boolean;
+                        queryOperators: QueryOperator[];
+                    } | undefined;
+                }[];
+            } | undefined;
+            array?: {
+                elementType: Type;
+            } | undefined;
+            pageLink?: {
+                calculator?: {
+                    fieldsPattern?: {
+                        pattern: string;
+                        lowercase: boolean;
+                    } | undefined;
+                    urlizedOnlyPattern?: {
+                        pattern: string;
+                    } | undefined;
+                } | undefined;
+            } | undefined;
+        } | undefined;
+        systemField: boolean;
+        capabilities?: {
+            sortable: boolean;
+            queryOperators: QueryOperator[];
+        } | undefined;
+        encrypted: boolean;
+        plugins: {
+            cmsOptions?: {
+                internal: boolean;
+            } | undefined;
+            type: FieldPluginType;
+        }[];
+    }[];
+    permissions?: {
+        insert: Role;
+        update: Role;
+        remove: Role;
+        read: Role;
+    } | undefined;
+    plugins: {
+        publishOptions?: {
+            defaultStatus: Status$1;
+        } | undefined;
+        singleItemOptions?: {
+            singleItemId: string;
+        } | undefined;
+        urlizedOptions?: {
+            format: Format;
+        } | undefined;
+        multilingualOptions?: {
+            translatableFieldKeys: string[];
+        } | undefined;
+        editablePageLinkOptions?: {
+            isPersisted: boolean;
+            isMutable: boolean;
+        } | undefined;
+        cmsOptions?: {
+            siteSort?: {
+                sort: {
+                    fieldKey: string;
+                    direction: Direction;
+                }[];
+            } | undefined;
+        } | undefined;
+        type: PluginType;
+    }[];
+    pagingModes: PagingMode[];
+}>;
+declare function getDataCollection$1(httpClient: HttpClient): (dataCollectionId: string, options?: GetDataCollectionOptions) => Promise<DataCollection & {
+    _id: string;
+    collectionType: CollectionType;
+    defaultDisplayOrder?: {
+        fieldKey: string;
+        direction: Direction;
+    } | undefined;
+    capabilities?: {
+        dataOperations: DataOperation[];
+        collectionOperations: CollectionOperation[];
+        indexLimits?: {
+            regular: number;
+            unique: number;
+            total: number;
+        } | undefined;
+    } | undefined;
+    fields: {
+        key: string;
+        type: Type;
+        typeMetadata?: {
+            reference?: {
+                referencedCollectionId: string;
+            } | undefined;
+            multiReference?: {
+                referencedCollectionId: string;
+                referencingFieldKey: string;
+                referencingDisplayName: string;
+            } | undefined;
+            object?: {
+                fields: {
+                    key: string;
+                    type: Type;
+                    capabilities?: {
+                        sortable: boolean;
+                        queryOperators: QueryOperator[];
+                    } | undefined;
+                }[];
+            } | undefined;
+            array?: {
+                elementType: Type;
+            } | undefined;
+            pageLink?: {
+                calculator?: {
+                    fieldsPattern?: {
+                        pattern: string;
+                        lowercase: boolean;
+                    } | undefined;
+                    urlizedOnlyPattern?: {
+                        pattern: string;
+                    } | undefined;
+                } | undefined;
+            } | undefined;
+        } | undefined;
+        systemField: boolean;
+        capabilities?: {
+            sortable: boolean;
+            queryOperators: QueryOperator[];
+        } | undefined;
+        encrypted: boolean;
+        plugins: {
+            cmsOptions?: {
+                internal: boolean;
+            } | undefined;
+            type: FieldPluginType;
+        }[];
+    }[];
+    permissions?: {
+        insert: Role;
+        update: Role;
+        remove: Role;
+        read: Role;
+    } | undefined;
+    plugins: {
+        publishOptions?: {
+            defaultStatus: Status$1;
+        } | undefined;
+        singleItemOptions?: {
+            singleItemId: string;
+        } | undefined;
+        urlizedOptions?: {
+            format: Format;
+        } | undefined;
+        multilingualOptions?: {
+            translatableFieldKeys: string[];
+        } | undefined;
+        editablePageLinkOptions?: {
+            isPersisted: boolean;
+            isMutable: boolean;
+        } | undefined;
+        cmsOptions?: {
+            siteSort?: {
+                sort: {
+                    fieldKey: string;
+                    direction: Direction;
+                }[];
+            } | undefined;
+        } | undefined;
+        type: PluginType;
+    }[];
+    pagingModes: PagingMode[];
+}>;
+declare function listDataCollections$1(httpClient: HttpClient): (options?: ListDataCollectionsOptions) => Promise<ListDataCollectionsResponse & ListDataCollectionsResponseNonNullableFields>;
+declare function updateDataCollection$1(httpClient: HttpClient): (collection: DataCollection) => Promise<DataCollection & {
+    _id: string;
+    collectionType: CollectionType;
+    defaultDisplayOrder?: {
+        fieldKey: string;
+        direction: Direction;
+    } | undefined;
+    capabilities?: {
+        dataOperations: DataOperation[];
+        collectionOperations: CollectionOperation[];
+        indexLimits?: {
+            regular: number;
+            unique: number;
+            total: number;
+        } | undefined;
+    } | undefined;
+    fields: {
+        key: string;
+        type: Type;
+        typeMetadata?: {
+            reference?: {
+                referencedCollectionId: string;
+            } | undefined;
+            multiReference?: {
+                referencedCollectionId: string;
+                referencingFieldKey: string;
+                referencingDisplayName: string;
+            } | undefined;
+            object?: {
+                fields: {
+                    key: string;
+                    type: Type;
+                    capabilities?: {
+                        sortable: boolean;
+                        queryOperators: QueryOperator[];
+                    } | undefined;
+                }[];
+            } | undefined;
+            array?: {
+                elementType: Type;
+            } | undefined;
+            pageLink?: {
+                calculator?: {
+                    fieldsPattern?: {
+                        pattern: string;
+                        lowercase: boolean;
+                    } | undefined;
+                    urlizedOnlyPattern?: {
+                        pattern: string;
+                    } | undefined;
+                } | undefined;
+            } | undefined;
+        } | undefined;
+        systemField: boolean;
+        capabilities?: {
+            sortable: boolean;
+            queryOperators: QueryOperator[];
+        } | undefined;
+        encrypted: boolean;
+        plugins: {
+            cmsOptions?: {
+                internal: boolean;
+            } | undefined;
+            type: FieldPluginType;
+        }[];
+    }[];
+    permissions?: {
+        insert: Role;
+        update: Role;
+        remove: Role;
+        read: Role;
+    } | undefined;
+    plugins: {
+        publishOptions?: {
+            defaultStatus: Status$1;
+        } | undefined;
+        singleItemOptions?: {
+            singleItemId: string;
+        } | undefined;
+        urlizedOptions?: {
+            format: Format;
+        } | undefined;
+        multilingualOptions?: {
+            translatableFieldKeys: string[];
+        } | undefined;
+        editablePageLinkOptions?: {
+            isPersisted: boolean;
+            isMutable: boolean;
+        } | undefined;
+        cmsOptions?: {
+            siteSort?: {
+                sort: {
+                    fieldKey: string;
+                    direction: Direction;
+                }[];
+            } | undefined;
+        } | undefined;
+        type: PluginType;
+    }[];
+    pagingModes: PagingMode[];
+}>;
+declare function deleteDataCollection$1(httpClient: HttpClient): (dataCollectionId: string) => Promise<void>;
+declare const onDataCollectionClonedEvent$1: EventDefinition<DataCollectionClonedEnvelope, "wix.data.v2.data_collection_data_collection_cloned_event">;
+declare const onDataCollectionChangedEvent$1: EventDefinition<DataCollectionChangedEnvelope, "wix.data.v2.data_collection_data_collection_changed_event">;
+declare const onDataCollectionCreated$1: EventDefinition<DataCollectionCreatedEnvelope, "wix.data.v2.data_collection_created">;
+declare const onDataCollectionUpdated$1: EventDefinition<DataCollectionUpdatedEnvelope, "wix.data.v2.data_collection_updated">;
+declare const onDataCollectionDeleted$1: EventDefinition<DataCollectionDeletedEnvelope, "wix.data.v2.data_collection_deleted">;
+
+declare const createDataCollection: BuildRESTFunction<typeof createDataCollection$1>;
+declare const getDataCollection: BuildRESTFunction<typeof getDataCollection$1>;
+declare const listDataCollections: BuildRESTFunction<typeof listDataCollections$1>;
+declare const updateDataCollection: BuildRESTFunction<typeof updateDataCollection$1>;
+declare const deleteDataCollection: BuildRESTFunction<typeof deleteDataCollection$1>;
+declare const onDataCollectionClonedEvent: BuildEventDefinition<typeof onDataCollectionClonedEvent$1>;
+declare const onDataCollectionChangedEvent: BuildEventDefinition<typeof onDataCollectionChangedEvent$1>;
+declare const onDataCollectionCreated: BuildEventDefinition<typeof onDataCollectionCreated$1>;
+declare const onDataCollectionUpdated: BuildEventDefinition<typeof onDataCollectionUpdated$1>;
+declare const onDataCollectionDeleted: BuildEventDefinition<typeof onDataCollectionDeleted$1>;
+
+declare const context$2_createDataCollection: typeof createDataCollection;
+declare const context$2_deleteDataCollection: typeof deleteDataCollection;
+declare const context$2_getDataCollection: typeof getDataCollection;
+declare const context$2_listDataCollections: typeof listDataCollections;
+declare const context$2_onDataCollectionChangedEvent: typeof onDataCollectionChangedEvent;
+declare const context$2_onDataCollectionClonedEvent: typeof onDataCollectionClonedEvent;
+declare const context$2_onDataCollectionCreated: typeof onDataCollectionCreated;
+declare const context$2_onDataCollectionDeleted: typeof onDataCollectionDeleted;
+declare const context$2_onDataCollectionUpdated: typeof onDataCollectionUpdated;
+declare const context$2_updateDataCollection: typeof updateDataCollection;
+declare namespace context$2 {
+  export { context$2_createDataCollection as createDataCollection, context$2_deleteDataCollection as deleteDataCollection, context$2_getDataCollection as getDataCollection, context$2_listDataCollections as listDataCollections, context$2_onDataCollectionChangedEvent as onDataCollectionChangedEvent, context$2_onDataCollectionClonedEvent as onDataCollectionClonedEvent, context$2_onDataCollectionCreated as onDataCollectionCreated, context$2_onDataCollectionDeleted as onDataCollectionDeleted, context$2_onDataCollectionUpdated as onDataCollectionUpdated, context$2_updateDataCollection as updateDataCollection };
+}
+
+interface DataItem {
+    /** Data item ID. */
+    _id?: string;
+    /**
+     * ID of the collection this item belongs to
+     * @readonly
+     */
+    dataCollectionId?: string;
+    /**
+     * Data item contents.
+     *
+     * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
+     *
+     * + `_id`: Item ID.
+     * + `_createdDate`: Date and time the item was added to the collection.
+     * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
+     * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
+     */
+    data?: Record<string, any> | null;
+}
+interface InsertDataItemResponse {
+    /** Inserted data item. */
+    dataItem?: DataItem;
+}
+interface BulkDataItemResult {
+    /**
+     * The action attempted for the data item.
+     *
+     * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
+     */
+    action?: BulkActionType;
+    /** Metadata related to the data item for which the action was attempted. */
+    itemMetadata?: ItemMetadata;
+    /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
+    dataItem?: DataItem;
+}
+declare enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
+    INSERT = "INSERT",
+    UPDATE = "UPDATE",
+    DELETE = "DELETE",
+    PATCH = "PATCH"
+}
+interface ItemMetadata {
+    /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+}
+interface UpdateDataItemResponse {
+    /** Updated data item. */
+    dataItem?: DataItem;
+}
+interface SaveDataItemResponse {
+    /**
+     * The action carried out for the item.
+     *
+     * + `INSERTED`: A new item was added to the collection.
+     * + `UPDATED`: An existing item in the collection was updated.
+     */
+    action?: Action;
+    /** Inserted or updated data item. */
+    dataItem?: DataItem;
+}
+declare enum Action {
+    UNKNOWN_ACTION = "UNKNOWN_ACTION",
+    INSERTED = "INSERTED",
+    UPDATED = "UPDATED"
+}
+interface RemoveDataItemResponse {
+    /** Removed item. */
+    dataItem?: DataItem;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /**
+     * Sort order.
+     *
+     * Supported values: `ASC`, `DESC`.
+     */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging$1 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */
+    total?: number | null;
+    /** Whether the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+/** @oneof */
+interface AggregateDataItemsRequestPagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Average {
+    /** Name of the field for which to calculate the average value. */
+    itemFieldName?: string;
+}
+interface Min {
+    /** Name of the field for which to calculate the minimum value. */
+    itemFieldName?: string;
+}
+interface Max {
+    /** Name of the field for which to calculate the maximum value. */
+    itemFieldName?: string;
+}
+interface Sum {
+    /** Name of the field for which to calculate the sum. */
+    itemFieldName?: string;
+}
+interface Count {
+}
+interface Operation extends OperationCalculateOneOf {
+    /** Calculate the average value of a specified field for all items in the grouping. */
+    average?: Average;
+    /** Calculate the minimum value of a specified field for all items in the grouping. */
+    min?: Min;
+    /** Calculate the maximum value of a specified field for all items in the grouping. */
+    max?: Max;
+    /** Calculate the sum of values of a specified field for all items in the grouping. */
+    sum?: Sum;
+    /** Calculate the number of items in the grouping. */
+    itemCount?: Count;
+    /** Name of the field containing results of the operation. */
+    resultFieldName?: string;
+}
+/** @oneof */
+interface OperationCalculateOneOf {
+    /** Calculate the average value of a specified field for all items in the grouping. */
+    average?: Average;
+    /** Calculate the minimum value of a specified field for all items in the grouping. */
+    min?: Min;
+    /** Calculate the maximum value of a specified field for all items in the grouping. */
+    max?: Max;
+    /** Calculate the sum of values of a specified field for all items in the grouping. */
+    sum?: Sum;
+    /** Calculate the number of items in the grouping. */
+    itemCount?: Count;
+}
+interface Aggregation {
+    /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */
+    groupingFields?: string[];
+    /** Operations to carry out on the data in each grouping. */
+    operations?: Operation[];
+}
+interface AggregateDataItemsResponse {
+    /** Aggregation results. */
+    results?: Record<string, any>[] | null;
+    /** Paging information. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface CountDataItemsResponse {
+    /** Number of items matching the query. */
+    totalCount?: number;
+}
+/** @oneof */
+interface QueryDistinctValuesRequestPagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface QueryDistinctValuesResponse {
+    /** List of distinct values contained in the field specified in `fieldName`. */
+    distinctValues?: any[];
+    /** Paging information. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface BulkInsertDataItemsResponse {
+    /** Information about the inserted items. */
+    results?: BulkDataItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateDataItemsResponse {
+    /** Information about the updated items. */
+    results?: BulkDataItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkSaveDataItemsResponse {
+    /** Information about the saved items. */
+    results?: BulkDataItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkRemoveDataItemsResponse {
+    /** Information about the removed data items. */
+    results?: BulkDataItemResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+/** @oneof */
+interface QueryReferencedDataItemsRequestPagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface QueryReferencedDataItemsResponse {
+    /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */
+    results?: ReferencedResult[];
+    /** Paging information. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface UnresolvedReference {
+    /** ID of the referring item. */
+    referringItemId?: string;
+    /** Field specified to query for references. */
+    referringItemFieldName?: string;
+}
+interface ReferencedResult extends ReferencedResultEntityOneOf {
+    /** Data item referenced. */
+    dataItem?: DataItem;
+    /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */
+    unresolvedReference?: UnresolvedReference;
+}
+/** @oneof */
+interface ReferencedResultEntityOneOf {
+    /** Data item referenced. */
+    dataItem?: DataItem;
+    /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */
+    unresolvedReference?: UnresolvedReference;
+}
+interface IsReferencedDataItemResponse {
+    /** Whether the specified reference exists. */
+    isReferenced?: boolean;
+}
+interface DataItemReference {
+    /** Referring item field containing the references to the referenced items. */
+    referringItemFieldName?: string;
+    /** ID of the referring item. */
+    referringItemId?: string;
+    /** ID of the referenced item. */
+    referencedItemId?: string;
+}
+interface InsertDataItemReferenceResponse {
+    /** Inserted reference. */
+    dataItemReference?: DataItemReference;
+}
+interface RemoveDataItemReferenceResponse {
+    /** Removed reference. */
+    dataItemReference?: DataItemReference;
+}
+interface BulkInsertDataItemReferencesResponse {
+    /** Information about the inserted references. */
+    results?: BulkDataItemReferenceResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkDataItemReferenceResult {
+    /**
+     * The action attempted for the reference.
+     *
+     * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
+     */
+    action?: BulkActionType;
+    /** Metadata related to the reference for which the action was attempted. */
+    referenceMetadata?: ItemMetadata;
+    /** The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
+    dataItemReference?: DataItemReference;
+}
+interface BulkRemoveDataItemReferencesResponse {
+    /** Information about the removed references. */
+    results?: BulkDataItemReferenceResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ReplaceDataItemReferencesResponse {
+    /** Updated references. */
+    dataItemReferences?: DataItemReference[];
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface InsertDataItemResponseNonNullableFields {
+    dataItem?: {
+        _id: string;
+        dataCollectionId: string;
+    };
+}
+interface UpdateDataItemResponseNonNullableFields {
+    dataItem?: {
+        _id: string;
+        dataCollectionId: string;
+    };
+}
+interface SaveDataItemResponseNonNullableFields {
+    action: Action;
+    dataItem?: {
+        _id: string;
+        dataCollectionId: string;
+    };
+}
+interface RemoveDataItemResponseNonNullableFields {
+    dataItem?: {
+        _id: string;
+        dataCollectionId: string;
+    };
+}
+interface CountDataItemsResponseNonNullableFields {
+    totalCount: number;
+}
+interface BulkInsertDataItemsResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItem?: {
+            _id: string;
+            dataCollectionId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface BulkUpdateDataItemsResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItem?: {
+            _id: string;
+            dataCollectionId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface BulkSaveDataItemsResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItem?: {
+            _id: string;
+            dataCollectionId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface BulkRemoveDataItemsResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItem?: {
+            _id: string;
+            dataCollectionId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface QueryReferencedDataItemsResponseNonNullableFields {
+    results: {
+        dataItem?: {
+            _id: string;
+            dataCollectionId: string;
+        };
+        unresolvedReference?: {
+            referringItemId: string;
+            referringItemFieldName: string;
+        };
+    }[];
+}
+interface IsReferencedDataItemResponseNonNullableFields {
+    isReferenced: boolean;
+}
+interface InsertDataItemReferenceResponseNonNullableFields {
+    dataItemReference?: {
+        referringItemFieldName: string;
+        referringItemId: string;
+        referencedItemId: string;
+    };
+}
+interface RemoveDataItemReferenceResponseNonNullableFields {
+    dataItemReference?: {
+        referringItemFieldName: string;
+        referringItemId: string;
+        referencedItemId: string;
+    };
+}
+interface BulkInsertDataItemReferencesResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        referenceMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItemReference?: {
+            referringItemFieldName: string;
+            referringItemId: string;
+            referencedItemId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface BulkRemoveDataItemReferencesResponseNonNullableFields {
+    results: {
+        action: BulkActionType;
+        referenceMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        dataItemReference?: {
+            referringItemFieldName: string;
+            referringItemId: string;
+            referencedItemId: string;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+    };
+}
+interface ReplaceDataItemReferencesResponseNonNullableFields {
+    dataItemReferences: {
+        referringItemFieldName: string;
+        referringItemId: string;
+        referencedItemId: string;
+    }[];
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface DataItemCreatedEnvelope {
+    entity: DataItem;
+    metadata: EventMetadata;
+}
+interface DataItemUpdatedEnvelope {
+    entity: DataItem;
+    metadata: EventMetadata;
+}
+interface DataItemDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface InsertDataItemOptions {
+    /** ID of the collection in which to insert the item. */
+    dataCollectionId: string;
+    /** Item to insert. */
+    dataItem: DataItem;
+}
+interface UpdateDataItemOptions {
+    /** Updated data item content. The existing data item's content is replaced entirely. */
+    dataItem: {
+        /** Data item ID. */
+        _id?: string;
+        /**
+         * ID of the collection this item belongs to
+         * @readonly
+         */
+        dataCollectionId?: string;
+        /**
+         * Data item contents.
+         *
+         * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
+         *
+         * + `_id`: Item ID.
+         * + `_createdDate`: Date and time the item was added to the collection.
+         * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
+         * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
+         */
+        data?: Record<string, any> | null;
+    };
+    /** ID of the collection containing the existing item. */
+    dataCollectionId: string;
+}
+interface SaveDataItemOptions {
+    /** ID of the collection in which to insert or update the item. */
+    dataCollectionId: string;
+    /** Data item to insert or update. */
+    dataItem: DataItem;
+}
+interface GetDataItemOptions {
+    /** ID of the collection from which to retrieve the data item. */
+    dataCollectionId: string;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null;
+    /**
+     * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
+     * **Note:** The `_id` system field is always returned.
+     */
+    fields?: string[];
+}
+interface RemoveDataItemOptions {
+    /** ID of the collection from which to remove the item. */
+    dataCollectionId: string;
+}
+interface TruncateDataItemsOptions {
+    /** ID of the collection to truncate. */
+    dataCollectionId: string;
+}
+interface QueryDataItemsOptions {
+    /** ID of the collection to query. */
+    dataCollectionId: string;
+    /**
+     * Whether to return the total count in the response for a query with offset paging.
+     * When `true`, the `pagingMetadata` object in the response contains a `total` field.
+     *
+     * Default: `false`
+     */
+    returnTotalCount?: boolean | undefined;
+    /**
+     * Properties for which to include referenced items in the query's results.
+     * Up to 50 referenced items can be included for each item that matches the query.
+     */
+    includeReferencedItems?: string[] | undefined;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean | undefined;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null | undefined;
+}
+interface QueryOffsetResult {
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface DataItemsQueryResult extends QueryOffsetResult {
+    items: DataItem[];
+    query: DataItemsQueryBuilder;
+    next: () => Promise<DataItemsQueryResult>;
+    prev: () => Promise<DataItemsQueryResult>;
+}
+interface DataItemsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'dataCollectionId' | string, value: string) => DataItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: boolean) => DataItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | 'dataCollectionId' | 'data' | string>) => DataItemsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | 'dataCollectionId' | 'data' | string>) => DataItemsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => DataItemsQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results.
+     * @documentationMaturity preview
+     */
+    skip: (skip: number) => DataItemsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<DataItemsQueryResult>;
+}
+interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
+    /** ID of the collection on which to run the aggregation. */
+    dataCollectionId: string;
+    /** Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */
+    initialFilter?: Record<string, any> | null;
+    /** Aggregation applied to the data. */
+    aggregation?: Aggregation;
+    /** Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */
+    finalFilter?: Record<string, any> | null;
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /**
+     * Whether to return the total count in the response for a query with offset paging.
+     * When `true`, the `pagingMetadata` object in the response contains a `total` field.
+     *
+     * Default: `false`
+     */
+    returnTotalCount?: boolean;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null;
+}
+interface CountDataItemsOptions {
+    /** ID of the collection for which to count query results. */
+    dataCollectionId: string;
+    /**
+     * Filter object in the following format:
+     *
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`.
+     *
+     * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null;
+}
+interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
+    /** ID of the collection to query. */
+    dataCollectionId: string;
+    /** Item field name for which to return all distinct values. */
+    fieldName?: string;
+    /**
+     * Filter object in the following format:
+     *
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`.
+     *
+     * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort order.
+     *
+     * Supported values: `ASC`, `DESC`.
+     */
+    order?: SortOrder;
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Whether to return the total count in the response for a query with offset paging.
+     * When `true`, the `pagingMetadata` object in the response contains a `total` field.
+     *
+     * Default: `false`
+     */
+    returnTotalCount?: boolean;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null;
+}
+interface BulkInsertDataItemsOptions {
+    /** ID of the collection in which to insert the items. */
+    dataCollectionId: string;
+    /** Data items to insert. */
+    dataItems: DataItem[];
+    /**
+     * Whether to return the inserted data items.
+     * When `true`, the `results` objects contain a `dataItem` field.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkUpdateDataItemsOptions {
+    /** ID of the collection in which to update items. */
+    dataCollectionId: string;
+    /** Data items to update. */
+    dataItems: DataItem[];
+    /**
+     * Whether to return the updated data items.
+     * When `true`, the `results` objects contain a `dataItem` field.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkSaveDataItemsOptions {
+    /** ID of the collection in which to insert or update the items. */
+    dataCollectionId: string;
+    /** Data items to insert or update. */
+    dataItems: DataItem[];
+    /**
+     * Whether to return the saved data item.
+     * When `true`, the `results` objects contain a `dataItem` field.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkRemoveDataItemsOptions {
+    /** ID of the collection from which to remove the item. */
+    dataCollectionId: string;
+    /** IDs of data items to remove. */
+    dataItemIds: string[];
+}
+interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
+    /** ID of the collection containing the referring item. */
+    dataCollectionId: string;
+    /** ID of the referring item. */
+    referringItemId?: string;
+    /** Field containing references in the referring item. */
+    referringItemFieldName?: string;
+    /** Order of the returned referenced items. Sorted by the date each item was referenced. */
+    order?: SortOrder;
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging$1;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Whether to return the total count in the response.
+     * When `true`, the `pagingMetadata` object in the response contains a `total` field.
+     *
+     * Default: `false`
+     */
+    returnTotalCount?: boolean;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+    /**
+     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * If provided, the result text is returned in the specified language.
+     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * If not provided, result text is not translated.
+     */
+    language?: string | null;
+    /**
+     * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
+     * **Note:** The `_id` system field is always returned.
+     */
+    fields?: string[];
+}
+interface IsReferencedDataItemOptions {
+    /** ID of the collection containing the referring data item. */
+    dataCollectionId: string;
+    /** Field to check for a reference to the item that may be referenced. */
+    referringItemFieldName: string;
+    /** ID of the referring item. */
+    referringItemId: string;
+    /** ID of the item that may be referenced. */
+    referencedItemId: string;
+    /**
+     * 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.
+     *
+     * Default: `false`
+     */
+    consistentRead?: boolean;
+}
+interface InsertDataItemReferenceOptions {
+    /** ID of the collection in which to insert the reference. */
+    dataCollectionId: string;
+    /** Reference to insert */
+    dataItemReference?: DataItemReference;
+}
+interface RemoveDataItemReferenceOptions {
+    /** ID of the collection containing the referring item. */
+    dataCollectionId: string;
+    /** Reference to remove. */
+    dataItemReference: DataItemReference;
+}
+interface BulkInsertDataItemReferencesOptions {
+    /** ID of the collection containing the referring items. */
+    dataCollectionId: string;
+    /** References to insert. */
+    dataItemReferences: DataItemReference[];
+    /**
+     * Whether to return the inserted data item references.
+     * When `true`, the `results` objects contain a `dataItemReference` field.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkRemoveDataItemReferencesOptions {
+    /** ID of the collection containing the referring items. */
+    dataCollectionId: string;
+    /** References to remove. */
+    dataItemReferences: DataItemReference[];
+}
+interface ReplaceDataItemReferencesOptions {
+    /** ID of the collection containing the referring item. */
+    dataCollectionId: string;
+    /** Field containing references in the referring item. */
+    referringItemFieldName: string;
+    /** ID of the referring item. */
+    referringItemId: string;
+    /** List of new referenced item IDs to replace the existing ones. */
+    newReferencedItemIds?: string[];
+}
+
+declare function insertDataItem$1(httpClient: HttpClient): (options: InsertDataItemOptions) => Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
+declare function updateDataItem$1(httpClient: HttpClient): (_id: string, options: UpdateDataItemOptions) => Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
+declare function saveDataItem$1(httpClient: HttpClient): (options: SaveDataItemOptions) => Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
+declare function getDataItem$1(httpClient: HttpClient): (dataItemId: string, options?: GetDataItemOptions) => Promise<DataItem & {
+    _id: string;
+    dataCollectionId: string;
+}>;
+declare function removeDataItem$1(httpClient: HttpClient): (dataItemId: string, options: RemoveDataItemOptions) => Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
+declare function truncateDataItems$1(httpClient: HttpClient): (options: TruncateDataItemsOptions) => Promise<void>;
+declare function queryDataItems$1(httpClient: HttpClient): (options: QueryDataItemsOptions) => DataItemsQueryBuilder;
+declare function aggregateDataItems$1(httpClient: HttpClient): (options?: AggregateDataItemsOptions) => Promise<AggregateDataItemsResponse>;
+declare function countDataItems$1(httpClient: HttpClient): (options?: CountDataItemsOptions) => Promise<CountDataItemsResponse & CountDataItemsResponseNonNullableFields>;
+declare function queryDistinctValues$1(httpClient: HttpClient): (options?: QueryDistinctValuesOptions) => Promise<QueryDistinctValuesResponse>;
+declare function bulkInsertDataItems$1(httpClient: HttpClient): (options?: BulkInsertDataItemsOptions) => Promise<BulkInsertDataItemsResponse & BulkInsertDataItemsResponseNonNullableFields>;
+declare function bulkUpdateDataItems$1(httpClient: HttpClient): (options?: BulkUpdateDataItemsOptions) => Promise<BulkUpdateDataItemsResponse & BulkUpdateDataItemsResponseNonNullableFields>;
+declare function bulkSaveDataItems$1(httpClient: HttpClient): (options?: BulkSaveDataItemsOptions) => Promise<BulkSaveDataItemsResponse & BulkSaveDataItemsResponseNonNullableFields>;
+declare function bulkRemoveDataItems$1(httpClient: HttpClient): (options: BulkRemoveDataItemsOptions) => Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
+declare function queryReferencedDataItems$1(httpClient: HttpClient): (options?: QueryReferencedDataItemsOptions) => Promise<QueryReferencedDataItemsResponse & QueryReferencedDataItemsResponseNonNullableFields>;
+declare function isReferencedDataItem$1(httpClient: HttpClient): (options?: IsReferencedDataItemOptions) => Promise<IsReferencedDataItemResponse & IsReferencedDataItemResponseNonNullableFields>;
+declare function insertDataItemReference$1(httpClient: HttpClient): (options?: InsertDataItemReferenceOptions) => Promise<InsertDataItemReferenceResponse & InsertDataItemReferenceResponseNonNullableFields>;
+declare function removeDataItemReference$1(httpClient: HttpClient): (options: RemoveDataItemReferenceOptions) => Promise<RemoveDataItemReferenceResponse & RemoveDataItemReferenceResponseNonNullableFields>;
+declare function bulkInsertDataItemReferences$1(httpClient: HttpClient): (options?: BulkInsertDataItemReferencesOptions) => Promise<BulkInsertDataItemReferencesResponse & BulkInsertDataItemReferencesResponseNonNullableFields>;
+declare function bulkRemoveDataItemReferences$1(httpClient: HttpClient): (options: BulkRemoveDataItemReferencesOptions) => Promise<BulkRemoveDataItemReferencesResponse & BulkRemoveDataItemReferencesResponseNonNullableFields>;
+declare function replaceDataItemReferences$1(httpClient: HttpClient): (options?: ReplaceDataItemReferencesOptions) => Promise<ReplaceDataItemReferencesResponse & ReplaceDataItemReferencesResponseNonNullableFields>;
+declare const onDataItemCreated$1: EventDefinition<DataItemCreatedEnvelope, "wix.data.v2.data_item_created">;
+declare const onDataItemUpdated$1: EventDefinition<DataItemUpdatedEnvelope, "wix.data.v2.data_item_updated">;
+declare const onDataItemDeleted$1: EventDefinition<DataItemDeletedEnvelope, "wix.data.v2.data_item_deleted">;
+
+declare const insertDataItem: BuildRESTFunction<typeof insertDataItem$1>;
+declare const updateDataItem: BuildRESTFunction<typeof updateDataItem$1>;
+declare const saveDataItem: BuildRESTFunction<typeof saveDataItem$1>;
+declare const getDataItem: BuildRESTFunction<typeof getDataItem$1>;
+declare const removeDataItem: BuildRESTFunction<typeof removeDataItem$1>;
+declare const truncateDataItems: BuildRESTFunction<typeof truncateDataItems$1>;
+declare const queryDataItems: BuildRESTFunction<typeof queryDataItems$1>;
+declare const aggregateDataItems: BuildRESTFunction<typeof aggregateDataItems$1>;
+declare const countDataItems: BuildRESTFunction<typeof countDataItems$1>;
+declare const queryDistinctValues: BuildRESTFunction<typeof queryDistinctValues$1>;
+declare const bulkInsertDataItems: BuildRESTFunction<typeof bulkInsertDataItems$1>;
+declare const bulkUpdateDataItems: BuildRESTFunction<typeof bulkUpdateDataItems$1>;
+declare const bulkSaveDataItems: BuildRESTFunction<typeof bulkSaveDataItems$1>;
+declare const bulkRemoveDataItems: BuildRESTFunction<typeof bulkRemoveDataItems$1>;
+declare const queryReferencedDataItems: BuildRESTFunction<typeof queryReferencedDataItems$1>;
+declare const isReferencedDataItem: BuildRESTFunction<typeof isReferencedDataItem$1>;
+declare const insertDataItemReference: BuildRESTFunction<typeof insertDataItemReference$1>;
+declare const removeDataItemReference: BuildRESTFunction<typeof removeDataItemReference$1>;
+declare const bulkInsertDataItemReferences: BuildRESTFunction<typeof bulkInsertDataItemReferences$1>;
+declare const bulkRemoveDataItemReferences: BuildRESTFunction<typeof bulkRemoveDataItemReferences$1>;
+declare const replaceDataItemReferences: BuildRESTFunction<typeof replaceDataItemReferences$1>;
+declare const onDataItemCreated: BuildEventDefinition<typeof onDataItemCreated$1>;
+declare const onDataItemUpdated: BuildEventDefinition<typeof onDataItemUpdated$1>;
+declare const onDataItemDeleted: BuildEventDefinition<typeof onDataItemDeleted$1>;
+
+declare const context$1_aggregateDataItems: typeof aggregateDataItems;
+declare const context$1_bulkInsertDataItemReferences: typeof bulkInsertDataItemReferences;
+declare const context$1_bulkInsertDataItems: typeof bulkInsertDataItems;
+declare const context$1_bulkRemoveDataItemReferences: typeof bulkRemoveDataItemReferences;
+declare const context$1_bulkRemoveDataItems: typeof bulkRemoveDataItems;
+declare const context$1_bulkSaveDataItems: typeof bulkSaveDataItems;
+declare const context$1_bulkUpdateDataItems: typeof bulkUpdateDataItems;
+declare const context$1_countDataItems: typeof countDataItems;
+declare const context$1_getDataItem: typeof getDataItem;
+declare const context$1_insertDataItem: typeof insertDataItem;
+declare const context$1_insertDataItemReference: typeof insertDataItemReference;
+declare const context$1_isReferencedDataItem: typeof isReferencedDataItem;
+declare const context$1_onDataItemCreated: typeof onDataItemCreated;
+declare const context$1_onDataItemDeleted: typeof onDataItemDeleted;
+declare const context$1_onDataItemUpdated: typeof onDataItemUpdated;
+declare const context$1_queryDataItems: typeof queryDataItems;
+declare const context$1_queryDistinctValues: typeof queryDistinctValues;
+declare const context$1_queryReferencedDataItems: typeof queryReferencedDataItems;
+declare const context$1_removeDataItem: typeof removeDataItem;
+declare const context$1_removeDataItemReference: typeof removeDataItemReference;
+declare const context$1_replaceDataItemReferences: typeof replaceDataItemReferences;
+declare const context$1_saveDataItem: typeof saveDataItem;
+declare const context$1_truncateDataItems: typeof truncateDataItems;
+declare const context$1_updateDataItem: typeof updateDataItem;
+declare namespace context$1 {
+  export { context$1_aggregateDataItems as aggregateDataItems, context$1_bulkInsertDataItemReferences as bulkInsertDataItemReferences, context$1_bulkInsertDataItems as bulkInsertDataItems, context$1_bulkRemoveDataItemReferences as bulkRemoveDataItemReferences, context$1_bulkRemoveDataItems as bulkRemoveDataItems, context$1_bulkSaveDataItems as bulkSaveDataItems, context$1_bulkUpdateDataItems as bulkUpdateDataItems, context$1_countDataItems as countDataItems, context$1_getDataItem as getDataItem, context$1_insertDataItem as insertDataItem, context$1_insertDataItemReference as insertDataItemReference, context$1_isReferencedDataItem as isReferencedDataItem, context$1_onDataItemCreated as onDataItemCreated, context$1_onDataItemDeleted as onDataItemDeleted, context$1_onDataItemUpdated as onDataItemUpdated, context$1_queryDataItems as queryDataItems, context$1_queryDistinctValues as queryDistinctValues, context$1_queryReferencedDataItems as queryReferencedDataItems, context$1_removeDataItem as removeDataItem, context$1_removeDataItemReference as removeDataItemReference, context$1_replaceDataItemReferences as replaceDataItemReferences, context$1_saveDataItem as saveDataItem, context$1_truncateDataItems as truncateDataItems, context$1_updateDataItem as updateDataItem };
+}
+
+/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
+interface Index {
+    /** Name of the index. */
+    name?: string;
+    /**
+     * Fields for which the index is defined.
+     *
+     * Max: 3 fields (for a unique index: 1 field)
+     */
+    fields?: Field[];
+    /**
+     * Current status of the index.
+     * - `BUILDING`: Index creation is in progress.
+     * - `ACTIVE`: Index has been successfully created and can be used in queries.
+     * - `DROPPING`: Index is in the process of being dropped.
+     * - `DROPPED`: Index has been dropped successfully.
+     * - `FAILED`: Index creation has failed.
+     * - `INVALID`: Index contains incorrectly indexed data.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Contains details about the reasons for failure when `status` is `FAILED`.
+     * @readonly
+     */
+    failure?: Failure;
+    /**
+     * Whether the index enforces uniqueness of values in the field for which it is defined.
+     * If `true`, the index can have only one field.
+     *
+     * Default: `false`
+     */
+    unique?: boolean;
+    /**
+     * Whether the index ignores case.
+     *
+     * Default: `false`
+     */
+    caseInsensitive?: boolean;
+}
+/**
+ * Order determines how values are ordered in the index. This is important when
+ * ordering and/or range querying by indexed fields.
+ */
+declare enum Order {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Field {
+    /** Path of the field to index. For example: `title` or `options.price`. */
+    path?: string;
+    /**
+     * Sort order for the index. Base on how the data is regularly queried.
+     *
+     * Default: `ASC`
+     */
+    order?: Order;
+}
+declare enum Status {
+    /** Place holder. Never returned by the service. */
+    UNKNOWN = "UNKNOWN",
+    /** Index creation is in progress. */
+    BUILDING = "BUILDING",
+    /** Index has been successfully created and can be used in queries. */
+    ACTIVE = "ACTIVE",
+    /** Index is in the process of being dropped. */
+    DROPPING = "DROPPING",
+    /** Index has been dropped successfully. */
+    DROPPED = "DROPPED",
+    /** Index creation has failed. */
+    FAILED = "FAILED",
+    /** Index contains incorrectly indexed data. */
+    INVALID = "INVALID"
+}
+interface Failure {
+    /**
+     * Error code.
+     * - `WDE0112`: Unknown error while building collection index.
+     * - `WDE0113`: Duplicate key error while building collection index.
+     * - `WDE0114`: Document too large while building collection index.
+     */
+    code?: string;
+    /** Description of the failure. */
+    description?: string;
+    /**
+     * ID of the data item that caused the failure.
+     * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
+     */
+    itemId?: string | null;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface ListIndexesResponse {
+    /** List of all indexes for the requested data collection. */
+    indexes?: Index[];
+    /** Paging metadata */
+    pagingMetadata?: PagingMetadata;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface ListIndexesResponseNonNullableFields {
+    indexes: {
+        name: string;
+        fields: {
+            path: string;
+            order: Order;
+        }[];
+        status: Status;
+        failure?: {
+            code: string;
+            description: string;
+        };
+        unique: boolean;
+        caseInsensitive: boolean;
+    }[];
+}
+interface ListIndexesOptions {
+    /** paging */
+    paging?: Paging;
+}
+
+declare function createIndex$1(httpClient: HttpClient): (dataCollectionId: string, index: Index) => Promise<Index & {
+    name: string;
+    fields: {
+        path: string;
+        order: Order;
+    }[];
+    status: Status;
+    failure?: {
+        code: string;
+        description: string;
+    } | undefined;
+    unique: boolean;
+    caseInsensitive: boolean;
+}>;
+declare function dropIndex$1(httpClient: HttpClient): (dataCollectionId: string, indexName: string) => Promise<void>;
+declare function listIndexes$1(httpClient: HttpClient): (dataCollectionId: string, options?: ListIndexesOptions) => Promise<ListIndexesResponse & ListIndexesResponseNonNullableFields>;
+
+declare const createIndex: BuildRESTFunction<typeof createIndex$1>;
+declare const dropIndex: BuildRESTFunction<typeof dropIndex$1>;
+declare const listIndexes: BuildRESTFunction<typeof listIndexes$1>;
+
+declare const context_createIndex: typeof createIndex;
+declare const context_dropIndex: typeof dropIndex;
+declare const context_listIndexes: typeof listIndexes;
+declare namespace context {
+  export { context_createIndex as createIndex, context_dropIndex as dropIndex, context_listIndexes as listIndexes };
+}
+
+export { context$2 as collections, context$3 as externalDatabaseConnections, context as indexes, context$1 as items };