node-appwrite 12.0.0-rc.4 → 12.0.1

package/docs/examples/functions/create.md

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.create(
-    '[FUNCTION_ID]', // functionId
-    '[NAME]', // name
+const result = await functions.create(
+    '<FUNCTION_ID>', // functionId
+    '<NAME>', // name
     sdk..Node145, // runtime
     ["any"], // execute (optional)
     [], // events (optional)
@@ -17,15 +17,15 @@ const response = await functions.create(
     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)
+    '<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)
+    '<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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.deleteDeployment(
-    '[FUNCTION_ID]', // functionId
-    '[DEPLOYMENT_ID]' // deploymentId
+const result = await functions.deleteDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.deleteVariable(
-    '[FUNCTION_ID]', // functionId
-    '[VARIABLE_ID]' // variableId
+const result = await functions.deleteVariable(
+    '<FUNCTION_ID>', // functionId
+    '<VARIABLE_ID>' // variableId
 );

package/docs/examples/functions/delete.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.delete(
-    '[FUNCTION_ID]' // functionId
+const result = await functions.delete(
+    '<FUNCTION_ID>' // functionId
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.downloadDeployment(
-    '[FUNCTION_ID]', // functionId
-    '[DEPLOYMENT_ID]' // deploymentId
+const result = await functions.downloadDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.getDeployment(
-    '[FUNCTION_ID]', // functionId
-    '[DEPLOYMENT_ID]' // deploymentId
+const result = await functions.getDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.getExecution(
-    '[FUNCTION_ID]', // functionId
-    '[EXECUTION_ID]' // executionId
+const result = await functions.getExecution(
+    '<FUNCTION_ID>', // functionId
+    '<EXECUTION_ID>' // executionId
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.getVariable(
-    '[FUNCTION_ID]', // functionId
-    '[VARIABLE_ID]' // variableId
+const result = await functions.getVariable(
+    '<FUNCTION_ID>', // functionId
+    '<VARIABLE_ID>' // variableId
 );

package/docs/examples/functions/get.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.get(
-    '[FUNCTION_ID]' // functionId
+const result = await functions.get(
+    '<FUNCTION_ID>' // functionId
 );

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

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.listDeployments(
-    '[FUNCTION_ID]', // functionId
+const result = await functions.listDeployments(
+    '<FUNCTION_ID>', // functionId
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

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

@@ -7,8 +7,8 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.listExecutions(
-    '[FUNCTION_ID]', // functionId
+const result = await functions.listExecutions(
+    '<FUNCTION_ID>', // functionId
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

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

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.listRuntimes();
+const result = await functions.listRuntimes();

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

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.listVariables(
-    '[FUNCTION_ID]' // functionId
+const result = await functions.listVariables(
+    '<FUNCTION_ID>' // functionId
 );

package/docs/examples/functions/list.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.list(
+const result = await functions.list(
     [], // queries (optional)
-    '[SEARCH]' // search (optional)
+    '<SEARCH>' // search (optional)
 );

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

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.updateDeployment(
-    '[FUNCTION_ID]', // functionId
-    '[DEPLOYMENT_ID]' // deploymentId
+const result = await functions.updateDeployment(
+    '<FUNCTION_ID>', // functionId
+    '<DEPLOYMENT_ID>' // deploymentId
 );

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

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.updateVariable(
-    '[FUNCTION_ID]', // functionId
-    '[VARIABLE_ID]', // variableId
-    '[KEY]', // key
-    '[VALUE]' // value (optional)
+const result = await functions.updateVariable(
+    '<FUNCTION_ID>', // functionId
+    '<VARIABLE_ID>', // variableId
+    '<KEY>', // key
+    '<VALUE>' // value (optional)
 );

package/docs/examples/functions/update.md

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 
 const functions = new sdk.Functions(client);
 
-const response = await functions.update(
-    '[FUNCTION_ID]', // functionId
-    '[NAME]', // name
+const result = await functions.update(
+    '<FUNCTION_ID>', // functionId
+    '<NAME>', // name
     sdk..Node145, // runtime (optional)
     ["any"], // execute (optional)
     [], // events (optional)
@@ -17,11 +17,11 @@ const response = await functions.update(
     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)
+    '<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)
+    '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional)
 );

package/docs/examples/graphql/mutation.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const graphql = new sdk.Graphql(client);
 
-const response = await graphql.mutation(
+const result = await graphql.mutation(
     {} // query
 );

package/docs/examples/graphql/query.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const graphql = new sdk.Graphql(client);
 
-const response = await graphql.query(
+const result = await graphql.query(
     {} // query
 );

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

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getAntivirus();
+const result = await health.getAntivirus();

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

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getCache();
+const result = await health.getCache();

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

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getCertificate(
+const result = await health.getCertificate(
     '' // domain (optional)
 );

package/docs/examples/health/get-d-b.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getDB();
+const result = await health.getDB();

package/docs/examples/health/get-failed-jobs.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getFailedJobs(
+const result = await health.getFailedJobs(
     sdk..V1Database, // name
     null // threshold (optional)
 );

package/docs/examples/health/get-pub-sub.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getPubSub();
+const result = await health.getPubSub();

package/docs/examples/health/get-queue-builds.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueBuilds(
+const result = await health.getQueueBuilds(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-certificates.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueCertificates(
+const result = await health.getQueueCertificates(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-databases.md

@@ -7,7 +7,7 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueDatabases(
-    '[NAME]', // name (optional)
+const result = await health.getQueueDatabases(
+    '<NAME>', // name (optional)
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-deletes.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueDeletes(
+const result = await health.getQueueDeletes(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-functions.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueFunctions(
+const result = await health.getQueueFunctions(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-logs.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueLogs(
+const result = await health.getQueueLogs(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-mails.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueMails(
+const result = await health.getQueueMails(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-messaging.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueMessaging(
+const result = await health.getQueueMessaging(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-migrations.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueMigrations(
+const result = await health.getQueueMigrations(
     null // threshold (optional)
 );

package/docs/examples/health/get-queue-usage-dump.md

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+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
+
+const health = new sdk.Health(client);
+
+const result = await health.getQueueUsageDump(
+    null // threshold (optional)
+);

package/docs/examples/health/get-queue-usage.md

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+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
+
+const health = new sdk.Health(client);
+
+const result = await health.getQueueUsage(
+    null // threshold (optional)
+);

package/docs/examples/health/get-queue-webhooks.md

@@ -7,6 +7,6 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueueWebhooks(
+const result = await health.getQueueWebhooks(
     null // threshold (optional)
 );

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

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getQueue();
+const result = await health.getQueue();

package/docs/examples/health/get-storage-local.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getStorageLocal();
+const result = await health.getStorageLocal();

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

@@ -0,0 +1,10 @@
+const sdk = require('node-appwrite');
+
+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
+
+const health = new sdk.Health(client);
+
+const result = await health.getStorage();

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

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.getTime();
+const result = await health.getTime();

package/docs/examples/health/get.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const health = new sdk.Health(client);
 
-const response = await health.get();
+const result = await health.get();

package/docs/examples/locale/get.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.get();
+const result = await locale.get();

package/docs/examples/locale/list-codes.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listCodes();
+const result = await locale.listCodes();

package/docs/examples/locale/list-continents.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listContinents();
+const result = await locale.listContinents();

package/docs/examples/locale/list-countries-e-u.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listCountriesEU();
+const result = await locale.listCountriesEU();

package/docs/examples/locale/list-countries-phones.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listCountriesPhones();
+const result = await locale.listCountriesPhones();

package/docs/examples/locale/list-countries.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listCountries();
+const result = await locale.listCountries();

package/docs/examples/locale/list-currencies.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listCurrencies();
+const result = await locale.listCurrencies();

package/docs/examples/locale/list-languages.md

@@ -7,4 +7,4 @@ const client = new sdk.Client()
 
 const locale = new sdk.Locale(client);
 
-const response = await locale.listLanguages();
+const result = await locale.listLanguages();

package/docs/examples/messaging/create-apns-provider.md

@@ -7,12 +7,13 @@ const client = new sdk.Client()
 
 const messaging = new sdk.Messaging(client);
 
-const response = await messaging.createApnsProvider(
-    '[PROVIDER_ID]', // providerId
-    '[NAME]', // name
-    '[AUTH_KEY]', // authKey (optional)
-    '[AUTH_KEY_ID]', // authKeyId (optional)
-    '[TEAM_ID]', // teamId (optional)
-    '[BUNDLE_ID]', // bundleId (optional)
+const result = await messaging.createApnsProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<AUTH_KEY>', // authKey (optional)
+    '<AUTH_KEY_ID>', // authKeyId (optional)
+    '<TEAM_ID>', // teamId (optional)
+    '<BUNDLE_ID>', // bundleId (optional)
+    false, // sandbox (optional)
     false // enabled (optional)
 );

package/docs/examples/messaging/create-email.md

@@ -7,17 +7,17 @@ const client = new sdk.Client()
 
 const messaging = new sdk.Messaging(client);
 
-const response = await messaging.createEmail(
-    '[MESSAGE_ID]', // messageId
-    '[SUBJECT]', // subject
-    '[CONTENT]', // content
+const result = await messaging.createEmail(
+    '<MESSAGE_ID>', // messageId
+    '<SUBJECT>', // subject
+    '<CONTENT>', // content
     [], // topics (optional)
     [], // users (optional)
     [], // targets (optional)
     [], // cc (optional)
     [], // bcc (optional)
     [], // attachments (optional)
-    sdk.MessageStatus.Draft, // status (optional)
+    false, // draft (optional)
     false, // html (optional)
     '' // scheduledAt (optional)
 );

package/docs/examples/messaging/create-fcm-provider.md

@@ -7,9 +7,9 @@ const client = new sdk.Client()
 
 const messaging = new sdk.Messaging(client);
 
-const response = await messaging.createFcmProvider(
-    '[PROVIDER_ID]', // providerId
-    '[NAME]', // name
+const result = await messaging.createFcmProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
     {}, // serviceAccountJSON (optional)
     false // enabled (optional)
 );

package/docs/examples/messaging/create-mailgun-provider.md

@@ -7,15 +7,15 @@ const client = new sdk.Client()
 
 const messaging = new sdk.Messaging(client);
 
-const response = await messaging.createMailgunProvider(
-    '[PROVIDER_ID]', // providerId
-    '[NAME]', // name
-    '[API_KEY]', // apiKey (optional)
-    '[DOMAIN]', // domain (optional)
+const result = await messaging.createMailgunProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<API_KEY>', // apiKey (optional)
+    '<DOMAIN>', // domain (optional)
     false, // isEuRegion (optional)
-    '[FROM_NAME]', // fromName (optional)
+    '<FROM_NAME>', // fromName (optional)
     'email@example.com', // fromEmail (optional)
-    '[REPLY_TO_NAME]', // replyToName (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
     'email@example.com', // replyToEmail (optional)
     false // enabled (optional)
 );