@scaleway/sdk 2.8.0 → 2.10.0

package/dist/index.cjs

@@ -497,7 +497,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v2.7.0';
+const version = 'v2.9.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () =>
@@ -6430,7 +6430,7 @@ const marshalUpdateSnapshotRequest$2 = (request, defaults) => ({
   expires_at: request.expiresAt,
   name: request.name
 });
-const marshalUpdateUserRequest$1 = (request, defaults) => ({
+const marshalUpdateUserRequest$2 = (request, defaults) => ({
   is_admin: request.isAdmin,
   password: request.password
 });
@@ -6983,7 +6983,7 @@ let API$o = class API extends API$w {
    * @returns A Promise of User
    */
   updateUser = request => this.client.fetch({
-    body: JSON.stringify(marshalUpdateUserRequest$1(request, this.client.settings)),
+    body: JSON.stringify(marshalUpdateUserRequest$2(request, this.client.settings)),
     headers: jsonContentHeaders$n,
     method: 'PATCH',
     path: `/document-db/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/users/${validatePathParam('name', request.name)}`
@@ -10968,6 +10968,9 @@ const marshalUpdateSSHKeyRequest = (request, defaults) => ({
   disabled: request.disabled,
   name: request.name
 });
+const marshalUpdateUserRequest$1 = (request, defaults) => ({
+  tags: request.tags
+});
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
@@ -11077,6 +11080,19 @@ let API$k = class API extends API$w {
     path: `/iam/v1alpha1/users/${validatePathParam('userId', request.userId)}`
   }, unmarshalUser$1);
 
+  /**
+   * Update a user. Update the parameters of a user, including `tags`.
+   *
+   * @param request - The request {@link UpdateUserRequest}
+   * @returns A Promise of User
+   */
+  updateUser = request => this.client.fetch({
+    body: JSON.stringify(marshalUpdateUserRequest$1(request, this.client.settings)),
+    headers: jsonContentHeaders$j,
+    method: 'PATCH',
+    path: `/iam/v1alpha1/users/${validatePathParam('userId', request.userId)}`
+  }, unmarshalUser$1);
+
   /**
    * Delete a guest user from an Organization. Remove a user from an
    * Organization in which they are a guest. You must define the `user_id` in
@@ -12016,6 +12032,7 @@ const unmarshalServerIp = data => {
     family: data.family,
     gateway: data.gateway,
     id: data.id,
+    ipamId: data.ipam_id,
     netmask: data.netmask,
     provisioningMode: data.provisioning_mode,
     state: data.state,
@@ -12134,6 +12151,7 @@ const unmarshalIp$1 = data => {
   return {
     address: data.address,
     id: data.id,
+    ipamId: data.ipam_id,
     organization: data.organization,
     prefix: data.prefix,
     project: data.project,
@@ -13209,6 +13227,7 @@ const marshalServerIp = (request, defaults) => ({
   family: request.family,
   gateway: request.gateway,
   id: request.id,
+  ipam_id: request.ipamId,
   netmask: request.netmask,
   provisioning_mode: request.provisioningMode,
   state: request.state,
@@ -15475,6 +15494,15 @@ const unmarshalResource = data => {
     type: data.type
   };
 };
+const unmarshalReverse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Reverse' failed as data isn't a dictionary.`);
+  }
+  return {
+    address: data.address,
+    hostname: data.hostname
+  };
+};
 const unmarshalSource = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Source' failed as data isn't a dictionary.`);
@@ -15497,6 +15525,7 @@ const unmarshalIP$1 = data => {
     projectId: data.project_id,
     region: data.region,
     resource: data.resource ? unmarshalResource(data.resource) : undefined,
+    reverses: unmarshalArrayOfObject(data.reverses, unmarshalReverse),
     source: unmarshalSource(data.source),
     tags: data.tags,
     updatedAt: unmarshalDate(data.updated_at),
@@ -15531,7 +15560,12 @@ const marshalBookIPRequest = (request, defaults) => ({
   source: marshalSource(request.source),
   tags: request.tags
 });
+const marshalReverse = (request, defaults) => ({
+  address: request.address,
+  hostname: request.hostname
+});
 const marshalUpdateIPRequest$1 = (request, defaults) => ({
+  reverses: request.reverses !== undefined ? request.reverses.map(elt => marshalReverse(elt)) : undefined,
   tags: request.tags
 });
 
@@ -16140,6 +16174,15 @@ var index$h = /*#__PURE__*/Object.freeze({
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalCronSchedule = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'CronSchedule' failed as data isn't a dictionary.`);
+  }
+  return {
+    schedule: data.schedule,
+    timezone: data.timezone
+  };
+};
 const unmarshalJobDefinition = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'JobDefinition' failed as data isn't a dictionary.`);
@@ -16148,6 +16191,7 @@ const unmarshalJobDefinition = data => {
     command: data.command,
     cpuLimit: data.cpu_limit,
     createdAt: unmarshalDate(data.created_at),
+    cronSchedule: data.cron_schedule ? unmarshalCronSchedule(data.cron_schedule) : undefined,
     description: data.description,
     environmentVariables: data.environment_variables,
     id: data.id,
@@ -16197,9 +16241,14 @@ const unmarshalListJobRunsResponse = data => {
     totalCount: data.total_count
   };
 };
+const marshalCreateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+  schedule: request.schedule,
+  timezone: request.timezone
+});
 const marshalCreateJobDefinitionRequest = (request, defaults) => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
+  cron_schedule: request.cronSchedule !== undefined ? marshalCreateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : undefined,
   description: request.description,
   environment_variables: request.environmentVariables !== undefined ? request.environmentVariables : undefined,
   image_uri: request.imageUri,
@@ -16208,9 +16257,14 @@ const marshalCreateJobDefinitionRequest = (request, defaults) => ({
   name: request.name || randomName('job'),
   project_id: request.projectId ?? defaults.defaultProjectId
 });
+const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
+  schedule: request.schedule,
+  timezone: request.timezone
+});
 const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
   command: request.command,
   cpu_limit: request.cpuLimit,
+  cron_schedule: request.cronSchedule !== undefined ? marshalUpdateJobDefinitionRequestCronScheduleConfig(request.cronSchedule) : undefined,
   description: request.description,
   environment_variables: request.environmentVariables,
   image_uri: request.imageUri,
@@ -16229,12 +16283,26 @@ const jsonContentHeaders$e = {
 let API$f = class API extends API$w {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
+
+  /**
+   * Create a new job definition in a specified Project.
+   *
+   * @param request - The request {@link CreateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
   createJobDefinition = request => this.client.fetch({
     body: JSON.stringify(marshalCreateJobDefinitionRequest(request, this.client.settings)),
     headers: jsonContentHeaders$e,
     method: 'POST',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions`
   }, unmarshalJobDefinition);
+
+  /**
+   * Get a job definition by its unique identifier.
+   *
+   * @param request - The request {@link GetJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
   getJobDefinition = request => this.client.fetch({
     method: 'GET',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}`
@@ -16244,27 +16312,70 @@ let API$f = class API extends API$w {
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions`,
     urlParams: urlParams(['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
   }, unmarshalListJobDefinitionsResponse);
+
+  /**
+   * List all your job definitions with filters.
+   *
+   * @param request - The request {@link ListJobDefinitionsRequest}
+   * @returns A Promise of ListJobDefinitionsResponse
+   */
   listJobDefinitions = (request = {}) => enrichForPagination('jobDefinitions', this.pageOfListJobDefinitions, request);
+
+  /**
+   * Update an existing job definition associated with the specified unique
+   * identifier.
+   *
+   * @param request - The request {@link UpdateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
   updateJobDefinition = request => this.client.fetch({
     body: JSON.stringify(marshalUpdateJobDefinitionRequest(request, this.client.settings)),
     headers: jsonContentHeaders$e,
     method: 'PATCH',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}`
   }, unmarshalJobDefinition);
+
+  /**
+   * Delete an exsisting job definition by its unique identifier.
+   *
+   * @param request - The request {@link DeleteJobDefinitionRequest}
+   */
   deleteJobDefinition = request => this.client.fetch({
     method: 'DELETE',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}`
   });
+
+  /**
+   * Run an existing job definition by its unique identifier. This will create a
+   * new job run.
+   *
+   * @param request - The request {@link StartJobDefinitionRequest}
+   * @returns A Promise of JobRun
+   */
   startJobDefinition = request => this.client.fetch({
     body: '{}',
     headers: jsonContentHeaders$e,
     method: 'POST',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}/start`
   }, unmarshalJobRun);
+
+  /**
+   * Get a job run by its unique identifier.
+   *
+   * @param request - The request {@link GetJobRunRequest}
+   * @returns A Promise of JobRun
+   */
   getJobRun = request => this.client.fetch({
     method: 'GET',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-runs/${validatePathParam('jobRunId', request.jobRunId)}`
   }, unmarshalJobRun);
+
+  /**
+   * Stop a job run by its unique identifier.
+   *
+   * @param request - The request {@link StopJobRunRequest}
+   * @returns A Promise of JobRun
+   */
   stopJobRun = request => this.client.fetch({
     body: '{}',
     headers: jsonContentHeaders$e,
@@ -16276,6 +16387,13 @@ let API$f = class API extends API$w {
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-runs`,
     urlParams: urlParams(['job_definition_id', request.jobDefinitionId], ['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
   }, unmarshalListJobRunsResponse);
+
+  /**
+   * List all job runs with filters.
+   *
+   * @param request - The request {@link ListJobRunsRequest}
+   * @returns A Promise of ListJobRunsResponse
+   */
   listJobRuns = (request = {}) => enrichForPagination('jobRuns', this.pageOfListJobRuns, request);
 };
 
@@ -16302,6 +16420,26 @@ const CreateJobDefinitionRequest = {
     pattern: /^[A-Za-z0-9-_]{3,50}$/
   }
 };
+const CreateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
+const CronSchedule = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
 const ListJobDefinitionsRequest = {
   page: {
     greaterThanOrEqual: 1
@@ -16334,13 +16472,26 @@ const UpdateJobDefinitionRequest = {
     pattern: /^[A-Za-z0-9-_]{3,50}$/
   }
 };
+const UpdateJobDefinitionRequestCronScheduleConfig = {
+  schedule: {
+    maxLength: 255,
+    minLength: 1
+  },
+  timezone: {
+    maxLength: 255,
+    minLength: 1
+  }
+};
 
 var validationRules_gen$5 = /*#__PURE__*/Object.freeze({
   __proto__: null,
   CreateJobDefinitionRequest: CreateJobDefinitionRequest,
+  CreateJobDefinitionRequestCronScheduleConfig: CreateJobDefinitionRequestCronScheduleConfig,
+  CronSchedule: CronSchedule,
   ListJobDefinitionsRequest: ListJobDefinitionsRequest,
   ListJobRunsRequest: ListJobRunsRequest,
-  UpdateJobDefinitionRequest: UpdateJobDefinitionRequest
+  UpdateJobDefinitionRequest: UpdateJobDefinitionRequest,
+  UpdateJobDefinitionRequestCronScheduleConfig: UpdateJobDefinitionRequestCronScheduleConfig
 });
 
 // This file was automatically generated. DO NOT EDIT.
@@ -16529,6 +16680,16 @@ const unmarshalNode = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
+const unmarshalExternalNodeCoreV1Taint = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ExternalNodeCoreV1Taint' failed as data isn't a dictionary.`);
+  }
+  return {
+    effect: data.effect,
+    key: data.key,
+    value: data.value
+  };
+};
 const unmarshalExternalNode = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ExternalNode' failed as data isn't a dictionary.`);
@@ -16544,6 +16705,7 @@ const unmarshalExternalNode = data => {
     kubeletConfig: data.kubelet_config,
     name: data.name,
     nodeLabels: data.node_labels,
+    nodeTaints: unmarshalArrayOfObject(data.node_taints, unmarshalExternalNodeCoreV1Taint),
     poolVersion: data.pool_version,
     runcVersion: data.runc_version
   };
@@ -17978,6 +18140,7 @@ const marshalCreateFrontendRequest = (request, defaults) => ({
   timeout_client: request.timeoutClient
 });
 const marshalCreateIpRequest = (request, defaults) => ({
+  is_ipv6: request.isIpv6,
   reverse: request.reverse,
   ...resolveOneOf([{
     default: defaults.defaultProjectId,
@@ -17991,8 +18154,10 @@ const marshalCreateIpRequest = (request, defaults) => ({
 });
 const marshalCreateLbRequest = (request, defaults) => ({
   assign_flexible_ip: request.assignFlexibleIp,
+  assign_flexible_ipv6: request.assignFlexibleIpv6,
   description: request.description,
   ip_id: request.ipId,
+  ip_ids: request.ipIds,
   name: request.name || randomName('lb'),
   ssl_compatibility_level: request.sslCompatibilityLevel,
   tags: request.tags,
@@ -18129,6 +18294,7 @@ const marshalUpdateHealthCheckRequest = (request, defaults) => ({
   }])
 });
 const marshalUpdateIpRequest = (request, defaults) => ({
+  lb_id: request.lbId,
   reverse: request.reverse
 });
 const marshalUpdateLbRequest = (request, defaults) => ({
@@ -18216,6 +18382,7 @@ const marshalZonedApiCreateFrontendRequest = (request, defaults) => ({
   timeout_client: request.timeoutClient
 });
 const marshalZonedApiCreateIpRequest = (request, defaults) => ({
+  is_ipv6: request.isIpv6,
   reverse: request.reverse,
   ...resolveOneOf([{
     default: defaults.defaultProjectId,
@@ -18229,8 +18396,10 @@ const marshalZonedApiCreateIpRequest = (request, defaults) => ({
 });
 const marshalZonedApiCreateLbRequest = (request, defaults) => ({
   assign_flexible_ip: request.assignFlexibleIp,
+  assign_flexible_ipv6: request.assignFlexibleIpv6,
   description: request.description,
   ip_id: request.ipId,
+  ip_ids: request.ipIds,
   name: request.name || randomName('lb'),
   ssl_compatibility_level: request.sslCompatibilityLevel,
   tags: request.tags,
@@ -18362,6 +18531,7 @@ const marshalZonedApiUpdateHealthCheckRequest = (request, defaults) => ({
   }])
 });
 const marshalZonedApiUpdateIpRequest = (request, defaults) => ({
+  lb_id: request.lbId,
   reverse: request.reverse
 });
 const marshalZonedApiUpdateLbRequest = (request, defaults) => ({
@@ -18499,7 +18669,7 @@ class ZonedAPI extends API$w {
   pageOfListIPs = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/lb/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips`,
-    urlParams: urlParams(['ip_address', request.ipAddress], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
+    urlParams: urlParams(['ip_address', request.ipAddress], ['ip_type', request.ipType], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
   }, unmarshalListIpsResponse);
 
   /**
@@ -18520,7 +18690,7 @@ class ZonedAPI extends API$w {
    * @param request - The request {@link ZonedApiCreateIpRequest}
    * @returns A Promise of Ip
    */
-  createIp = (request = {}) => this.client.fetch({
+  createIp = request => this.client.fetch({
     body: JSON.stringify(marshalZonedApiCreateIpRequest(request, this.client.settings)),
     headers: jsonContentHeaders$c,
     method: 'POST',
@@ -19288,7 +19458,7 @@ let API$d = class API extends API$w {
   pageOfListIPs = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/lb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips`,
-    urlParams: urlParams(['ip_address', request.ipAddress], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
+    urlParams: urlParams(['ip_address', request.ipAddress], ['ip_type', request.ipType], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
   }, unmarshalListIpsResponse);
 
   /**
@@ -19305,7 +19475,7 @@ let API$d = class API extends API$w {
    * @param request - The request {@link CreateIpRequest}
    * @returns A Promise of Ip
    */
-  createIp = (request = {}) => this.client.fetch({
+  createIp = request => this.client.fetch({
     body: JSON.stringify(marshalCreateIpRequest(request, this.client.settings)),
     headers: jsonContentHeaders$c,
     method: 'POST',
@@ -23679,6 +23849,16 @@ const unmarshalFolder = data => {
     region: data.region
   };
 };
+const unmarshalEphemeralProperties = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'EphemeralProperties' failed as data isn't a dictionary.`);
+  }
+  return {
+    action: data.action,
+    expiresAt: unmarshalDate(data.expires_at),
+    expiresOnceAccessed: data.expires_once_accessed
+  };
+};
 const unmarshalSecretVersion = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'SecretVersion' failed as data isn't a dictionary.`);
@@ -23686,6 +23866,7 @@ const unmarshalSecretVersion = data => {
   return {
     createdAt: unmarshalDate(data.created_at),
     description: data.description,
+    ephemeralProperties: data.ephemeral_properties ? unmarshalEphemeralProperties(data.ephemeral_properties) : undefined,
     isLatest: data.is_latest,
     revision: data.revision,
     secretId: data.secret_id,
@@ -23693,6 +23874,16 @@ const unmarshalSecretVersion = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
+const unmarshalEphemeralPolicy = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'EphemeralPolicy' failed as data isn't a dictionary.`);
+  }
+  return {
+    action: data.action,
+    expiresOnceAccessed: data.expires_once_accessed,
+    timeToLive: data.time_to_live
+  };
+};
 const unmarshalSecret = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Secret' failed as data isn't a dictionary.`);
@@ -23700,8 +23891,7 @@ const unmarshalSecret = data => {
   return {
     createdAt: unmarshalDate(data.created_at),
     description: data.description,
-    ephemeralAction: data.ephemeral_action,
-    expiresAt: unmarshalDate(data.expires_at),
+    ephemeralPolicy: data.ephemeral_policy ? unmarshalEphemeralPolicy(data.ephemeral_policy) : undefined,
     id: data.id,
     isManaged: data.is_managed,
     isProtected: data.is_protected,
@@ -23772,10 +23962,14 @@ const marshalCreateFolderRequest = (request, defaults) => ({
   path: request.path,
   project_id: request.projectId ?? defaults.defaultProjectId
 });
+const marshalEphemeralPolicy = (request, defaults) => ({
+  action: request.action,
+  expires_once_accessed: request.expiresOnceAccessed,
+  time_to_live: request.timeToLive
+});
 const marshalCreateSecretRequest = (request, defaults) => ({
   description: request.description,
-  ephemeral_action: request.ephemeralAction,
-  expires_at: request.expiresAt,
+  ephemeral_policy: request.ephemeralPolicy !== undefined ? marshalEphemeralPolicy(request.ephemeralPolicy) : undefined,
   name: request.name,
   path: request.path,
   project_id: request.projectId ?? defaults.defaultProjectId,
@@ -23807,12 +24001,19 @@ const marshalGeneratePasswordRequest = (request, defaults) => ({
 });
 const marshalUpdateSecretRequest = (request, defaults) => ({
   description: request.description,
+  ephemeral_policy: request.ephemeralPolicy !== undefined ? marshalEphemeralPolicy(request.ephemeralPolicy) : undefined,
   name: request.name,
   path: request.path,
   tags: request.tags
 });
+const marshalEphemeralProperties = (request, defaults) => ({
+  action: request.action,
+  expires_at: request.expiresAt,
+  expires_once_accessed: request.expiresOnceAccessed
+});
 const marshalUpdateSecretVersionRequest = (request, defaults) => ({
-  description: request.description
+  description: request.description,
+  ephemeral_properties: request.ephemeralProperties !== undefined ? marshalEphemeralProperties(request.ephemeralProperties) : undefined
 });
 
 // This file was automatically generated. DO NOT EDIT.
@@ -23889,9 +24090,9 @@ let API$7 = class API extends API$w {
   }, unmarshalSecret);
 
   /**
-   * Update metadata of a secret. Edit a secret's metadata such as name, tag(s)
-   * and description. The secret to update is specified by the `secret_id` and
-   * `region` parameters.
+   * Update metadata of a secret. Edit a secret's metadata such as name, tag(s),
+   * description and ephemeral policy. The secret to update is specified by the
+   * `secret_id` and `region` parameters.
    *
    * @param request - The request {@link UpdateSecretRequest}
    * @returns A Promise of Secret