@appwrite.io/console 1.6.0 → 1.8.0

package/docs/examples/projects/update-auth-password-history.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-auth-sessions-limit.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-auth-status.md

@@ -1,7 +1,7 @@
 import { Client, Projects, AuthMethod } 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 projects = new Projects(client);

package/docs/examples/projects/update-dev-key.md

@@ -0,0 +1,16 @@
+import { Client, Projects } 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 projects = new Projects(client);
+
+const result = await projects.updateDevKey(
+    '<PROJECT_ID>', // projectId
+    '<KEY_ID>', // keyId
+    '<NAME>', // name
+    '' // expire
+);
+
+console.log(result);

package/docs/examples/projects/update-email-template.md

@@ -1,7 +1,7 @@
 import { Client, Projects, EmailTemplateType, EmailTemplateLocale } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-memberships-privacy.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-mock-numbers.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-o-auth2.md

@@ -1,7 +1,7 @@
 import { Client, Projects, OAuthProvider } 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 projects = new Projects(client);

package/docs/examples/projects/update-personal-data-check.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-service-status-all.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-service-status.md

@@ -1,7 +1,7 @@
 import { Client, Projects, ApiService } 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 projects = new Projects(client);

package/docs/examples/projects/update-session-alerts.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update-sms-template.md

@@ -1,7 +1,7 @@
 import { Client, Projects, SmsTemplateType, SmsTemplateLocale } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects, SMTPSecure } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

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

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/projects/update.md

@@ -1,7 +1,7 @@
 import { Client, Projects } 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 projects = new Projects(client);

package/docs/examples/proxy/create-a-p-i-rule.md

@@ -0,0 +1,13 @@
+import { Client, Proxy } 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 proxy = new Proxy(client);
+
+const result = await proxy.createAPIRule(
+    '' // domain
+);
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, Proxy } 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 proxy = new Proxy(client);
+
+const result = await proxy.createFunctionRule(
+    '', // domain
+    '<FUNCTION_ID>', // functionId
+    '<BRANCH>' // branch (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, Proxy,  } 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 proxy = new Proxy(client);
+
+const result = await proxy.createRedirectRule(
+    '', // domain
+    'https://example.com', // url
+    .MovedPermanently301 // statusCode
+);
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, Proxy } 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 proxy = new Proxy(client);
+
+const result = await proxy.createSiteRule(
+    '', // domain
+    '<SITE_ID>', // siteId
+    '<BRANCH>' // branch (optional)
+);
+
+console.log(result);

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

@@ -1,7 +1,7 @@
 import { Client, Proxy } 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 proxy = new Proxy(client);

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

@@ -1,7 +1,7 @@
 import { Client, Proxy } 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 proxy = new Proxy(client);

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

@@ -1,7 +1,7 @@
 import { Client, Proxy } 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 proxy = new Proxy(client);

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

@@ -1,7 +1,7 @@
 import { Client, Proxy } 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 proxy = new Proxy(client);

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

@@ -0,0 +1,18 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.createDeployment(
+    '<SITE_ID>', // siteId
+    document.getElementById('uploader').files[0], // code
+    false, // activate
+    '<INSTALL_COMMAND>', // installCommand (optional)
+    '<BUILD_COMMAND>', // buildCommand (optional)
+    '<OUTPUT_DIRECTORY>' // outputDirectory (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.createDuplicateDeployment(
+    '<SITE_ID>', // siteId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
+
+console.log(result);

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

@@ -0,0 +1,18 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.createTemplateDeployment(
+    '<SITE_ID>', // siteId
+    '<REPOSITORY>', // repository
+    '<OWNER>', // owner
+    '<ROOT_DIRECTORY>', // rootDirectory
+    '<VERSION>', // version
+    false // activate (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,16 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.createVariable(
+    '<SITE_ID>', // siteId
+    '<KEY>', // key
+    '<VALUE>', // value
+    false // secret (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,16 @@
+import { Client, Sites, 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 sites = new Sites(client);
+
+const result = await sites.createVcsDeployment(
+    '<SITE_ID>', // siteId
+    VCSDeploymentType.Branch, // type
+    '<REFERENCE>', // reference
+    false // activate (optional)
+);
+
+console.log(result);

package/docs/examples/sites/create.md

@@ -0,0 +1,30 @@
+import { Client, Sites, , ,  } 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 sites = new Sites(client);
+
+const result = await sites.create(
+    '<SITE_ID>', // siteId
+    '<NAME>', // name
+    .Analog, // framework
+    .Node145, // buildRuntime
+    false, // enabled (optional)
+    false, // logging (optional)
+    1, // timeout (optional)
+    '<INSTALL_COMMAND>', // installCommand (optional)
+    '<BUILD_COMMAND>', // buildCommand (optional)
+    '<OUTPUT_DIRECTORY>', // outputDirectory (optional)
+    .Static, // adapter (optional)
+    '<INSTALLATION_ID>', // installationId (optional)
+    '<FALLBACK_FILE>', // fallbackFile (optional)
+    '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
+    '<PROVIDER_BRANCH>', // providerBranch (optional)
+    false, // providerSilentMode (optional)
+    '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
+    '' // specification (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.deleteDeployment(
+    '<SITE_ID>', // siteId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
+
+console.log(result);

package/docs/examples/sites/delete-log.md

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.deleteLog(
+    '<SITE_ID>', // siteId
+    '<LOG_ID>' // logId
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.deleteVariable(
+    '<SITE_ID>', // siteId
+    '<VARIABLE_ID>' // variableId
+);
+
+console.log(result);

package/docs/examples/sites/delete.md

@@ -0,0 +1,13 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.delete(
+    '<SITE_ID>' // siteId
+);
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, Sites, DeploymentDownloadType } 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 sites = new Sites(client);
+
+const result = sites.getDeploymentDownload(
+    '<SITE_ID>', // siteId
+    '<DEPLOYMENT_ID>', // deploymentId
+    DeploymentDownloadType.Source // type (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.getDeployment(
+    '<SITE_ID>', // siteId
+    '<DEPLOYMENT_ID>' // deploymentId
+);
+
+console.log(result);

package/docs/examples/sites/get-log.md

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.getLog(
+    '<SITE_ID>', // siteId
+    '<LOG_ID>' // logId
+);
+
+console.log(result);

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

@@ -0,0 +1,13 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.getTemplate(
+    '<TEMPLATE_ID>' // templateId
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites, SiteUsageRange } 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 sites = new Sites(client);
+
+const result = await sites.getUsage(
+    '<SITE_ID>', // siteId
+    SiteUsageRange.TwentyFourHours // range (optional)
+);
+
+console.log(result);

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

@@ -0,0 +1,14 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.getVariable(
+    '<SITE_ID>', // siteId
+    '<VARIABLE_ID>' // variableId
+);
+
+console.log(result);

package/docs/examples/sites/get.md

@@ -0,0 +1,13 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.get(
+    '<SITE_ID>' // siteId
+);
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.listDeployments(
+    '<SITE_ID>', // siteId
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);
+
+console.log(result);

package/docs/examples/sites/list-frameworks.md

@@ -0,0 +1,11 @@
+import { Client, Sites } 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 sites = new Sites(client);
+
+const result = await sites.listFrameworks();
+
+console.log(result);