appbuild-oceanbase-console 1.12.2 → 1.13.0

package/types/services/sites.d.ts

@@ -3,9 +3,11 @@ import type { Models } from '../models';
 import { Framework } from '../enums/framework';
 import { BuildRuntime } from '../enums/build-runtime';
 import { Adapter } from '../enums/adapter';
+import { Frameworks } from '../enums/frameworks';
+import { UseCases } from '../enums/use-cases';
 import { UsageRange } from '../enums/usage-range';
-import { Type } from '../enums/type';
-import { VCSDeploymentType } from '../enums/vcs-deployment-type';
+import { TemplateReferenceType } from '../enums/template-reference-type';
+import { VCSReferenceType } from '../enums/vcs-reference-type';
 import { DeploymentDownloadType } from '../enums/deployment-download-type';
 export declare class Sites {
     client: Client;
@@ -47,6 +49,7 @@ export declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @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 {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.
@@ -55,7 +58,9 @@ export declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -69,6 +74,7 @@ export declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         adapter?: Adapter;
         installationId?: string;
@@ -77,7 +83,9 @@ export declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Create a new site.
@@ -91,6 +99,7 @@ export declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @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.
@@ -99,12 +108,14 @@ export declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    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>;
+    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, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Get a list of all frameworks that are currently available on the server instance.
      *
@@ -122,31 +133,31 @@ export declare class Sites {
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {string[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
-     * @param {string[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
+     * @param {Frameworks[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {UseCases[]} 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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TemplateSiteList>}
      */
     listTemplates(params?: {
-        frameworks?: string[];
-        useCases?: string[];
+        frameworks?: Frameworks[];
+        useCases?: UseCases[];
         limit?: number;
         offset?: number;
     }): Promise<Models.TemplateSiteList>;
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {string[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
-     * @param {string[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
+     * @param {Frameworks[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {UseCases[]} 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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TemplateSiteList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTemplates(frameworks?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
+    listTemplates(frameworks?: Frameworks[], useCases?: UseCases[], 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.
      *
@@ -215,6 +226,7 @@ export declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @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 {BuildRuntime} params.buildRuntime - Runtime to use during build step.
      * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -224,7 +236,9 @@ export declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -237,6 +251,7 @@ export declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         buildRuntime?: BuildRuntime;
         adapter?: Adapter;
@@ -246,7 +261,9 @@ export declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Update site by its unique ID.
@@ -259,6 +276,7 @@ export declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
      * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -268,12 +286,14 @@ export declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    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>;
+    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, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Delete a site by its unique ID.
      *
@@ -348,20 +368,20 @@ export declare class Sites {
      *
      * @param {string} params.siteId - Site ID.
      * @param {File} params.code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
-     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @param {string} params.installCommand - Install Commands.
      * @param {string} params.buildCommand - Build Commands.
      * @param {string} params.outputDirectory - Output Directory.
+     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
     createDeployment(params: {
         siteId: string;
         code: File;
-        activate: boolean;
         installCommand?: string;
         buildCommand?: string;
         outputDirectory?: string;
+        activate?: boolean;
         onProgress?: (progress: UploadProgress) => void;
     }): Promise<Models.Deployment>;
     /**
@@ -369,15 +389,15 @@ export declare class Sites {
      *
      * @param {string} siteId - Site ID.
      * @param {File} code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
-     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @param {string} installCommand - Install Commands.
      * @param {string} buildCommand - Build Commands.
      * @param {string} outputDirectory - Output Directory.
+     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createDeployment(siteId: string, code: File, activate: boolean, installCommand?: string, buildCommand?: string, outputDirectory?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    createDeployment(siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean, 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's code will be preserved and used for the new build.
      *
@@ -409,7 +429,7 @@ export declare class Sites {
      * @param {string} params.repository - Repository name of the template.
      * @param {string} params.owner - The name of the owner of the template.
      * @param {string} params.rootDirectory - Path to site code in the template repo.
-     * @param {Type} params.type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {TemplateReferenceType} params.type - Type for the reference provided. Can be commit, branch, or tag
      * @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
@@ -420,7 +440,7 @@ export declare class Sites {
         repository: string;
         owner: string;
         rootDirectory: string;
-        type: Type;
+        type: TemplateReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -433,21 +453,21 @@ export declare class Sites {
      * @param {string} repository - Repository name of the template.
      * @param {string} owner - The name of the owner of the template.
      * @param {string} rootDirectory - Path to site code in the template repo.
-     * @param {Type} type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {TemplateReferenceType} type - Type for the reference provided. Can be commit, branch, or tag
      * @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
      * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createTemplateDeployment(siteId: string, repository: string, owner: string, rootDirectory: string, type: Type, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    createTemplateDeployment(siteId: string, repository: string, owner: string, rootDirectory: string, type: TemplateReferenceType, reference: 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} params.siteId - Site ID.
-     * @param {VCSDeploymentType} params.type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} params.type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
@@ -455,7 +475,7 @@ export declare class Sites {
      */
     createVcsDeployment(params: {
         siteId: string;
-        type: VCSDeploymentType;
+        type: VCSReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -465,14 +485,14 @@ export declare class Sites {
      * This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} siteId - Site ID.
-     * @param {VCSDeploymentType} type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createVcsDeployment(siteId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    createVcsDeployment(siteId: string, type: VCSReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
     /**
      * Get a site deployment by its unique ID.
      *

package/types/services/storage.d.ts

@@ -42,7 +42,7 @@ export declare class Storage {
      * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
      * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
      * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-     * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+     * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
      * @param {boolean} params.transformations - Are image transformations enabled?
@@ -72,7 +72,7 @@ export declare class Storage {
      * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
      * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
      * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-     * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+     * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
      * @param {boolean} transformations - Are image transformations enabled?
@@ -110,7 +110,7 @@ export declare class Storage {
      * @param {boolean} params.enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
      * @param {number} params.maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
      * @param {string[]} params.allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-     * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+     * @param {Compression} params.compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
      * @param {boolean} params.transformations - Are image transformations enabled?
@@ -140,7 +140,7 @@ export declare class Storage {
      * @param {boolean} enabled - Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
      * @param {number} maximumFileSize - Maximum file size allowed in bytes. Maximum allowed value is 5GB.
      * @param {string[]} allowedFileExtensions - Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
-     * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
+     * @param {Compression} compression - Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
      * @param {boolean} transformations - Are image transformations enabled?
@@ -264,10 +264,10 @@ export declare class Storage {
     /**
      * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
-     * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
-     * @param {string} params.fileId - File unique ID.
-     * @param {string} params.name - Name of the file
-     * @param {string[]} params.permissions - An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} params.bucketId - Bucket unique ID.
+     * @param {string} params.fileId - File ID.
+     * @param {string} params.name - File name.
+     * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @throws {AppwriteException}
      * @returns {Promise<Models.File>}
      */
@@ -280,10 +280,10 @@ export declare class Storage {
     /**
      * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
-     * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
-     * @param {string} fileId - File unique ID.
-     * @param {string} name - Name of the file
-     * @param {string[]} permissions - An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {string} bucketId - Bucket unique ID.
+     * @param {string} fileId - File ID.
+     * @param {string} name - File name.
+     * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @throws {AppwriteException}
      * @returns {Promise<Models.File>}
      * @deprecated Use the object parameter style method for a better developer experience.