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

package/docs/examples/projects/update-team.md

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateTeam('[PROJECT_ID]', '[TEAM_ID]');
+const result = await projects.updateTeam(
+    '<PROJECT_ID>', // projectId
+    '<TEAM_ID>' // teamId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-webhook-signature.md

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateWebhookSignature('[PROJECT_ID]', '[WEBHOOK_ID]');
+const result = await projects.updateWebhookSignature(
+    '<PROJECT_ID>', // projectId
+    '<WEBHOOK_ID>' // webhookId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-webhook.md

@@ -1,18 +1,21 @@
-import { Client,  Projects } from "@appwrite.io/console";
+import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateWebhook('[PROJECT_ID]', '[WEBHOOK_ID]', '[NAME]', [], '', false);
+const result = await projects.updateWebhook(
+    '<PROJECT_ID>', // projectId
+    '<WEBHOOK_ID>', // webhookId
+    '<NAME>', // name
+    [], // events
+    '', // url
+    false, // security
+    false, // enabled (optional)
+    '<HTTP_USER>', // httpUser (optional)
+    '<HTTP_PASS>' // httpPass (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update.md

@@ -1,18 +1,23 @@
-import { Client,  Projects } from "@appwrite.io/console";
+import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.update('[PROJECT_ID]', '[NAME]');
+const result = await projects.update(
+    '<PROJECT_ID>', // projectId
+    '<NAME>', // name
+    '<DESCRIPTION>', // description (optional)
+    '<LOGO>', // logo (optional)
+    'https://example.com', // url (optional)
+    '<LEGAL_NAME>', // legalName (optional)
+    '<LEGAL_COUNTRY>', // legalCountry (optional)
+    '<LEGAL_STATE>', // legalState (optional)
+    '<LEGAL_CITY>', // legalCity (optional)
+    '<LEGAL_ADDRESS>', // legalAddress (optional)
+    '<LEGAL_TAX_ID>' // legalTaxId (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/create-rule.md

@@ -1,18 +1,15 @@
-import { Client, , Proxy } from "@appwrite.io/console";
+import { Client, Proxy,  } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.createRule('', .Api);
+const result = await proxy.createRule(
+    '', // domain
+    .Api, // resourceType
+    '<RESOURCE_ID>' // resourceId (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/delete-rule.md

@@ -1,18 +1,13 @@
-import { Client,  Proxy } from "@appwrite.io/console";
+import { Client, Proxy } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.deleteRule('[RULE_ID]');
+const result = await proxy.deleteRule(
+    '<RULE_ID>' // ruleId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/get-rule.md

@@ -1,18 +1,13 @@
-import { Client,  Proxy } from "@appwrite.io/console";
+import { Client, Proxy } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.getRule('[RULE_ID]');
+const result = await proxy.getRule(
+    '<RULE_ID>' // ruleId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/list-rules.md

@@ -1,18 +1,14 @@
-import { Client,  Proxy } from "@appwrite.io/console";
+import { Client, Proxy } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.listRules();
+const result = await proxy.listRules(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/update-rule-verification.md

@@ -1,18 +1,13 @@
-import { Client,  Proxy } from "@appwrite.io/console";
+import { Client, Proxy } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.updateRuleVerification('[RULE_ID]');
+const result = await proxy.updateRuleVerification(
+    '<RULE_ID>' // ruleId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/create-bucket.md

@@ -1,18 +1,22 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage,  } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.createBucket('[BUCKET_ID]', '[NAME]');
+const result = await storage.createBucket(
+    '<BUCKET_ID>', // bucketId
+    '<NAME>', // name
+    ["read("any")"], // permissions (optional)
+    false, // fileSecurity (optional)
+    false, // enabled (optional)
+    1, // maximumFileSize (optional)
+    [], // allowedFileExtensions (optional)
+    .None, // compression (optional)
+    false, // encryption (optional)
+    false // antivirus (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/create-file.md

@@ -1,18 +1,16 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.createFile('[BUCKET_ID]', '[FILE_ID]', document.getElementById('uploader').files[0]);
+const result = await storage.createFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    document.getElementById('uploader').files[0], // file
+    ["read("any")"] // permissions (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/delete-bucket.md

@@ -1,18 +1,13 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.deleteBucket('[BUCKET_ID]');
+const result = await storage.deleteBucket(
+    '<BUCKET_ID>' // bucketId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/delete-file.md

@@ -1,18 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.deleteFile('[BUCKET_ID]', '[FILE_ID]');
+const result = await storage.deleteFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/get-bucket-usage.md

@@ -1,18 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage, StorageUsageRange } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.getBucketUsage('[BUCKET_ID]');
+const result = await storage.getBucketUsage(
+    '<BUCKET_ID>', // bucketId
+    StorageUsageRange.TwentyFourHours // range (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/get-bucket.md

@@ -1,18 +1,13 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.getBucket('[BUCKET_ID]');
+const result = await storage.getBucket(
+    '<BUCKET_ID>' // bucketId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/get-file-download.md

@@ -1,14 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = storage.getFileDownload('[BUCKET_ID]', '[FILE_ID]');
+const result = storage.getFileDownload(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/storage/get-file-preview.md

@@ -1,14 +1,25 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage, ImageGravity, ImageFormat } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = storage.getFilePreview('[BUCKET_ID]', '[FILE_ID]');
+const result = storage.getFilePreview(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    0, // width (optional)
+    0, // height (optional)
+    ImageGravity.Center, // gravity (optional)
+    0, // quality (optional)
+    0, // borderWidth (optional)
+    '', // borderColor (optional)
+    0, // borderRadius (optional)
+    0, // opacity (optional)
+    -360, // rotation (optional)
+    '', // background (optional)
+    ImageFormat.Jpg // output (optional)
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/storage/get-file-view.md

@@ -1,14 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = storage.getFileView('[BUCKET_ID]', '[FILE_ID]');
+const result = storage.getFileView(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/storage/get-file.md

@@ -1,18 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.getFile('[BUCKET_ID]', '[FILE_ID]');
+const result = await storage.getFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/get-usage.md

@@ -1,18 +1,13 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage, StorageUsageRange } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.getUsage();
+const result = await storage.getUsage(
+    StorageUsageRange.TwentyFourHours // range (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/list-buckets.md

@@ -1,18 +1,14 @@
-import { Client,  Storage } from "@appwrite.io/console";
+import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.listBuckets();
+const result = await storage.listBuckets(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);