@appwrite.io/console 1.6.0 → 1.7.0

package/types/services/functions.d.ts

@@ -2,6 +2,8 @@ import { Client, UploadProgress } from '../client';
 import type { Models } from '../models';
 import { Runtime } from '../enums/runtime';
 import { FunctionUsageRange } from '../enums/function-usage-range';
+import { VCSDeploymentType } from '../enums/v-c-s-deployment-type';
+import { DeploymentDownloadType } from '../enums/deployment-download-type';
 import { ExecutionMethod } from '../enums/execution-method';
 export declare class Functions {
     client: Client;
@@ -35,15 +37,15 @@ export declare class Functions {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
+     * @param {string} specification
      * @param {string} templateRepository
      * @param {string} templateOwner
      * @param {string} templateRootDirectory
      * @param {string} templateVersion
-     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
-    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>;
+    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, specification?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -53,7 +55,6 @@ export declare class Functions {
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
      * List allowed function specifications for this instance.
-
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
@@ -79,13 +80,13 @@ export declare class Functions {
      */
     getTemplate(templateId: string): Promise<Models.TemplateFunction>;
     /**
-     * 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.
+     * 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.
      *
      * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageFunctions>}
      */
-    getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
+    listUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
     /**
      * Get a function by its unique ID.
      *
@@ -128,7 +129,16 @@ export declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
+     * Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Function>}
+     */
+    updateFunctionDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    /**
+     * Get a list of all the function&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
@@ -154,70 +164,89 @@ 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 a code deployment by its unique ID.
+     * 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
      * @param {string} deploymentId
+     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
+    createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.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.
+     * 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.
      *
      * @param {string} functionId
-     * @param {string} deploymentId
+     * @param {string} repository
+     * @param {string} owner
+     * @param {string} rootDirectory
+     * @param {string} version
+     * @param {boolean} activate
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Function>}
+     * @returns {Promise<Models.Deployment>}
      */
-    updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
     /**
-     * Delete a code deployment by its unique ID.
+     * Create a deployment when a function is connected to VCS.
+
+This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} functionId
+     * @param {VCSDeploymentType} type
+     * @param {string} reference
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Get a function deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Deployment>}
      */
-    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
+    getDeployment(functionId: string, deploymentId: string): Promise<Models.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.
+     * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
-     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
+    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * 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.
+     * Get a function deployment content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
      *
      * @param {string} functionId
      * @param {string} deploymentId
+     * @param {DeploymentDownloadType} type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Build>}
+     * @returns {string}
      */
-    updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
+    getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): string;
     /**
-     * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
+     * 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
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {string}
+     * @returns {Promise<Models.Deployment>}
      */
-    getDeploymentDownload(functionId: string, deploymentId: string): string;
+    updateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
-     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
-    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
     /**
      * 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.
      *
@@ -243,7 +272,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 a function execution by its unique ID.
-
      *
      * @param {string} functionId
      * @param {string} executionId
@@ -259,7 +287,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageFunction>}
      */
-    getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
+    getUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
     /**
      * Get a list of all variables of a specific function.
      *
@@ -274,10 +302,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
+    createVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Get a variable by its unique ID.
      *
@@ -294,10 +323,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    updateVariable(functionId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Delete a variable by its unique ID.
      *

package/types/services/health.d.ts

@@ -147,29 +147,29 @@ export declare class Health {
      */
     getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
+     * Get region manager queue
      *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
-    getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
+    getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
+     * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
-    getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
+    getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.
+     * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
-    getQueueStatsUsageDump(threshold?: number): Promise<Models.HealthQueue>;
+    getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
      *

package/types/services/migrations.d.ts

@@ -34,6 +34,16 @@ export declare class Migrations {
      * @returns {Promise<Models.MigrationReport>}
      */
     getAppwriteReport(resources: string[], endpoint: string, projectID: string, key: string): Promise<Models.MigrationReport>;
+    /**
+     * Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string} resourceId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Migration>}
+     */
+    createCsvMigration(bucketId: string, fileId: string, resourceId: string): Promise<Models.Migration>;
     /**
      * Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
      *

package/types/services/organizations.d.ts

@@ -268,14 +268,4 @@ export declare class Organizations {
      * @returns {Promise<Models.Organization<Preferences>>}
      */
     setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
-    /**
-     * Get the usage data for an organization.
-     *
-     * @param {string} organizationId
-     * @param {string} startDate
-     * @param {string} endDate
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageOrganization>}
-     */
-    getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
 }

package/types/services/project.d.ts

@@ -26,10 +26,11 @@ export declare class Project {
      *
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(key: string, value: string): Promise<Models.Variable>;
+    createVariable(key: string, value: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Get a project variable by its unique ID.
      *
@@ -44,10 +45,11 @@ export declare class Project {
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    updateVariable(variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Delete a project variable by its unique ID.
      *

package/types/services/projects.d.ts

@@ -189,6 +189,54 @@ export declare class Projects {
      * @returns {Promise<Models.Project>}
      */
     updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
+    /**
+     * List all the project\&#039;s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.&#039;
+     *
+     * @param {string} projectId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKeyList>}
+     */
+    listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
+    /**
+     * Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
+     *
+     * @param {string} projectId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey>;
+    /**
+     * Get a project\&#039;s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    getDevKey(projectId: string, keyId: string): Promise<Models.DevKey>;
+    /**
+     * Update a project\&#039;s dev key by its unique ID. Use this endpoint to update a project\&#039;s dev key name or expiration time.&#039;
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @param {string} name
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DevKey>}
+     */
+    updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey>;
+    /**
+     * Delete a project\&#039;s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
+     *
+     * @param {string} projectId
+     * @param {string} keyId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteDevKey(projectId: string, keyId: string): Promise<{}>;
     /**
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
      *

package/types/services/proxy.d.ts

@@ -1,6 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
-import { ResourceType } from '../enums/resource-type';
+import { StatusCode } from '../enums/status-code';
 export declare class Proxy {
     client: Client;
     constructor(client: Client);
@@ -14,15 +14,43 @@ export declare class Proxy {
      */
     listRules(queries?: string[], search?: string): Promise<Models.ProxyRuleList>;
     /**
-     * Create a new proxy rule.
+     * Create a new proxy rule for serving Appwrite&#039;s API on custom domain.
      *
      * @param {string} domain
-     * @param {ResourceType} resourceType
-     * @param {string} resourceId
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    createRule(domain: string, resourceType: ResourceType, resourceId?: string): Promise<Models.ProxyRule>;
+    createAPIRule(domain: string): Promise<Models.ProxyRule>;
+    /**
+     * Create a new proxy rule for executing Appwrite Function on custom domain.
+     *
+     * @param {string} domain
+     * @param {string} functionId
+     * @param {string} branch
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createFunctionRule(domain: string, functionId: string, branch?: string): Promise<Models.ProxyRule>;
+    /**
+     * Create a new proxy rule for to redirect from custom domain to another domain.
+     *
+     * @param {string} domain
+     * @param {string} url
+     * @param {StatusCode} statusCode
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createRedirectRule(domain: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule>;
+    /**
+     * Create a new proxy rule for serving Appwrite Site on custom domain.
+     *
+     * @param {string} domain
+     * @param {string} siteId
+     * @param {string} branch
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ProxyRule>}
+     */
+    createSiteRule(domain: string, siteId: string, branch?: string): Promise<Models.ProxyRule>;
     /**
      * Get a proxy rule by its unique ID.
      *