@appwrite.io/console 1.6.0 → 1.8.0

package/docs/examples/domains/get-preset-google-workspace.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetGoogleWorkspace(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-preset-i-cloud.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetICloud(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-preset-mailgun.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetMailgun(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-preset-outlook.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetOutlook(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-preset-proton-mail.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetProtonMail(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-preset-zoho.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getPresetZoho(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get-record.md

@@ -0,0 +1,14 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getRecord(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>' // recordId
+);
+
+console.log(result);

package/docs/examples/domains/get-zone.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.getZone(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/get.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.get(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/list-records.md

@@ -0,0 +1,14 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.listRecords(
+    '<DOMAIN_ID>', // domainId
+    [] // queries (optional)
+);
+
+console.log(result);

package/docs/examples/domains/list.md

@@ -0,0 +1,14 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.list(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-nameservers.md

@@ -0,0 +1,13 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateNameservers(
+    '<DOMAIN_ID>' // domainId
+);
+
+console.log(result);

package/docs/examples/domains/update-record-a-a-a-a.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordAAAA(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-a.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordA(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-alias.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordAlias(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-c-a-a.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordCAA(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-c-n-a-m-e.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordCNAME(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-h-t-t-p-s.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordHTTPS(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-m-x.md

@@ -0,0 +1,19 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordMX(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    null, // priority
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-n-s.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordNS(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-s-r-v.md

@@ -0,0 +1,21 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordSRV(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    null, // priority
+    null, // weight
+    null, // port
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

package/docs/examples/domains/update-record-t-x-t.md

@@ -0,0 +1,18 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateRecordTXT(
+    '<DOMAIN_ID>', // domainId
+    '<RECORD_ID>', // recordId
+    '<NAME>', // name
+    '<VALUE>', // value
+    null, // ttl
+    '<COMMENT>' // comment (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateTeam(
+    '<DOMAIN_ID>', // domainId
+    '<TEAM_ID>' // teamId
+);
+
+console.log(result);

package/docs/examples/domains/update-zone.md

@@ -0,0 +1,14 @@
+import { Client, Domains } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const domains = new Domains(client);
+
+const result = await domains.updateZone(
+    '<DOMAIN_ID>', // domainId
+    '<CONTENT>' // content
+);
+
+console.log(result);

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

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

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

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

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

@@ -1,7 +1,7 @@
 import { Client, Functions, ExecutionMethod } from "@appwrite.io/console";
 
 const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);

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

@@ -0,0 +1,18 @@
+import { Client, Functions } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.createTemplateDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<REPOSITORY>', // repository
+    '<OWNER>', // owner
+    '<ROOT_DIRECTORY>', // rootDirectory
+    '<VERSION>', // version
+    false // activate (optional)
+);
+
+console.log(result);

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

@@ -1,7 +1,7 @@
 import { Client, Functions } from "@appwrite.io/console";
 
 const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
@@ -9,7 +9,8 @@ const functions = new Functions(client);
 const result = await functions.createVariable(
     '<FUNCTION_ID>', // functionId
     '<KEY>', // key
-    '<VALUE>' // value
+    '<VALUE>', // value
+    false // secret (optional)
 );
 
 console.log(result);

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

@@ -0,0 +1,16 @@
+import { Client, Functions, VCSDeploymentType } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const functions = new Functions(client);
+
+const result = await functions.createVcsDeployment(
+    '<FUNCTION_ID>', // functionId
+    VCSDeploymentType.Branch, // type
+    '<REFERENCE>', // reference
+    false // activate (optional)
+);
+
+console.log(result);

package/docs/examples/functions/create.md

@@ -1,7 +1,7 @@
 import { Client, Functions,  } from "@appwrite.io/console";
 
 const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
@@ -24,10 +24,6 @@ const result = await functions.create(
     '<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_VERSION>', // templateVersion (optional)
     '' // specification (optional)
 );
 

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

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

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

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

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

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

package/docs/examples/functions/delete.md

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

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

@@ -1,14 +1,15 @@
-import { Client, Functions } from "@appwrite.io/console";
+import { Client, Functions, DeploymentDownloadType } from "@appwrite.io/console";
 
 const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
 const result = functions.getDeploymentDownload(
     '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
+    '<DEPLOYMENT_ID>', // deploymentId
+    DeploymentDownloadType.Source // type (optional)
 );
 
 console.log(result);

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

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

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

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

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

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

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

@@ -1,12 +1,13 @@
 import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console";
 
 const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('<YOUR_PROJECT_ID>'); // Your project ID
 
 const functions = new Functions(client);
 
 const result = await functions.getUsage(
+    '<FUNCTION_ID>', // functionId
     FunctionUsageRange.TwentyFourHours // range (optional)
 );
 

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

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