@appwrite.io/console 5.0.0 → 7.0.0-rc.1

package/types/services/vectors-db.d.ts

@@ -0,0 +1,854 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { Model } from '../enums/model';
+import { UsageRange } from '../enums/usage-range';
+import { VectorsDBIndexType } from '../enums/vectors-db-index-type';
+import { OrderBy } from '../enums/order-by';
+export declare class VectorsDB {
+    client: Client;
+    constructor(client: Client);
+    /**
+     *
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DatabaseList>}
+     */
+    list(params?: {
+        queries?: string[];
+        search?: string;
+        total?: boolean;
+    }): Promise<Models.DatabaseList>;
+    /**
+     *
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DatabaseList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    list(queries?: string[], search?: string, total?: boolean): Promise<Models.DatabaseList>;
+    /**
+     *
+     * @param {string} params.databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} params.name - Database name. Max length: 128 chars.
+     * @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     */
+    create(params: {
+        databaseId: string;
+        name: string;
+        enabled?: boolean;
+    }): Promise<Models.Database>;
+    /**
+     *
+     * @param {string} databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} name - Database name. Max length: 128 chars.
+     * @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
+    /**
+     *
+     * @param {string[]} params.texts - Array of text to generate embeddings.
+     * @param {Model} params.model - The embedding model to use for generating vector embeddings.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EmbeddingList>}
+     */
+    createTextEmbeddings(params: {
+        texts: string[];
+        model?: Model;
+    }): Promise<Models.EmbeddingList>;
+    /**
+     *
+     * @param {string[]} texts - Array of text to generate embeddings.
+     * @param {Model} model - The embedding model to use for generating vector embeddings.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EmbeddingList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createTextEmbeddings(texts: string[], model?: Model): Promise<Models.EmbeddingList>;
+    /**
+     *
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TransactionList>}
+     */
+    listTransactions(params?: {
+        queries?: string[];
+    }): Promise<Models.TransactionList>;
+    /**
+     *
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TransactionList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listTransactions(queries?: string[]): Promise<Models.TransactionList>;
+    /**
+     *
+     * @param {number} params.ttl - Seconds before the transaction expires.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     */
+    createTransaction(params?: {
+        ttl?: number;
+    }): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {number} ttl - Seconds before the transaction expires.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createTransaction(ttl?: number): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} params.transactionId - Transaction ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     */
+    getTransaction(params: {
+        transactionId: string;
+    }): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} transactionId - Transaction ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getTransaction(transactionId: string): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} params.transactionId - Transaction ID.
+     * @param {boolean} params.commit - Commit transaction?
+     * @param {boolean} params.rollback - Rollback transaction?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     */
+    updateTransaction(params: {
+        transactionId: string;
+        commit?: boolean;
+        rollback?: boolean;
+    }): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} transactionId - Transaction ID.
+     * @param {boolean} commit - Commit transaction?
+     * @param {boolean} rollback - Rollback transaction?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateTransaction(transactionId: string, commit?: boolean, rollback?: boolean): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} params.transactionId - Transaction ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteTransaction(params: {
+        transactionId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} transactionId - Transaction ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteTransaction(transactionId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.transactionId - Transaction ID.
+     * @param {object[]} params.operations - Array of staged operations.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     */
+    createOperations(params: {
+        transactionId: string;
+        operations?: object[];
+    }): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {string} transactionId - Transaction ID.
+     * @param {object[]} operations - Array of staged operations.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Transaction>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createOperations(transactionId: string, operations?: object[]): Promise<Models.Transaction>;
+    /**
+     *
+     * @param {UsageRange} params.range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageVectorsDBs>}
+     */
+    listUsage(params?: {
+        range?: UsageRange;
+    }): Promise<Models.UsageVectorsDBs>;
+    /**
+     *
+     * @param {UsageRange} range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageVectorsDBs>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listUsage(range?: UsageRange): Promise<Models.UsageVectorsDBs>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     */
+    get(params: {
+        databaseId: string;
+    }): Promise<Models.Database>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    get(databaseId: string): Promise<Models.Database>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.name - Database name. Max length: 128 chars.
+     * @param {boolean} params.enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     */
+    update(params: {
+        databaseId: string;
+        name: string;
+        enabled?: boolean;
+    }): Promise<Models.Database>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} name - Database name. Max length: 128 chars.
+     * @param {boolean} enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Database>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(params: {
+        databaseId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    delete(databaseId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollectionList>}
+     */
+    listCollections(params: {
+        databaseId: string;
+        queries?: string[];
+        search?: string;
+        total?: boolean;
+    }): Promise<Models.VectorsdbCollectionList>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollectionList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCollections(databaseId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.VectorsdbCollectionList>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} params.name - Collection name. Max length: 128 chars.
+     * @param {number} params.dimension - Embedding dimension.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     */
+    createCollection(params: {
+        databaseId: string;
+        collectionId: string;
+        name: string;
+        dimension: number;
+        permissions?: string[];
+        documentSecurity?: boolean;
+        enabled?: boolean;
+    }): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {string} name - Collection name. Max length: 128 chars.
+     * @param {number} dimension - Embedding dimension.
+     * @param {string[]} permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createCollection(databaseId: string, collectionId: string, name: string, dimension: number, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     */
+    getCollection(params: {
+        databaseId: string;
+        collectionId: string;
+    }): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getCollection(databaseId: string, collectionId: string): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.name - Collection name. Max length: 128 chars.
+     * @param {number} params.dimension - Embedding dimensions.
+     * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     */
+    updateCollection(params: {
+        databaseId: string;
+        collectionId: string;
+        name: string;
+        dimension?: number;
+        permissions?: string[];
+        documentSecurity?: boolean;
+        enabled?: boolean;
+    }): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} name - Collection name. Max length: 128 chars.
+     * @param {number} dimension - Embedding dimensions.
+     * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VectorsdbCollection>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateCollection(databaseId: string, collectionId: string, name: string, dimension?: number, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.VectorsdbCollection>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteCollection(params: {
+        databaseId: string;
+        collectionId: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     */
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        queries?: string[];
+        transactionId?: string;
+        total?: boolean;
+        ttl?: number;
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {string} params.documentId - Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>} params.data - Document data as JSON object.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    createDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>;
+        permissions?: string[];
+    }): Promise<Document>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {string} documentId - Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>} data - Document data as JSON object.
+     * @param {string[]} permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {object[]} params.documents - Array of documents data as JSON objects.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     */
+    createDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documents: object[];
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.
+     * @param {object[]} documents - Array of documents data as JSON objects.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {object[]} params.documents - Array of document data as JSON objects. May contain partial documents.
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     */
+    upsertDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documents: object[];
+        transactionId?: string;
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {object[]} documents - Array of document data as JSON objects. May contain partial documents.
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    upsertDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documents: object[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {object} params.data - Document data as JSON object. Include only attribute and value pairs to be updated.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     */
+    updateDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        data?: object;
+        queries?: string[];
+        transactionId?: string;
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {object} data - Document data as JSON object. Include only attribute and value pairs to be updated.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, data?: object, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     */
+    deleteDocuments<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        queries?: string[];
+        transactionId?: string;
+    }): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DocumentList<Document>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.documentId - Document ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    getDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        queries?: string[];
+        transactionId?: string;
+    }): Promise<Document>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} documentId - Document ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, queries?: string[], transactionId?: string): Promise<Document>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} params.data - Document data as JSON object. Include all required fields of the document to be created or updated.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    upsertDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>;
+        permissions?: string[];
+        transactionId?: string;
+    }): Promise<Document>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} data - Document data as JSON object. Include all required fields of the document to be created or updated.
+     * @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    upsertDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>, permissions?: string[], transactionId?: string): Promise<Document>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} params.data - Document data as JSON object. Include only fields and value pairs to be updated.
+     * @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    updateDocument<Document extends Models.Document = Models.DefaultDocument>(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>;
+        permissions?: string[];
+        transactionId?: string;
+    }): Promise<Document>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} documentId - Document ID.
+     * @param {Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>} data - Document data as JSON object. Include only fields and value pairs to be updated.
+     * @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>, permissions?: string[], transactionId?: string): Promise<Document>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.documentId - Document ID.
+     * @param {string} params.transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteDocument(params: {
+        databaseId: string;
+        collectionId: string;
+        documentId: string;
+        transactionId?: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} documentId - Document ID.
+     * @param {string} transactionId - Transaction ID for staging the operation.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteDocument(databaseId: string, collectionId: string, documentId: string, transactionId?: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.IndexList>}
+     */
+    listIndexes(params: {
+        databaseId: string;
+        collectionId: string;
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.IndexList>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.IndexList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listIndexes(databaseId: string, collectionId: string, queries?: string[], total?: boolean): Promise<Models.IndexList>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.key - Index Key.
+     * @param {VectorsDBIndexType} params.type - Index type.
+     * @param {string[]} params.attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
+     * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
+     * @param {number[]} params.lengths - Length of index. Maximum of 100
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Index>}
+     */
+    createIndex(params: {
+        databaseId: string;
+        collectionId: string;
+        key: string;
+        type: VectorsDBIndexType;
+        attributes: string[];
+        orders?: OrderBy[];
+        lengths?: number[];
+    }): Promise<Models.Index>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} key - Index Key.
+     * @param {VectorsDBIndexType} type - Index type.
+     * @param {string[]} attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
+     * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
+     * @param {number[]} lengths - Length of index. Maximum of 100
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Index>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createIndex(databaseId: string, collectionId: string, key: string, type: VectorsDBIndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.key - Index Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Index>}
+     */
+    getIndex(params: {
+        databaseId: string;
+        collectionId: string;
+        key: string;
+    }): Promise<Models.Index>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} key - Index Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Index>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.key - Index Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteIndex(params: {
+        databaseId: string;
+        collectionId: string;
+        key: string;
+    }): Promise<{}>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} key - Index Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LogList>}
+     */
+    listCollectionLogs(params: {
+        databaseId: string;
+        collectionId: string;
+        queries?: string[];
+    }): Promise<Models.LogList>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LogList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {UsageRange} params.range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageCollection>}
+     */
+    getCollectionUsage(params: {
+        databaseId: string;
+        collectionId: string;
+        range?: UsageRange;
+    }): Promise<Models.UsageCollection>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {UsageRange} range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageCollection>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getCollectionUsage(databaseId: string, collectionId: string, range?: UsageRange): Promise<Models.UsageCollection>;
+    /**
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {UsageRange} params.range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageVectorsDB>}
+     */
+    getUsage(params: {
+        databaseId: string;
+        range?: UsageRange;
+    }): Promise<Models.UsageVectorsDB>;
+    /**
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {UsageRange} range - Date range.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageVectorsDB>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getUsage(databaseId: string, range?: UsageRange): Promise<Models.UsageVectorsDB>;
+}