node-appwrite 11.0.0 → 12.0.0-rc.4

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

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.createVariable('[FUNCTION_ID]', '[KEY]', '[VALUE]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.createVariable(
+    '[FUNCTION_ID]', // functionId
+    '[KEY]', // key
+    '[VALUE]' // value
+);

package/docs/examples/functions/create.md

@@ -1,20 +1,31 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.create('[FUNCTION_ID]', '[NAME]', 'node-18.0');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.create(
+    '[FUNCTION_ID]', // functionId
+    '[NAME]', // name
+    sdk..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)
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.deleteDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.deleteDeployment(
+    '[FUNCTION_ID]', // functionId
+    '[DEPLOYMENT_ID]' // deploymentId
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.deleteVariable('[FUNCTION_ID]', '[VARIABLE_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.deleteVariable(
+    '[FUNCTION_ID]', // functionId
+    '[VARIABLE_ID]' // variableId
+);

package/docs/examples/functions/delete.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.delete('[FUNCTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.delete(
+    '[FUNCTION_ID]' // functionId
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.downloadDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.downloadDeployment(
+    '[FUNCTION_ID]', // functionId
+    '[DEPLOYMENT_ID]' // deploymentId
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.getDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.getDeployment(
+    '[FUNCTION_ID]', // functionId
+    '[DEPLOYMENT_ID]' // deploymentId
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = functions.getExecution('[FUNCTION_ID]', '[EXECUTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.getExecution(
+    '[FUNCTION_ID]', // functionId
+    '[EXECUTION_ID]' // executionId
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.getVariable('[FUNCTION_ID]', '[VARIABLE_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.getVariable(
+    '[FUNCTION_ID]', // functionId
+    '[VARIABLE_ID]' // variableId
+);

package/docs/examples/functions/get.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.get('[FUNCTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.get(
+    '[FUNCTION_ID]' // functionId
+);

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

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.listDeployments('[FUNCTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.listDeployments(
+    '[FUNCTION_ID]', // functionId
+    [], // queries (optional)
+    '[SEARCH]' // search (optional)
+);

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

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = functions.listExecutions('[FUNCTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.listExecutions(
+    '[FUNCTION_ID]', // functionId
+    [], // queries (optional)
+    '[SEARCH]' // search (optional)
+);

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

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.listRuntimes();
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.listRuntimes();

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

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.listVariables('[FUNCTION_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.listVariables(
+    '[FUNCTION_ID]' // functionId
+);

package/docs/examples/functions/list.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.list();
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.list(
+    [], // queries (optional)
+    '[SEARCH]' // search (optional)
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.updateDeployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.updateDeployment(
+    '[FUNCTION_ID]', // functionId
+    '[DEPLOYMENT_ID]' // deploymentId
+);

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

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.updateVariable('[FUNCTION_ID]', '[VARIABLE_ID]', '[KEY]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.updateVariable(
+    '[FUNCTION_ID]', // functionId
+    '[VARIABLE_ID]', // variableId
+    '[KEY]', // key
+    '[VALUE]' // value (optional)
+);

package/docs/examples/functions/update.md

@@ -1,20 +1,27 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const functions = new sdk.Functions(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = functions.update('[FUNCTION_ID]', '[NAME]');
+const functions = new sdk.Functions(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await functions.update(
+    '[FUNCTION_ID]', // functionId
+    '[NAME]', // name
+    sdk..Node145, // runtime (optional)
+    ["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)
+);

package/docs/examples/graphql/mutation.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const graphql = new sdk.Graphql(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = graphql.mutation({});
+const graphql = new sdk.Graphql(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await graphql.mutation(
+    {} // query
+);

package/docs/examples/graphql/query.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const graphql = new sdk.Graphql(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = graphql.query({});
+const graphql = new sdk.Graphql(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await graphql.query(
+    {} // query
+);

package/docs/examples/health/get-antivirus.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const health = new sdk.Health(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = health.getAntivirus();
+const health = new sdk.Health(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await health.getAntivirus();