@appwrite.io/console 0.2.0 → 0.4.0

package/types/services/functions.d.ts

@@ -5,7 +5,7 @@ import type { UploadProgress } from '../client';
 export declare class Functions extends Service {
     constructor(client: Client);
     /**
-     * List Functions
+     * List functions
      *
      * Get a list of all the project's functions. You can use the query params to
      * filter your results.
@@ -14,14 +14,15 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
-     * Create Function
+     * Create function
      *
      * Create a new function. You can pass a list of
-     * [permissions](/docs/permissions) to allow different project users or team
-     * with access to execute the function using the client API.
+     * [permissions](https://appwrite.io/docs/permissions) to allow different
+     * project users or team with access to execute the function using the client
+     * API.
      *
      * @param {string} functionId
      * @param {string} name
@@ -31,10 +32,22 @@ export declare class Functions extends Service {
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
+     * @param {string} templateRepository
+     * @param {string} templateOwner
+     * @param {string} templateRootDirectory
+     * @param {string} templateBranch
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    */
+    create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
     /**
      * List runtimes
      *
@@ -42,55 +55,64 @@ export declare class Functions extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * Get Functions Usage
+     * Get functions usage
      *
      *
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageFunctions>;
     /**
-     * Get Function
+     * Get function
      *
      * Get a function by its unique ID.
      *
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(functionId: string): Promise<Models.Function>;
     /**
-     * Update Function
+     * Update function
      *
      * Update function by its unique ID.
      *
      * @param {string} functionId
      * @param {string} name
+     * @param {string} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
      * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {string} entrypoint
+     * @param {string} commands
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    update(functionId: string, name: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    */
+    update(functionId: string, name: string, runtime?: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
     /**
-     * Delete Function
+     * Delete function
      *
      * Delete a function by its unique ID.
      *
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     delete(functionId: string): Promise<{}>;
     /**
-     * List Deployments
+     * List deployments
      *
      * Get a list of all the project's code deployments. You can use the query
      * params to filter your results.
@@ -100,10 +122,10 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
-     * Create Deployment
+     * Create deployment
      *
      * 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
@@ -112,20 +134,21 @@ export declare class Functions extends Service {
      * 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](/docs/functions).
+     * tutorial](https://appwrite.io/docs/functions).
      *
-     * Use the "command" param to set the entry point used to execute your code.
+     * Use the "command" param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
-     * @param {string} entrypoint
      * @param {File} code
      * @param {boolean} activate
+     * @param {string} entrypoint
+     * @param {string} commands
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createDeployment(functionId: string, entrypoint: string, code: File, activate: boolean, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    */
+    createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get Deployment
+     * Get deployment
      *
      * Get a code deployment by its unique ID.
      *
@@ -133,10 +156,10 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update Function Deployment
+     * Update function deployment
      *
      * Update the function code deployment ID using the unique function ID. Use
      * this endpoint to switch the code deployment that should be executed by the
@@ -146,10 +169,10 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
-     * Delete Deployment
+     * Delete deployment
      *
      * Delete a code deployment by its unique ID.
      *
@@ -157,21 +180,35 @@ export declare class Functions extends Service {
      * @param {string} deploymentId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Create Build
+     * Create build
      *
+     * Create a new build for an Appwrite Function deployment. This endpoint can
+     * be used to retry a failed build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
     /**
-     * List Executions
+     * Download Deployment
+     *
+     * Get a Deployment's contents by its unique ID. This endpoint supports range
+     * requests for partial or streaming file download.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {URL}
+    */
+    downloadDeployment(functionId: string, deploymentId: string): URL;
+    /**
+     * List executions
      *
      * Get a list of all the current user function execution logs. You can use the
      * query params to filter your results.
@@ -181,10 +218,10 @@ export declare class Functions extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
-     * Create Execution
+     * Create execution
      *
      * Trigger a function execution. The returned object will return you the
      * current execution status. You can ping the `Get Execution` endpoint to get
@@ -192,14 +229,17 @@ export declare class Functions extends Service {
      * function execution process will start asynchronously.
      *
      * @param {string} functionId
-     * @param {string} data
+     * @param {string} body
      * @param {boolean} async
+     * @param {string} xpath
+     * @param {string} method
+     * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createExecution(functionId: string, data?: string, async?: boolean): Promise<Models.Execution>;
+    */
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
     /**
-     * Get Execution
+     * Get execution
      *
      * Get a function execution log by its unique ID.
      *
@@ -207,43 +247,43 @@ export declare class Functions extends Service {
      * @param {string} executionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
-     * Get Function Usage
+     * Get function usage
      *
      *
      * @param {string} functionId
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunctions>;
     /**
-     * List Variables
+     * List variables
      *
      * Get a list of all variables of a specific function.
      *
      * @param {string} functionId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
-     * Create Variable
+     * Create variable
      *
-     * Create a new function variable. These variables can be accessed within
-     * function in the `env` object under the request variable.
+     * Create a new function environment variable. These variables can be accessed
+     * in the function at runtime as environment variables.
      *
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get Variable
+     * Get variable
      *
      * Get a variable by its unique ID.
      *
@@ -251,10 +291,10 @@ export declare class Functions extends Service {
      * @param {string} variableId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
-     * Update Variable
+     * Update variable
      *
      * Update variable by its unique ID.
      *
@@ -264,10 +304,10 @@ export declare class Functions extends Service {
      * @param {string} value
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete Variable
+     * Delete variable
      *
      * Delete a variable by its unique ID.
      *
@@ -275,6 +315,6 @@ export declare class Functions extends Service {
      * @param {string} variableId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteVariable(functionId: string, variableId: string): Promise<{}>;
 }

package/types/services/graphql.d.ts

@@ -3,23 +3,23 @@ import { Client } from '../client';
 export declare class Graphql extends Service {
     constructor(client: Client);
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
      * @param {object} query
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     query(query: object): Promise<{}>;
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
      * @param {object} query
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     mutation(query: object): Promise<{}>;
 }

package/types/services/health.d.ts

@@ -10,26 +10,26 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(): Promise<Models.HealthStatus>;
     /**
-     * Get Antivirus
+     * Get antivirus
      *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getAntivirus(): Promise<Models.HealthAntivirus>;
     /**
-     * Get Cache
+     * Get cache
      *
      * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getCache(): Promise<Models.HealthStatus>;
     /**
      * Get DB
@@ -38,77 +38,148 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getDB(): Promise<Models.HealthStatus>;
     /**
-     * Get PubSub
+     * Get pubsub
      *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
-     * Get Queue
+     * Get queue
      *
      * Check the Appwrite queue messaging servers are up and connection is
      * successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getQueue(): Promise<Models.HealthStatus>;
     /**
-     * Get Certificates Queue
+     * Get builds queue
+     *
+     * Get the number of builds that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get certificates queue
      *
      * Get the number of certificates that are waiting to be issued against
      * [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
      * server.
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    getQueueCertificates(): Promise<Models.HealthQueue>;
+    */
+    getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Functions Queue
+     * Get databases queue
      *
+     * Get the number of database changes that are waiting to be processed in the
+     * Appwrite internal queue server.
      *
+     * @param {string} name
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    getQueueFunctions(): Promise<Models.HealthQueue>;
+    */
+    getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Logs Queue
+     * Get deletes queue
+     *
+     * Get the number of background destructive changes that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get functions queue
+     *
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get logs queue
      *
      * Get the number of logs that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get mails queue
+     *
+     * Get the number of mails that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get messaging queue
+     *
+     * Get the number of messages that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get migrations queue
+     *
+     * Get the number of migrations that are waiting to be processed in the
+     * Appwrite internal queue server.
+     *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    getQueueLogs(): Promise<Models.HealthQueue>;
+    */
+    getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Webhooks Queue
+     * Get webhooks queue
      *
      * Get the number of webhooks that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    getQueueWebhooks(): Promise<Models.HealthQueue>;
+    */
+    getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get Local Storage
+     * Get local storage
      *
      * Check the Appwrite local storage device is up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getStorageLocal(): Promise<Models.HealthStatus>;
     /**
-     * Get Time
+     * Get time
      *
      * Check the Appwrite server time is synced with Google remote NTP server. We
      * use this technology to smoothly handle leap seconds with no disruptive
@@ -120,6 +191,6 @@ export declare class Health extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getTime(): Promise<Models.HealthTime>;
 }

package/types/services/locale.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Locale extends Service {
     constructor(client: Client);
     /**
-     * Get User Locale
+     * Get user 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
@@ -15,50 +15,60 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get(): Promise<Models.Locale>;
     /**
-     * List Continents
+     * List Locale Codes
+     *
+     * List of all locale codes in [ISO
+     * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listCodes(): Promise<Models.LocaleCodeList>;
+    /**
+     * List continents
      *
      * List of all continents. You can use the locale header to get the data in a
      * supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listContinents(): Promise<Models.ContinentList>;
     /**
-     * List Countries
+     * List countries
      *
      * List of all countries. You can use the locale header to get the data in a
      * supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountries(): Promise<Models.CountryList>;
     /**
-     * List EU Countries
+     * List EU countries
      *
      * 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.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountriesEU(): Promise<Models.CountryList>;
     /**
-     * List Countries Phone Codes
+     * List countries phone codes
      *
      * List of all countries phone codes. You can use the locale header to get the
      * data in a supported language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCountriesPhones(): Promise<Models.PhoneList>;
     /**
-     * List Currencies
+     * List currencies
      *
      * List of all currencies, including currency symbol, name, plural, and
      * decimal digits for all major and minor currencies. You can use the locale
@@ -66,16 +76,16 @@ export declare class Locale extends Service {
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listCurrencies(): Promise<Models.CurrencyList>;
     /**
-     * List Languages
+     * List languages
      *
      * List of all languages classified by ISO 639-1 including 2-letter code, name
      * in English, and name in the respective language.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listLanguages(): Promise<Models.LanguageList>;
 }