@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -31,17 +31,14 @@ class API extends API$1 {
     unmarshalListHubsResponse
   );
   /**
-   * 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.
+   * 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
    */
   listHubs = (request = {}) => enrichForPagination("hubs", this.pageOfListHubs, request);
   /**
-   * Create a hub. Create a new Hub in the targeted region, specifying its
-   * configuration including name and product plan.
+   * 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
@@ -58,9 +55,7 @@ class API extends API$1 {
     unmarshalHub
   );
   /**
-   * 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.
+   * 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
@@ -86,8 +81,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Update a hub. Update the parameters of an existing IoT Hub, specified by
-   * its Hub ID.
+   * 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
@@ -134,8 +128,7 @@ class API extends API$1 {
     unmarshalHub
   );
   /**
-   * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting
-   * a Hub is permanent, and cannot be undone.
+   * 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}
    */
@@ -145,8 +138,7 @@ class API extends API$1 {
     urlParams: urlParams(["delete_devices", request.deleteDevices])
   });
   /**
-   * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
-   * its Hub ID.
+   * 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}
@@ -161,8 +153,7 @@ class API extends API$1 {
     unmarshalGetHubMetricsResponse
   );
   /**
-   * Set the certificate authority of a hub. Set a particular PEM-encoded
-   * certificate, specified by the Hub ID.
+   * 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
@@ -179,8 +170,7 @@ class API extends API$1 {
     unmarshalHub
   );
   /**
-   * Get the certificate authority of a hub. Get information for a particular
-   * PEM-encoded certificate, specified by the Hub ID.
+   * 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
@@ -212,9 +202,7 @@ class API extends API$1 {
     unmarshalListDevicesResponse
   );
   /**
-   * 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.
+   * 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
@@ -238,9 +226,7 @@ class API extends API$1 {
     unmarshalCreateDeviceResponse
   );
   /**
-   * 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.
+   * 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
@@ -253,8 +239,7 @@ class API extends API$1 {
     unmarshalDevice
   );
   /**
-   * Update a device. Update the parameters of an existing device, specified by
-   * its device ID.
+   * 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
@@ -301,8 +286,7 @@ class API extends API$1 {
     unmarshalDevice
   );
   /**
-   * Renew a device certificate. Renew the certificate of an existing device,
-   * specified by its device ID.
+   * 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
@@ -317,8 +301,7 @@ class API extends API$1 {
     unmarshalRenewDeviceCertificateResponse
   );
   /**
-   * Set a custom certificate on a device. Switch the existing certificate of a
-   * given device with an EM-encoded custom certificate.
+   * 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
@@ -335,9 +318,7 @@ class API extends API$1 {
     unmarshalSetDeviceCertificateResponse
   );
   /**
-   * 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.
+   * 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
@@ -350,8 +331,7 @@ class API extends API$1 {
     unmarshalGetDeviceCertificateResponse
   );
   /**
-   * Remove a device. Remove a specific device from the specific Hub it is
-   * attached to.
+   * Remove a device. Remove a specific device from the specific Hub it is attached to.
    *
    * @param request - The request {@link DeleteDeviceRequest}
    */
@@ -360,8 +340,7 @@ 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 the metrics of an existing device, specified by
-   * its device ID.
+   * Get a device's metrics. Get the metrics of an existing device, specified by its device ID.
    *
    * @deprecated
    * @param request - The request {@link GetDeviceMetricsRequest}
@@ -393,30 +372,27 @@ class API extends API$1 {
     unmarshalListRoutesResponse
   );
   /**
-   * 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.
+   * 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
    */
   listRoutes = (request = {}) => enrichForPagination("routes", this.pageOfListRoutes, request);
   /**
-   * Create a route. Multiple kinds of routes can be created, such as:
-   *
-   * - 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.
-   * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
-   *   into an Object Storage bucket. You need to create the bucket yourself and
-   *   grant write access. Granting can be done with s3cmd (`s3cmd setacl
-   *   s3://<my-bucket>
-   *   --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
-   *
-   * @param request - The request {@link CreateRouteRequest}
-   * @returns A Promise of Route
-   */
+     * Create a route. Multiple kinds of routes can be created, such as:
+  - 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.
+  - Amazon S3 Routes.
+    Create a route that will put subscribed MQTT messages into an Object Storage bucket.
+    You need to create the bucket yourself and grant write access.
+    Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
+     *
+     * @param request - The request {@link CreateRouteRequest}
+     * @returns A Promise of Route
+     */
   createRoute = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -429,8 +405,7 @@ class API extends API$1 {
     unmarshalRoute
   );
   /**
-   * Update a route. Update the parameters of an existing route, specified by
-   * its route ID.
+   * 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
@@ -447,9 +422,7 @@ class API extends API$1 {
     unmarshalRoute
   );
   /**
-   * 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.
+   * 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
@@ -462,8 +435,7 @@ class API extends API$1 {
     unmarshalRoute
   );
   /**
-   * Delete a route. Delete an existing route, specified by its route ID.
-   * Deleting a route is permanent, and cannot be undone.
+   * 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}
    */
@@ -497,9 +469,7 @@ class API extends API$1 {
    */
   listNetworks = (request = {}) => enrichForPagination("networks", this.pageOfListNetworks, request);
   /**
-   * 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.
+   * 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
@@ -516,9 +486,7 @@ class API extends API$1 {
     unmarshalCreateNetworkResponse
   );
   /**
-   * 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.
+   * 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
@@ -531,8 +499,7 @@ class API extends API$1 {
     unmarshalNetwork
   );
   /**
-   * Delete a Network. Delete an existing network, specified by its network ID.
-   * Deleting a network is permanent, and cannot be undone.
+   * 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}
    */