@scaleway/sdk 1.6.0 → 1.8.0

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

@@ -11,9 +11,9 @@ const jsonContentHeaders = {
 };
 
 /**
- * IoT API.
+ * IoT Hub API.
  *
- * This API allows you to manage IoT hubs and devices. IoT API.
+ * This API allows you to manage IoT hubs and devices. IoT Hub API.
  */
 class API extends API$1 {
   constructor() {
@@ -31,7 +31,9 @@ class API extends API$1 {
       }, unmarshalListHubsResponse);
     };
     /**
-     * List hubs.
+     * List hubs. List all Hubs in the specified zone. By default, returned Hubs
+     * are ordered by creation date in ascending order, though this can be
+     * modified via the `order_by` field.
      *
      * @param request - The request {@link ListHubsRequest}
      * @returns A Promise of ListHubsResponse
@@ -43,7 +45,8 @@ class API extends API$1 {
       return enrichForPagination('hubs', _this.pageOfListHubs, request);
     };
     /**
-     * Create a hub.
+     * Create a hub. Create a new Hub in the targeted region, specifying its
+     * configuration including name and product plan.
      *
      * @param request - The request {@link CreateHubRequest}
      * @returns A Promise of Hub
@@ -55,7 +58,9 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs`
     }, unmarshalHub);
     /**
-     * Get a hub.
+     * Get a hub. Retrieve information about an existing IoT Hub, specified by its
+     * Hub ID. Its full details, including name, status and endpoint, are returned
+     * in the response object.
      *
      * @param request - The request {@link GetHubRequest}
      * @returns A Promise of Hub
@@ -71,9 +76,10 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Hub
      */
-    this.waitForHub = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
+    this.waitForHub = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))), this.getHub, request, options);
     /**
-     * Update a hub.
+     * Update a hub. Update the parameters of an existing IoT Hub, specified by
+     * its Hub ID.
      *
      * @param request - The request {@link UpdateHubRequest}
      * @returns A Promise of Hub
@@ -85,7 +91,7 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}`
     }, unmarshalHub);
     /**
-     * Enable a hub.
+     * Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
      *
      * @param request - The request {@link EnableHubRequest}
      * @returns A Promise of Hub
@@ -97,7 +103,7 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/enable`
     }, unmarshalHub);
     /**
-     * Disable a hub.
+     * Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
      *
      * @param request - The request {@link DisableHubRequest}
      * @returns A Promise of Hub
@@ -109,7 +115,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/disable`
     }, unmarshalHub);
     /**
-     * Delete a hub.
+     * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
+     * a Hub is permanent, and cannot be undone.
      *
      * @param request - The request {@link DeleteHubRequest}
      */
@@ -119,7 +126,8 @@ class API extends API$1 {
       urlParams: urlParams(['delete_devices', request.deleteDevices])
     });
     /**
-     * Get a hub's metrics.
+     * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
+     * its Hub ID.
      *
      * @deprecated
      * @param request - The request {@link GetHubMetricsRequest}
@@ -131,7 +139,8 @@ class API extends API$1 {
       urlParams: urlParams(['start_date', request.startDate])
     }, unmarshalGetHubMetricsResponse);
     /**
-     * Set the certificate authority of a hub.
+     * Set the certificate authority of a hub. Set a particular PEM-encoded
+     * certificate, specified by the Hub ID.
      *
      * @param request - The request {@link SetHubCARequest}
      * @returns A Promise of Hub
@@ -143,7 +152,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam('hubId', request.hubId)}/ca`
     }, unmarshalHub);
     /**
-     * Get the certificate authority of a hub.
+     * Get the certificate authority of a hub. Get information for a particular
+     * PEM-encoded certificate, specified by the Hub ID.
      *
      * @param request - The request {@link GetHubCARequest}
      * @returns A Promise of GetHubCAResponse
@@ -163,7 +173,9 @@ class API extends API$1 {
       }, unmarshalListDevicesResponse);
     };
     /**
-     * List devices.
+     * List devices. List all devices in the specified region. By default,
+     * returned devices are ordered by creation date in ascending order, though
+     * this can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListDevicesRequest}
      * @returns A Promise of ListDevicesResponse
@@ -175,7 +187,7 @@ class API extends API$1 {
       return enrichForPagination('devices', _this.pageOfListDevices, request);
     };
     /**
-     * Add a device.
+     * Add a device. Attach a device to a given Hub.
      *
      * @param request - The request {@link CreateDeviceRequest}
      * @returns A Promise of CreateDeviceResponse
@@ -187,7 +199,9 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices`
     }, unmarshalCreateDeviceResponse);
     /**
-     * Get a device.
+     * Get a device. Retrieve information about an existing device, specified by
+     * its device ID. Its full details, including name, status and ID, are
+     * returned in the response object.
      *
      * @param request - The request {@link GetDeviceRequest}
      * @returns A Promise of Device
@@ -197,7 +211,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
     }, unmarshalDevice);
     /**
-     * Update a device.
+     * Update a device. Update the parameters of an existing device, specified by
+     * its device ID.
      *
      * @param request - The request {@link UpdateDeviceRequest}
      * @returns A Promise of Device
@@ -209,7 +224,7 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
     }, unmarshalDevice);
     /**
-     * Enable a device.
+     * Enable a device. Enable a specific device, specified by its device ID.
      *
      * @param request - The request {@link EnableDeviceRequest}
      * @returns A Promise of Device
@@ -221,7 +236,7 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/enable`
     }, unmarshalDevice);
     /**
-     * Disable a device.
+     * Disable a device. Disable an existing device, specified by its device ID.
      *
      * @param request - The request {@link DisableDeviceRequest}
      * @returns A Promise of Device
@@ -233,7 +248,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/disable`
     }, unmarshalDevice);
     /**
-     * Renew a device certificate.
+     * Renew a device certificate. Renew the certificate of an existing device,
+     * specified by its device ID.
      *
      * @param request - The request {@link RenewDeviceCertificateRequest}
      * @returns A Promise of RenewDeviceCertificateResponse
@@ -245,7 +261,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/renew-certificate`
     }, unmarshalRenewDeviceCertificateResponse);
     /**
-     * Set a custom certificate on a device.
+     * Set a custom certificate on a device. Switch the existing certificate of a
+     * given device with an EM-encoded custom certificate.
      *
      * @param request - The request {@link SetDeviceCertificateRequest}
      * @returns A Promise of SetDeviceCertificateResponse
@@ -257,7 +274,9 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/certificate`
     }, unmarshalSetDeviceCertificateResponse);
     /**
-     * Get a device's certificate.
+     * Get a device's certificate. Get information for a particular PEM-encoded
+     * certificate, specified by the device ID. The response returns full details
+     * of the device, including its type of certificate.
      *
      * @param request - The request {@link GetDeviceCertificateRequest}
      * @returns A Promise of GetDeviceCertificateResponse
@@ -267,7 +286,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}/certificate`
     }, unmarshalGetDeviceCertificateResponse);
     /**
-     * Remove a device.
+     * Remove a device. Remove a specific device from the specific Hub it is
+     * attached to.
      *
      * @param request - The request {@link DeleteDeviceRequest}
      */
@@ -276,7 +296,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam('deviceId', request.deviceId)}`
     });
     /**
-     * Get a device's metrics.
+     * Get a device's metrics. Get the metrics of an existing device, specified by
+     * its device ID.
      *
      * @deprecated
      * @param request - The request {@link GetDeviceMetricsRequest}
@@ -298,7 +319,9 @@ class API extends API$1 {
       }, unmarshalListRoutesResponse);
     };
     /**
-     * List routes.
+     * List routes. List all routes in the specified region. By default, returned
+     * routes are ordered by creation date in ascending order, though this can be
+     * modified via the `order_by` field.
      *
      * @param request - The request {@link ListRoutesRequest}
      * @returns A Promise of ListRoutesResponse
@@ -310,15 +333,15 @@ class API extends API$1 {
       return enrichForPagination('routes', _this.pageOfListRoutes, request);
     };
     /**
-     * Create a route. Multiple route kinds can be created:
+     * Create a route. Multiple kinds of routes can be created, such as:
      *
-     * - Database Route. Create a route that will record subscribed MQTT messages
+     * - Database Route Create a route that will record subscribed MQTT messages
      *   into your database. <b>You need to manage the database by yourself</b>.
      * - REST Route. Create a route that will call a REST API on received subscribed
      *   MQTT messages.
      * - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
-     *   bucket. You need to create the bucket yourself and grant us write access.
-     *   The grant can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
+     *   bucket. You need to create the bucket yourself and grant write access.
+     *   Granting can be done with s3cmd (`s3cmd setacl s3://&lt;my-bucket&gt;
      *   --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
      *
      * @param request - The request {@link CreateRouteRequest}
@@ -331,7 +354,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes`
     }, unmarshalRoute);
     /**
-     * Update a route.
+     * Update a route. Update the parameters of an existing route, specified by
+     * its route ID.
      *
      * @param request - The request {@link UpdateRouteRequest}
      * @returns A Promise of Route
@@ -343,7 +367,9 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam('routeId', request.routeId)}`
     }, unmarshalRoute);
     /**
-     * Get a route.
+     * Get a route. Get information for a particular route, specified by the route
+     * ID. The response returns full details of the route, including its type, the
+     * topic it subscribes to and its configuration.
      *
      * @param request - The request {@link GetRouteRequest}
      * @returns A Promise of Route
@@ -353,7 +379,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam('routeId', request.routeId)}`
     }, unmarshalRoute);
     /**
-     * Delete a route.
+     * Delete a route. Delete an existing route, specified by its route ID.
+     * Deleting a route is permanent, and cannot be undone.
      *
      * @param request - The request {@link DeleteRouteRequest}
      */
@@ -372,7 +399,7 @@ class API extends API$1 {
       }, unmarshalListNetworksResponse);
     };
     /**
-     * List the Networks.
+     * List the networks.
      *
      * @param request - The request {@link ListNetworksRequest}
      * @returns A Promise of ListNetworksResponse
@@ -384,7 +411,9 @@ class API extends API$1 {
       return enrichForPagination('networks', _this.pageOfListNetworks, request);
     };
     /**
-     * Create a new Network.
+     * Create a new network. Create a new network for an existing hub. Beside the
+     * default network, you can add networks for different data providers.
+     * Possible network types are Sigfox and REST.
      *
      * @param request - The request {@link CreateNetworkRequest}
      * @returns A Promise of CreateNetworkResponse
@@ -396,7 +425,9 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/networks`
     }, unmarshalCreateNetworkResponse);
     /**
-     * Retrieve a specific Network.
+     * Retrieve a specific network. Retrieve an existing network, specified by its
+     * network ID. The response returns full details of the network, including its
+     * type, the topic prefix and its endpoint.
      *
      * @param request - The request {@link GetNetworkRequest}
      * @returns A Promise of Network
@@ -406,7 +437,8 @@ class API extends API$1 {
       path: `/iot/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/networks/${validatePathParam('networkId', request.networkId)}`
     }, unmarshalNetwork);
     /**
-     * Delete a Network.
+     * Delete a Network. Delete an existing network, specified by its network ID.
+     * Deleting a network is permanent, and cannot be undone.
      *
      * @param request - The request {@link DeleteNetworkRequest}
      */

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

@@ -10,7 +10,7 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Kapsule API. */
+/** Kubernetes API. */
 class API extends API$1 {
   constructor() {
     var _this;
@@ -70,7 +70,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Cluster
      */
-    this.waitForCluster = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CLUSTER_TRANSIENT_STATUSES.includes(res.status))), this.getCluster, request, options);
+    this.waitForCluster = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CLUSTER_TRANSIENT_STATUSES.includes(res.status))), this.getCluster, request, options);
     /**
      * Update a cluster. Update a specific Kubernetes cluster. Note that this
      * method is designed to update details such as name, description, tags and
@@ -202,7 +202,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Pool
      */
-    this.waitForPool = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!POOL_TRANSIENT_STATUSES.includes(res.status))), this.getPool, request, options);
+    this.waitForPool = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!POOL_TRANSIENT_STATUSES.includes(res.status))), this.getPool, request, options);
     /**
      * Upgrade a pool in a cluster. Upgrade the Kubernetes version of a specific
      * pool. Note that this will work when the targeted version is the same than
@@ -285,7 +285,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Node
      */
-    this.waitForNode = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!NODE_TRANSIENT_STATUSES.includes(res.status))), this.getNode, request, options);
+    this.waitForNode = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NODE_TRANSIENT_STATUSES.includes(res.status))), this.getNode, request, options);
     /**
      * Replace a node in a cluster. Replace a specific node. The node will be set
      * cordoned, meaning that scheduling will be disabled. Then the existing pods

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

@@ -71,7 +71,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Lb
      */
-    this.waitForLb = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!LB_TRANSIENT_STATUSES.includes(res.status))), this.getLb, request, options);
+    this.waitForLb = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!LB_TRANSIENT_STATUSES.includes(res.status))), this.getLb, request, options);
     /**
      * Update a load balancer.
      *
@@ -513,7 +513,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Certificate
      */
-    this.waitForCertificate = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getCertificate, request, options);
+    this.waitForCertificate = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getCertificate, request, options);
     /**
      * Update a TLS certificate.
      *
@@ -743,7 +743,7 @@ class ZonedAPI extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Lb
      */
-    this.waitForLb = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!LB_TRANSIENT_STATUSES.includes(res.status))), this.getLb, request, options);
+    this.waitForLb = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!LB_TRANSIENT_STATUSES.includes(res.status))), this.getLb, request, options);
     /**
      * Update a Load Balancer. Update the parameters of an existing Load Balancer,
      * specified by its Load Balancer ID. Note that the request type is PUT and
@@ -1285,7 +1285,7 @@ class ZonedAPI extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Certificate
      */
-    this.waitForCertificate = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getCertificate, request, options);
+    this.waitForCertificate = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CERTIFICATE_TRANSIENT_STATUSES.includes(res.status))), this.getCertificate, request, options);
     /**
      * Update an SSL/TLS certificate. Update the name of a particular SSL/TLS
      * certificate, specified by its certificate ID.

package/dist/api/lb/v1/api.utils.js

@@ -24,7 +24,7 @@ class LbV1UtilsAPI extends API {
         done: value.privateNetwork.find(elt => PRIVATE_NETWORK_TRANSIENT_STATUSES.includes(elt.status)) === undefined,
         value
       };
-    }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    }, createExponentialBackoffStrategy(options?.minDelay ?? 1, options?.maxDelay ?? 30), options?.timeout);
     /**
      * Waits for all instances of a load balancer to be in a final state.
      *
@@ -38,7 +38,7 @@ class LbV1UtilsAPI extends API {
         done: !LB_TRANSIENT_STATUSES.includes(value.status) && value.instances.find(elt => INSTANCE_TRANSIENT_STATUSES.includes(elt.status)) === undefined,
         value
       };
-    }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    }, createExponentialBackoffStrategy(options?.minDelay ?? 1, options?.maxDelay ?? 30), options?.timeout);
   }
 }
 class LbZonedV1UtilsAPI extends ZonedAPI {
@@ -64,7 +64,7 @@ class LbZonedV1UtilsAPI extends ZonedAPI {
         done: value.privateNetwork.find(elt => PRIVATE_NETWORK_TRANSIENT_STATUSES.includes(elt.status)) === undefined,
         value
       };
-    }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    }, createExponentialBackoffStrategy(options?.minDelay ?? 1, options?.maxDelay ?? 30), options?.timeout);
     /**
      * Waits for all instances of a (zoned) load balancer to be in a final state.
      *
@@ -78,7 +78,7 @@ class LbZonedV1UtilsAPI extends ZonedAPI {
         done: !LB_TRANSIENT_STATUSES.includes(value.status) && value.instances.find(elt => INSTANCE_TRANSIENT_STATUSES.includes(elt.status)) === undefined,
         value
       };
-    }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    }, createExponentialBackoffStrategy(options?.minDelay ?? 1, options?.maxDelay ?? 30), options?.timeout);
   }
 }
 

package/dist/api/marketplace/v2/api.gen.js

@@ -16,14 +16,16 @@ class API extends API$1 {
       urlParams: urlParams(['arch', request.arch], ['category', request.category], ['include_eol', request.includeEol], ['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListImagesResponse);
     /**
-     * List marketplace images.
+     * List marketplace images. List all available images on the marketplace,
+     * their UUID, CPU architecture and description.
      *
      * @param request - The request {@link ListImagesRequest}
      * @returns A Promise of ListImagesResponse
      */
     this.listImages = request => enrichForPagination('images', this.pageOfListImages, request);
     /**
-     * Get a specific marketplace image.
+     * Get a specific marketplace image. Get detailed information about a
+     * marketplace image, specified by its `image_id` (UUID format).
      *
      * @param request - The request {@link GetImageRequest}
      * @returns A Promise of Image
@@ -37,7 +39,22 @@ class API extends API$1 {
       path: `/marketplace/v2/versions`,
       urlParams: urlParams(['image_id', request.imageId], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListVersionsResponse);
+    /**
+     * List versions of an Image. Get a list of all available version of an image,
+     * specified by its `image_id` (UUID format).
+     *
+     * @param request - The request {@link ListVersionsRequest}
+     * @returns A Promise of ListVersionsResponse
+     */
     this.listVersions = request => enrichForPagination('versions', this.pageOfListVersions, request);
+    /**
+     * Get a specific image version. Get information such as the name, creation
+     * date, last update and published date for an image version specified by its
+     * `version_id` (UUID format).
+     *
+     * @param request - The request {@link GetVersionRequest}
+     * @returns A Promise of Version
+     */
     this.getVersion = request => this.client.fetch({
       method: 'GET',
       path: `/marketplace/v2/versions/${validatePathParam('versionId', request.versionId)}`
@@ -62,7 +79,10 @@ class API extends API$1 {
       }, unmarshalListLocalImagesResponse);
     };
     /**
-     * List local images from a specific image or version.
+     * List local images from a specific image or version. List information about
+     * local images in a specific Availability Zone, specified by its `image_id`
+     * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
+     * these three parameters may be set.
      *
      * @param request - The request {@link ListLocalImagesRequest}
      * @returns A Promise of ListLocalImagesResponse
@@ -73,6 +93,15 @@ class API extends API$1 {
       }
       return enrichForPagination('localImages', _this.pageOfListLocalImages, request);
     };
+    /**
+     * Get a specific local image by ID. Get detailed information about a local
+     * image, including compatible commercial types, supported architecture,
+     * labels and the Availability Zone of the image, specified by its
+     * `local_image_id` (UUID format).
+     *
+     * @param request - The request {@link GetLocalImageRequest}
+     * @returns A Promise of LocalImage
+     */
     this.getLocalImage = request => this.client.fetch({
       method: 'GET',
       path: `/marketplace/v2/local-images/${validatePathParam('localImageId', request.localImageId)}`
@@ -87,12 +116,26 @@ class API extends API$1 {
         urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
       }, unmarshalListCategoriesResponse);
     };
+    /**
+     * List existing image categories. Get a list of all existing categories. The
+     * output can be paginated.
+     *
+     * @param request - The request {@link ListCategoriesRequest}
+     * @returns A Promise of ListCategoriesResponse
+     */
     this.listCategories = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('categories', _this.pageOfListCategories, request);
     };
+    /**
+     * Get a specific category. Get information about a specific category of the
+     * marketplace catalog, specified by its `category_id` (UUID format).
+     *
+     * @param request - The request {@link GetCategoryRequest}
+     * @returns A Promise of Category
+     */
     this.getCategory = request => this.client.fetch({
       method: 'GET',
       path: `/marketplace/v2/categories/${validatePathParam('categoryId', request.categoryId)}`

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

@@ -9,9 +9,10 @@ const jsonContentHeaders = {
 };
 
 /**
- * MnQ API (beta).
+ * Messaging and Queuing API.
  *
- * This API allows you to manage Messaging or Queueing brokers. MnQ API (beta).
+ * This API allows you to manage Scaleway Messaging and Queueing brokers.
+ * Messaging and Queuing API.
  */
 class API extends API$1 {
   constructor() {
@@ -29,7 +30,10 @@ class API extends API$1 {
       }, unmarshalListNamespacesResponse);
     };
     /**
-     * List namespaces.
+     * List namespaces. List all Messaging and Queuing namespaces in the specified
+     * region, for a Scaleway Organization or Project. By default, the namespaces
+     * 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 ListNamespacesRequest}
      * @returns A Promise of ListNamespacesResponse
@@ -41,7 +45,8 @@ class API extends API$1 {
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
     /**
-     * Create a namespace.
+     * Create a namespace. Create a Messaging and Queuing namespace, set to the
+     * desired protocol.
      *
      * @param request - The request {@link CreateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -53,7 +58,8 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
     /**
-     * Update the name of a namespace.
+     * Update the name of a namespace. Update the name of a Messaging and Queuing
+     * namespace, specified by its namespace ID.
      *
      * @param request - The request {@link UpdateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -65,7 +71,9 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces`
     }, unmarshalNamespace);
     /**
-     * Get a namespace.
+     * Get a namespace. Retrieve information about an existing Messaging and
+     * Queuing namespace, identified by its namespace ID. Its full details,
+     * including name, endpoint and protocol, are returned in the response.
      *
      * @param request - The request {@link GetNamespaceRequest}
      * @returns A Promise of Namespace
@@ -75,7 +83,10 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     }, unmarshalNamespace);
     /**
-     * Delete a namespace.
+     * Delete a namespace. Delete a Messaging and Queuing namespace, specified by
+     * its namespace ID. Note that deleting a namespace is irreversible, and any
+     * URLs, credentials and queued messages belonging to this namespace will also
+     * be deleted.
      *
      * @param request - The request {@link DeleteNamespaceRequest}
      */
@@ -84,8 +95,11 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/namespaces/${validatePathParam('namespaceId', request.namespaceId)}`
     });
     /**
-     * Create a set of credentials. Create a set of credentials for a specific
-     * namespace.
+     * Create credentials. Create a set of credentials for a Messaging and Queuing
+     * namespace, specified by its namespace ID. If creating credentials for a
+     * NATS namespace, the `permissions` object must not be included in the
+     * request. If creating credentials for an SQS/SNS namespace, the
+     * `permissions` object is required, with all three of its child attributes.
      *
      * @param request - The request {@link CreateCredentialRequest}
      * @returns A Promise of Credential
@@ -97,7 +111,9 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials`
     }, unmarshalCredential);
     /**
-     * Delete credentials.
+     * Delete credentials. Delete a set of credentials, specified by their
+     * credential ID. Deleting credentials is irreversible and cannot be undone.
+     * The credentials can no longer be used to access the namespace.
      *
      * @param request - The request {@link DeleteCredentialRequest}
      */
@@ -116,7 +132,9 @@ class API extends API$1 {
       }, unmarshalListCredentialsResponse);
     };
     /**
-     * List credentials.
+     * List credentials. List existing credentials in the specified region. The
+     * response contains only the metadata for the credentials, not the
+     * credentials themselves (for this, use **Get Credentials**).
      *
      * @param request - The request {@link ListCredentialsRequest}
      * @returns A Promise of ListCredentialsResponse
@@ -128,7 +146,10 @@ class API extends API$1 {
       return enrichForPagination('credentials', _this.pageOfListCredentials, request);
     };
     /**
-     * Update a set of credentials.
+     * Update credentials. Update a set of credentials. You can update the
+     * credentials' name, or (in the case of SQS/SNS credentials only) their
+     * permissions. To update the name of NATS credentials, do not include the
+     * `permissions` object in your request.
      *
      * @param request - The request {@link UpdateCredentialRequest}
      * @returns A Promise of Credential
@@ -140,7 +161,9 @@ class API extends API$1 {
       path: `/mnq/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/credentials/${validatePathParam('credentialId', request.credentialId)}`
     }, unmarshalCredential);
     /**
-     * Get a set of credentials.
+     * Get credentials. Retrieve an existing set of credentials, identified by the
+     * `credential_id`. The credentials themselves, as well as their metadata
+     * (protocol, namespace ID etc), are returned in the response.
      *
      * @param request - The request {@link GetCredentialRequest}
      * @returns A Promise of Credential