@appwrite.io/console 0.1.0-preview-0.0 → 0.1.0

package/dist/iife/sdk.js

@@ -96,7 +96,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '0.1.0-preview-0.0',
+                'x-sdk-version': '0.1.0',
                 'X-Appwrite-Response-Format': '1.0.0',
             };
             this.realtime = {
@@ -881,7 +881,7 @@
          * password combination. This route will create a new session for the user.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} email
          * @param {string} password
@@ -926,7 +926,7 @@
          * your Appwrite instance by default.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} email
@@ -1017,7 +1017,7 @@
          * user.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          *
          * @param {string} provider
@@ -1065,7 +1065,7 @@
          * is valid for 15 minutes.
          *
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} phone
@@ -2723,6 +2723,64 @@
                 }, payload);
             });
         }
+        /**
+         * Create Relationship Attribute
+         *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
+         *
+         *
+         * @param {string} databaseId
+         * @param {string} collectionId
+         * @param {string} relatedCollectionId
+         * @param {string} type
+         * @param {boolean} twoWay
+         * @param {string} key
+         * @param {string} twoWayKey
+         * @param {string} onDelete
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        createRelationshipAttribute(databaseId, collectionId, relatedCollectionId, type, twoWay, key, twoWayKey, onDelete) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof databaseId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "databaseId"');
+                }
+                if (typeof collectionId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "collectionId"');
+                }
+                if (typeof relatedCollectionId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "relatedCollectionId"');
+                }
+                if (typeof type === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "type"');
+                }
+                let path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId);
+                let payload = {};
+                if (typeof relatedCollectionId !== 'undefined') {
+                    payload['relatedCollectionId'] = relatedCollectionId;
+                }
+                if (typeof type !== 'undefined') {
+                    payload['type'] = type;
+                }
+                if (typeof twoWay !== 'undefined') {
+                    payload['twoWay'] = twoWay;
+                }
+                if (typeof key !== 'undefined') {
+                    payload['key'] = key;
+                }
+                if (typeof twoWayKey !== 'undefined') {
+                    payload['twoWayKey'] = twoWayKey;
+                }
+                if (typeof onDelete !== 'undefined') {
+                    payload['onDelete'] = onDelete;
+                }
+                const uri = new URL(this.client.config.endpoint + path);
+                return yield this.client.call('post', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
         /**
          * Create String Attribute
          *
@@ -2978,6 +3036,42 @@
                 }, payload);
             });
         }
+        /**
+         * Update Relationship Attribute
+         *
+         * Update relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
+         *
+         *
+         * @param {string} databaseId
+         * @param {string} collectionId
+         * @param {string} key
+         * @param {string} onDelete
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        updateRelationshipAttribute(databaseId, collectionId, key, onDelete) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof databaseId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "databaseId"');
+                }
+                if (typeof collectionId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "collectionId"');
+                }
+                if (typeof key === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "key"');
+                }
+                let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
+                let payload = {};
+                if (typeof onDelete !== 'undefined') {
+                    payload['onDelete'] = onDelete;
+                }
+                const uri = new URL(this.client.config.endpoint + path);
+                return yield this.client.call('patch', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
         /**
          * List Documents
          *
@@ -3065,10 +3159,11 @@
          * @param {string} databaseId
          * @param {string} collectionId
          * @param {string} documentId
+         * @param {string[]} queries
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        getDocument(databaseId, collectionId, documentId) {
+        getDocument(databaseId, collectionId, documentId, queries) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof databaseId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -3081,6 +3176,9 @@
                 }
                 let path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
                 let payload = {};
+                if (typeof queries !== 'undefined') {
+                    payload['queries'] = queries;
+                }
                 const uri = new URL(this.client.config.endpoint + path);
                 return yield this.client.call('get', uri, {
                     'content-type': 'application/json',

package/docs/examples/databases/create-relationship-attribute.md

@@ -0,0 +1,18 @@
+import { Client, Databases } from "@appwrite.io/console";
+
+const client = new Client();
+
+const databases = new Databases(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+;
+
+const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
+
+promise.then(function (response) {
+    console.log(response); // Success
+}, function (error) {
+    console.log(error); // Failure
+});

package/docs/examples/{teams/update.md → databases/update-relationship-attribute.md}

@@ -1,15 +1,15 @@
-import { Client, Teams } from "appwrite";
+import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client();
 
-const teams = new Teams(client);
+const databases = new Databases(client);
 
 client
     .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = teams.update('[TEAM_ID]', '[NAME]');
+const promise = databases.updateRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
 
 promise.then(function (response) {
     console.log(response); // Success

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.1.0-preview-0.0",
+  "version": "0.1.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -104,7 +104,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '0.1.0-preview-0.0',
+        'x-sdk-version': '0.1.0',
         'X-Appwrite-Response-Format': '1.0.0',
     };
 

package/src/models.ts

@@ -721,6 +721,55 @@ export namespace Models {
          */
         default?: string;
     }
+    /**
+     * AttributeRelationship
+     */
+    export type AttributeRelationship = {
+        /**
+         * Attribute Key.
+         */
+        key: string;
+        /**
+         * Attribute type.
+         */
+        type: string;
+        /**
+         * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+         */
+        status: string;
+        /**
+         * Is attribute required?
+         */
+        required: boolean;
+        /**
+         * Is attribute an array?
+         */
+        array?: boolean;
+        /**
+         * The ID of the related collection.
+         */
+        relatedCollection: string;
+        /**
+         * The type of the relationship.
+         */
+        relationType: string;
+        /**
+         * Is the relationship two-way?
+         */
+        twoWay: boolean;
+        /**
+         * The key of the two-way relationship.
+         */
+        twoWayKey: string;
+        /**
+         * How deleting the parent document will propagate to child documents.
+         */
+        onDelete: string;
+        /**
+         * Whether this is the parent or child side of the relationship
+         */
+        side: string;
+    }
     /**
      * Index
      */
@@ -888,15 +937,15 @@ export namespace Models {
         /**
          * Hashed user password.
          */
-        password: string;
+        password?: string;
         /**
          * Password hashing algorithm.
          */
-        hash: string;
+        hash?: string;
         /**
          * Password hashing algorithm configuration.
          */
-        hashOptions: object;
+        hashOptions?: object;
         /**
          * User registration date in ISO 8601 format.
          */
@@ -1033,59 +1082,6 @@ export namespace Models {
          */
         threads: number;
     }
-    /**
-     * Account
-     */
-    export type Account<Preferences extends Models.Preferences> = {
-        /**
-         * User ID.
-         */
-        $id: string;
-        /**
-         * User creation date in ISO 8601 format.
-         */
-        $createdAt: string;
-        /**
-         * User update date in ISO 8601 format.
-         */
-        $updatedAt: string;
-        /**
-         * User name.
-         */
-        name: string;
-        /**
-         * User registration date in ISO 8601 format.
-         */
-        registration: string;
-        /**
-         * User status. Pass `true` for enabled and `false` for disabled.
-         */
-        status: boolean;
-        /**
-         * Password update time in ISO 8601 format.
-         */
-        passwordUpdate: string;
-        /**
-         * User email address.
-         */
-        email: string;
-        /**
-         * User phone number in E.164 format.
-         */
-        phone: string;
-        /**
-         * Email verification status.
-         */
-        emailVerification: boolean;
-        /**
-         * Phone verification status.
-         */
-        phoneVerification: boolean;
-        /**
-         * User preferences as a key-value object
-         */
-        prefs: Preferences;
-    }
     /**
      * Preferences
      */

package/src/services/account.ts

@@ -211,7 +211,7 @@ export class Account extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.Account<Preferences>> {
+        async updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>> {
             if (typeof password === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "password"');
             }
@@ -493,7 +493,7 @@ export class Account extends Service {
          * password combination. This route will create a new session for the user.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} email
          * @param {string} password
@@ -542,7 +542,7 @@ export class Account extends Service {
          * your Appwrite instance by default.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} email
@@ -642,7 +642,7 @@ export class Account extends Service {
          * user.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          * 
          *
          * @param {string} provider
@@ -697,7 +697,7 @@ export class Account extends Service {
          * is valid for 15 minutes.
          * 
          * A user is limited to 10 active sessions at a time by default. [Learn more
-         * about session limits](/docs/authentication#limits).
+         * about session limits](/docs/authentication-security#limits).
          *
          * @param {string} userId
          * @param {string} phone
@@ -855,7 +855,7 @@ export class Account extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateStatus<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>> {
+        async updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>> {
             let path = '/account/status';
             let payload: Payload = {};
 

package/src/services/databases.ts

@@ -1239,6 +1239,74 @@ export class Databases extends Service {
             }, payload);
         }
 
+        /**
+         * Create Relationship Attribute
+         *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
+         * 
+         *
+         * @param {string} databaseId
+         * @param {string} collectionId
+         * @param {string} relatedCollectionId
+         * @param {string} type
+         * @param {boolean} twoWay
+         * @param {string} key
+         * @param {string} twoWayKey
+         * @param {string} onDelete
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship> {
+            if (typeof databaseId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "databaseId"');
+            }
+
+            if (typeof collectionId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "collectionId"');
+            }
+
+            if (typeof relatedCollectionId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "relatedCollectionId"');
+            }
+
+            if (typeof type === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "type"');
+            }
+
+            let path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId);
+            let payload: Payload = {};
+
+            if (typeof relatedCollectionId !== 'undefined') {
+                payload['relatedCollectionId'] = relatedCollectionId;
+            }
+
+            if (typeof type !== 'undefined') {
+                payload['type'] = type;
+            }
+
+            if (typeof twoWay !== 'undefined') {
+                payload['twoWay'] = twoWay;
+            }
+
+            if (typeof key !== 'undefined') {
+                payload['key'] = key;
+            }
+
+            if (typeof twoWayKey !== 'undefined') {
+                payload['twoWayKey'] = twoWayKey;
+            }
+
+            if (typeof onDelete !== 'undefined') {
+                payload['onDelete'] = onDelete;
+            }
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+
         /**
          * Create String Attribute
          *
@@ -1532,6 +1600,46 @@ export class Databases extends Service {
             }, payload);
         }
 
+        /**
+         * Update Relationship Attribute
+         *
+         * Update relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
+         * 
+         *
+         * @param {string} databaseId
+         * @param {string} collectionId
+         * @param {string} key
+         * @param {string} onDelete
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship> {
+            if (typeof databaseId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "databaseId"');
+            }
+
+            if (typeof collectionId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "collectionId"');
+            }
+
+            if (typeof key === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "key"');
+            }
+
+            let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
+            let payload: Payload = {};
+
+            if (typeof onDelete !== 'undefined') {
+                payload['onDelete'] = onDelete;
+            }
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('patch', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+
         /**
          * List Documents
          *
@@ -1629,10 +1737,11 @@ export class Databases extends Service {
          * @param {string} databaseId
          * @param {string} collectionId
          * @param {string} documentId
+         * @param {string[]} queries
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string): Promise<Document> {
+        async getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1648,6 +1757,10 @@ export class Databases extends Service {
             let path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
             let payload: Payload = {};
 
+            if (typeof queries !== 'undefined') {
+                payload['queries'] = queries;
+            }
+
             const uri = new URL(this.client.config.endpoint + path);
             return await this.client.call('get', uri, {
                 'content-type': 'application/json',