@scaleway/sdk 1.4.0 → 1.5.0

package/dist/api/account/index.js

@@ -1,4 +1,2 @@
-import * as index$1 from './v2alpha1/index.js';
-export { index$1 as v2alpha1 };
 import * as index_gen from './v2/index.gen.js';
 export { index_gen as v2 };

package/dist/api/baremetal/index.js

@@ -1,2 +1,2 @@
-import * as index$1 from './v1/index.js';
-export { index$1 as v1 };
+import * as index from './v1/index.js';
+export { index as v1 };

package/dist/api/billing/index.js

@@ -0,0 +1,2 @@
+import * as index_gen from './v2alpha1/index.gen.js';
+export { index_gen as v2alpha1 };

package/dist/api/billing/v2alpha1/api.gen.js

@@ -0,0 +1,52 @@
+import { API as API$1 } from '../../../scw/api.js';
+import { urlParams, validatePathParam } from '../../../helpers/marshalling.js';
+import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
+import { unmarshalGetConsumptionResponse, unmarshalListInvoicesResponse } from './marshalling.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+/**
+ * Billing API.
+ *
+ * This API allows you to query your consumption. Billing API.
+ */
+class API extends API$1 {
+  constructor() {
+    var _this;
+    super(...arguments);
+    _this = this;
+    this.getConsumption = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/billing/v2alpha1/consumption`,
+        urlParams: urlParams(['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId])
+      }, unmarshalGetConsumptionResponse);
+    };
+    this.pageOfListInvoices = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/billing/v2alpha1/invoices`,
+        urlParams: urlParams(['invoice_type', request.invoiceType ?? 'unknown_type'], ['order_by', request.orderBy ?? 'invoice_number_desc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['started_after', request.startedAfter], ['started_before', request.startedBefore])
+      }, unmarshalListInvoicesResponse);
+    };
+    this.listInvoices = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('invoices', _this.pageOfListInvoices, request);
+    };
+    this.downloadInvoice = request => this.client.fetch({
+      method: 'GET',
+      path: `/billing/v2alpha1/invoices/${validatePathParam('invoiceId', request.invoiceId)}/download`,
+      urlParams: urlParams(['dl', 1], ['file_type', request.fileType ?? 'pdf']),
+      responseType: 'blob'
+    });
+  }
+}
+
+export { API };

package/dist/api/billing/v2alpha1/index.gen.js

@@ -0,0 +1,3 @@
+export { API } from './api.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.

package/dist/api/billing/v2alpha1/marshalling.gen.js

@@ -0,0 +1,52 @@
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalMoney } from '../../../scw/custom-marshalling.js';
+import { unmarshalArrayOfObject, unmarshalDate } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+const unmarshalGetConsumptionResponseConsumption = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'GetConsumptionResponseConsumption' failed as data isn't a dictionary.`);
+  }
+  return {
+    category: data.category,
+    description: data.description,
+    operationPath: data.operation_path,
+    projectId: data.project_id,
+    value: data.value ? unmarshalMoney(data.value) : undefined
+  };
+};
+const unmarshalInvoice = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Invoice' failed as data isn't a dictionary.`);
+  }
+  return {
+    dueDate: unmarshalDate(data.due_date),
+    id: data.id,
+    invoiceType: data.invoice_type,
+    issuedDate: unmarshalDate(data.issued_date),
+    number: data.number,
+    startDate: unmarshalDate(data.start_date),
+    totalTaxed: data.total_taxed ? unmarshalMoney(data.total_taxed) : undefined,
+    totalUntaxed: data.total_untaxed ? unmarshalMoney(data.total_untaxed) : undefined
+  };
+};
+const unmarshalGetConsumptionResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'GetConsumptionResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    consumptions: unmarshalArrayOfObject(data.consumptions, unmarshalGetConsumptionResponseConsumption),
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalListInvoicesResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListInvoicesResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    invoices: unmarshalArrayOfObject(data.invoices, unmarshalInvoice),
+    totalCount: data.total_count
+  };
+};
+
+export { unmarshalGetConsumptionResponse, unmarshalListInvoicesResponse };

package/dist/api/cockpit/v1beta1/api.gen.js

@@ -109,12 +109,17 @@ class API extends API$1 {
      * @param request - The request {@link CreateTokenRequest}
      * @returns A Promise of Token
      */
-    this.createToken = request => this.client.fetch({
-      body: JSON.stringify(marshalCreateTokenRequest(request, this.client.settings)),
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/cockpit/v1beta1/tokens`
-    }, unmarshalToken);
+    this.createToken = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalCreateTokenRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/tokens`
+      }, unmarshalToken);
+    };
     this.pageOfListTokens = function (request) {
       if (request === void 0) {
         request = {};

package/dist/api/cockpit/v1beta1/marshalling.gen.js

@@ -1,3 +1,4 @@
+import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.1/node_modules/@scaleway/random-name/dist/index.js';
 import { isJSONObject } from '../../../helpers/json.js';
 import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
 
@@ -141,7 +142,7 @@ const marshalCreateGrafanaUserRequest = (request, defaults) => ({
   role: request.role ?? 'unknown_role'
 });
 const marshalCreateTokenRequest = (request, defaults) => ({
-  name: request.name,
+  name: request.name || randomName('token'),
   project_id: request.projectId ?? defaults.defaultProjectId,
   scopes: request.scopes ? marshalTokenScopes(request.scopes) : undefined
 });

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

@@ -138,6 +138,13 @@ class API extends API$1 {
       method: 'POST',
       path: `/flexible-ip/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/fips/${validatePathParam('fipId', request.fipId)}/mac/duplicate`
     }, unmarshalFlexibleIP);
+    /**
+     * Move a virtual MAC. Move a Virtual MAC from a given Flexible IP onto
+     * another Flexible IP.
+     *
+     * @param request - The request {@link MoveMACAddrRequest}
+     * @returns A Promise of FlexibleIP
+     */
     this.moveMACAddr = request => this.client.fetch({
       body: JSON.stringify(marshalMoveMACAddrRequest(request, this.client.settings)),
       headers: jsonContentHeaders,

package/dist/api/function/v1beta1/marshalling.gen.js

@@ -17,6 +17,7 @@ const unmarshalTriggerMnqNatsClientConfig = data => {
     throw new TypeError(`Unmarshalling the type 'TriggerMnqNatsClientConfig' failed as data isn't a dictionary.`);
   }
   return {
+    mnqCredentialId: data.mnq_credential_id,
     mnqNamespaceId: data.mnq_namespace_id,
     mnqProjectId: data.mnq_project_id,
     mnqRegion: data.mnq_region,
@@ -28,6 +29,7 @@ const unmarshalTriggerMnqSqsClientConfig = data => {
     throw new TypeError(`Unmarshalling the type 'TriggerMnqSqsClientConfig' failed as data isn't a dictionary.`);
   }
   return {
+    mnqCredentialId: data.mnq_credential_id,
     mnqNamespaceId: data.mnq_namespace_id,
     mnqProjectId: data.mnq_project_id,
     mnqRegion: data.mnq_region,
@@ -140,6 +142,7 @@ const unmarshalRuntime = data => {
     extension: data.extension,
     implementation: data.implementation,
     language: data.language,
+    logoUrl: data.logo_url,
     name: data.name,
     status: data.status,
     statusMessage: data.status_message,

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

@@ -420,6 +420,13 @@ class API extends API$1 {
       method: 'DELETE',
       path: `/iam/v1alpha1/policies/${validatePathParam('policyId', request.policyId)}`
     });
+    /**
+     * Clone a policy. Clone a policy. You must define specify the `policy_id`
+     * parameter in your request.
+     *
+     * @param request - The request {@link ClonePolicyRequest}
+     * @returns A Promise of Policy
+     */
     this.clonePolicy = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,

package/dist/api/instance/index.js

@@ -1,2 +1,2 @@
-import * as index$1 from './v1/index.js';
-export { index$1 as v1 };
+import * as index from './v1/index.js';
+export { index as v1 };

package/dist/api/k8s/index.js

@@ -1,2 +1,2 @@
-import * as index$1 from './v1/index.js';
-export { index$1 as v1 };
+import * as index from './v1/index.js';
+export { index as v1 };

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

@@ -3,7 +3,7 @@ import { API as API$1 } from '../../../scw/api.js';
 import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { CLUSTER_TRANSIENT_STATUSES, POOL_TRANSIENT_STATUSES, NODE_TRANSIENT_STATUSES } from './content.gen.js';
-import { unmarshalListClustersResponse, marshalCreateClusterRequest, unmarshalCluster, marshalUpdateClusterRequest, marshalUpgradeClusterRequest, unmarshalListClusterAvailableVersionsResponse, unmarshalListPoolsResponse, marshalCreatePoolRequest, unmarshalPool, marshalUpgradePoolRequest, marshalUpdatePoolRequest, unmarshalExternalNode, unmarshalListNodesResponse, unmarshalNode, unmarshalListVersionsResponse, unmarshalVersion } from './marshalling.gen.js';
+import { unmarshalListClustersResponse, marshalCreateClusterRequest, unmarshalCluster, marshalUpdateClusterRequest, marshalUpgradeClusterRequest, marshalSetClusterTypeRequest, unmarshalListClusterAvailableVersionsResponse, unmarshalListPoolsResponse, marshalCreatePoolRequest, unmarshalPool, marshalUpgradePoolRequest, marshalUpdatePoolRequest, unmarshalExternalNode, unmarshalListNodesResponse, unmarshalNode, unmarshalListVersionsResponse, unmarshalVersion } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 const jsonContentHeaders = {
@@ -112,6 +112,18 @@ class API extends API$1 {
       method: 'POST',
       path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/upgrade`
     }, unmarshalCluster);
+    /**
+     * Change type of a cluster. Change type of a specific Kubernetes cluster.
+     *
+     * @param request - The request {@link SetClusterTypeRequest}
+     * @returns A Promise of Cluster
+     */
+    this.setClusterType = request => this.client.fetch({
+      body: JSON.stringify(marshalSetClusterTypeRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/set-type`
+    }, unmarshalCluster);
     /**
      * List available versions for a cluster. List the versions that a specific
      * Kubernetes cluster is allowed to upgrade to. Results will comprise every

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

@@ -82,6 +82,7 @@ const unmarshalCluster = data => {
     name: data.name,
     openIdConnectConfig: data.open_id_connect_config ? unmarshalClusterOpenIDConnectConfig(data.open_id_connect_config) : undefined,
     organizationId: data.organization_id,
+    privateNetworkId: data.private_network_id,
     projectId: data.project_id,
     region: data.region,
     status: data.status,
@@ -310,6 +311,7 @@ const marshalCreateClusterRequest = (request, defaults) => ({
   name: request.name || randomName('k8s'),
   open_id_connect_config: request.openIdConnectConfig ? marshalCreateClusterRequestOpenIDConnectConfig(request.openIdConnectConfig) : undefined,
   pools: request.pools ? request.pools.map(elt => marshalCreateClusterRequestPoolConfig(elt)) : undefined,
+  private_network_id: request.privateNetworkId,
   tags: request.tags,
   type: request.type,
   version: request.version,
@@ -340,6 +342,9 @@ const marshalCreatePoolRequest = (request, defaults) => ({
   upgrade_policy: request.upgradePolicy ? marshalCreatePoolRequestUpgradePolicy(request.upgradePolicy) : undefined,
   zone: request.zone ?? defaults.defaultZone
 });
+const marshalSetClusterTypeRequest = (request, defaults) => ({
+  type: request.type
+});
 const marshalUpdateClusterRequest = (request, defaults) => ({
   admission_plugins: request.admissionPlugins,
   apiserver_cert_sans: request.apiserverCertSans,
@@ -371,4 +376,4 @@ const marshalUpgradePoolRequest = (request, defaults) => ({
   version: request.version
 });
 
-export { marshalCreateClusterRequest, marshalCreatePoolRequest, marshalUpdateClusterRequest, marshalUpdatePoolRequest, marshalUpgradeClusterRequest, marshalUpgradePoolRequest, unmarshalCluster, unmarshalExternalNode, unmarshalListClusterAvailableVersionsResponse, unmarshalListClustersResponse, unmarshalListNodesResponse, unmarshalListPoolsResponse, unmarshalListVersionsResponse, unmarshalNode, unmarshalPool, unmarshalVersion };
+export { marshalCreateClusterRequest, marshalCreatePoolRequest, marshalSetClusterTypeRequest, marshalUpdateClusterRequest, marshalUpdatePoolRequest, marshalUpgradeClusterRequest, marshalUpgradePoolRequest, unmarshalCluster, unmarshalExternalNode, unmarshalListClusterAvailableVersionsResponse, unmarshalListClustersResponse, unmarshalListNodesResponse, unmarshalListPoolsResponse, unmarshalListVersionsResponse, unmarshalNode, unmarshalPool, unmarshalVersion };

package/dist/api/lb/index.js

@@ -1,2 +1,2 @@
-import * as index$1 from './v1/index.js';
-export { index$1 as v1 };
+import * as index from './v1/index.js';
+export { index as v1 };

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

@@ -46,8 +46,8 @@ class API extends API$1 {
     }, unmarshalListNodeTypesResponse);
     /**
      * List available node types. List all available node types. By default, the
-     * databases returned in the list are ordered by creation date in ascending
-     * order, though this can be modified via the order_by field.
+     * 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
@@ -64,7 +64,7 @@ class API extends API$1 {
       }, unmarshalListDatabaseBackupsResponse);
     };
     /**
-     * List database backups. List all backups in a specified zone, for a given
+     * List database backups. List all backups in a specified region, for a given
      * Scaleway Organization or Scaleway Project. By default, the backups listed
      * are ordered by creation date in ascending order. This can be modified via
      * the `order_by` field.
@@ -190,9 +190,9 @@ class API extends API$1 {
       }, unmarshalListInstancesResponse);
     };
     /**
-     * List Database Instances. List all Database Instances in the specified zone,
-     * for a given Scaleway Organization or Scaleway Project. By default, the
-     * Database Instances returned in the list are ordered by creation date in
+     * List Database Instances. List all Database Instances in the specified
+     * region, for a given Scaleway Organization or Scaleway Project. 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` and `name`.
      * For the `name` parameter, the value you include will be checked against the
@@ -329,7 +329,7 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/renew-certificate`
     });
     /**
-     * Get Database Instance metrics. Retrieve the time series metrics of a give
+     * Get Database Instance metrics. Retrieve the time series metrics of a given
      * Database Instance. You can define the period from which to retrieve metrics
      * by specifying the `start_date` and `end_date`.
      *
@@ -726,10 +726,10 @@ class API extends API$1 {
     };
     /**
      * List snapshots. List snapshots. You can include the `instance_id` or
-     * `project_id` in your query to get the list of snaphots for specific
+     * `project_id` in your query to get the list of snapshots for specific
      * Database Instances and/or Projects. By default, the details returned in the
      * list are ordered by creation date in ascending order, though this can be
-     * modified via the order_by field.
+     * modified via the `order_by` field.
      *
      * @param request - The request {@link ListSnapshotsRequest}
      * @returns A Promise of ListSnapshotsResponse
@@ -820,7 +820,7 @@ class API extends API$1 {
     }, unmarshalInstance);
     /**
      * Create a new Database Instance endpoint. Create a new endpoint for a
-     * Database Instance. You can add `load_balacer` and `private_network`
+     * Database Instance. You can add `load_balancer` and `private_network`
      * specifications to the body of the request. Note that this action replaces
      * your current endpoint, which means you might need to update any environment
      * configurations that point to the old endpoint.

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,11 +95,13 @@ class API extends API$1 {
       return enrichForPagination('clusters', _this.pageOfListClusters, request);
     };
     /**
-     * Migrate your cluster architecture. 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
@@ -97,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
@@ -107,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
@@ -123,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
@@ -135,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
@@ -154,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
@@ -166,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
@@ -178,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
@@ -188,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
@@ -200,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
@@ -212,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
@@ -224,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
@@ -234,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
@@ -244,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
@@ -256,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
@@ -268,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
@@ -278,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
@@ -287,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,