node-appwrite 15.0.0 → 15.0.1

package/dist/services/databases.d.mts

@@ -9,8 +9,6 @@ declare class Databases {
     client: Client;
     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
@@ -20,8 +18,6 @@ declare class Databases {
      */
     list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
     /**
-     * Create database
-     *
      * Create a new Database.
 
      *
@@ -33,8 +29,6 @@ declare class Databases {
      */
     create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Get database
-     *
      * Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
      *
      * @param {string} databaseId
@@ -43,8 +37,6 @@ declare class Databases {
      */
     get(databaseId: string): Promise<Models.Database>;
     /**
-     * Update database
-     *
      * Update a database by its unique ID.
      *
      * @param {string} databaseId
@@ -55,8 +47,6 @@ declare class Databases {
      */
     update(databaseId: string, name: string, enabled?: boolean): 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
@@ -65,8 +55,6 @@ declare class Databases {
      */
     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
@@ -77,8 +65,6 @@ declare class Databases {
      */
     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](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
      * @param {string} databaseId
@@ -92,8 +78,6 @@ declare class Databases {
      */
     createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: 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
@@ -103,8 +87,6 @@ declare class Databases {
      */
     getCollection(databaseId: string, collectionId: string): Promise<Models.Collection>;
     /**
-     * Update collection
-     *
      * Update a collection by its unique ID.
      *
      * @param {string} databaseId
@@ -118,8 +100,6 @@ declare class Databases {
      */
     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
@@ -129,8 +109,6 @@ declare class Databases {
      */
     deleteCollection(databaseId: string, collectionId: string): Promise<{}>;
     /**
-     * List attributes
-     *
      * List attributes in the collection.
      *
      * @param {string} databaseId
@@ -141,8 +119,6 @@ declare class Databases {
      */
     listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
     /**
-     * Create boolean attribute
-     *
      * Create a boolean attribute.
 
      *
@@ -157,8 +133,6 @@ declare class Databases {
      */
     createBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, array?: boolean): Promise<Models.AttributeBoolean>;
     /**
-     * Update boolean attribute
-     *
      * Update a boolean attribute. Changing the `default` value will not update already existing documents.
      *
      * @param {string} databaseId
@@ -172,8 +146,6 @@ declare class Databases {
      */
     updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, newKey?: string): Promise<Models.AttributeBoolean>;
     /**
-     * Create datetime attribute
-     *
      * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
@@ -187,8 +159,6 @@ declare class Databases {
      */
     createDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeDatetime>;
     /**
-     * Update dateTime attribute
-     *
      * Update a date time attribute. Changing the `default` value will not update already existing documents.
      *
      * @param {string} databaseId
@@ -202,8 +172,6 @@ declare class Databases {
      */
     updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeDatetime>;
     /**
-     * Create email attribute
-     *
      * Create an email attribute.
 
      *
@@ -218,8 +186,6 @@ declare class Databases {
      */
     createEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEmail>;
     /**
-     * Update email attribute
-     *
      * Update an email attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -234,8 +200,6 @@ declare class Databases {
      */
     updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEmail>;
     /**
-     * Create enum attribute
-     *
      * Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
 
      *
@@ -251,8 +215,6 @@ declare class Databases {
      */
     createEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeEnum>;
     /**
-     * Update enum attribute
-     *
      * Update an enum attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -268,8 +230,6 @@ declare class Databases {
      */
     updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEnum>;
     /**
-     * Create float attribute
-     *
      * Create a float attribute. Optionally, minimum and maximum values can be provided.
 
      *
@@ -286,8 +246,6 @@ declare class Databases {
      */
     createFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeFloat>;
     /**
-     * Update float attribute
-     *
      * Update a float attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -304,8 +262,6 @@ declare class Databases {
      */
     updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeFloat>;
     /**
-     * Create integer attribute
-     *
      * Create an integer attribute. Optionally, minimum and maximum values can be provided.
 
      *
@@ -322,8 +278,6 @@ declare class Databases {
      */
     createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
     /**
-     * Update integer attribute
-     *
      * Update an integer attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -340,8 +294,6 @@ declare class Databases {
      */
     updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeInteger>;
     /**
-     * Create IP address attribute
-     *
      * Create IP address attribute.
 
      *
@@ -356,8 +308,6 @@ declare class Databases {
      */
     createIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeIp>;
     /**
-     * Update IP address attribute
-     *
      * Update an ip attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -372,8 +322,6 @@ declare class Databases {
      */
     updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeIp>;
     /**
-     * Create relationship attribute
-     *
      * Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
 
      *
@@ -390,8 +338,6 @@ declare class Databases {
      */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
-     * Create string attribute
-     *
      * Create a string attribute.
 
      *
@@ -408,8 +354,6 @@ declare class Databases {
      */
     createStringAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeString>;
     /**
-     * Update string attribute
-     *
      * Update a string attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -425,8 +369,6 @@ declare class Databases {
      */
     updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
     /**
-     * Create URL attribute
-     *
      * Create a URL attribute.
 
      *
@@ -441,8 +383,6 @@ declare class Databases {
      */
     createUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeUrl>;
     /**
-     * Update URL attribute
-     *
      * Update an url attribute. Changing the `default` value will not update already existing documents.
 
      *
@@ -457,8 +397,6 @@ declare class Databases {
      */
     updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
     /**
-     * Get attribute
-     *
      * Get attribute by ID.
      *
      * @param {string} databaseId
@@ -469,8 +407,6 @@ declare class Databases {
      */
     getAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Delete attribute
-     *
      * Deletes an attribute.
      *
      * @param {string} databaseId
@@ -481,8 +417,6 @@ declare class Databases {
      */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
     /**
-     * Update relationship attribute
-     *
      * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
 
      *
@@ -496,8 +430,6 @@ declare class Databases {
      */
     updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
-     * List documents
-     *
      * Get a list of all the user&#039;s documents in a given collection. You can use the query params to filter your results.
      *
      * @param {string} databaseId
@@ -508,8 +440,6 @@ declare class Databases {
      */
     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](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
      * @param {string} databaseId
@@ -522,8 +452,6 @@ declare class Databases {
      */
     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
@@ -535,8 +463,6 @@ declare class Databases {
      */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: 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
@@ -549,8 +475,6 @@ declare class Databases {
      */
     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
@@ -561,8 +485,6 @@ declare class Databases {
      */
     deleteDocument(databaseId: string, collectionId: string, documentId: string): Promise<{}>;
     /**
-     * List indexes
-     *
      * List indexes in the collection.
      *
      * @param {string} databaseId
@@ -573,8 +495,6 @@ declare class Databases {
      */
     listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
     /**
-     * Create index
-     *
      * Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
 Attributes can be `key`, `fulltext`, and `unique`.
      *
@@ -589,8 +509,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
     /**
-     * Get index
-     *
      * Get index by ID.
      *
      * @param {string} databaseId
@@ -601,8 +519,6 @@ Attributes can be `key`, `fulltext`, and `unique`.
      */
     getIndex(databaseId: string, collectionId: string, key: string): Promise<Models.Index>;
     /**
-     * Delete index
-     *
      * Delete an index.
      *
      * @param {string} databaseId