@appwrite.io/console 1.9.0 → 1.10.0

package/src/services/functions.ts

@@ -43,6 +43,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
      *
@@ -146,6 +147,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -167,6 +169,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * List allowed function specifications for this instance.
      *
@@ -188,6 +191,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
@@ -225,6 +229,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
@@ -250,6 +255,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Get usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
@@ -275,6 +281,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Get a function by its unique ID.
      *
@@ -300,6 +307,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Update function by its unique ID.
      *
@@ -397,6 +405,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Delete a function by its unique ID.
      *
@@ -423,6 +432,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
      *
@@ -456,6 +466,7 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Get a list of all the function's code deployments. You can use the query params to filter your results.
      *
@@ -489,12 +500,13 @@ export class Functions {
             payload
         );
     }
+
     /**
      * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.
-
-This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
-
-Use the "command" param to set the entrypoint used to execute your code.
+     * 
+     * This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
+     * 
+     * Use the "command" param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
      * @param {File} code
@@ -542,6 +554,7 @@ Use the "command" param to set the entrypoint used to execute your cod
             onProgress
         );
     }
+
     /**
      * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
      *
@@ -579,10 +592,11 @@ Use the "command" param to set the entrypoint used to execute your cod
             payload
         );
     }
+
     /**
      * Create a deployment based on a template.
-
-Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
+     * 
+     * Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
      *
      * @param {string} functionId
      * @param {string} repository
@@ -639,10 +653,11 @@ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/s
             payload
         );
     }
+
     /**
      * Create a deployment when a function is connected to VCS.
-
-This endpoint lets you create deployment from a branch, commit, or a tag.
+     * 
+     * This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} functionId
      * @param {VCSDeploymentType} type
@@ -685,6 +700,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a function deployment by its unique ID.
      *
@@ -714,6 +730,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a code deployment by its unique ID.
      *
@@ -744,6 +761,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
      *
@@ -778,6 +796,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
         
         return uri.toString();
     }
+
     /**
      * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
      *
@@ -808,6 +827,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
@@ -837,6 +857,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *
@@ -887,6 +908,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a function execution log by its unique ID.
      *
@@ -916,6 +938,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a function execution by its unique ID.
      *
@@ -946,6 +969,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
      *
@@ -975,6 +999,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a list of all variables of a specific function.
      *
@@ -1000,6 +1025,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.
      *
@@ -1044,6 +1070,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Get a variable by its unique ID.
      *
@@ -1073,6 +1100,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Update variable by its unique ID.
      *
@@ -1118,6 +1146,7 @@ This endpoint lets you create deployment from a branch, commit, or a tag.
             payload
         );
     }
+
     /**
      * Delete a variable by its unique ID.
      *

package/src/services/graphql.ts

@@ -39,6 +39,7 @@ export class Graphql {
             payload
         );
     }
+
     /**
      * Execute a GraphQL mutation.
      *

package/src/services/health.ts

@@ -31,6 +31,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
@@ -52,6 +53,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite in-memory cache servers are up and connection is successful.
      *
@@ -73,6 +75,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the SSL certificate for a domain
      *
@@ -98,6 +101,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite database servers are up and connection is successful.
      *
@@ -119,6 +123,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
@@ -140,6 +145,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get billing project aggregation queue
      *
@@ -165,6 +171,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get billing team aggregation queue
      *
@@ -190,6 +197,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -215,6 +223,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the priority builds queue size.
      *
@@ -240,6 +249,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
      *
@@ -265,6 +275,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -294,6 +305,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -319,9 +331,10 @@ export class Health {
             payload
         );
     }
+
     /**
      * Returns the amount of failed jobs in a given queue.
-
+     * 
      *
      * @param {Name} name
      * @param {number} threshold
@@ -349,6 +362,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -374,6 +388,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -399,6 +414,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -424,6 +440,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -449,6 +466,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -474,6 +492,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get region manager queue
      *
@@ -499,6 +518,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
      *
@@ -524,6 +544,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -549,6 +570,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
      *
@@ -574,6 +596,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite storage device is up and connection is successful.
      *
@@ -595,6 +618,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite local storage device is up and connection is successful.
      *
@@ -616,6 +640,7 @@ export class Health {
             payload
         );
     }
+
     /**
      * Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.
      *

package/src/services/locale.ts

@@ -11,8 +11,8 @@ export class Locale {
 
     /**
      * Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
-
-([IP Geolocation by DB-IP](https://db-ip.com))
+     * 
+     * ([IP Geolocation by DB-IP](https://db-ip.com))
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.Locale>}
@@ -32,6 +32,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
      *
@@ -53,6 +54,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all continents. You can use the locale header to get the data in a supported language.
      *
@@ -74,6 +76,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all countries. You can use the locale header to get the data in a supported language.
      *
@@ -95,6 +98,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
      *
@@ -116,6 +120,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all countries phone codes. You can use the locale header to get the data in a supported language.
      *
@@ -137,6 +142,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
      *
@@ -158,6 +164,7 @@ export class Locale {
             payload
         );
     }
+
     /**
      * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
      *