@appwrite.io/console 0.6.0-rc.8 → 0.6.0

package/docs/examples/avatars/get-image.md

@@ -1,14 +1,15 @@
 import { Client, Avatars } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const avatars = new Avatars(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = avatars.getImage('https://example.com');
+const result = avatars.getImage(
+    'https://example.com', // url
+    0, // width (optional)
+    0 // height (optional)
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/avatars/get-initials.md

@@ -1,14 +1,16 @@
 import { Client, Avatars } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const avatars = new Avatars(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = avatars.getInitials();
+const result = avatars.getInitials(
+    '<NAME>', // name (optional)
+    0, // width (optional)
+    0, // height (optional)
+    '' // background (optional)
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/avatars/get-q-r.md

@@ -1,14 +1,16 @@
 import { Client, Avatars } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const avatars = new Avatars(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = avatars.getQR('[TEXT]');
+const result = avatars.getQR(
+    '<TEXT>', // text
+    1, // size (optional)
+    0, // margin (optional)
+    false // download (optional)
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/console/variables.md

@@ -1,18 +1,11 @@
 import { Client, Console } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const console = new Console(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = console.variables();
+const result = await console.variables();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createBooleanAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    false, // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/create-collection.md

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
+const result = await databases.createCollection(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<NAME>', // name
+    ["read("any")"], // permissions (optional)
+    false, // documentSecurity (optional)
+    false // enabled (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createDatetimeAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    '', // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/create-document.md

@@ -1,18 +1,17 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {});
+const result = await databases.createDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>', // documentId
+    {}, // data
+    ["read("any")"] // permissions (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createEmailAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    'email@example.com', // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,19 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false);
+const result = await databases.createEnumAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    [], // elements
+    false, // required
+    '<DEFAULT>', // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,20 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createFloatAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    null, // min (optional)
+    null, // max (optional)
+    null, // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/create-index.md

@@ -1,18 +1,18 @@
-import { Client, Databases } from "@appwrite.io/console";
+import { Client, Databases, IndexType } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createIndex('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', []);
+const result = await databases.createIndex(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    IndexType.Key, // type
+    [], // attributes
+    [] // orders (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,20 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createIntegerAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    null, // min (optional)
+    null, // max (optional)
+    null, // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createIpAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    '', // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,20 @@
-import { Client, Databases } from "@appwrite.io/console";
+import { Client, Databases, RelationshipType, RelationMutate } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne');
+const result = await databases.createRelationshipAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<RELATED_COLLECTION_ID>', // relatedCollectionId
+    RelationshipType.OneToOne, // type
+    false, // twoWay (optional)
+    '', // key (optional)
+    '', // twoWayKey (optional)
+    RelationMutate.Cascade // onDelete (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,20 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, false);
+const result = await databases.createStringAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    1, // size
+    false, // required
+    '<DEFAULT>', // default (optional)
+    false, // array (optional)
+    false // encrypt (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,18 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.createUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const result = await databases.createUrlAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    'https://example.com', // default (optional)
+    false // array (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/create.md

@@ -1,18 +1,15 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.create('[DATABASE_ID]', '[NAME]');
+const result = await databases.create(
+    '<DATABASE_ID>', // databaseId
+    '<NAME>', // name
+    false // enabled (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/delete-attribute.md

@@ -1,18 +1,15 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.deleteAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
+const result = await databases.deleteAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '' // key
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/delete-collection.md

@@ -1,18 +1,14 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.deleteCollection('[DATABASE_ID]', '[COLLECTION_ID]');
+const result = await databases.deleteCollection(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>' // collectionId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/delete-document.md

@@ -1,18 +1,15 @@
 import { Client, Databases } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const databases = new Databases(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = databases.deleteDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]');
+const result = await databases.deleteDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>' // documentId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);