@appwrite.io/console 1.6.0 → 1.8.0

package/types/services/sites.d.ts

@@ -0,0 +1,319 @@
+import { Client, UploadProgress } from '../client';
+import type { Models } from '../models';
+import { Framework } from '../enums/framework';
+import { BuildRuntime } from '../enums/build-runtime';
+import { Adapter } from '../enums/adapter';
+import { SiteUsageRange } from '../enums/site-usage-range';
+import { VCSDeploymentType } from '../enums/v-c-s-deployment-type';
+import { DeploymentDownloadType } from '../enums/deployment-download-type';
+export declare class Sites {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Get a list of all the project's sites. You can use the query params to filter your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.SiteList>}
+     */
+    list(queries?: string[], search?: string): Promise<Models.SiteList>;
+    /**
+     * Create a new site.
+     *
+     * @param {string} siteId
+     * @param {string} name
+     * @param {Framework} framework
+     * @param {BuildRuntime} buildRuntime
+     * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {number} timeout
+     * @param {string} installCommand
+     * @param {string} buildCommand
+     * @param {string} outputDirectory
+     * @param {Adapter} adapter
+     * @param {string} installationId
+     * @param {string} fallbackFile
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
+     * @param {string} specification
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Site>}
+     */
+    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    /**
+     * Get a list of all frameworks that are currently available on the server instance.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.FrameworkList>}
+     */
+    listFrameworks(): Promise<Models.FrameworkList>;
+    /**
+     * List allowed site specifications for this instance.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.SpecificationList>}
+     */
+    listSpecifications(): Promise<Models.SpecificationList>;
+    /**
+     * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
+     *
+     * @param {string[]} frameworks
+     * @param {string[]} useCases
+     * @param {number} limit
+     * @param {number} offset
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TemplateSiteList>}
+     */
+    listTemplates(frameworks?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
+    /**
+     * Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
+     *
+     * @param {string} templateId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TemplateSite>}
+     */
+    getTemplate(templateId: string): Promise<Models.TemplateSite>;
+    /**
+     * Get usage metrics and statistics for all sites 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 {SiteUsageRange} range
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageSites>}
+     */
+    listUsage(range?: SiteUsageRange): Promise<Models.UsageSites>;
+    /**
+     * Get a site by its unique ID.
+     *
+     * @param {string} siteId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Site>}
+     */
+    get(siteId: string): Promise<Models.Site>;
+    /**
+     * Update site by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} name
+     * @param {Framework} framework
+     * @param {boolean} enabled
+     * @param {boolean} logging
+     * @param {number} timeout
+     * @param {string} installCommand
+     * @param {string} buildCommand
+     * @param {string} outputDirectory
+     * @param {BuildRuntime} buildRuntime
+     * @param {Adapter} adapter
+     * @param {string} fallbackFile
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerBranch
+     * @param {boolean} providerSilentMode
+     * @param {string} providerRootDirectory
+     * @param {string} specification
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Site>}
+     */
+    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    /**
+     * Delete a site by its unique ID.
+     *
+     * @param {string} siteId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(siteId: string): Promise<{}>;
+    /**
+     * Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.
+     *
+     * @param {string} siteId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Site>}
+     */
+    updateSiteDeployment(siteId: string, deploymentId: string): Promise<Models.Site>;
+    /**
+     * Get a list of all the site&#039;s code deployments. You can use the query params to filter your results.
+     *
+     * @param {string} siteId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DeploymentList>}
+     */
+    listDeployments(siteId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
+    /**
+     * Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you&#039;ll need to update the function&#039;s deployment to use your new deployment ID.
+     *
+     * @param {string} siteId
+     * @param {File} code
+     * @param {boolean} activate
+     * @param {string} installCommand
+     * @param {string} buildCommand
+     * @param {string} outputDirectory
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createDeployment(siteId: string, code: File, activate: boolean, installCommand?: string, buildCommand?: string, outputDirectory?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    /**
+     * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory 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} siteId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createDuplicateDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Create a deployment based on a template.
+
+Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
+     *
+     * @param {string} siteId
+     * @param {string} repository
+     * @param {string} owner
+     * @param {string} rootDirectory
+     * @param {string} version
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createTemplateDeployment(siteId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Create a deployment when a site is connected to VCS.
+
+This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} siteId
+     * @param {VCSDeploymentType} type
+     * @param {string} reference
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createVcsDeployment(siteId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Get a site deployment by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    getDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Delete a site deployment by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteDeployment(siteId: string, deploymentId: string): Promise<{}>;
+    /**
+     * Get a site 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} siteId
+     * @param {string} deploymentId
+     * @param {DeploymentDownloadType} type
+     * @throws {AppwriteException}
+     * @returns {string}
+     */
+    getDeploymentDownload(siteId: string, deploymentId: string, type?: DeploymentDownloadType): string;
+    /**
+     * Cancel an ongoing site 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} siteId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    updateDeploymentStatus(siteId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Get a list of all site logs. You can use the query params to filter your results.
+     *
+     * @param {string} siteId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ExecutionList>}
+     */
+    listLogs(siteId: string, queries?: string[]): Promise<Models.ExecutionList>;
+    /**
+     * Get a site request log by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} logId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Execution>}
+     */
+    getLog(siteId: string, logId: string): Promise<Models.Execution>;
+    /**
+     * Delete a site log by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} logId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteLog(siteId: string, logId: string): Promise<{}>;
+    /**
+     * Get usage metrics and statistics for a for a specific site. 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} siteId
+     * @param {SiteUsageRange} range
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageSite>}
+     */
+    getUsage(siteId: string, range?: SiteUsageRange): Promise<Models.UsageSite>;
+    /**
+     * Get a list of all variables of a specific site.
+     *
+     * @param {string} siteId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VariableList>}
+     */
+    listVariables(siteId: string): Promise<Models.VariableList>;
+    /**
+     * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
+     *
+     * @param {string} siteId
+     * @param {string} key
+     * @param {string} value
+     * @param {boolean} secret
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Variable>}
+     */
+    createVariable(siteId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
+    /**
+     * Get a variable by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Variable>}
+     */
+    getVariable(siteId: string, variableId: string): Promise<Models.Variable>;
+    /**
+     * Update variable by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} variableId
+     * @param {string} key
+     * @param {string} value
+     * @param {boolean} secret
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Variable>}
+     */
+    updateVariable(siteId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
+    /**
+     * Delete a variable by its unique ID.
+     *
+     * @param {string} siteId
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteVariable(siteId: string, variableId: string): Promise<{}>;
+}

package/types/services/storage.d.ts

@@ -128,10 +128,11 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFileDownload(bucketId: string, fileId: string): string;
+    getFileDownload(bucketId: string, fileId: string, token?: string): string;
     /**
      * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
      *
@@ -148,19 +149,21 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
      * @param {number} rotation
      * @param {string} background
      * @param {ImageFormat} output
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat): string;
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string;
     /**
      * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFileView(bucketId: string, fileId: string): string;
+    getFileView(bucketId: string, fileId: string, token?: string): string;
     /**
      * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. 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, range defaults to 30 days.
 

package/types/services/tokens.d.ts

@@ -0,0 +1,51 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Tokens {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * List all the tokens created for a specific file or bucket. You can use the query params to filter your results.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ResourceTokenList>}
+     */
+    list(bucketId: string, fileId: string, queries?: string[]): Promise<Models.ResourceTokenList>;
+    /**
+     * Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.
+     *
+     * @param {string} bucketId
+     * @param {string} fileId
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    createFileToken(bucketId: string, fileId: string, expire?: string): Promise<Models.ResourceToken>;
+    /**
+     * Get a token by its unique ID.
+     *
+     * @param {string} tokenId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    get(tokenId: string): Promise<Models.ResourceToken>;
+    /**
+     * Update a token by its unique ID. Use this endpoint to update a token&#039;s expiry date.
+     *
+     * @param {string} tokenId
+     * @param {string} expire
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ResourceToken>}
+     */
+    update(tokenId: string, expire?: string): Promise<Models.ResourceToken>;
+    /**
+     * Delete a token by its unique ID.
+     *
+     * @param {string} tokenId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(tokenId: string): Promise<{}>;
+}

package/types/services/users.d.ts

@@ -199,10 +199,12 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * Get the user membership list by its unique ID.
      *
      * @param {string} userId
+     * @param {string[]} queries
+     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.MembershipList>}
      */
-    listMemberships(userId: string): Promise<Models.MembershipList>;
+    listMemberships(userId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
     /**
      * Enable or disable MFA on a user account.
      *

package/types/services/vcs.d.ts

@@ -1,17 +1,30 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { VCSDetectionType } from '../enums/v-c-s-detection-type';
 export declare class Vcs {
     client: Client;
     constructor(client: Client);
+    /**
+     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
+     *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {VCSDetectionType} type
+     * @param {string} providerRootDirectory
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DetectionFramework>}
+     */
+    createRepositoryDetection(installationId: string, providerRepositoryId: string, type: VCSDetectionType, providerRootDirectory?: string): Promise<Models.DetectionFramework>;
     /**
      * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository&#039;s runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
      *
      * @param {string} installationId
+     * @param {VCSDetectionType} type
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise<Models.ProviderRepositoryList>}
+     * @returns {Promise<Models.ProviderRepositoryFrameworkList>}
      */
-    listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList>;
+    listRepositories(installationId: string, type: VCSDetectionType, search?: string): Promise<Models.ProviderRepositoryFrameworkList>;
     /**
      * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *
@@ -52,16 +65,6 @@ export declare class Vcs {
      * @returns {Promise<Models.VcsContentList>}
      */
     getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList>;
-    /**
-     * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository&#039;s files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
-     *
-     * @param {string} installationId
-     * @param {string} providerRepositoryId
-     * @param {string} providerRootDirectory
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Detection>}
-     */
-    createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection>;
     /**
      * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
      *