@appwrite.io/console 1.5.2 → 1.6.0

package/types/services/functions.d.ts

@@ -7,8 +7,6 @@ export declare class Functions {
     client: Client;
     constructor(client: Client);
     /**
-     * List functions
-     *
      * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -18,8 +16,6 @@ export declare class Functions {
      */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
-     * Create function
-     *
      * 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.
      *
      * @param {string} functionId
@@ -49,8 +45,6 @@ export declare class Functions {
      */
     create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string, specification?: string): Promise<Models.Function>;
     /**
-     * List runtimes
-     *
      * Get a list of all runtimes that are currently active on your instance.
      *
      * @throws {AppwriteException}
@@ -58,8 +52,6 @@ export declare class Functions {
      */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * List available function runtime specifications
-     *
      * List allowed function specifications for this instance.
 
      *
@@ -68,8 +60,6 @@ export declare class Functions {
      */
     listSpecifications(): Promise<Models.SpecificationList>;
     /**
-     * List function templates
-     *
      * List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
      * @param {string[]} runtimes
@@ -81,8 +71,6 @@ export declare class Functions {
      */
     listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
     /**
-     * Get function template
-     *
      * Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
      *
      * @param {string} templateId
@@ -91,8 +79,6 @@ export declare class Functions {
      */
     getTemplate(templateId: string): Promise<Models.TemplateFunction>;
     /**
-     * Get functions usage
-     *
      * Get usage metrics and statistics for a for all functions. View statistics including total functions, 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.
      *
      * @param {FunctionUsageRange} range
@@ -101,8 +87,6 @@ export declare class Functions {
      */
     getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
     /**
-     * Get function
-     *
      * Get a function by its unique ID.
      *
      * @param {string} functionId
@@ -111,8 +95,6 @@ export declare class Functions {
      */
     get(functionId: string): Promise<Models.Function>;
     /**
-     * Update function
-     *
      * Update function by its unique ID.
      *
      * @param {string} functionId
@@ -138,8 +120,6 @@ export declare class Functions {
      */
     update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
-     * Delete function
-     *
      * Delete a function by its unique ID.
      *
      * @param {string} functionId
@@ -148,8 +128,6 @@ export declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * List deployments
-     *
      * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -160,8 +138,6 @@ export declare class Functions {
      */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
-     * 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&#039;ll need to update the function&#039;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).
@@ -178,8 +154,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get deployment
-     *
      * Get a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -189,8 +163,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update 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 execution endpoint.
      *
      * @param {string} functionId
@@ -200,8 +172,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
-     * Delete deployment
-     *
      * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -211,8 +181,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Rebuild deployment
-     *
      * 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&#039;s code will be preserved and used for the new build.
      *
      * @param {string} functionId
@@ -223,8 +191,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
     /**
-     * Cancel deployment
-     *
      * 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&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
      *
      * @param {string} functionId
@@ -234,8 +200,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
     /**
-     * Download deployment
-     *
      * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
      *
      * @param {string} functionId
@@ -245,8 +209,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeploymentDownload(functionId: string, deploymentId: string): string;
     /**
-     * List executions
-     *
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -257,8 +219,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
-     * 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 updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *
      * @param {string} functionId
@@ -273,8 +233,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
     /**
-     * Get execution
-     *
      * Get a function execution log by its unique ID.
      *
      * @param {string} functionId
@@ -284,8 +242,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
-     * Delete execution
-     *
      * Delete a function execution by its unique ID.
 
      *
@@ -296,8 +252,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteExecution(functionId: string, executionId: string): Promise<{}>;
     /**
-     * Get function usage
-     *
      * 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.
      *
      * @param {string} functionId
@@ -307,8 +261,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
     /**
-     * List variables
-     *
      * Get a list of all variables of a specific function.
      *
      * @param {string} functionId
@@ -317,8 +269,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
-     * Create variable
-     *
      * Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.
      *
      * @param {string} functionId
@@ -329,8 +279,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get variable
-     *
      * Get a variable by its unique ID.
      *
      * @param {string} functionId
@@ -340,8 +288,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
-     * Update variable
-     *
      * Update variable by its unique ID.
      *
      * @param {string} functionId
@@ -353,8 +299,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete variable
-     *
      * Delete a variable by its unique ID.
      *
      * @param {string} functionId

package/types/services/graphql.d.ts

@@ -3,8 +3,6 @@ export declare class Graphql {
     client: Client;
     constructor(client: Client);
     /**
-     * GraphQL endpoint
-     *
      * Execute a GraphQL mutation.
      *
      * @param {object} query
@@ -13,8 +11,6 @@ export declare class Graphql {
      */
     query(query: object): Promise<{}>;
     /**
-     * GraphQL endpoint
-     *
      * Execute a GraphQL mutation.
      *
      * @param {object} query

package/types/services/health.d.ts

@@ -5,8 +5,6 @@ export declare class Health {
     client: Client;
     constructor(client: Client);
     /**
-     * Get HTTP
-     *
      * Check the Appwrite HTTP server is up and responsive.
      *
      * @throws {AppwriteException}
@@ -14,8 +12,6 @@ export declare class Health {
      */
     get(): Promise<Models.HealthStatus>;
     /**
-     * Get antivirus
-     *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -23,8 +19,6 @@ export declare class Health {
      */
     getAntivirus(): Promise<Models.HealthAntivirus>;
     /**
-     * Get cache
-     *
      * Check the Appwrite in-memory cache servers are up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -32,8 +26,6 @@ export declare class Health {
      */
     getCache(): Promise<Models.HealthStatus>;
     /**
-     * Get the SSL certificate for a domain
-     *
      * Get the SSL certificate for a domain
      *
      * @param {string} domain
@@ -42,8 +34,6 @@ export declare class Health {
      */
     getCertificate(domain?: string): Promise<Models.HealthCertificate>;
     /**
-     * Get DB
-     *
      * Check the Appwrite database servers are up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -51,8 +41,6 @@ export declare class Health {
      */
     getDB(): Promise<Models.HealthStatus>;
     /**
-     * Get pubsub
-     *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -60,8 +48,6 @@ export declare class Health {
      */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
-     * Get billing aggregation queue
-     *
      * Get billing aggregation queue
      *
      * @param {number} threshold
@@ -70,8 +56,6 @@ export declare class Health {
      */
     getQueueBillingAggregation(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get builds queue
-     *
      * Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
@@ -80,8 +64,6 @@ export declare class Health {
      */
     getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get billing aggregation queue
-     *
      * Get the priority builds queue size.
      *
      * @param {number} threshold
@@ -90,8 +72,6 @@ export declare class Health {
      */
     getQueuePriorityBuilds(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
@@ -100,8 +80,6 @@ export declare class Health {
      */
     getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get databases queue
-     *
      * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {string} name
@@ -111,8 +89,6 @@ export declare class Health {
      */
     getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * 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
@@ -121,8 +97,6 @@ export declare class Health {
      */
     getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get number of failed queue jobs
-     *
      * Returns the amount of failed jobs in a given queue.
 
      *
@@ -133,8 +107,6 @@ export declare class Health {
      */
     getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get functions queue
-     *
      * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
@@ -143,8 +115,6 @@ export declare class Health {
      */
     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
@@ -153,8 +123,6 @@ export declare class Health {
      */
     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
@@ -163,8 +131,6 @@ export declare class Health {
      */
     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
@@ -173,8 +139,6 @@ export declare class Health {
      */
     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
@@ -183,8 +147,6 @@ export declare class Health {
      */
     getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get stats  resources queue
-     *
      * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
      *
      * @param {number} threshold
@@ -193,8 +155,6 @@ export declare class Health {
      */
     getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get stats usage queue
-     *
      * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
@@ -203,8 +163,6 @@ export declare class Health {
      */
     getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get usage dump queue
-     *
      * Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
@@ -213,8 +171,6 @@ export declare class Health {
      */
     getQueueStatsUsageDump(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get webhooks queue
-     *
      * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
@@ -223,8 +179,6 @@ export declare class Health {
      */
     getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get storage
-     *
      * Check the Appwrite storage device is up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -232,8 +186,6 @@ export declare class Health {
      */
     getStorage(): Promise<Models.HealthStatus>;
     /**
-     * Get local storage
-     *
      * Check the Appwrite local storage device is up and connection is successful.
      *
      * @throws {AppwriteException}
@@ -241,8 +193,6 @@ export declare class Health {
      */
     getStorageLocal(): Promise<Models.HealthStatus>;
     /**
-     * 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 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.
      *
      * @throws {AppwriteException}

package/types/services/locale.d.ts

@@ -4,8 +4,6 @@ export declare class Locale {
     client: Client;
     constructor(client: Client);
     /**
-     * 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 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))
@@ -15,8 +13,6 @@ export declare class Locale {
      */
     get(): Promise<Models.Locale>;
     /**
-     * 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}
@@ -24,8 +20,6 @@ export declare class Locale {
      */
     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}
@@ -33,8 +27,6 @@ export declare class Locale {
      */
     listContinents(): Promise<Models.ContinentList>;
     /**
-     * List countries
-     *
      * List of all countries. You can use the locale header to get the data in a supported language.
      *
      * @throws {AppwriteException}
@@ -42,8 +34,6 @@ export declare class Locale {
      */
     listCountries(): Promise<Models.CountryList>;
     /**
-     * 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}
@@ -51,8 +41,6 @@ export declare class Locale {
      */
     listCountriesEU(): Promise<Models.CountryList>;
     /**
-     * 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}
@@ -60,8 +48,6 @@ export declare class Locale {
      */
     listCountriesPhones(): Promise<Models.PhoneList>;
     /**
-     * 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 header to get the data in a supported language.
      *
      * @throws {AppwriteException}
@@ -69,8 +55,6 @@ export declare class Locale {
      */
     listCurrencies(): Promise<Models.CurrencyList>;
     /**
-     * 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}