@appwrite.io/console 1.10.0 → 2.1.0

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

@@ -6,9 +6,10 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.listExecutions(
-    '<FUNCTION_ID>', // functionId
-    [] // queries (optional)
-);
+const result = await functions.listExecutions({
+    functionId: '<FUNCTION_ID>',
+    queries: [], // optional
+    total: false // optional
+});
 
 console.log(result);

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

@@ -6,11 +6,12 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.listTemplates(
-    [], // runtimes (optional)
-    [], // useCases (optional)
-    1, // limit (optional)
-    0 // offset (optional)
-);
+const result = await functions.listTemplates({
+    runtimes: [], // optional
+    useCases: [], // optional
+    limit: 1, // optional
+    offset: 0, // optional
+    total: false // optional
+});
 
 console.log(result);

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

@@ -1,4 +1,4 @@
-import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console";
+import { Client, Functions, UsageRange } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,8 +6,8 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.listUsage(
-    FunctionUsageRange.TwentyFourHours // range (optional)
-);
+const result = await functions.listUsage({
+    range: UsageRange.TwentyFourHours // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.listVariables(
-    '<FUNCTION_ID>' // functionId
-);
+const result = await functions.listVariables({
+    functionId: '<FUNCTION_ID>'
+});
 
 console.log(result);

package/docs/examples/functions/list.md

@@ -6,9 +6,10 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.list(
-    [], // queries (optional)
-    '<SEARCH>' // search (optional)
-);
+const result = await functions.list({
+    queries: [], // optional
+    search: '<SEARCH>', // optional
+    total: false // optional
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.updateDeploymentStatus(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
-);
+const result = await functions.updateDeploymentStatus({
+    functionId: '<FUNCTION_ID>',
+    deploymentId: '<DEPLOYMENT_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.updateFunctionDeployment(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
-);
+const result = await functions.updateFunctionDeployment({
+    functionId: '<FUNCTION_ID>',
+    deploymentId: '<DEPLOYMENT_ID>'
+});
 
 console.log(result);

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

@@ -6,12 +6,12 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.updateVariable(
-    '<FUNCTION_ID>', // functionId
-    '<VARIABLE_ID>', // variableId
-    '<KEY>', // key
-    '<VALUE>', // value (optional)
-    false // secret (optional)
-);
+const result = await functions.updateVariable({
+    functionId: '<FUNCTION_ID>',
+    variableId: '<VARIABLE_ID>',
+    key: '<KEY>',
+    value: '<VALUE>', // optional
+    secret: false // optional
+});
 
 console.log(result);

package/docs/examples/functions/update.md

@@ -1,4 +1,4 @@
-import { Client, Functions,  } from "@appwrite.io/console";
+import { Client, Functions, Runtime } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,25 +6,25 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.update(
-    '<FUNCTION_ID>', // functionId
-    '<NAME>', // name
-    .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)
-    [], // scopes (optional)
-    '<INSTALLATION_ID>', // installationId (optional)
-    '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
-    '<PROVIDER_BRANCH>', // providerBranch (optional)
-    false, // providerSilentMode (optional)
-    '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
-    '' // specification (optional)
-);
+const result = await functions.update({
+    functionId: '<FUNCTION_ID>',
+    name: '<NAME>',
+    runtime: Runtime.Node145, // optional
+    execute: ["any"], // optional
+    events: [], // optional
+    schedule: '', // optional
+    timeout: 1, // optional
+    enabled: false, // optional
+    logging: false, // optional
+    entrypoint: '<ENTRYPOINT>', // optional
+    commands: '<COMMANDS>', // optional
+    scopes: [], // optional
+    installationId: '<INSTALLATION_ID>', // optional
+    providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
+    providerBranch: '<PROVIDER_BRANCH>', // optional
+    providerSilentMode: false, // optional
+    providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
+    specification: '' // optional
+});
 
 console.log(result);

package/docs/examples/graphql/mutation.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const graphql = new Graphql(client);
 
-const result = await graphql.mutation(
-    {} // query
-);
+const result = await graphql.mutation({
+    query: {}
+});
 
 console.log(result);

package/docs/examples/graphql/query.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const graphql = new Graphql(client);
 
-const result = await graphql.query(
-    {} // query
-);
+const result = await graphql.query({
+    query: {}
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getCertificate(
-    '' // domain (optional)
-);
+const result = await health.getCertificate({
+    domain: '' // optional
+});
 
 console.log(result);

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

@@ -1,4 +1,4 @@
-import { Client, Health,  } from "@appwrite.io/console";
+import { Client, Health, Name } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,9 +6,9 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getFailedJobs(
-    .V1Database, // name
-    null // threshold (optional)
-);
+const result = await health.getFailedJobs({
+    name: Name.V1Database,
+    threshold: null // optional
+});
 
 console.log(result);

package/docs/examples/health/get-queue-billing-project-aggregation.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueBillingProjectAggregation(
-    null // threshold (optional)
-);
+const result = await health.getQueueBillingProjectAggregation({
+    threshold: null // optional
+});
 
 console.log(result);

package/docs/examples/health/get-queue-billing-team-aggregation.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueBillingTeamAggregation(
-    null // threshold (optional)
-);
+const result = await health.getQueueBillingTeamAggregation({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueBuilds(
-    null // threshold (optional)
-);
+const result = await health.getQueueBuilds({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueCertificates(
-    null // threshold (optional)
-);
+const result = await health.getQueueCertificates({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueDatabases(
-    '<NAME>', // name (optional)
-    null // threshold (optional)
-);
+const result = await health.getQueueDatabases({
+    name: '<NAME>', // optional
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueDeletes(
-    null // threshold (optional)
-);
+const result = await health.getQueueDeletes({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueFunctions(
-    null // threshold (optional)
-);
+const result = await health.getQueueFunctions({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueLogs(
-    null // threshold (optional)
-);
+const result = await health.getQueueLogs({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueMails(
-    null // threshold (optional)
-);
+const result = await health.getQueueMails({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueMessaging(
-    null // threshold (optional)
-);
+const result = await health.getQueueMessaging({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueMigrations(
-    null // threshold (optional)
-);
+const result = await health.getQueueMigrations({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueuePriorityBuilds(
-    null // threshold (optional)
-);
+const result = await health.getQueuePriorityBuilds({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueRegionManager(
-    null // threshold (optional)
-);
+const result = await health.getQueueRegionManager({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueStatsResources(
-    null // threshold (optional)
-);
+const result = await health.getQueueStatsResources({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -0,0 +1,13 @@
+import { Client, Health } 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 health = new Health(client);
+
+const result = await health.getQueueThreats({
+    threshold: null // optional
+});
+
+console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueUsage(
-    null // threshold (optional)
-);
+const result = await health.getQueueUsage({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const health = new Health(client);
 
-const result = await health.getQueueWebhooks(
-    null // threshold (optional)
-);
+const result = await health.getQueueWebhooks({
+    threshold: null // optional
+});
 
 console.log(result);

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

@@ -6,15 +6,15 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-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)
-);
+const result = await messaging.createAPNSProvider({
+    providerId: '<PROVIDER_ID>',
+    name: '<NAME>',
+    authKey: '<AUTH_KEY>', // optional
+    authKeyId: '<AUTH_KEY_ID>', // optional
+    teamId: '<TEAM_ID>', // optional
+    bundleId: '<BUNDLE_ID>', // optional
+    sandbox: false, // optional
+    enabled: false // optional
+});
 
 console.log(result);

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

@@ -6,19 +6,19 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.createEmail(
-    '<MESSAGE_ID>', // messageId
-    '<SUBJECT>', // subject
-    '<CONTENT>', // content
-    [], // topics (optional)
-    [], // users (optional)
-    [], // targets (optional)
-    [], // cc (optional)
-    [], // bcc (optional)
-    [], // attachments (optional)
-    false, // draft (optional)
-    false, // html (optional)
-    '' // scheduledAt (optional)
-);
+const result = await messaging.createEmail({
+    messageId: '<MESSAGE_ID>',
+    subject: '<SUBJECT>',
+    content: '<CONTENT>',
+    topics: [], // optional
+    users: [], // optional
+    targets: [], // optional
+    cc: [], // optional
+    bcc: [], // optional
+    attachments: [], // optional
+    draft: false, // optional
+    html: false, // optional
+    scheduledAt: '' // optional
+});
 
 console.log(result);

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

@@ -6,11 +6,11 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.createFcmProvider(
-    '<PROVIDER_ID>', // providerId
-    '<NAME>', // name
-    {}, // serviceAccountJSON (optional)
-    false // enabled (optional)
-);
+const result = await messaging.createFCMProvider({
+    providerId: '<PROVIDER_ID>',
+    name: '<NAME>',
+    serviceAccountJSON: {}, // optional
+    enabled: false // optional
+});
 
 console.log(result);

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

@@ -6,17 +6,17 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.createMailgunProvider(
-    '<PROVIDER_ID>', // providerId
-    '<NAME>', // name
-    '<API_KEY>', // apiKey (optional)
-    '<DOMAIN>', // domain (optional)
-    false, // isEuRegion (optional)
-    '<FROM_NAME>', // fromName (optional)
-    'email@example.com', // fromEmail (optional)
-    '<REPLY_TO_NAME>', // replyToName (optional)
-    'email@example.com', // replyToEmail (optional)
-    false // enabled (optional)
-);
+const result = await messaging.createMailgunProvider({
+    providerId: '<PROVIDER_ID>',
+    name: '<NAME>',
+    apiKey: '<API_KEY>', // optional
+    domain: '<DOMAIN>', // optional
+    isEuRegion: false, // optional
+    fromName: '<FROM_NAME>', // optional
+    fromEmail: 'email@example.com', // optional
+    replyToName: '<REPLY_TO_NAME>', // optional
+    replyToEmail: 'email@example.com', // optional
+    enabled: false // optional
+});
 
 console.log(result);

package/docs/examples/messaging/{create-msg91provider.md → create-msg-91-provider.md}

@@ -6,13 +6,13 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.createMsg91Provider(
-    '<PROVIDER_ID>', // providerId
-    '<NAME>', // name
-    '<TEMPLATE_ID>', // templateId (optional)
-    '<SENDER_ID>', // senderId (optional)
-    '<AUTH_KEY>', // authKey (optional)
-    false // enabled (optional)
-);
+const result = await messaging.createMsg91Provider({
+    providerId: '<PROVIDER_ID>',
+    name: '<NAME>',
+    templateId: '<TEMPLATE_ID>', // optional
+    senderId: '<SENDER_ID>', // optional
+    authKey: '<AUTH_KEY>', // optional
+    enabled: false // optional
+});
 
 console.log(result);