@wix/auto_sdk_data_indexes 1.0.0

package/build/cjs/src/data-v2-index-indexes.meta.js

@@ -0,0 +1,104 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listAvailableIndexes = exports.listIndexes = exports.dropIndex = exports.createIndex = void 0;
+const ambassadorWixDataV2Index = __importStar(require("./data-v2-index-indexes.http.js"));
+function createIndex() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV2Index.createIndex(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'POST',
+        path: '/v2/indexes',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.createIndex = createIndex;
+function dropIndex() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV2Index.dropIndex(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'DELETE',
+        path: '/v2/indexes',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.dropIndex = dropIndex;
+function listIndexes() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV2Index.listIndexes(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v2/indexes',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.listIndexes = listIndexes;
+function listAvailableIndexes() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixDataV2Index.listAvailableIndexes(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v2/indexes/available',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+exports.listAvailableIndexes = listAvailableIndexes;
+//# sourceMappingURL=data-v2-index-indexes.meta.js.map

package/build/cjs/src/data-v2-index-indexes.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-v2-index-indexes.meta.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0FAA4E;AAsB5E,SAAgB,WAAW;IAUzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA7BD,kCA6BC;AAED,SAAgB,SAAS;IAQvB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAEtE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,QAAQ;QACpB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA3BD,8BA2BC;AAED,SAAgB,WAAW;IAUzB,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA7BD,kCA6BC;AAED,SAAgB,oBAAoB;IAUlC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,wBAAwB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,uBAAuB;QAC7B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AA9BD,oDA8BC"}

package/build/cjs/src/data-v2-index-indexes.public.d.ts

@@ -0,0 +1,51 @@
+import { HttpClient } from '@wix/sdk-types';
+import { Index, IndexNonNullableFields, ListIndexesOptions, ListIndexesResponse, ListIndexesResponseNonNullableFields } from './data-v2-index-indexes.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function createIndex(httpClient: HttpClient): CreateIndexSignature;
+interface CreateIndexSignature {
+    /**
+     * Creates an index for a data collection.
+     *
+     * The index can't be used immediately, as the process of generating the index takes time.
+     * You can check whether an index is ready by calling List Indexes.
+     *
+     * Note that when an index fails to create, the failed index still occupies a slot.
+     * To remove the failed index and free up the slot for a new index, call Drop Index.
+     * @param - ID of the data collection for which to generate the index.
+     * @param - Details of the index to be created.
+     * @param - Options for creating an index.
+     * @returns Details of the index being generated.
+     */
+    (dataCollectionId: string, index: Index): Promise<Index & IndexNonNullableFields>;
+}
+export declare function dropIndex(httpClient: HttpClient): DropIndexSignature;
+interface DropIndexSignature {
+    /**
+     * Removes an index from a data collection.
+     *
+     * The process of dropping an index from a collection takes time.
+     * You can check whether an index has been dropped by calling List Indexes.
+     * @param - ID of the data collection for which the index to be dropped is defined.
+     * @param - Name of the index to drop.
+     * @param - Options for dropping an index.
+     */
+    (dataCollectionId: string, indexName: string): Promise<void>;
+}
+export declare function listIndexes(httpClient: HttpClient): ListIndexesSignature;
+interface ListIndexesSignature {
+    /**
+     * Lists all indexes defined for a data collection.
+     *
+     * When an index's status is `ACTIVE`, it is ready to use.
+     * While it is still being created, its status is `BUILDING`.
+     *
+     * When an index's status is `DROPPED`, it has been dropped successfully.
+     * While it is still in the process of being removed, its status is `DROPPING`.
+     * @param - ID of the data collection for which to list indexes.
+     * @param - Options for retrieving a list of indexes.
+     */
+    (dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse & ListIndexesResponseNonNullableFields>;
+}
+export { CreateIndexRequest, CreateIndexResponse, CreateIndexResponseNonNullableFields, DropIndexRequest, DropIndexResponse, Environment, Failure, Field, Index, IndexNonNullableFields, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListAvailableIndexesResponseNonNullableFields, ListIndexesOptions, ListIndexesRequest, ListIndexesResponse, ListIndexesResponseNonNullableFields, Order, Paging, PagingMetadata, Status, } from './data-v2-index-indexes.universal.js';

package/build/cjs/src/data-v2-index-indexes.public.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Status = exports.Order = exports.Environment = exports.listAvailableIndexes = exports.listIndexes = exports.dropIndex = exports.createIndex = exports.__metadata = void 0;
+const data_v2_index_indexes_universal_js_1 = require("./data-v2-index-indexes.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/data' };
+function createIndex(httpClient) {
+    return (dataCollectionId, index) => (0, data_v2_index_indexes_universal_js_1.createIndex)(dataCollectionId, index, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.createIndex = createIndex;
+function dropIndex(httpClient) {
+    return (dataCollectionId, indexName) => (0, data_v2_index_indexes_universal_js_1.dropIndex)(dataCollectionId, indexName, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.dropIndex = dropIndex;
+function listIndexes(httpClient) {
+    return (dataCollectionId, options) => (0, data_v2_index_indexes_universal_js_1.listIndexes)(dataCollectionId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.listIndexes = listIndexes;
+/** @internal */
+function listAvailableIndexes(httpClient) {
+    return (dataCollectionId) => (0, data_v2_index_indexes_universal_js_1.listAvailableIndexes)(dataCollectionId, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.listAvailableIndexes = listAvailableIndexes;
+var data_v2_index_indexes_universal_js_2 = require("./data-v2-index-indexes.universal.js");
+Object.defineProperty(exports, "Environment", { enumerable: true, get: function () { return data_v2_index_indexes_universal_js_2.Environment; } });
+Object.defineProperty(exports, "Order", { enumerable: true, get: function () { return data_v2_index_indexes_universal_js_2.Order; } });
+Object.defineProperty(exports, "Status", { enumerable: true, get: function () { return data_v2_index_indexes_universal_js_2.Status; } });
+//# sourceMappingURL=data-v2-index-indexes.public.js.map

package/build/cjs/src/data-v2-index-indexes.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-v2-index-indexes.public.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.public.ts"],"names":[],"mappings":";;;AACA,6FAY8C;AAEjC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,KAAY,EAAE,EAAE,CAChD,IAAA,gDAAoB,EAClB,gBAAgB,EAChB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAqBD,SAAgB,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,SAAiB,EAAE,EAAE,CACrD,IAAA,8CAAkB,EAChB,gBAAgB,EAChB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8BAQC;AAeD,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,gBAAwB,EAAE,OAA4B,EAAE,EAAE,CAChE,IAAA,gDAAoB,EAClB,gBAAgB,EAChB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAmBD,gBAAgB;AAChB,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,IAAA,yDAA6B,EAC3B,gBAAgB;IAChB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,oDASC;AAYD,2FAsB8C;AAhB5C,iIAAA,WAAW,OAAA;AAYX,2HAAA,KAAK,OAAA;AAGL,4HAAA,MAAM,OAAA"}

package/build/cjs/src/data-v2-index-indexes.types.d.ts

@@ -0,0 +1,181 @@
+/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
+export 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.
+     * @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.
+ */
+export declare enum Order {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export 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"
+}
+export 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;
+}
+export interface CreateIndexRequest {
+    /** Details of the index to be created. */
+    index: Index;
+    /** ID of the data collection for which to generate the index. */
+    dataCollectionId: string;
+}
+export declare enum Environment {
+    LIVE = "LIVE",
+    SANDBOX = "SANDBOX",
+    SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
+}
+export interface CreateIndexResponse {
+    /** Details of the index being generated. */
+    index?: Index;
+}
+export interface DropIndexRequest {
+    /** Name of the index to drop. */
+    indexName: string;
+    /** ID of the data collection for which the index to be dropped is defined. */
+    dataCollectionId: string;
+}
+export interface DropIndexResponse {
+}
+export interface ListIndexesRequest {
+    /** ID of the data collection for which to list indexes. */
+    dataCollectionId: string;
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListIndexesResponse {
+    /** List of all indexes for the requested data collection. */
+    indexes?: Index[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadata;
+}
+export 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;
+}
+export interface ListAvailableIndexesRequest {
+    /** Data collection to show available indexes for */
+    dataCollectionId: string;
+}
+export interface ListAvailableIndexesResponse {
+    /**
+     * limit of regular single-field indexes, even if 0 1-field indices may be created using
+     * 3-field quota (if available)
+     */
+    regular1Field?: number;
+    /** limit of regular indexes up to 3-fields (in addition to 1-field indexes quota) */
+    regular3Field?: number;
+    /** limit of unique indexes */
+    unique1Field?: number;
+    /** Overall index limit, missing value means there's no overall limit */
+    total?: number | null;
+}
+interface FieldNonNullableFields {
+    path: string;
+    order: Order;
+}
+interface FailureNonNullableFields {
+    code: string;
+    broadCode: string;
+    description: string;
+}
+interface IndexNonNullableFields {
+    name: string;
+    fields: FieldNonNullableFields[];
+    status: Status;
+    failure?: FailureNonNullableFields;
+    unique: boolean;
+    caseInsensitive: boolean;
+}
+export interface CreateIndexResponseNonNullableFields {
+    index?: IndexNonNullableFields;
+}
+export interface ListIndexesResponseNonNullableFields {
+    indexes: IndexNonNullableFields[];
+}
+export interface ListAvailableIndexesResponseNonNullableFields {
+    regular1Field: number;
+    regular3Field: number;
+    unique1Field: number;
+}
+export {};

package/build/cjs/src/data-v2-index-indexes.types.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = exports.Status = exports.Order = void 0;
+/**
+ * Order determines how values are ordered in the index. This is important when
+ * ordering and/or range querying by indexed fields.
+ */
+var Order;
+(function (Order) {
+    Order["ASC"] = "ASC";
+    Order["DESC"] = "DESC";
+})(Order || (exports.Order = Order = {}));
+var Status;
+(function (Status) {
+    /** Place holder. Never returned by the service. */
+    Status["UNKNOWN"] = "UNKNOWN";
+    /** Index creation is in progress. */
+    Status["BUILDING"] = "BUILDING";
+    /** Index has been successfully created and can be used in queries. */
+    Status["ACTIVE"] = "ACTIVE";
+    /** Index is in the process of being dropped. */
+    Status["DROPPING"] = "DROPPING";
+    /** Index has been dropped successfully. */
+    Status["DROPPED"] = "DROPPED";
+    /** Index creation has failed. */
+    Status["FAILED"] = "FAILED";
+    /** Index contains incorrectly indexed data. */
+    Status["INVALID"] = "INVALID";
+})(Status || (exports.Status = Status = {}));
+var Environment;
+(function (Environment) {
+    Environment["LIVE"] = "LIVE";
+    Environment["SANDBOX"] = "SANDBOX";
+    Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
+})(Environment || (exports.Environment = Environment = {}));
+//# sourceMappingURL=data-v2-index-indexes.types.js.map

package/build/cjs/src/data-v2-index-indexes.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-v2-index-indexes.types.js","sourceRoot":"","sources":["../../../src/data-v2-index-indexes.types.ts"],"names":[],"mappings":";;;AAmCA;;;GAGG;AACH,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,oBAAW,CAAA;IACX,sBAAa,CAAA;AACf,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAaD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,mDAAmD;IACnD,6BAAmB,CAAA;IACnB,qCAAqC;IACrC,+BAAqB,CAAA;IACrB,sEAAsE;IACtE,2BAAiB,CAAA;IACjB,gDAAgD;IAChD,+BAAqB,CAAA;IACrB,2CAA2C;IAC3C,6BAAmB,CAAA;IACnB,iCAAiC;IACjC,2BAAiB,CAAA;IACjB,+CAA+C;IAC/C,6BAAmB,CAAA;AACrB,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AA0BD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,kCAAmB,CAAA;IACnB,sDAAuC,CAAA;AACzC,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB"}

package/build/cjs/src/data-v2-index-indexes.universal.d.ts

@@ -0,0 +1,247 @@
+/** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
+export 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.
+     * @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.
+ */
+export declare enum Order {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export 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"
+}
+export 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;
+}
+export interface CreateIndexRequest {
+    /** Details of the index to be created. */
+    index: Index;
+    /** ID of the data collection for which to generate the index. */
+    dataCollectionId: string;
+}
+export declare enum Environment {
+    LIVE = "LIVE",
+    SANDBOX = "SANDBOX",
+    SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
+}
+export interface CreateIndexResponse {
+    /** Details of the index being generated. */
+    index?: Index;
+}
+export interface DropIndexRequest {
+    /** Name of the index to drop. */
+    indexName: string;
+    /** ID of the data collection for which the index to be dropped is defined. */
+    dataCollectionId: string;
+}
+export interface DropIndexResponse {
+}
+export interface ListIndexesRequest {
+    /** ID of the data collection for which to list indexes. */
+    dataCollectionId: string;
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListIndexesResponse {
+    /** List of all indexes for the requested data collection. */
+    indexes?: Index[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadata;
+}
+export 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;
+}
+export interface ListAvailableIndexesRequest {
+    /** Data collection to show available indexes for */
+    dataCollectionId: string;
+}
+export interface ListAvailableIndexesResponse {
+    /**
+     * limit of regular single-field indexes, even if 0 1-field indices may be created using
+     * 3-field quota (if available)
+     */
+    regular1Field?: number;
+    /** limit of regular indexes up to 3-fields (in addition to 1-field indexes quota) */
+    regular3Field?: number;
+    /** limit of unique indexes */
+    unique1Field?: number;
+    /** Overall index limit, missing value means there's no overall limit */
+    total?: number | null;
+}
+interface FieldNonNullableFields {
+    path: string;
+    order: Order;
+}
+interface FailureNonNullableFields {
+    code: string;
+    broadCode: string;
+    description: string;
+}
+export interface IndexNonNullableFields {
+    name: string;
+    fields: FieldNonNullableFields[];
+    status: Status;
+    failure?: FailureNonNullableFields;
+    unique: boolean;
+    caseInsensitive: boolean;
+}
+export interface CreateIndexResponseNonNullableFields {
+    index?: IndexNonNullableFields;
+}
+export interface ListIndexesResponseNonNullableFields {
+    indexes: IndexNonNullableFields[];
+}
+export interface ListAvailableIndexesResponseNonNullableFields {
+    regular1Field: number;
+    regular3Field: number;
+    unique1Field: number;
+}
+/**
+ * Creates an index for a data collection.
+ *
+ * The index can't be used immediately, as the process of generating the index takes time.
+ * You can check whether an index is ready by calling List Indexes.
+ *
+ * Note that when an index fails to create, the failed index still occupies a slot.
+ * To remove the failed index and free up the slot for a new index, call Drop Index.
+ * @param dataCollectionId - ID of the data collection for which to generate the index.
+ * @param index - Details of the index to be created.
+ * @public
+ * @requiredField dataCollectionId
+ * @requiredField index
+ * @requiredField index.fields
+ * @requiredField index.fields.path
+ * @requiredField index.name
+ * @param options - Options for creating an index.
+ * @permissionId WIX_DATA.CREATE_INDEX
+ * @permissionScope Manage Data Indexes
+ * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
+ * @applicableIdentity APP
+ * @returns Details of the index being generated.
+ * @fqn com.wixpress.cloud.data.api.index.IndexService.CreateIndex
+ */
+export declare function createIndex(dataCollectionId: string, index: Index): Promise<Index & IndexNonNullableFields>;
+/**
+ * Removes an index from a data collection.
+ *
+ * The process of dropping an index from a collection takes time.
+ * You can check whether an index has been dropped by calling List Indexes.
+ * @param dataCollectionId - ID of the data collection for which the index to be dropped is defined.
+ * @param indexName - Name of the index to drop.
+ * @public
+ * @requiredField dataCollectionId
+ * @requiredField indexName
+ * @param options - Options for dropping an index.
+ * @permissionId WIX_DATA.DROP_INDEX
+ * @permissionScope Manage Data Indexes
+ * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.index.IndexService.DropIndex
+ */
+export declare function dropIndex(dataCollectionId: string, indexName: string): Promise<void>;
+/**
+ * Lists all indexes defined for a data collection.
+ *
+ * When an index's status is `ACTIVE`, it is ready to use.
+ * While it is still being created, its status is `BUILDING`.
+ *
+ * When an index's status is `DROPPED`, it has been dropped successfully.
+ * While it is still in the process of being removed, its status is `DROPPING`.
+ * @param dataCollectionId - ID of the data collection for which to list indexes.
+ * @public
+ * @requiredField dataCollectionId
+ * @param options - Options for retrieving a list of indexes.
+ * @permissionId WIX_DATA.LIST_INDEXES
+ * @permissionScope Manage Data Indexes
+ * @permissionScopeId SCOPE.DC-DATA.INDEXES-MANAGE
+ * @applicableIdentity APP
+ * @fqn com.wixpress.cloud.data.api.index.IndexService.ListIndexes
+ */
+export declare function listIndexes(dataCollectionId: string, options?: ListIndexesOptions): Promise<ListIndexesResponse & ListIndexesResponseNonNullableFields>;
+export interface ListIndexesOptions {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+}
+export {};