@appwrite.io/console 0.1.0-preview-0.1 → 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.1',
+                '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
@@ -2724,7 +2724,10 @@
             });
         }
         /**
-         * Create relationship Attribute
+         * Create Relationship Attribute
+         *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
          *
          *
          * @param {string} databaseId
@@ -3036,16 +3039,18 @@
         /**
          * 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 {boolean} twoWay
          * @param {string} onDelete
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        updateRelationshipAttribute(databaseId, collectionId, key, twoWay, onDelete) {
+        updateRelationshipAttribute(databaseId, collectionId, key, onDelete) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof databaseId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -3058,9 +3063,6 @@
                 }
                 let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
                 let payload = {};
-                if (typeof twoWay !== 'undefined') {
-                    payload['twoWay'] = twoWay;
-                }
                 if (typeof onDelete !== 'undefined') {
                     payload['onDelete'] = onDelete;
                 }

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

@@ -9,7 +9,7 @@ client
     .setProject('5df5acd0d48c2') // Your project ID
 ;
 
-const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'onetoone');
+const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
 
 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.1",
+  "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.1',
+        'x-sdk-version': '0.1.0',
         'X-Appwrite-Response-Format': '1.0.0',
     };
 

package/src/models.ts

@@ -746,11 +746,11 @@ export namespace Models {
          */
         array?: boolean;
         /**
-         * The Id of the related collection
+         * The ID of the related collection.
          */
         relatedCollection: string;
         /**
-         * The type of the relationship
+         * The type of the relationship.
          */
         relationType: string;
         /**
@@ -758,13 +758,17 @@ export namespace Models {
          */
         twoWay: boolean;
         /**
-         * The key of the two-way relationship
+         * The key of the two-way relationship.
          */
         twoWayKey: string;
         /**
-         * Action to take on related documents when parent document is deleted
+         * 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
@@ -933,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.
          */
@@ -1078,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

@@ -1240,8 +1240,11 @@ export class Databases extends Service {
         }
 
         /**
-         * Create relationship Attribute
+         * Create Relationship Attribute
          *
+         * Create relationship attribute. [Learn more about relationship
+         * attributes](docs/databases-relationships#relationship-attributes).
+         * 
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -1600,16 +1603,18 @@ export class Databases extends Service {
         /**
          * 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 {boolean} twoWay
          * @param {string} onDelete
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, twoWay?: boolean, onDelete?: string): Promise<Models.AttributeRelationship> {
+        async updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1625,10 +1630,6 @@ export class Databases extends Service {
             let path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
             let payload: Payload = {};
 
-            if (typeof twoWay !== 'undefined') {
-                payload['twoWay'] = twoWay;
-            }
-
             if (typeof onDelete !== 'undefined') {
                 payload['onDelete'] = onDelete;
             }

package/types/models.d.ts

@@ -746,11 +746,11 @@ export declare namespace Models {
          */
         array?: boolean;
         /**
-         * The Id of the related collection
+         * The ID of the related collection.
          */
         relatedCollection: string;
         /**
-         * The type of the relationship
+         * The type of the relationship.
          */
         relationType: string;
         /**
@@ -758,13 +758,17 @@ export declare namespace Models {
          */
         twoWay: boolean;
         /**
-         * The key of the two-way relationship
+         * The key of the two-way relationship.
          */
         twoWayKey: string;
         /**
-         * Action to take on related documents when parent document is deleted
+         * 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
@@ -933,15 +937,15 @@ export declare 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.
          */
@@ -1078,59 +1082,6 @@ export declare namespace Models {
          */
         threads: number;
     };
-    /**
-     * Account
-     */
-    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/types/services/account.d.ts

@@ -94,7 +94,7 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.Account<Preferences>>;
+    updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
     /**
      * Update Phone
      *
@@ -211,7 +211,7 @@ export declare 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
@@ -235,7 +235,7 @@ export declare 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
@@ -281,7 +281,7 @@ export declare 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
@@ -303,7 +303,7 @@ export declare 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
@@ -372,7 +372,7 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.Account<Preferences>>;
+    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
      * Create Email Verification
      *

package/types/services/databases.d.ts

@@ -375,7 +375,10 @@ export declare class Databases extends Service {
      */
     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).
      *
      *
      * @param {string} databaseId
@@ -480,16 +483,18 @@ export declare class Databases extends Service {
     /**
      * 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 {boolean} twoWay
      * @param {string} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, twoWay?: boolean, onDelete?: string): Promise<Models.AttributeRelationship>;
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
     /**
      * List Documents
      *

package/docs/examples/teams/update.md

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