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

package/docs/examples/databases/update-email-attribute.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.updateEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'email@example.com');
+const result = await databases.updateEmailAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    'email@example.com' // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update-enum-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.updateEnumAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], false, '[DEFAULT]');
+const result = await databases.updateEnumAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    [], // elements
+    false, // required
+    '<DEFAULT>' // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update-float-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.updateFloatAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
+const result = await databases.updateFloatAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    null, // min
+    null, // max
+    null // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update-integer-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.updateIntegerAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, null, null, null);
+const result = await databases.updateIntegerAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    null, // min
+    null, // max
+    null // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update-ip-attribute.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.updateIpAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '');
+const result = await databases.updateIpAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    '' // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,16 @@
-import { Client, Databases } from "@appwrite.io/console";
+import { Client, Databases, 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.updateRelationshipAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '');
+const result = await databases.updateRelationshipAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    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/update-string-attribute.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.updateStringAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, '[DEFAULT]');
+const result = await databases.updateStringAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    '<DEFAULT>' // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update-url-attribute.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.updateUrlAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false, 'https://example.com');
+const result = await databases.updateUrlAttribute(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '', // key
+    false, // required
+    'https://example.com' // default
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/databases/update.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.update('[DATABASE_ID]', '[NAME]');
+const result = await databases.update(
+    '<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/functions/create-build.md

@@ -1,18 +1,15 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.createBuild('[FUNCTION_ID]', '[DEPLOYMENT_ID]', '[BUILD_ID]');
+const result = await functions.createBuild(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>', // deploymentId
+    '<BUILD_ID>' // buildId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/create-deployment.md

@@ -1,18 +1,17 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.createDeployment('[FUNCTION_ID]', document.getElementById('uploader').files[0], false);
+const result = await functions.createDeployment(
+    '<FUNCTION_ID>', // functionId
+    document.getElementById('uploader').files[0], // code
+    false, // activate
+    '<ENTRYPOINT>', // entrypoint (optional)
+    '<COMMANDS>' // commands (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/create-execution.md

@@ -1,18 +1,18 @@
-import { Client, Functions } from "@appwrite.io/console";
+import { Client, Functions, ExecutionMethod } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.createExecution('[FUNCTION_ID]');
+const result = await functions.createExecution(
+    '<FUNCTION_ID>', // functionId
+    '<BODY>', // body (optional)
+    false, // async (optional)
+    '<PATH>', // path (optional)
+    ExecutionMethod.GET, // method (optional)
+    {} // headers (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/create-variable.md

@@ -1,18 +1,15 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.createVariable('[FUNCTION_ID]', '[KEY]', '[VALUE]');
+const result = await functions.createVariable(
+    '<FUNCTION_ID>', // functionId
+    '<KEY>', // key
+    '<VALUE>' // value
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/create.md

@@ -1,18 +1,32 @@
-import { Client, Functions } from "@appwrite.io/console";
+import { Client, Functions,  } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.create('[FUNCTION_ID]', '[NAME]', 'node-18.0');
+const result = await functions.create(
+    '<FUNCTION_ID>', // functionId
+    '<NAME>', // name
+    .Node145, // runtime
+    ["any"], // execute (optional)
+    [], // events (optional)
+    '', // schedule (optional)
+    1, // timeout (optional)
+    false, // enabled (optional)
+    false, // logging (optional)
+    '<ENTRYPOINT>', // entrypoint (optional)
+    '<COMMANDS>', // commands (optional)
+    '<INSTALLATION_ID>', // installationId (optional)
+    '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
+    '<PROVIDER_BRANCH>', // providerBranch (optional)
+    false, // providerSilentMode (optional)
+    '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
+    '<TEMPLATE_REPOSITORY>', // templateRepository (optional)
+    '<TEMPLATE_OWNER>', // templateOwner (optional)
+    '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional)
+    '<TEMPLATE_BRANCH>' // templateBranch (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/delete-deployment.md

@@ -1,18 +1,14 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.deleteDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const result = await functions.deleteDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/delete-variable.md

@@ -1,18 +1,14 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.deleteVariable('[FUNCTION_ID]', '[VARIABLE_ID]');
+const result = await functions.deleteVariable(
+    '<FUNCTION_ID>', // functionId
+    '<VARIABLE_ID>' // variableId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/delete.md

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

package/docs/examples/functions/download-deployment.md

@@ -1,14 +1,14 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const result = functions.downloadDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const result = functions.downloadDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
 
-console.log(result); // Resource URL
+console.log(result);

package/docs/examples/functions/get-deployment.md

@@ -1,18 +1,14 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.getDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const result = await functions.getDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/get-execution.md

@@ -1,18 +1,14 @@
 import { Client, Functions } 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 functions = new Functions(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = functions.getExecution('[FUNCTION_ID]', '[EXECUTION_ID]');
+const result = await functions.getExecution(
+    '<FUNCTION_ID>', // functionId
+    '<EXECUTION_ID>' // executionId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/functions/get-function-usage.md

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