node-appwrite 5.0.0 → 7.0.0

package/lib/services/{database.js → databases.js}

@@ -1,18 +1,169 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const InputFile = require('../inputFile.js');
 const client = require('../client.js');
+const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
 
-class Database extends Service {
+class Databases extends Service {
+    databaseId;
+    /**
+     * Set databaseId.
+     *
+     * @param {string} databaseId
+     *
+     * @return void
+     */
+     setDatabaseId(databaseId)
+     {
+        this.databaseId = databaseId;
+     }
+    /**
+     * Get databaseId.
+     *
+     * @return string
+     */
+     getDatabaseId(databaseId)
+     {
+        return this.databaseId;
+     }
+     constructor(client,  databaseId)
+     {
+        super(client);
+
+        this.databaseId = databaseId;
+     }
 
     /**
-     * List Collections
+     * List Databases
      *
-     * Get a list of all the user collections. You can use the query params to
-     * filter your results. On admin mode, this endpoint will return a list of all
-     * of the project's collections. [Learn more about different API
-     * modes](/docs/admin).
+     * @param {string} search
+     * @param {number} limit
+     * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
+     * @param {string} orderType
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async list(search, limit, offset, cursor, cursorDirection, orderType) {
+        let path = '/databases';
+        let payload = {};
+
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
+
+        if (typeof limit !== 'undefined') {
+            payload['limit'] = limit;
+        }
+
+        if (typeof offset !== 'undefined') {
+            payload['offset'] = offset;
+        }
+
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
+        if (typeof orderType !== 'undefined') {
+            payload['orderType'] = orderType;
+        }
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create Database
+     *
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async create(name) {
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+        let path = '/databases';
+        let payload = {};
+
+        if (typeof this.databaseId !== 'undefined') {
+            payload['databaseId'] = this.databaseId;
+        }
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        return await this.client.call('post', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get Database
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async get() {
+        let path = '/databases/{databaseId}'.replace('{databaseId}', this.databaseId);
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update Database
+     *
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async update(name) {
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+        let path = '/databases/{databaseId}'.replace('{databaseId}', this.databaseId);
+        let payload = {};
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        return await this.client.call('put', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete Database
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async delete() {
+        let path = '/databases/{databaseId}'.replace('{databaseId}', this.databaseId);
+        let payload = {};
+
+        return await this.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Collections
      *
      * @param {string} search
      * @param {number} limit
@@ -24,7 +175,7 @@ class Database extends Service {
      * @returns {Promise}
      */
     async listCollections(search, limit, offset, cursor, cursorDirection, orderType) {
-        let path = '/database/collections';
+        let path = '/databases/{databaseId}/collections'.replace('{databaseId}', this.databaseId);
         let payload = {};
 
         if (typeof search !== 'undefined') {
@@ -59,8 +210,6 @@ class Database extends Service {
     /**
      * Create Collection
      *
-     * Create a new Collection.
-     *
      * @param {string} collectionId
      * @param {string} name
      * @param {string} permission
@@ -90,7 +239,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "write"');
         }
 
-        let path = '/database/collections';
+        let path = '/databases/{databaseId}/collections'.replace('{databaseId}', this.databaseId);
         let payload = {};
 
         if (typeof collectionId !== 'undefined') {
@@ -121,9 +270,6 @@ class Database extends Service {
     /**
      * Get Collection
      *
-     * Get a collection by its unique ID. This endpoint response returns a JSON
-     * object with the collection metadata.
-     *
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -133,7 +279,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
 
-        let path = '/database/collections/{collectionId}'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -144,8 +290,6 @@ class Database extends Service {
     /**
      * Update Collection
      *
-     * Update a collection by its unique ID.
-     *
      * @param {string} collectionId
      * @param {string} name
      * @param {string} permission
@@ -168,7 +312,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "permission"');
         }
 
-        let path = '/database/collections/{collectionId}'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof name !== 'undefined') {
@@ -199,9 +343,6 @@ class Database extends Service {
     /**
      * Delete Collection
      *
-     * Delete a collection by its unique ID. Only users with write permissions
-     * have access to delete this resource.
-     *
      * @param {string} collectionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -211,7 +352,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
 
-        let path = '/database/collections/{collectionId}'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         return await this.client.call('delete', path, {
@@ -231,7 +372,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -242,9 +383,6 @@ class Database extends Service {
     /**
      * Create Boolean Attribute
      *
-     * Create a boolean attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -266,7 +404,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/boolean'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -293,9 +431,6 @@ class Database extends Service {
     /**
      * Create Email Attribute
      *
-     * Create an email attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -317,7 +452,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/email'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -370,7 +505,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/enum'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -401,10 +536,6 @@ class Database extends Service {
     /**
      * Create Float Attribute
      *
-     * Create a float attribute. Optionally, minimum and maximum values can be
-     * provided.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -428,7 +559,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/float'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -463,10 +594,6 @@ class Database extends Service {
     /**
      * Create Integer Attribute
      *
-     * Create an integer attribute. Optionally, minimum and maximum values can be
-     * provided.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -490,7 +617,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/integer'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -525,9 +652,6 @@ class Database extends Service {
     /**
      * Create IP Address Attribute
      *
-     * Create IP address attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -549,7 +673,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/ip'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -576,9 +700,6 @@ class Database extends Service {
     /**
      * Create String Attribute
      *
-     * Create a string attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {number} size
@@ -605,7 +726,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/string'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -636,9 +757,6 @@ class Database extends Service {
     /**
      * Create URL Attribute
      *
-     * Create a URL attribute.
-     * 
-     *
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
@@ -660,7 +778,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "required"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/url'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -701,7 +819,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "key"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/{key}'.replace('{collectionId}', collectionId).replace('{key}', key);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -726,7 +844,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "key"');
         }
 
-        let path = '/database/collections/{collectionId}/attributes/{key}'.replace('{collectionId}', collectionId).replace('{key}', key);
+        let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
         let payload = {};
 
         return await this.client.call('delete', path, {
@@ -737,11 +855,6 @@ class Database extends Service {
     /**
      * List Documents
      *
-     * Get a list of all the user documents. You can use the query params to
-     * filter your results. On admin mode, this endpoint will return a list of all
-     * of the project's documents. [Learn more about different API
-     * modes](/docs/admin).
-     *
      * @param {string} collectionId
      * @param {string[]} queries
      * @param {number} limit
@@ -758,7 +871,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
 
-        let path = '/database/collections/{collectionId}/documents'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/documents'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof queries !== 'undefined') {
@@ -797,11 +910,6 @@ class Database extends Service {
     /**
      * Create Document
      *
-     * Create a new Document. Before using this route, you should create a new
-     * collection resource using either a [server
-     * integration](/docs/server/database#databaseCreateCollection) API or
-     * directly from your database console.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @param {object} data
@@ -823,7 +931,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "data"');
         }
 
-        let path = '/database/collections/{collectionId}/documents'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/documents'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof documentId !== 'undefined') {
@@ -850,9 +958,6 @@ class Database extends Service {
     /**
      * Get Document
      *
-     * Get a document by its unique ID. This endpoint response returns a JSON
-     * object with the document data.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @throws {AppwriteException}
@@ -867,7 +972,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "documentId"');
         }
 
-        let path = '/database/collections/{collectionId}/documents/{documentId}'.replace('{collectionId}', collectionId).replace('{documentId}', documentId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -878,9 +983,6 @@ class Database extends Service {
     /**
      * 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} collectionId
      * @param {string} documentId
      * @param {object} data
@@ -898,11 +1000,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "documentId"');
         }
 
-        if (typeof data === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "data"');
-        }
-
-        let path = '/database/collections/{collectionId}/documents/{documentId}'.replace('{collectionId}', collectionId).replace('{documentId}', documentId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         let payload = {};
 
         if (typeof data !== 'undefined') {
@@ -925,10 +1023,6 @@ class Database extends Service {
     /**
      * Delete Document
      *
-     * Delete a document by its unique ID. This endpoint deletes only the parent
-     * documents, its attributes and relations to other documents. Child documents
-     * **will not** be deleted.
-     *
      * @param {string} collectionId
      * @param {string} documentId
      * @throws {AppwriteException}
@@ -943,7 +1037,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "documentId"');
         }
 
-        let path = '/database/collections/{collectionId}/documents/{documentId}'.replace('{collectionId}', collectionId).replace('{documentId}', documentId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
         let payload = {};
 
         return await this.client.call('delete', path, {
@@ -963,7 +1057,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
 
-        let path = '/database/collections/{collectionId}/indexes'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/indexes'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -999,7 +1093,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "attributes"');
         }
 
-        let path = '/database/collections/{collectionId}/indexes'.replace('{collectionId}', collectionId);
+        let path = '/databases/{databaseId}/collections/{collectionId}/indexes'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId);
         let payload = {};
 
         if (typeof key !== 'undefined') {
@@ -1040,7 +1134,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "key"');
         }
 
-        let path = '/database/collections/{collectionId}/indexes/{key}'.replace('{collectionId}', collectionId).replace('{key}', key);
+        let path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -1065,7 +1159,7 @@ class Database extends Service {
             throw new AppwriteException('Missing required parameter: "key"');
         }
 
-        let path = '/database/collections/{collectionId}/indexes/{key}'.replace('{collectionId}', collectionId).replace('{key}', key);
+        let path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replace('{databaseId}', this.databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
         let payload = {};
 
         return await this.client.call('delete', path, {
@@ -1074,4 +1168,4 @@ class Database extends Service {
     }
 }
 
-module.exports = Database;
+module.exports = Databases;