@appwrite.io/console 1.6.0 → 1.8.0

package/src/services/functions.ts

@@ -3,6 +3,8 @@ import { AppwriteException, Client, type Payload, UploadProgress } from '../clie
 import type { Models } from '../models';
 import { Runtime } from '../enums/runtime';
 import { FunctionUsageRange } from '../enums/function-usage-range';
+import { VCSDeploymentType } from '../enums/v-c-s-deployment-type';
+import { DeploymentDownloadType } from '../enums/deployment-download-type';
 import { ExecutionMethod } from '../enums/execution-method';
 
 export class Functions {
@@ -32,7 +34,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -62,15 +63,11 @@ export class Functions {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
-     * @param {string} templateRepository
-     * @param {string} templateOwner
-     * @param {string} templateRootDirectory
-     * @param {string} templateVersion
      * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
-    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> {
+    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, specification?: string): Promise<Models.Function> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -133,18 +130,6 @@ export class Functions {
         if (typeof providerRootDirectory !== 'undefined') {
             payload['providerRootDirectory'] = providerRootDirectory;
         }
-        if (typeof templateRepository !== 'undefined') {
-            payload['templateRepository'] = templateRepository;
-        }
-        if (typeof templateOwner !== 'undefined') {
-            payload['templateOwner'] = templateOwner;
-        }
-        if (typeof templateRootDirectory !== 'undefined') {
-            payload['templateRootDirectory'] = templateRootDirectory;
-        }
-        if (typeof templateVersion !== 'undefined') {
-            payload['templateVersion'] = templateVersion;
-        }
         if (typeof specification !== 'undefined') {
             payload['specification'] = specification;
         }
@@ -173,7 +158,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -185,7 +169,6 @@ export class Functions {
     }
     /**
      * List allowed function specifications for this instance.
-
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
@@ -196,7 +179,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -234,7 +216,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -260,7 +241,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -271,13 +251,13 @@ export class Functions {
         );
     }
     /**
-     * Get usage metrics and statistics for a for all functions. View statistics including total functions, 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.
+     * Get usage metrics and statistics for all functions 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 {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageFunctions>}
      */
-    getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions> {
+    listUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions> {
         const apiPath = '/functions/usage';
         const payload: Payload = {};
         if (typeof range !== 'undefined') {
@@ -286,7 +266,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -312,7 +291,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -446,7 +424,40 @@ export class Functions {
         );
     }
     /**
-     * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
+     * Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Function>}
+     */
+    updateFunctionDeployment(functionId: string, deploymentId: string): Promise<Models.Function> {
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
+        }
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
+        }
+        const apiPath = '/functions/{functionId}/deployment'.replace('{functionId}', functionId);
+        const payload: Payload = {};
+        if (typeof deploymentId !== 'undefined') {
+            payload['deploymentId'] = deploymentId;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Get a list of all the function&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
@@ -469,7 +480,6 @@ export class Functions {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -533,22 +543,29 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         );
     }
     /**
-     * Get a code deployment by its unique ID.
+     * 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
+     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment> {
+    createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
         if (typeof deploymentId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
-        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/duplicate'.replace('{functionId}', functionId);
         const payload: Payload = {};
+        if (typeof deploymentId !== 'undefined') {
+            payload['deploymentId'] = deploymentId;
+        }
+        if (typeof buildId !== 'undefined') {
+            payload['buildId'] = buildId;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -556,29 +573,59 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         }
 
         return this.client.call(
-            'get',
+            'post',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * 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.
+     * Create a deployment based on a template.
+
+Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
      *
      * @param {string} functionId
-     * @param {string} deploymentId
+     * @param {string} repository
+     * @param {string} owner
+     * @param {string} rootDirectory
+     * @param {string} version
+     * @param {boolean} activate
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Function>}
+     * @returns {Promise<Models.Deployment>}
      */
-    updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function> {
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
-        if (typeof deploymentId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "deploymentId"');
+        if (typeof repository === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "repository"');
         }
-        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        if (typeof owner === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "owner"');
+        }
+        if (typeof rootDirectory === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "rootDirectory"');
+        }
+        if (typeof version === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "version"');
+        }
+        const apiPath = '/functions/{functionId}/deployments/template'.replace('{functionId}', functionId);
         const payload: Payload = {};
+        if (typeof repository !== 'undefined') {
+            payload['repository'] = repository;
+        }
+        if (typeof owner !== 'undefined') {
+            payload['owner'] = owner;
+        }
+        if (typeof rootDirectory !== 'undefined') {
+            payload['rootDirectory'] = rootDirectory;
+        }
+        if (typeof version !== 'undefined') {
+            payload['version'] = version;
+        }
+        if (typeof activate !== 'undefined') {
+            payload['activate'] = activate;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -586,29 +633,45 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         }
 
         return this.client.call(
-            'patch',
+            'post',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * Delete a code deployment by its unique ID.
+     * Create a deployment when a function is connected to VCS.
+
+This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} functionId
-     * @param {string} deploymentId
+     * @param {VCSDeploymentType} type
+     * @param {string} reference
+     * @param {boolean} activate
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Deployment>}
      */
-    deleteDeployment(functionId: string, deploymentId: string): Promise<{}> {
+    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
-        if (typeof deploymentId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "deploymentId"');
+        if (typeof type === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "type"');
         }
-        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        if (typeof reference === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "reference"');
+        }
+        const apiPath = '/functions/{functionId}/deployments/vcs'.replace('{functionId}', functionId);
         const payload: Payload = {};
+        if (typeof type !== 'undefined') {
+            payload['type'] = type;
+        }
+        if (typeof reference !== 'undefined') {
+            payload['reference'] = reference;
+        }
+        if (typeof activate !== 'undefined') {
+            payload['activate'] = activate;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -616,62 +679,57 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         }
 
         return this.client.call(
-            'delete',
+            'post',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * 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.
+     * Get a function deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
-     * @param {string} buildId
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Deployment>}
      */
-    createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}> {
+    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
         if (typeof deploymentId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
-        const apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         const payload: Payload = {};
-        if (typeof buildId !== 'undefined') {
-            payload['buildId'] = buildId;
-        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
-            'post',
+            'get',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * 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.
+     * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Build>}
+     * @returns {Promise<{}>}
      */
-    updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build> {
+    deleteDeployment(functionId: string, deploymentId: string): Promise<{}> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
         if (typeof deploymentId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "deploymentId"');
         }
-        const apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         const payload: Payload = {};
         const uri = new URL(this.client.config.endpoint + apiPath);
 
@@ -680,21 +738,22 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         }
 
         return this.client.call(
-            'patch',
+            'delete',
             uri,
             apiHeaders,
             payload
         );
     }
     /**
-     * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
+     * Get a function 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} functionId
      * @param {string} deploymentId
+     * @param {DeploymentDownloadType} type
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getDeploymentDownload(functionId: string, deploymentId: string): string {
+    getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): string {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -703,10 +762,12 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         }
         const apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
         const payload: Payload = {};
+        if (typeof type !== 'undefined') {
+            payload['type'] = type;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         payload['project'] = this.client.config.project;
@@ -717,16 +778,45 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         
         return uri.toString();
     }
+    /**
+     * 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
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    updateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment> {
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
+        }
+        if (typeof deploymentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "deploymentId"');
+        }
+        const apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
-     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
-    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList> {
+    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -735,13 +825,9 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
-        if (typeof search !== 'undefined') {
-            payload['search'] = search;
-        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -821,7 +907,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -833,7 +918,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     }
     /**
      * Delete a function execution by its unique ID.
-
      *
      * @param {string} functionId
      * @param {string} executionId
@@ -870,7 +954,7 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageFunction>}
      */
-    getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction> {
+    getUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -882,7 +966,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -908,7 +991,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -924,10 +1006,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(functionId: string, key: string, value: string): Promise<Models.Variable> {
+    createVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -945,6 +1028,9 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         if (typeof value !== 'undefined') {
             payload['value'] = value;
         }
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
@@ -978,7 +1064,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         return this.client.call(
@@ -995,10 +1080,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable> {
+    updateVariable(functionId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable> {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -1016,6 +1102,9 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
         if (typeof value !== 'undefined') {
             payload['value'] = value;
         }
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {