node-appwrite 20.3.0 → 21.0.0

package/dist/services/sites.d.mts

@@ -3,7 +3,8 @@ import { Models } from '../models.mjs';
 import { Framework } from '../enums/framework.mjs';
 import { BuildRuntime } from '../enums/build-runtime.mjs';
 import { Adapter } from '../enums/adapter.mjs';
-import { VCSDeploymentType } from '../enums/vcs-deployment-type.mjs';
+import { TemplateReferenceType } from '../enums/template-reference-type.mjs';
+import { VCSReferenceType } from '../enums/vcs-reference-type.mjs';
 import { DeploymentDownloadType } from '../enums/deployment-download-type.mjs';
 import '../query.mjs';
 import '../enums/database-type.mjs';
@@ -288,7 +289,7 @@ declare class Sites {
      */
     listDeployments(siteId: string, queries?: string[], search?: string, total?: boolean): 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'll need to update the function's deployment to use your new deployment ID.
+     * 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'll need to update the site's deployment to use your new deployment ID.
      *
      * @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.
@@ -309,7 +310,7 @@ declare class Sites {
         onProgress?: (progress: UploadProgress) => void;
     }): Promise<Models.Deployment>;
     /**
-     * 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'll need to update the function's deployment to use your new deployment ID.
+     * 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'll need to update the site's deployment to use your new deployment ID.
      *
      * @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.
@@ -353,7 +354,8 @@ 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 {string} params.version - Version (tag) for the repo linked to the site template.
+     * @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}
      * @returns {Promise<Models.Deployment>}
@@ -363,7 +365,8 @@ declare class Sites {
         repository: string;
         owner: string;
         rootDirectory: string;
-        version: string;
+        type: TemplateReferenceType;
+        reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
     /**
@@ -375,20 +378,21 @@ 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 {string} version - Version (tag) for the repo linked to the site template.
+     * @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, version: 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}
@@ -396,7 +400,7 @@ declare class Sites {
      */
     createVcsDeployment(params: {
         siteId: string;
-        type: VCSDeploymentType;
+        type: VCSReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -406,14 +410,14 @@ 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/dist/services/sites.d.ts

@@ -3,7 +3,8 @@ import { Models } from '../models.js';
 import { Framework } from '../enums/framework.js';
 import { BuildRuntime } from '../enums/build-runtime.js';
 import { Adapter } from '../enums/adapter.js';
-import { VCSDeploymentType } from '../enums/vcs-deployment-type.js';
+import { TemplateReferenceType } from '../enums/template-reference-type.js';
+import { VCSReferenceType } from '../enums/vcs-reference-type.js';
 import { DeploymentDownloadType } from '../enums/deployment-download-type.js';
 import '../query.js';
 import '../enums/database-type.js';
@@ -288,7 +289,7 @@ declare class Sites {
      */
     listDeployments(siteId: string, queries?: string[], search?: string, total?: boolean): 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'll need to update the function's deployment to use your new deployment ID.
+     * 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'll need to update the site's deployment to use your new deployment ID.
      *
      * @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.
@@ -309,7 +310,7 @@ declare class Sites {
         onProgress?: (progress: UploadProgress) => void;
     }): Promise<Models.Deployment>;
     /**
-     * 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'll need to update the function's deployment to use your new deployment ID.
+     * 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'll need to update the site's deployment to use your new deployment ID.
      *
      * @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.
@@ -353,7 +354,8 @@ 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 {string} params.version - Version (tag) for the repo linked to the site template.
+     * @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}
      * @returns {Promise<Models.Deployment>}
@@ -363,7 +365,8 @@ declare class Sites {
         repository: string;
         owner: string;
         rootDirectory: string;
-        version: string;
+        type: TemplateReferenceType;
+        reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
     /**
@@ -375,20 +378,21 @@ 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 {string} version - Version (tag) for the repo linked to the site template.
+     * @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, version: 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}
@@ -396,7 +400,7 @@ declare class Sites {
      */
     createVcsDeployment(params: {
         siteId: string;
-        type: VCSDeploymentType;
+        type: VCSReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -406,14 +410,14 @@ 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/dist/services/sites.js

@@ -544,15 +544,17 @@ class Sites {
         repository: rest[0],
         owner: rest[1],
         rootDirectory: rest[2],
-        version: rest[3],
-        activate: rest[4]
+        type: rest[3],
+        reference: rest[4],
+        activate: rest[5]
       };
     }
     const siteId = params.siteId;
     const repository = params.repository;
     const owner = params.owner;
     const rootDirectory = params.rootDirectory;
-    const version = params.version;
+    const type = params.type;
+    const reference = params.reference;
     const activate = params.activate;
     if (typeof siteId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "siteId"');
@@ -566,8 +568,11 @@ class Sites {
     if (typeof rootDirectory === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "rootDirectory"');
     }
-    if (typeof version === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "version"');
+    if (typeof type === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "type"');
+    }
+    if (typeof reference === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "reference"');
     }
     const apiPath = "/sites/{siteId}/deployments/template".replace("{siteId}", siteId);
     const payload = {};
@@ -580,8 +585,11 @@ class Sites {
     if (typeof rootDirectory !== "undefined") {
       payload["rootDirectory"] = rootDirectory;
     }
-    if (typeof version !== "undefined") {
-      payload["version"] = version;
+    if (typeof type !== "undefined") {
+      payload["type"] = type;
+    }
+    if (typeof reference !== "undefined") {
+      payload["reference"] = reference;
     }
     if (typeof activate !== "undefined") {
       payload["activate"] = activate;