@appwrite.io/console 0.6.2 → 0.7.0-rc.1

package/docs/examples/databases/list-collection-logs.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -12,4 +12,4 @@ const result = await databases.listCollectionLogs(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list-collections.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -12,4 +12,4 @@ const result = await databases.listCollections(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list-document-logs.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -13,4 +13,4 @@ const result = await databases.listDocumentLogs(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list-documents.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -12,4 +12,4 @@ const result = await databases.listDocuments(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list-indexes.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -12,4 +12,4 @@ const result = await databases.listIndexes(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list-logs.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -11,4 +11,4 @@ const result = await databases.listLogs(
     [] // queries (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/list.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -11,4 +11,4 @@ const result = await databases.list(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateBooleanAttribute(
     false // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -15,4 +15,4 @@ const result = await databases.updateCollection(
     false // enabled (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateDatetimeAttribute(
     '' // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateDocument(
     ["read("any")"] // permissions (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateEmailAttribute(
     'email@example.com' // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -15,4 +15,4 @@ const result = await databases.updateEnumAttribute(
     '<DEFAULT>' // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -16,4 +16,4 @@ const result = await databases.updateFloatAttribute(
     null // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -16,4 +16,4 @@ const result = await databases.updateIntegerAttribute(
     null // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateIpAttribute(
     '' // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases, RelationMutate } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -13,4 +13,4 @@ const result = await databases.updateRelationshipAttribute(
     RelationMutate.Cascade // onDelete (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateStringAttribute(
     '<DEFAULT>' // default
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -14,4 +14,4 @@ const result = await databases.updateUrlAttribute(
     'https://example.com' // default
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/databases/update.md

@@ -2,7 +2,7 @@ import { Client, Databases } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const databases = new Databases(client);
 
@@ -12,4 +12,4 @@ const result = await databases.update(
     false // enabled (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,14 +2,14 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
 const result = await functions.createBuild(
     '<FUNCTION_ID>', // functionId
     '<DEPLOYMENT_ID>', // deploymentId
-    '<BUILD_ID>' // buildId
+    '<BUILD_ID>' // buildId (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -14,4 +14,4 @@ const result = await functions.createDeployment(
     '<COMMANDS>' // commands (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions, ExecutionMethod } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -12,7 +12,8 @@ const result = await functions.createExecution(
     false, // async (optional)
     '<PATH>', // path (optional)
     ExecutionMethod.GET, // method (optional)
-    {} // headers (optional)
+    {}, // headers (optional)
+    '' // scheduledAt (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -12,4 +12,4 @@ const result = await functions.createVariable(
     '<VALUE>' // value
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/create.md

@@ -2,7 +2,7 @@ import { Client, Functions,  } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -18,6 +18,7 @@ const result = await functions.create(
     false, // logging (optional)
     '<ENTRYPOINT>', // entrypoint (optional)
     '<COMMANDS>', // commands (optional)
+    [], // scopes (optional)
     '<INSTALLATION_ID>', // installationId (optional)
     '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
     '<PROVIDER_BRANCH>', // providerBranch (optional)
@@ -26,7 +27,7 @@ const result = await functions.create(
     '<TEMPLATE_REPOSITORY>', // templateRepository (optional)
     '<TEMPLATE_OWNER>', // templateOwner (optional)
     '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional)
-    '<TEMPLATE_BRANCH>' // templateBranch (optional)
+    '<TEMPLATE_VERSION>' // templateVersion (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.deleteDeployment(
     '<DEPLOYMENT_ID>' // deploymentId
 );
 
-console.log(response);
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Functions } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.deleteExecution(
+    '<FUNCTION_ID>', // functionId
+    '<EXECUTION_ID>' // executionId
+);
+
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.deleteVariable(
     '<VARIABLE_ID>' // variableId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/delete.md

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -10,4 +10,4 @@ const result = await functions.delete(
     '<FUNCTION_ID>' // functionId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/{download-deployment.md → get-deployment-download.md}

@@ -2,11 +2,11 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
-const result = functions.downloadDeployment(
+const result = functions.getDeploymentDownload(
     '<FUNCTION_ID>', // functionId
     '<DEPLOYMENT_ID>' // deploymentId
 );

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.getDeployment(
     '<DEPLOYMENT_ID>' // deploymentId
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.getExecution(
     '<EXECUTION_ID>' // executionId
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.getFunctionUsage(
     FunctionUsageRange.TwentyFourHours // range (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -0,0 +1,13 @@
+import { Client, Functions } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.getTemplate(
+    '<TEMPLATE_ID>' // templateId
+);
+
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -10,4 +10,4 @@ const result = await functions.getUsage(
     FunctionUsageRange.TwentyFourHours // range (optional)
 );
 
-console.log(response);
+console.log(result);

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

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -11,4 +11,4 @@ const result = await functions.getVariable(
     '<VARIABLE_ID>' // variableId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/get.md

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -10,4 +10,4 @@ const result = await functions.get(
     '<FUNCTION_ID>' // functionId
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/list-deployments.md

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -12,4 +12,4 @@ const result = await functions.listDeployments(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/list-executions.md

@@ -2,7 +2,7 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
@@ -12,4 +12,4 @@ const result = await functions.listExecutions(
     '<SEARCH>' // search (optional)
 );
 
-console.log(response);
+console.log(result);

package/docs/examples/functions/list-runtimes.md

@@ -2,10 +2,10 @@ import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
 const result = await functions.listRuntimes();
 
-console.log(response);
+console.log(result);