@appwrite.io/console 0.2.0 → 0.4.0

package/types/services/databases.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Databases extends Service {
     constructor(client: Client);
     /**
-     * List Databases
+     * List databases
      *
      * Get a list of all databases from the current Appwrite project. You can use
      * the search parameter to filter your results.
@@ -13,20 +13,21 @@ export declare class Databases extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
     /**
-     * Create Database
+     * Create database
      *
      * Create a new Database.
      *
      *
      * @param {string} databaseId
      * @param {string} name
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    create(databaseId: string, name: string): Promise<Models.Database>;
+    */
+    create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
      * Get usage stats for the database
      *
@@ -34,10 +35,10 @@ export declare class Databases extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageDatabases>;
     /**
-     * Get Database
+     * Get database
      *
      * Get a database by its unique ID. This endpoint response returns a JSON
      * object with the database metadata.
@@ -45,21 +46,22 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(databaseId: string): Promise<Models.Database>;
     /**
-     * Update Database
+     * Update database
      *
      * Update a database by its unique ID.
      *
      * @param {string} databaseId
      * @param {string} name
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    update(databaseId: string, name: string): Promise<Models.Database>;
+    */
+    update(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Delete Database
+     * Delete database
      *
      * Delete a database by its unique ID. Only API keys with with databases.write
      * scope can delete a database.
@@ -67,10 +69,10 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     delete(databaseId: string): Promise<{}>;
     /**
-     * List Collections
+     * List collections
      *
      * Get a list of all collections that belong to the provided databaseId. You
      * can use the search parameter to filter your results.
@@ -80,27 +82,28 @@ export declare class Databases extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
     /**
-     * Create Collection
+     * 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.
+     * integration](https://appwrite.io/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
+     * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean): Promise<Models.Collection>;
+    */
+    createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
     /**
-     * Get Collection
+     * Get collection
      *
      * Get a collection by its unique ID. This endpoint response returns a JSON
      * object with the collection metadata.
@@ -109,10 +112,10 @@ export declare class Databases extends Service {
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
     /**
-     * Update Collection
+     * Update collection
      *
      * Update a collection by its unique ID.
      *
@@ -124,10 +127,10 @@ export declare class Databases extends Service {
      * @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 collection
      *
      * Delete a collection by its unique ID. Only users with write permissions
      * have access to delete this resource.
@@ -136,20 +139,21 @@ export declare class Databases extends Service {
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
     /**
-     * List Attributes
+     * List attributes
      *
      *
      * @param {string} databaseId
      * @param {string} collectionId
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    listAttributes(databaseId: string, collectionId: string): Promise<Models.AttributeList>;
+    */
+    listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
     /**
-     * Create Boolean Attribute
+     * Create boolean attribute
      *
      * Create a boolean attribute.
      *
@@ -162,10 +166,10 @@ export declare class Databases extends Service {
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Update Boolean Attribute
+     * Update boolean attribute
      *
      *
      * @param {string} databaseId
@@ -175,10 +179,10 @@ export declare class Databases extends Service {
      * @param {boolean} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Create DateTime Attribute
+     * Create datetime attribute
      *
      *
      * @param {string} databaseId
@@ -189,10 +193,10 @@ export declare class Databases extends Service {
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
     /**
-     * Update DateTime Attribute
+     * Update dateTime attribute
      *
      *
      * @param {string} databaseId
@@ -202,10 +206,10 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
     /**
-     * Create Email Attribute
+     * Create email attribute
      *
      * Create an email attribute.
      *
@@ -218,10 +222,10 @@ export declare class Databases extends Service {
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
     /**
-     * Update Email Attribute
+     * Update email attribute
      *
      * Update an email attribute. Changing the `default` value will not update
      * already existing documents.
@@ -234,10 +238,10 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
     /**
-     * Create Enum Attribute
+     * Create enum attribute
      *
      *
      * @param {string} databaseId
@@ -249,10 +253,10 @@ export declare class Databases extends Service {
      * @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>;
     /**
-     * Update Enum Attribute
+     * Update enum attribute
      *
      * Update an enum attribute. Changing the `default` value will not update
      * already existing documents.
@@ -266,10 +270,10 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
     /**
-     * Create Float Attribute
+     * Create float attribute
      *
      * Create a float attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -285,10 +289,10 @@ export declare class Databases extends Service {
      * @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>;
     /**
-     * Update Float Attribute
+     * Update float attribute
      *
      * Update a float attribute. Changing the `default` value will not update
      * already existing documents.
@@ -303,10 +307,10 @@ export declare class Databases extends Service {
      * @param {number} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
     /**
-     * Create Integer Attribute
+     * Create integer attribute
      *
      * Create an integer attribute. Optionally, minimum and maximum values can be
      * provided.
@@ -322,10 +326,10 @@ export declare class Databases extends Service {
      * @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>;
     /**
-     * Update Integer Attribute
+     * Update integer attribute
      *
      * Update an integer attribute. Changing the `default` value will not update
      * already existing documents.
@@ -340,10 +344,10 @@ export declare class Databases extends Service {
      * @param {number} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
     /**
-     * Create IP Address Attribute
+     * Create IP address attribute
      *
      * Create IP address attribute.
      *
@@ -356,10 +360,10 @@ export declare class Databases extends Service {
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
     /**
-     * Update IP Address Attribute
+     * Update IP address attribute
      *
      * Update an ip attribute. Changing the `default` value will not update
      * already existing documents.
@@ -372,13 +376,13 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
     /**
-     * Create Relationship Attribute
+     * Create relationship attribute
      *
      * Create relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -391,10 +395,10 @@ export declare class Databases extends Service {
      * @param {string} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
-     * Create String Attribute
+     * Create string attribute
      *
      * Create a string attribute.
      *
@@ -406,12 +410,13 @@ export declare class Databases extends Service {
      * @param {boolean} required
      * @param {string} xdefault
      * @param {boolean} array
+     * @param {boolean} encrypt
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeString>;
+    */
+    createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
     /**
-     * Update String Attribute
+     * Update string attribute
      *
      * Update a string attribute. Changing the `default` value will not update
      * already existing documents.
@@ -424,10 +429,10 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
     /**
-     * Create URL Attribute
+     * Create URL attribute
      *
      * Create a URL attribute.
      *
@@ -440,10 +445,10 @@ export declare class Databases extends Service {
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
     /**
-     * Update URL Attribute
+     * Update URL attribute
      *
      * Update an url attribute. Changing the `default` value will not update
      * already existing documents.
@@ -456,10 +461,10 @@ export declare class Databases extends Service {
      * @param {string} xdefault
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
     /**
-     * Get Attribute
+     * Get attribute
      *
      *
      * @param {string} databaseId
@@ -467,10 +472,10 @@ export declare class Databases extends Service {
      * @param {string} key
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Delete Attribute
+     * Delete attribute
      *
      *
      * @param {string} databaseId
@@ -478,13 +483,13 @@ export declare class Databases extends Service {
      * @param {string} key
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Update Relationship Attribute
+     * Update relationship attribute
      *
      * Update relationship attribute. [Learn more about relationship
-     * attributes](/docs/databases-relationships#relationship-attributes).
+     * attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
      *
      *
      * @param {string} databaseId
@@ -493,10 +498,10 @@ export declare class Databases extends Service {
      * @param {string} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
-     * List Documents
+     * 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.
@@ -506,15 +511,15 @@ export declare class Databases extends Service {
      * @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 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.
+     * integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
+     * API or directly from your database console.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -523,10 +528,10 @@ export declare class Databases extends Service {
      * @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 document
      *
      * Get a document by its unique ID. This endpoint response returns a JSON
      * object with the document data.
@@ -537,10 +542,10 @@ export declare class Databases extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
     /**
-     * Update Document
+     * Update document
      *
      * Update a document by its unique ID. Using the patch method you can pass
      * only specific fields that will get updated.
@@ -552,10 +557,10 @@ export declare class Databases extends Service {
      * @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 document
      *
      * Delete a document by its unique ID.
      *
@@ -564,10 +569,10 @@ export declare class Databases extends Service {
      * @param {string} documentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
     /**
-     * List Document Logs
+     * List document logs
      *
      * Get the document activity logs list by its unique ID.
      *
@@ -577,20 +582,21 @@ export declare class Databases extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List Indexes
+     * List indexes
      *
      *
      * @param {string} databaseId
      * @param {string} collectionId
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    listIndexes(databaseId: string, collectionId: string): Promise<Models.IndexList>;
+    */
+    listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
     /**
-     * Create Index
+     * Create index
      *
      *
      * @param {string} databaseId
@@ -601,10 +607,10 @@ export declare class Databases extends Service {
      * @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
+     * Get index
      *
      *
      * @param {string} databaseId
@@ -612,10 +618,10 @@ export declare class Databases extends Service {
      * @param {string} key
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
     /**
-     * Delete Index
+     * Delete index
      *
      *
      * @param {string} databaseId
@@ -623,10 +629,10 @@ export declare class Databases extends Service {
      * @param {string} key
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * List Collection Logs
+     * List collection logs
      *
      * Get the collection activity logs list by its unique ID.
      *
@@ -635,7 +641,7 @@ export declare class Databases extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * Get usage stats for a collection
@@ -646,10 +652,10 @@ export declare class Databases extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection>;
     /**
-     * List Database Logs
+     * List database logs
      *
      * Get the database activity logs list by its unique ID.
      *
@@ -657,7 +663,7 @@ export declare class Databases extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * Get usage stats for the database
@@ -667,6 +673,6 @@ export declare class Databases extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDatabaseUsage(databaseId: string, range?: string): Promise<Models.UsageDatabase>;
 }