@appwrite.io/console 13.1.0 → 13.2.0

package/types/services/sites.d.ts

@@ -1,8 +1,8 @@
 import { Client, UploadProgress } from '../client';
 import type { Models } from '../models';
-import { SiteFramework } from '../enums/site-framework';
-import { SiteBuildRuntime } from '../enums/site-build-runtime';
-import { SiteAdapter } from '../enums/site-adapter';
+import { Framework } from '../enums/framework';
+import { BuildRuntime } from '../enums/build-runtime';
+import { Adapter } from '../enums/adapter';
 import { SiteTemplateUseCase } from '../enums/site-template-use-case';
 import { UsageRange } from '../enums/usage-range';
 import { TemplateReferenceType } from '../enums/template-reference-type';
@@ -41,8 +41,8 @@ export declare class Sites {
      *
      * @param {string} params.siteId - Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} params.name - Site name. Max length: 128 chars.
-     * @param {SiteFramework} params.framework - Sites framework.
-     * @param {SiteBuildRuntime} params.buildRuntime - Runtime to use during build step.
+     * @param {Framework} params.framework - Sites framework.
+     * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
      * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
      * @param {number} params.timeout - Maximum request time in seconds.
@@ -50,7 +50,7 @@ export declare class Sites {
      * @param {string} params.buildCommand - Build Command.
      * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
-     * @param {SiteAdapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} params.fallbackFile - Fallback file for single page application sites.
      * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
@@ -68,8 +68,8 @@ export declare class Sites {
     create(params: {
         siteId: string;
         name: string;
-        framework: SiteFramework;
-        buildRuntime: SiteBuildRuntime;
+        framework: Framework;
+        buildRuntime: BuildRuntime;
         enabled?: boolean;
         logging?: boolean;
         timeout?: number;
@@ -77,7 +77,7 @@ export declare class Sites {
         buildCommand?: string;
         startCommand?: string;
         outputDirectory?: string;
-        adapter?: SiteAdapter;
+        adapter?: Adapter;
         installationId?: string;
         fallbackFile?: string;
         providerRepositoryId?: string;
@@ -95,8 +95,8 @@ export declare class Sites {
      *
      * @param {string} siteId - Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} name - Site name. Max length: 128 chars.
-     * @param {SiteFramework} framework - Sites framework.
-     * @param {SiteBuildRuntime} buildRuntime - Runtime to use during build step.
+     * @param {Framework} framework - Sites framework.
+     * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
      * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
      * @param {number} timeout - Maximum request time in seconds.
@@ -104,7 +104,7 @@ export declare class Sites {
      * @param {string} buildCommand - Build Command.
      * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
-     * @param {SiteAdapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} fallbackFile - Fallback file for single page application sites.
      * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
@@ -120,7 +120,7 @@ export declare class Sites {
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(siteId: string, name: string, framework: SiteFramework, buildRuntime: SiteBuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: SiteAdapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
+    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Get a list of all frameworks that are currently available on the server instance.
      *
@@ -138,7 +138,7 @@ export declare class Sites {
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {SiteFramework[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {Framework[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
      * @param {SiteTemplateUseCase[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
      * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -146,7 +146,7 @@ export declare class Sites {
      * @returns {Promise<Models.TemplateSiteList>}
      */
     listTemplates(params?: {
-        frameworks?: SiteFramework[];
+        frameworks?: Framework[];
         useCases?: SiteTemplateUseCase[];
         limit?: number;
         offset?: number;
@@ -154,7 +154,7 @@ export declare class Sites {
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {SiteFramework[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {Framework[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
      * @param {SiteTemplateUseCase[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
      * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
@@ -162,7 +162,7 @@ export declare class Sites {
      * @returns {Promise<Models.TemplateSiteList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTemplates(frameworks?: SiteFramework[], useCases?: SiteTemplateUseCase[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
+    listTemplates(frameworks?: Framework[], useCases?: SiteTemplateUseCase[], 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.
      *
@@ -225,7 +225,7 @@ export declare class Sites {
      *
      * @param {string} params.siteId - Site ID.
      * @param {string} params.name - Site name. Max length: 128 chars.
-     * @param {SiteFramework} params.framework - Sites framework.
+     * @param {Framework} params.framework - Sites framework.
      * @param {boolean} params.enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
      * @param {boolean} params.logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
      * @param {number} params.timeout - Maximum request time in seconds.
@@ -233,8 +233,8 @@ export declare class Sites {
      * @param {string} params.buildCommand - Build Command.
      * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
-     * @param {SiteBuildRuntime} params.buildRuntime - Runtime to use during build step.
-     * @param {SiteAdapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
+     * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} params.fallbackFile - Fallback file for single page application sites.
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} params.providerRepositoryId - Repository ID of the repo linked to the site.
@@ -252,7 +252,7 @@ export declare class Sites {
     update(params: {
         siteId: string;
         name: string;
-        framework: SiteFramework;
+        framework: Framework;
         enabled?: boolean;
         logging?: boolean;
         timeout?: number;
@@ -260,8 +260,8 @@ export declare class Sites {
         buildCommand?: string;
         startCommand?: string;
         outputDirectory?: string;
-        buildRuntime?: SiteBuildRuntime;
-        adapter?: SiteAdapter;
+        buildRuntime?: BuildRuntime;
+        adapter?: Adapter;
         fallbackFile?: string;
         installationId?: string;
         providerRepositoryId?: string;
@@ -279,7 +279,7 @@ export declare class Sites {
      *
      * @param {string} siteId - Site ID.
      * @param {string} name - Site name. Max length: 128 chars.
-     * @param {SiteFramework} framework - Sites framework.
+     * @param {Framework} framework - Sites framework.
      * @param {boolean} enabled - Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
      * @param {boolean} logging - When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
      * @param {number} timeout - Maximum request time in seconds.
@@ -287,8 +287,8 @@ export declare class Sites {
      * @param {string} buildCommand - Build Command.
      * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
-     * @param {SiteBuildRuntime} buildRuntime - Runtime to use during build step.
-     * @param {SiteAdapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
+     * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
+     * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} fallbackFile - Fallback file for single page application sites.
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
      * @param {string} providerRepositoryId - Repository ID of the repo linked to the site.
@@ -304,7 +304,7 @@ export declare class Sites {
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(siteId: string, name: string, framework: SiteFramework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: SiteBuildRuntime, adapter?: SiteAdapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
+    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, providerBranches?: string[], providerPaths?: string[], buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Delete a site by its unique ID.
      *

package/types/enums/project-status.d.ts

@@ -1,3 +0,0 @@
-export declare enum ProjectStatus {
-    Active = "active"
-}