@scaleway/sdk 1.2.0 → 1.5.0

package/dist/api/rdb/v1/marshalling.gen.js

@@ -491,15 +491,29 @@ const unmarshalSetInstanceSettingsResponse = data => {
     settings: unmarshalArrayOfObject(data.settings, unmarshalInstanceSetting)
   };
 };
+const marshalEndpointSpecPrivateNetworkIpamConfig = (request, defaults) => ({});
+const marshalReadReplicaEndpointSpecPrivateNetworkIpamConfig = (request, defaults) => ({});
 const marshalEndpointSpecLoadBalancer = (request, defaults) => ({});
 const marshalEndpointSpecPrivateNetwork = (request, defaults) => ({
   private_network_id: request.privateNetworkId,
-  service_ip: request.serviceIp
+  ...resolveOneOf([{
+    param: 'service_ip',
+    value: request.serviceIp
+  }, {
+    param: 'ipam_config',
+    value: request.ipamConfig ? marshalEndpointSpecPrivateNetworkIpamConfig(request.ipamConfig) : undefined
+  }])
 });
 const marshalReadReplicaEndpointSpecDirectAccess = (request, defaults) => ({});
 const marshalReadReplicaEndpointSpecPrivateNetwork = (request, defaults) => ({
   private_network_id: request.privateNetworkId,
-  service_ip: request.serviceIp
+  ...resolveOneOf([{
+    param: 'service_ip',
+    value: request.serviceIp
+  }, {
+    param: 'ipam_config',
+    value: request.ipamConfig ? marshalReadReplicaEndpointSpecPrivateNetworkIpamConfig(request.ipamConfig) : undefined
+  }])
 });
 const marshalACLRuleRequest = (request, defaults) => ({
   description: request.description,

package/dist/api/redis/v1/api.gen.js

@@ -17,7 +17,10 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Create a cluster
+     * Create a Redis™ Database Instance. Create a new Redis™ Database Instance
+     * (Redis™ cluster). You must set the `zone`, `project_id`, `version`,
+     * `node_type`, `user_name` and `password` parameters. Optionally you can
+     * define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`.
      *
      * @param request - The request {@link CreateClusterRequest}
      * @returns A Promise of Cluster
@@ -29,7 +32,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters`
     }, unmarshalCluster);
     /**
-     * Update a cluster
+     * Update a Redis™ Database Instance. Update the parameters of a Redis™
+     * Database Instance (Redis™ cluster), including `name`, `tags`, `user_name`
+     * and `password`.
      *
      * @param request - The request {@link UpdateClusterRequest}
      * @returns A Promise of Cluster
@@ -41,7 +46,11 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
     /**
-     * Get a cluster
+     * Get a Redis™ Database Instance. Retrieve information about a Redis™
+     * Database Instance (Redis™ cluster). Specify the `cluster_id` and `region`
+     * in your request to get information such as `id`, `status`, `version`,
+     * `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints`
+     * about your cluster in the response.
      *
      * @param request - The request {@link GetClusterRequest}
      * @returns A Promise of Cluster
@@ -69,7 +78,12 @@ class API extends API$1 {
       }, unmarshalListClustersResponse);
     };
     /**
-     * List clusters
+     * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™
+     * cluster) in the specified zone. By default, the Database Instances returned
+     * in the list are ordered by creation date in ascending order, though this
+     * can be modified via the order_by field. You can define additional
+     * parameters for your query, such as `tags`, `name`, `organization_id` and
+     * `version`.
      *
      * @param request - The request {@link ListClustersRequest}
      * @returns A Promise of ListClustersResponse
@@ -81,10 +95,13 @@ class API extends API$1 {
       return enrichForPagination('clusters', _this.pageOfListClusters, request);
     };
     /**
-     * Upgrade your Database for Redis® cluster to a new version or scale it
-     * vertically / horizontally. Please note: scaling horizontally your Database
-     * for Redis® cluster won't renew its TLS certificate. In order to refresh the
-     * SSL certificate, you have to use the dedicated api route.
+     * Scale up a Redis™ Database Instance. Upgrade your standalone Redis™
+     * Database Instance node, either by upgrading to a bigger node type (vertical
+     * scaling) or by adding more nodes to your Database Instance to increase your
+     * number of endpoints and distribute cache (horizontal scaling). Note that
+     * scaling horizontally your Redis™ Database Instance will not renew its TLS
+     * certificate. In order to refresh the TLS certificate, you must use the
+     * Renew TLS certificate endpoint.
      *
      * @param request - The request {@link MigrateClusterRequest}
      * @returns A Promise of Cluster
@@ -96,7 +113,10 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/migrate`
     }, unmarshalCluster);
     /**
-     * Delete a cluster
+     * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance
+     * (Redis™ cluster), specified by the `region` and `cluster_id` parameters.
+     * Deleting a Database Instance is permanent, and cannot be undone. Note that
+     * upon deletion all your data will be lost.
      *
      * @param request - The request {@link DeleteClusterRequest}
      * @returns A Promise of Cluster
@@ -106,7 +126,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}`
     }, unmarshalCluster);
     /**
-     * Get metrics of a cluster
+     * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™
+     * Database Instance (Redis™ cluster). You can define the period from which to
+     * retrieve metrics by specifying the `start_date` and `end_date`.
      *
      * @param request - The request {@link GetClusterMetricsRequest}
      * @returns A Promise of ClusterMetricsResponse
@@ -122,7 +144,9 @@ class API extends API$1 {
       urlParams: urlParams(['include_disabled_types', request.includeDisabledTypes], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListNodeTypesResponse);
     /**
-     * List available node types
+     * List available node types. List all available node types. By default, the
+     * node types returned in the list are ordered by creation date in ascending
+     * order, though this can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListNodeTypesRequest}
      * @returns A Promise of ListNodeTypesResponse
@@ -134,14 +158,18 @@ class API extends API$1 {
       urlParams: urlParams(['include_beta', request.includeBeta], ['include_deprecated', request.includeDeprecated], ['include_disabled', request.includeDisabled], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['version', request.version])
     }, unmarshalListClusterVersionsResponse);
     /**
-     * List available Redis™ versions
+     * List available Redis™ versions. List the Redis™ database engine versions
+     * available. You can define additional parameters for your query, such as
+     * `include_disabled`, `include_beta`, `include_deprecated` and `version`.
      *
      * @param request - The request {@link ListClusterVersionsRequest}
      * @returns A Promise of ListClusterVersionsResponse
      */
     this.listClusterVersions = request => enrichForPagination('versions', this.pageOfListClusterVersions, request);
     /**
-     * Get the TLS certificate of a cluster
+     * Get the TLS certificate of a cluster. Retrieve information about the TLS
+     * certificate of a Redis™ Database Instance (Redis™ cluster). Details like
+     * name and content are returned in the response.
      *
      * @param request - The request {@link GetClusterCertificateRequest}
      * @returns A Promise of Blob
@@ -153,7 +181,11 @@ class API extends API$1 {
       responseType: 'blob'
     });
     /**
-     * Renew the TLS certificate of a cluster
+     * Renew the TLS certificate of a cluster. Renew a TLS certificate for a
+     * Redis™ Database Instance (Redis™ cluster). Renewing a certificate means
+     * that you will not be able to connect to your Database Instance using the
+     * previous certificate. You will also need to download and update the new
+     * certificate for all database clients.
      *
      * @param request - The request {@link RenewClusterCertificateRequest}
      * @returns A Promise of Cluster
@@ -165,7 +197,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/renew-certificate`
     }, unmarshalCluster);
     /**
-     * Add cluster settings
+     * Add advanced settings. Add an advanced setting to a Redis™ Database
+     * Instance (Redis™ cluster). You must set the `name` and the `value` of each
+     * setting.
      *
      * @param request - The request {@link AddClusterSettingsRequest}
      * @returns A Promise of ClusterSettingsResponse
@@ -177,7 +211,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings`
     }, unmarshalClusterSettingsResponse);
     /**
-     * Delete a cluster setting
+     * Delete advanced setting. Delete an advanced setting in a Redis™ Database
+     * Instance (Redis™ cluster). You must specify the names of the settings you
+     * want to delete in the request body.
      *
      * @param request - The request {@link DeleteClusterSettingRequest}
      * @returns A Promise of Cluster
@@ -187,7 +223,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings/${validatePathParam('settingName', request.settingName)}`
     }, unmarshalCluster);
     /**
-     * Set cluster settings
+     * Set advanced settings. Update an advanced setting for a Redis™ Database
+     * Instance (Redis™ cluster). Settings added upon database engine
+     * initalization can only be defined once, and cannot, therefore, be updated.
      *
      * @param request - The request {@link SetClusterSettingsRequest}
      * @returns A Promise of ClusterSettingsResponse
@@ -199,7 +237,8 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/settings`
     }, unmarshalClusterSettingsResponse);
     /**
-     * Set ACL rules for a given cluster
+     * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database
+     * Instance (Redis™ cluster).
      *
      * @param request - The request {@link SetAclRulesRequest}
      * @returns A Promise of SetAclRulesResponse
@@ -211,7 +250,8 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/acls`
     }, unmarshalSetAclRulesResponse);
     /**
-     * Add ACL rules for a given cluster
+     * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™
+     * Database Instance (Redis™ cluster).
      *
      * @param request - The request {@link AddAclRulesRequest}
      * @returns A Promise of AddAclRulesResponse
@@ -223,7 +263,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/acls`
     }, unmarshalAddAclRulesResponse);
     /**
-     * Delete an ACL rule for a given cluster
+     * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database
+     * Instance (Redis™ cluster). You must specify the `acl_id` of the rule you
+     * want to delete in your request.
      *
      * @param request - The request {@link DeleteAclRuleRequest}
      * @returns A Promise of Cluster
@@ -233,7 +275,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/acls/${validatePathParam('aclId', request.aclId)}`
     }, unmarshalCluster);
     /**
-     * Get an ACL rule
+     * Get an ACL rule. Retrieve information about an ACL rule of a Redis™
+     * Database Instance (Redis™ cluster). You must specify the `acl_id` of the
+     * rule in your request.
      *
      * @param request - The request {@link GetAclRuleRequest}
      * @returns A Promise of ACLRule
@@ -243,7 +287,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/acls/${validatePathParam('aclId', request.aclId)}`
     }, unmarshalACLRule);
     /**
-     * Set endpoints for a given cluster
+     * Set endpoints for a cluster. Update an endpoint for a Redis™ Database
+     * Instance (Redis™ cluster). You must specify the `cluster_id` and the
+     * `endpoints` parameters in your request.
      *
      * @param request - The request {@link SetEndpointsRequest}
      * @returns A Promise of SetEndpointsResponse
@@ -255,7 +301,9 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/endpoints`
     }, unmarshalSetEndpointsResponse);
     /**
-     * Add endpoints for a given cluster
+     * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database
+     * Instance (Redis™ cluster). You can add `private_network` or
+     * `public_network` specifications to the body of the request.
      *
      * @param request - The request {@link AddEndpointsRequest}
      * @returns A Promise of AddEndpointsResponse
@@ -267,7 +315,10 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/clusters/${validatePathParam('clusterId', request.clusterId)}/endpoints`
     }, unmarshalAddEndpointsResponse);
     /**
-     * Delete an endpoint for a given cluster
+     * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database
+     * Instance (Redis™ cluster). You must specify the `region` and `endpoint_id`
+     * parameters of the endpoint you want to delete. Note that might need to
+     * update any environment configurations that point to the deleted endpoint.
      *
      * @param request - The request {@link DeleteEndpointRequest}
      * @returns A Promise of Cluster
@@ -277,7 +328,10 @@ class API extends API$1 {
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     }, unmarshalCluster);
     /**
-     * Get an endpoint
+     * Get an endpoint. Retrieve information about a Redis™ Database Instance
+     * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
+     * `port`, `private_network` and `public_network` specifications are returned
+     * in the response.
      *
      * @param request - The request {@link GetEndpointRequest}
      * @returns A Promise of Endpoint
@@ -286,6 +340,15 @@ class API extends API$1 {
       method: 'GET',
       path: `/redis/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     }, unmarshalEndpoint);
+    /**
+     * Update an endpoint. Update information about a Redis™ Database Instance
+     * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`,
+     * `port`, `private_network` and `public_network` specifications are returned
+     * in the response.
+     *
+     * @param request - The request {@link UpdateEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
     this.updateEndpoint = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateEndpointRequest(request, this.client.settings)),
       headers: jsonContentHeaders,

package/dist/api/registry/v1/api.gen.js

@@ -13,7 +13,7 @@ const jsonContentHeaders = {
 /**
  * Registry API.
  *
- * Container registry API.
+ * Container registry API. Registry API.
  */
 class API extends API$1 {
   constructor() {
@@ -31,7 +31,7 @@ class API extends API$1 {
       }, unmarshalListNamespacesResponse);
     };
     /**
-     * List all your namespaces
+     * List all your namespaces.
      *
      * @param request - The request {@link ListNamespacesRequest}
      * @returns A Promise of ListNamespacesResponse
@@ -43,7 +43,7 @@ class API extends API$1 {
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
     /**
-     * Get the namespace associated with the given id.
+     * Get a namespace. Get the namespace associated with the given id.
      *
      * @param request - The request {@link GetNamespaceRequest}
      * @returns A Promise of Namespace
@@ -61,7 +61,7 @@ class API extends API$1 {
      */
     this.waitForNamespace = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
     /**
-     * Create a new namespace
+     * Create a new namespace.
      *
      * @param request - The request {@link CreateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -73,7 +73,8 @@ class API extends API$1 {
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
     /**
-     * Update the namespace associated with the given id.
+     * Update an existing namespace. Update the namespace associated with the
+     * given id.
      *
      * @param request - The request {@link UpdateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -85,7 +86,8 @@ class API extends API$1 {
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
     /**
-     * Delete the namespace associated with the given id.
+     * Delete an existing namespace. Delete the namespace associated with the
+     * given id.
      *
      * @param request - The request {@link DeleteNamespaceRequest}
      * @returns A Promise of Namespace
@@ -105,7 +107,7 @@ class API extends API$1 {
       }, unmarshalListImagesResponse);
     };
     /**
-     * List all your images
+     * List all your images.
      *
      * @param request - The request {@link ListImagesRequest}
      * @returns A Promise of ListImagesResponse
@@ -117,7 +119,7 @@ class API extends API$1 {
       return enrichForPagination('images', _this.pageOfListImages, request);
     };
     /**
-     * Get the image associated with the given id.
+     * Get a image. Get the image associated with the given id.
      *
      * @param request - The request {@link GetImageRequest}
      * @returns A Promise of Image
@@ -135,7 +137,7 @@ class API extends API$1 {
      */
     this.waitForImage = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!IMAGE_TRANSIENT_STATUSES.includes(res.status))), this.getImage, request, options);
     /**
-     * Update the image associated with the given id.
+     * Update an existing image. Update the image associated with the given id.
      *
      * @param request - The request {@link UpdateImageRequest}
      * @returns A Promise of Image
@@ -147,7 +149,7 @@ class API extends API$1 {
       path: `/registry/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/images/${validatePathParam('imageId', request.imageId)}`
     }, unmarshalImage);
     /**
-     * Delete the image associated with the given id.
+     * Delete an image. Delete the image associated with the given id.
      *
      * @param request - The request {@link DeleteImageRequest}
      * @returns A Promise of Image
@@ -162,14 +164,14 @@ class API extends API$1 {
       urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListTagsResponse);
     /**
-     * List all your tags
+     * List all your tags.
      *
      * @param request - The request {@link ListTagsRequest}
      * @returns A Promise of ListTagsResponse
      */
     this.listTags = request => enrichForPagination('tags', this.pageOfListTags, request);
     /**
-     * Get the tag associated with the given id.
+     * Get a tag. Get the tag associated with the given id.
      *
      * @param request - The request {@link GetTagRequest}
      * @returns A Promise of Tag
@@ -187,7 +189,7 @@ class API extends API$1 {
      */
     this.waitForTag = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!TAG_TRANSIENT_STATUSES.includes(res.status))), this.getTag, request, options);
     /**
-     * Delete the tag associated with the given id.
+     * Delete a tag. Delete the tag associated with the given id.
      *
      * @param request - The request {@link DeleteTagRequest}
      * @returns A Promise of Tag

package/dist/api/secret/v1alpha1/api.gen.js

@@ -9,9 +9,10 @@ const jsonContentHeaders = {
 };
 
 /**
- * Secret API (beta).
+ * Secret Manager API documentation.
  *
  * This API allows you to conveniently store, access and share sensitive data.
+ * Secret Manager API documentation.
  */
 class API extends API$1 {
   constructor() {
@@ -19,7 +20,7 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Create a Secret containing no versions
+     * Create a secret. You must sepcify the `region` to create a secret.
      *
      * @param request - The request {@link CreateSecretRequest}
      * @returns A Promise of Secret
@@ -31,7 +32,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
     }, unmarshalSecret);
     /**
-     * Get metadata of a Secret
+     * Get metadata using the secret's name. Retrieve the metadata of a secret
+     * specified by the `region` and the `secret_name` parameters.
      *
      * @param request - The request {@link GetSecretRequest}
      * @returns A Promise of Secret
@@ -41,7 +43,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
     }, unmarshalSecret);
     /**
-     * Get metadata of a Secret
+     * Get metadata using the secret's ID. Retrieve the metadata of a secret
+     * specified by the `region` and the `secret_id` parameters.
      *
      * @param request - The request {@link GetSecretByNameRequest}
      * @returns A Promise of Secret
@@ -51,7 +54,9 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}`
     }, unmarshalSecret);
     /**
-     * Update metadata of a Secret
+     * 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.
      *
      * @param request - The request {@link UpdateSecretRequest}
      * @returns A Promise of Secret
@@ -73,7 +78,9 @@ class API extends API$1 {
       }, unmarshalListSecretsResponse);
     };
     /**
-     * List Secrets
+     * List secrets. Retrieve the list of secrets created within an Organization
+     * and/or Project. You must specify either the `organization_id` or the
+     * `project_id` and the `region`.
      *
      * @param request - The request {@link ListSecretsRequest}
      * @returns A Promise of ListSecretsResponse
@@ -85,7 +92,8 @@ class API extends API$1 {
       return enrichForPagination('secrets', _this.pageOfListSecrets, request);
     };
     /**
-     * Delete a secret
+     * Delete a secret. Delete a given secret specified by the `region` and
+     * `secret_id` parameters.
      *
      * @param request - The request {@link DeleteSecretRequest}
      */
@@ -94,7 +102,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
     });
     /**
-     * Create a SecretVersion
+     * Create a version. Create a version of a given secret specified by the
+     * `region` and `secret_id` parameters.
      *
      * @param request - The request {@link CreateSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -106,7 +115,9 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`
     }, unmarshalSecretVersion);
     /**
-     * Get metadata of a SecretVersion
+     * Get metadata of a secret's version using the secret's ID. Retrieve the
+     * metadata of a secret's given version specified by the `region`, `secret_id`
+     * and `revision` parameters.
      *
      * @param request - The request {@link GetSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -116,7 +127,9 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
     }, unmarshalSecretVersion);
     /**
-     * Get metadata of a SecretVersion
+     * Get metadata of a secret's version using the secret's name. Retrieve the
+     * metadata of a secret's given version specified by the `region`,
+     * `secret_name` and `revision` parameters.
      *
      * @param request - The request {@link GetSecretVersionByNameRequest}
      * @returns A Promise of SecretVersion
@@ -126,7 +139,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${validatePathParam('secretName', request.secretName)}/versions/${validatePathParam('revision', request.revision)}`
     }, unmarshalSecretVersion);
     /**
-     * Update metadata of a SecretVersion
+     * Update metadata of a version. Edit the metadata of a secret's given
+     * version, specified by the `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link UpdateSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -143,7 +157,9 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status])
     }, unmarshalListSecretVersionsResponse);
     /**
-     * List versions of a secret, not returning any sensitive data
+     * List versions of a secret using the secret's ID. Retrieve the list of a
+     * given secret's versions specified by the `secret_id` and `region`
+     * parameters.
      *
      * @param request - The request {@link ListSecretVersionsRequest}
      * @returns A Promise of ListSecretVersionsResponse
@@ -155,14 +171,17 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status])
     }, unmarshalListSecretVersionsResponse);
     /**
-     * List versions of a secret, not returning any sensitive data
+     * List versions of a secret using the secret's name. Retrieve the list of a
+     * given secret's versions specified by the `secret_name` and `region`
+     * parameters.
      *
      * @param request - The request {@link ListSecretVersionsByNameRequest}
      * @returns A Promise of ListSecretVersionsResponse
      */
     this.listSecretVersionsByName = request => enrichForPagination('versions', this.pageOfListSecretVersionsByName, request);
     /**
-     * Destroy a SecretVersion, permanently destroying the sensitive data
+     * Delete a version. Delete a secret's version and the sensitive data
+     * contained in it. Deleting a version is permanent and cannot be undone.
      *
      * @param request - The request {@link DestroySecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -174,7 +193,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
     }, unmarshalSecretVersion);
     /**
-     * Enable a SecretVersion
+     * Enable a version. Make a specific version accessible. You must specify the
+     * `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link EnableSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -186,7 +206,8 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/enable`
     }, unmarshalSecretVersion);
     /**
-     * Disable a SecretVersion
+     * Disable a version. Make a specific version inaccessible. You must specify
+     * the `region`, `secret_id` and `revision` parameters.
      *
      * @param request - The request {@link DisableSecretVersionRequest}
      * @returns A Promise of SecretVersion
@@ -198,7 +219,9 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/disable`
     }, unmarshalSecretVersion);
     /**
-     * Access a SecretVersion, returning the sensitive data
+     * Access a secret's version using the secret's ID. Access sensitive data in a
+     * secret's version specified by the `region`, `secret_id` and `revision`
+     * parameters.
      *
      * @param request - The request {@link AccessSecretVersionRequest}
      * @returns A Promise of AccessSecretVersionResponse
@@ -208,7 +231,9 @@ class API extends API$1 {
       path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/access`
     }, unmarshalAccessSecretVersionResponse);
     /**
-     * Access a SecretVersion, returning the sensitive data
+     * Access a secret's version using the secret's name. Access sensitive data in
+     * a secret's version specified by the `region`, `secret_name` and `revision`
+     * parameters.
      *
      * @param request - The request {@link AccessSecretVersionByNameRequest}
      * @returns A Promise of AccessSecretVersionResponse