@appwrite.io/console 0.0.1 → 0.0.2-preview-0.0

package/types/services/databases.d.ts

@@ -0,0 +1,494 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Databases extends Service {
+    constructor(client: Client);
+    /**
+     * List Databases
+     *
+     * Get a list of all databases from the current Appwrite project. You can use
+     * the search parameter to filter your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
+    /**
+     * Create Database
+     *
+     * Create a new Database.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create(databaseId: string, name: string): Promise<Models.Database>;
+    /**
+     * Get usage stats for the database
+     *
+     *
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(range?: string): Promise<Models.UsageDatabases>;
+    /**
+     * Get Database
+     *
+     * Get a database by its unique ID. This endpoint response returns a JSON
+     * object with the database metadata.
+     *
+     * @param {string} databaseId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(databaseId: string): Promise<Models.Database>;
+    /**
+     * Update Database
+     *
+     * Update a database by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    update(databaseId: string, name: string): Promise<Models.Database>;
+    /**
+     * Delete Database
+     *
+     * Delete a database by its unique ID. Only API keys with with databases.write
+     * scope can delete a database.
+     *
+     * @param {string} databaseId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(databaseId: string): Promise<{}>;
+    /**
+     * List Collections
+     *
+     * Get a list of all collections that belong to the provided databaseId. You
+     * can use the search parameter to filter your results.
+     *
+     * @param {string} databaseId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
+    /**
+     * Create Collection
+     *
+     * Create a new Collection. Before using this route, you should create a new
+     * database resource using either a [server
+     * integration](/docs/server/databases#databasesCreateCollection) API or
+     * directly from your database console.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} name
+     * @param {string[]} permissions
+     * @param {boolean} documentSecurity
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean): Promise<Models.Collection>;
+    /**
+     * Get Collection
+     *
+     * Get a collection by its unique ID. This endpoint response returns a JSON
+     * object with the collection metadata.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
+    /**
+     * Update Collection
+     *
+     * Update a collection by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} name
+     * @param {string[]} permissions
+     * @param {boolean} documentSecurity
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
+    /**
+     * Delete Collection
+     *
+     * Delete a collection by its unique ID. Only users with write permissions
+     * have access to delete this resource.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
+    /**
+     * List Attributes
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listAttributes(databaseId: string, collectionId: string): Promise<Models.AttributeList>;
+    /**
+     * Create Boolean Attribute
+     *
+     * Create a boolean attribute.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {boolean} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
+    /**
+     * Create DateTime Attribute
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
+    /**
+     * Create Email Attribute
+     *
+     * Create an email attribute.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
+    /**
+     * Create Enum Attribute
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {string[]} elements
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
+    /**
+     * Create Float Attribute
+     *
+     * Create a float attribute. Optionally, minimum and maximum values can be
+     * provided.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {number} min
+     * @param {number} max
+     * @param {number} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
+    /**
+     * Create Integer Attribute
+     *
+     * Create an integer attribute. Optionally, minimum and maximum values can be
+     * provided.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {number} min
+     * @param {number} max
+     * @param {number} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
+    /**
+     * Create IP Address Attribute
+     *
+     * Create IP address attribute.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
+    /**
+     * Create String Attribute
+     *
+     * Create a string attribute.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {number} size
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeString>;
+    /**
+     * Create URL Attribute
+     *
+     * Create a URL attribute.
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {boolean} required
+     * @param {string} xdefault
+     * @param {boolean} array
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
+    /**
+     * Get Attribute
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
+    /**
+     * Delete Attribute
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
+    /**
+     * List Documents
+     *
+     * Get a list of all the user's documents in a given collection. You can use
+     * the query params to filter your results.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.DocumentList<Document>>;
+    /**
+     * Create Document
+     *
+     * Create a new Document. Before using this route, you should create a new
+     * collection resource using either a [server
+     * integration](/docs/server/databases#databasesCreateCollection) API or
+     * directly from your database console.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {Omit<Document, keyof Models.Document>} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: Omit<Document, keyof Models.Document>, permissions?: string[]): Promise<Document>;
+    /**
+     * Get Document
+     *
+     * Get a document by its unique ID. This endpoint response returns a JSON
+     * object with the document data.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string): Promise<Document>;
+    /**
+     * Update Document
+     *
+     * Update a document by its unique ID. Using the patch method you can pass
+     * only specific fields that will get updated.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {Partial<Omit<Document, keyof Models.Document>>} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data?: Partial<Omit<Document, keyof Models.Document>>, permissions?: string[]): Promise<Document>;
+    /**
+     * Delete Document
+     *
+     * Delete a document by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
+    /**
+     * List Document Logs
+     *
+     * Get the document activity logs list by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * List Indexes
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listIndexes(databaseId: string, collectionId: string): Promise<Models.IndexList>;
+    /**
+     * Create Index
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @param {string} type
+     * @param {string[]} attributes
+     * @param {string[]} orders
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index>;
+    /**
+     * Get Index
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
+    /**
+     * Delete Index
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} key
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
+    /**
+     * List Collection Logs
+     *
+     * Get the collection activity logs list by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * Get usage stats for a collection
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection>;
+    /**
+     * List Database Logs
+     *
+     * Get the database activity logs list by its unique ID.
+     *
+     * @param {string} databaseId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * Get usage stats for the database
+     *
+     *
+     * @param {string} databaseId
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getDatabaseUsage(databaseId: string, range?: string): Promise<Models.UsageDatabase>;
+}