node-appwrite 15.0.0-rc1 → 15.0.1

package/dist/services/functions.d.mts

@@ -1,5 +1,4 @@
 import { Client, UploadProgress } from '../client.mjs';
-import { Payload } from '../payload.mjs';
 import { Models } from '../models.mjs';
 import { Runtime } from '../enums/runtime.mjs';
 import { ExecutionMethod } from '../enums/execution-method.mjs';
@@ -9,8 +8,6 @@ declare class Functions {
     client: Client;
     constructor(client: Client);
     /**
-     * List functions
-     *
      * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -20,8 +17,6 @@ declare class Functions {
      */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
-     * Create function
-     *
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
      *
      * @param {string} functionId
@@ -51,8 +46,6 @@ declare class Functions {
      */
     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>;
     /**
-     * List runtimes
-     *
      * Get a list of all runtimes that are currently active on your instance.
      *
      * @throws {AppwriteException}
@@ -60,8 +53,6 @@ declare class Functions {
      */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * List available function runtime specifications
-     *
      * List allowed function specifications for this instance.
 
      *
@@ -70,8 +61,6 @@ declare class Functions {
      */
     listSpecifications(): Promise<Models.SpecificationList>;
     /**
-     * Get function
-     *
      * Get a function by its unique ID.
      *
      * @param {string} functionId
@@ -80,8 +69,6 @@ declare class Functions {
      */
     get(functionId: string): Promise<Models.Function>;
     /**
-     * Update function
-     *
      * Update function by its unique ID.
      *
      * @param {string} functionId
@@ -107,8 +94,6 @@ declare class Functions {
      */
     update(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): Promise<Models.Function>;
     /**
-     * Delete function
-     *
      * Delete a function by its unique ID.
      *
      * @param {string} functionId
@@ -117,8 +102,6 @@ declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * List deployments
-     *
      * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -129,8 +112,6 @@ declare class Functions {
      */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
-     * Create deployment
-     *
      * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you&#039;ll need to update the function&#039;s deployment to use your new deployment UID.
 
 This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
@@ -138,17 +119,15 @@ This endpoint accepts a tar.gz file compressed with your code. Make sure to incl
 Use the &quot;command&quot; param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
-     * @param {Payload} code
+     * @param {File} code
      * @param {boolean} activate
      * @param {string} entrypoint
      * @param {string} commands
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    createDeployment(functionId: string, code: Payload, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get deployment
-     *
      * Get a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -158,8 +137,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update 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.
      *
      * @param {string} functionId
@@ -169,8 +146,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
-     * Delete deployment
-     *
      * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -180,8 +155,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Rebuild 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.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -191,8 +165,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
     /**
-     * Cancel deployment
-     *
+     * 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
@@ -201,8 +174,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
     /**
-     * Download deployment
-     *
      * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
      *
      * @param {string} functionId
@@ -212,8 +183,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
     /**
-     * List executions
-     *
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -224,12 +193,10 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
-     * Create execution
-     *
      * 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.
      *
      * @param {string} functionId
-     * @param {Payload} body
+     * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
      * @param {ExecutionMethod} method
@@ -238,10 +205,8 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @throws {AppwriteException}
      * @returns {Promise<Models.Execution>}
      */
-    createExecution(functionId: string, body?: Payload, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
     /**
-     * Get execution
-     *
      * Get a function execution log by its unique ID.
      *
      * @param {string} functionId
@@ -251,8 +216,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 execution
-     *
      * Delete a function execution by its unique ID.
 
      *
@@ -263,8 +226,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteExecution(functionId: string, executionId: string): Promise<{}>;
     /**
-     * List variables
-     *
      * Get a list of all variables of a specific function.
      *
      * @param {string} functionId
@@ -273,8 +234,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
-     * Create variable
-     *
      * Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.
      *
      * @param {string} functionId
@@ -285,8 +244,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get variable
-     *
      * Get a variable by its unique ID.
      *
      * @param {string} functionId
@@ -296,8 +253,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
-     * Update variable
-     *
      * Update variable by its unique ID.
      *
      * @param {string} functionId
@@ -309,8 +264,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete variable
-     *
      * Delete a variable by its unique ID.
      *
      * @param {string} functionId

package/dist/services/functions.d.ts

@@ -1,5 +1,4 @@
 import { Client, UploadProgress } from '../client.js';
-import { Payload } from '../payload.js';
 import { Models } from '../models.js';
 import { Runtime } from '../enums/runtime.js';
 import { ExecutionMethod } from '../enums/execution-method.js';
@@ -9,8 +8,6 @@ declare class Functions {
     client: Client;
     constructor(client: Client);
     /**
-     * List functions
-     *
      * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -20,8 +17,6 @@ declare class Functions {
      */
     list(queries?: string[], search?: string): Promise<Models.FunctionList>;
     /**
-     * Create function
-     *
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
      *
      * @param {string} functionId
@@ -51,8 +46,6 @@ declare class Functions {
      */
     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>;
     /**
-     * List runtimes
-     *
      * Get a list of all runtimes that are currently active on your instance.
      *
      * @throws {AppwriteException}
@@ -60,8 +53,6 @@ declare class Functions {
      */
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
-     * List available function runtime specifications
-     *
      * List allowed function specifications for this instance.
 
      *
@@ -70,8 +61,6 @@ declare class Functions {
      */
     listSpecifications(): Promise<Models.SpecificationList>;
     /**
-     * Get function
-     *
      * Get a function by its unique ID.
      *
      * @param {string} functionId
@@ -80,8 +69,6 @@ declare class Functions {
      */
     get(functionId: string): Promise<Models.Function>;
     /**
-     * Update function
-     *
      * Update function by its unique ID.
      *
      * @param {string} functionId
@@ -107,8 +94,6 @@ declare class Functions {
      */
     update(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): Promise<Models.Function>;
     /**
-     * Delete function
-     *
      * Delete a function by its unique ID.
      *
      * @param {string} functionId
@@ -117,8 +102,6 @@ declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * List deployments
-     *
      * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -129,8 +112,6 @@ declare class Functions {
      */
     listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
     /**
-     * Create deployment
-     *
      * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you&#039;ll need to update the function&#039;s deployment to use your new deployment UID.
 
 This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
@@ -138,17 +119,15 @@ This endpoint accepts a tar.gz file compressed with your code. Make sure to incl
 Use the &quot;command&quot; param to set the entrypoint used to execute your code.
      *
      * @param {string} functionId
-     * @param {Payload} code
+     * @param {File} code
      * @param {boolean} activate
      * @param {string} entrypoint
      * @param {string} commands
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    createDeployment(functionId: string, code: Payload, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get deployment
-     *
      * Get a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -158,8 +137,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update 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.
      *
      * @param {string} functionId
@@ -169,8 +146,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
     /**
-     * Delete deployment
-     *
      * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
@@ -180,8 +155,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Rebuild 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.
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -191,8 +165,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
     /**
-     * Cancel deployment
-     *
+     * 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
@@ -201,8 +174,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
     /**
-     * Download deployment
-     *
      * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
      *
      * @param {string} functionId
@@ -212,8 +183,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
     /**
-     * List executions
-     *
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
@@ -224,12 +193,10 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
     /**
-     * Create execution
-     *
      * 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.
      *
      * @param {string} functionId
-     * @param {Payload} body
+     * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
      * @param {ExecutionMethod} method
@@ -238,10 +205,8 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @throws {AppwriteException}
      * @returns {Promise<Models.Execution>}
      */
-    createExecution(functionId: string, body?: Payload, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
     /**
-     * Get execution
-     *
      * Get a function execution log by its unique ID.
      *
      * @param {string} functionId
@@ -251,8 +216,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 execution
-     *
      * Delete a function execution by its unique ID.
 
      *
@@ -263,8 +226,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     deleteExecution(functionId: string, executionId: string): Promise<{}>;
     /**
-     * List variables
-     *
      * Get a list of all variables of a specific function.
      *
      * @param {string} functionId
@@ -273,8 +234,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     listVariables(functionId: string): Promise<Models.VariableList>;
     /**
-     * Create variable
-     *
      * Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.
      *
      * @param {string} functionId
@@ -285,8 +244,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get variable
-     *
      * Get a variable by its unique ID.
      *
      * @param {string} functionId
@@ -296,8 +253,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
     /**
-     * Update variable
-     *
      * Update variable by its unique ID.
      *
      * @param {string} functionId
@@ -309,8 +264,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete variable
-     *
      * Delete a variable by its unique ID.
      *
      * @param {string} functionId