@scaleway/sdk-iot 1.0.1

package/dist/v1/api.gen.js

@@ -0,0 +1,586 @@
+import { API as API$1, urlParams, validatePathParam, enrichForPagination, waitForResource } from "@scaleway/sdk-client";
+import { HUB_TRANSIENT_STATUSES } from "./content.gen.js";
+import { unmarshalListHubsResponse, marshalCreateHubRequest, unmarshalHub, marshalUpdateHubRequest, unmarshalGetHubMetricsResponse, marshalSetHubCARequest, unmarshalGetHubCAResponse, unmarshalListDevicesResponse, marshalCreateDeviceRequest, unmarshalCreateDeviceResponse, unmarshalDevice, marshalUpdateDeviceRequest, unmarshalRenewDeviceCertificateResponse, marshalSetDeviceCertificateRequest, unmarshalSetDeviceCertificateResponse, unmarshalGetDeviceCertificateResponse, unmarshalGetDeviceMetricsResponse, unmarshalListRoutesResponse, marshalCreateRouteRequest, unmarshalRoute, marshalUpdateRouteRequest, unmarshalListNetworksResponse, marshalCreateNetworkRequest, unmarshalCreateNetworkResponse, unmarshalNetwork, unmarshalTwinDocument, marshalPutTwinDocumentRequest, marshalPatchTwinDocumentRequest, unmarshalListTwinDocumentsResponse } from "./marshalling.gen.js";
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends API$1 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par"];
+  pageOfListHubs = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs`,
+      urlParams: urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    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.
+   *
+   * @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.
+   *
+   * @param request - The request {@link CreateHubRequest}
+   * @returns A Promise of Hub
+   */
+  createHub = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateHubRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs`
+    },
+    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.
+   *
+   * @param request - The request {@link GetHubRequest}
+   * @returns A Promise of Hub
+   */
+  getHub = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}`
+    },
+    unmarshalHub
+  );
+  /**
+   * Waits for {@link Hub} to be in a final state.
+   *
+   * @param request - The request {@link GetHubRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Hub
+   */
+  waitForHub = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!HUB_TRANSIENT_STATUSES.includes(res.status))),
+    this.getHub,
+    request,
+    options
+  );
+  /**
+   * 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
+   */
+  updateHub = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateHubRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}`
+    },
+    unmarshalHub
+  );
+  /**
+   * Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
+   *
+   * @param request - The request {@link EnableHubRequest}
+   * @returns A Promise of Hub
+   */
+  enableHub = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}/enable`
+    },
+    unmarshalHub
+  );
+  /**
+   * Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
+   *
+   * @param request - The request {@link DisableHubRequest}
+   * @returns A Promise of Hub
+   */
+  disableHub = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}/disable`
+    },
+    unmarshalHub
+  );
+  /**
+   * 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}
+   */
+  deleteHub = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}`,
+    urlParams: urlParams(["delete_devices", request.deleteDevices])
+  });
+  /**
+   * 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}
+   * @returns A Promise of GetHubMetricsResponse
+   */
+  getHubMetrics = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}/metrics`,
+      urlParams: urlParams(["start_date", request.startDate])
+    },
+    unmarshalGetHubMetricsResponse
+  );
+  /**
+   * 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
+   */
+  setHubCA = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalSetHubCARequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      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 information for a particular PEM-encoded certificate, specified by the Hub ID.
+   *
+   * @param request - The request {@link GetHubCARequest}
+   * @returns A Promise of GetHubCAResponse
+   */
+  getHubCA = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hubs/${validatePathParam("hubId", request.hubId)}/ca`
+    },
+    unmarshalGetHubCAResponse
+  );
+  pageOfListDevices = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices`,
+      urlParams: urlParams(
+        ["allow_insecure", request.allowInsecure],
+        ["hub_id", request.hubId],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["status", request.status]
+      )
+    },
+    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.
+   *
+   * @param request - The request {@link ListDevicesRequest}
+   * @returns A Promise of ListDevicesResponse
+   */
+  listDevices = (request = {}) => enrichForPagination("devices", this.pageOfListDevices, request);
+  /**
+   * Add a device. Attach a device to a given Hub.
+   *
+   * @param request - The request {@link CreateDeviceRequest}
+   * @returns A Promise of CreateDeviceResponse
+   */
+  createDevice = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateDeviceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices`
+    },
+    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.
+   *
+   * @param request - The request {@link GetDeviceRequest}
+   * @returns A Promise of Device
+   */
+  getDevice = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}`
+    },
+    unmarshalDevice
+  );
+  /**
+   * 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
+   */
+  updateDevice = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateDeviceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}`
+    },
+    unmarshalDevice
+  );
+  /**
+   * Enable a device. Enable a specific device, specified by its device ID.
+   *
+   * @param request - The request {@link EnableDeviceRequest}
+   * @returns A Promise of Device
+   */
+  enableDevice = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}/enable`
+    },
+    unmarshalDevice
+  );
+  /**
+   * Disable a device. Disable an existing device, specified by its device ID.
+   *
+   * @param request - The request {@link DisableDeviceRequest}
+   * @returns A Promise of Device
+   */
+  disableDevice = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}/disable`
+    },
+    unmarshalDevice
+  );
+  /**
+   * 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
+   */
+  renewDeviceCertificate = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      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. 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
+   */
+  setDeviceCertificate = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalSetDeviceCertificateRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      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 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
+   */
+  getDeviceCertificate = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}/certificate`
+    },
+    unmarshalGetDeviceCertificateResponse
+  );
+  /**
+   * Remove a device. Remove a specific device from the specific Hub it is attached to.
+   *
+   * @param request - The request {@link DeleteDeviceRequest}
+   */
+  deleteDevice = (request) => this.client.fetch({
+    method: "DELETE",
+    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.
+   *
+   * @deprecated
+   * @param request - The request {@link GetDeviceMetricsRequest}
+   * @returns A Promise of GetDeviceMetricsResponse
+   */
+  getDeviceMetrics = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/devices/${validatePathParam("deviceId", request.deviceId)}/metrics`,
+      urlParams: urlParams(["start_date", request.startDate])
+    },
+    unmarshalGetDeviceMetricsResponse
+  );
+  pageOfListRoutes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/routes`,
+      urlParams: urlParams(
+        ["hub_id", request.hubId],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    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.
+   *
+   * @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
+     */
+  createRoute = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateRouteRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/routes`
+    },
+    unmarshalRoute
+  );
+  /**
+   * 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
+   */
+  updateRoute = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateRouteRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam("routeId", request.routeId)}`
+    },
+    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.
+   *
+   * @param request - The request {@link GetRouteRequest}
+   * @returns A Promise of Route
+   */
+  getRoute = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam("routeId", request.routeId)}`
+    },
+    unmarshalRoute
+  );
+  /**
+   * 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}
+   */
+  deleteRoute = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/routes/${validatePathParam("routeId", request.routeId)}`
+  });
+  pageOfListNetworks = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/networks`,
+      urlParams: urlParams(
+        ["hub_id", request.hubId],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["topic_prefix", request.topicPrefix]
+      )
+    },
+    unmarshalListNetworksResponse
+  );
+  /**
+   * List the networks.
+   *
+   * @param request - The request {@link ListNetworksRequest}
+   * @returns A Promise of ListNetworksResponse
+   */
+  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.
+   *
+   * @param request - The request {@link CreateNetworkRequest}
+   * @returns A Promise of CreateNetworkResponse
+   */
+  createNetwork = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateNetworkRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/networks`
+    },
+    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.
+   *
+   * @param request - The request {@link GetNetworkRequest}
+   * @returns A Promise of Network
+   */
+  getNetwork = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/networks/${validatePathParam("networkId", request.networkId)}`
+    },
+    unmarshalNetwork
+  );
+  /**
+   * 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}
+   */
+  deleteNetwork = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/networks/${validatePathParam("networkId", request.networkId)}`
+  });
+  /**
+   * BETA - Get a Cloud Twin Document.
+   *
+   * @param request - The request {@link GetTwinDocumentRequest}
+   * @returns A Promise of TwinDocument
+   */
+  getTwinDocument = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}/documents/${validatePathParam("documentName", request.documentName)}`
+    },
+    unmarshalTwinDocument
+  );
+  /**
+   * BETA - Update a Cloud Twin Document.
+   *
+   * @param request - The request {@link PutTwinDocumentRequest}
+   * @returns A Promise of TwinDocument
+   */
+  putTwinDocument = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalPutTwinDocumentRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}/documents/${validatePathParam("documentName", request.documentName)}`
+    },
+    unmarshalTwinDocument
+  );
+  /**
+   * BETA - Patch a Cloud Twin Document.
+   *
+   * @param request - The request {@link PatchTwinDocumentRequest}
+   * @returns A Promise of TwinDocument
+   */
+  patchTwinDocument = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalPatchTwinDocumentRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}/documents/${validatePathParam("documentName", request.documentName)}`
+    },
+    unmarshalTwinDocument
+  );
+  /**
+   * BETA - Delete a Cloud Twin Document.
+   *
+   * @param request - The request {@link DeleteTwinDocumentRequest}
+   */
+  deleteTwinDocument = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}/documents/${validatePathParam("documentName", request.documentName)}`
+  });
+  /**
+   * BETA - List the documents of a Cloud Twin.
+   *
+   * @param request - The request {@link ListTwinDocumentsRequest}
+   * @returns A Promise of ListTwinDocumentsResponse
+   */
+  listTwinDocuments = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}`
+    },
+    unmarshalListTwinDocumentsResponse
+  );
+  /**
+   * BETA - Delete all the documents of a Cloud Twin.
+   *
+   * @param request - The request {@link DeleteTwinDocumentsRequest}
+   */
+  deleteTwinDocuments = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/iot/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/twins/${validatePathParam("twinId", request.twinId)}`
+  });
+}
+export {
+  API
+};

package/dist/v1/content.gen.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const HUB_TRANSIENT_STATUSES = ["enabling", "disabling"];
+exports.HUB_TRANSIENT_STATUSES = HUB_TRANSIENT_STATUSES;

package/dist/v1/content.gen.d.ts

@@ -0,0 +1,3 @@
+import type { HubStatus } from './types.gen';
+/** Lists transient statutes of the enum {@link HubStatus}. */
+export declare const HUB_TRANSIENT_STATUSES: HubStatus[];

package/dist/v1/content.gen.js

@@ -0,0 +1,4 @@
+const HUB_TRANSIENT_STATUSES = ["enabling", "disabling"];
+export {
+  HUB_TRANSIENT_STATUSES
+};

package/dist/v1/index.gen.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+exports.API = api_gen.API;
+exports.HUB_TRANSIENT_STATUSES = content_gen.HUB_TRANSIENT_STATUSES;
+exports.marshalCreateDeviceRequest = marshalling_gen.marshalCreateDeviceRequest;
+exports.marshalCreateHubRequest = marshalling_gen.marshalCreateHubRequest;
+exports.marshalCreateNetworkRequest = marshalling_gen.marshalCreateNetworkRequest;
+exports.marshalCreateRouteRequest = marshalling_gen.marshalCreateRouteRequest;
+exports.marshalPatchTwinDocumentRequest = marshalling_gen.marshalPatchTwinDocumentRequest;
+exports.marshalPutTwinDocumentRequest = marshalling_gen.marshalPutTwinDocumentRequest;
+exports.marshalSetDeviceCertificateRequest = marshalling_gen.marshalSetDeviceCertificateRequest;
+exports.marshalSetHubCARequest = marshalling_gen.marshalSetHubCARequest;
+exports.marshalUpdateDeviceRequest = marshalling_gen.marshalUpdateDeviceRequest;
+exports.marshalUpdateHubRequest = marshalling_gen.marshalUpdateHubRequest;
+exports.marshalUpdateRouteRequest = marshalling_gen.marshalUpdateRouteRequest;
+exports.unmarshalCreateDeviceResponse = marshalling_gen.unmarshalCreateDeviceResponse;
+exports.unmarshalCreateNetworkResponse = marshalling_gen.unmarshalCreateNetworkResponse;
+exports.unmarshalDevice = marshalling_gen.unmarshalDevice;
+exports.unmarshalGetDeviceCertificateResponse = marshalling_gen.unmarshalGetDeviceCertificateResponse;
+exports.unmarshalGetDeviceMetricsResponse = marshalling_gen.unmarshalGetDeviceMetricsResponse;
+exports.unmarshalGetHubCAResponse = marshalling_gen.unmarshalGetHubCAResponse;
+exports.unmarshalGetHubMetricsResponse = marshalling_gen.unmarshalGetHubMetricsResponse;
+exports.unmarshalHub = marshalling_gen.unmarshalHub;
+exports.unmarshalListDevicesResponse = marshalling_gen.unmarshalListDevicesResponse;
+exports.unmarshalListHubsResponse = marshalling_gen.unmarshalListHubsResponse;
+exports.unmarshalListNetworksResponse = marshalling_gen.unmarshalListNetworksResponse;
+exports.unmarshalListRoutesResponse = marshalling_gen.unmarshalListRoutesResponse;
+exports.unmarshalListTwinDocumentsResponse = marshalling_gen.unmarshalListTwinDocumentsResponse;
+exports.unmarshalNetwork = marshalling_gen.unmarshalNetwork;
+exports.unmarshalRenewDeviceCertificateResponse = marshalling_gen.unmarshalRenewDeviceCertificateResponse;
+exports.unmarshalRoute = marshalling_gen.unmarshalRoute;
+exports.unmarshalSetDeviceCertificateResponse = marshalling_gen.unmarshalSetDeviceCertificateResponse;
+exports.unmarshalTwinDocument = marshalling_gen.unmarshalTwinDocument;

package/dist/v1/index.gen.d.ts

@@ -0,0 +1,4 @@
+export { API } from './api.gen';
+export * from './content.gen';
+export * from './marshalling.gen';
+export type { Certificate, CreateDeviceRequest, CreateDeviceResponse, CreateHubRequest, CreateNetworkRequest, CreateNetworkResponse, CreateRouteRequest, CreateRouteRequestDatabaseConfig, CreateRouteRequestRestConfig, CreateRouteRequestS3Config, DeleteDeviceRequest, DeleteHubRequest, DeleteNetworkRequest, DeleteRouteRequest, DeleteTwinDocumentRequest, DeleteTwinDocumentsRequest, Device, DeviceMessageFilters, DeviceMessageFiltersRule, DeviceMessageFiltersRulePolicy, DeviceStatus, DisableDeviceRequest, DisableHubRequest, EnableDeviceRequest, EnableHubRequest, GetDeviceCertificateRequest, GetDeviceCertificateResponse, GetDeviceMetricsRequest, GetDeviceMetricsResponse, GetDeviceRequest, GetHubCARequest, GetHubCAResponse, GetHubMetricsRequest, GetHubMetricsResponse, GetHubRequest, GetNetworkRequest, GetRouteRequest, GetTwinDocumentRequest, Hub, HubProductPlan, HubStatus, HubTwinsGraphiteConfig, ListDevicesRequest, ListDevicesRequestOrderBy, ListDevicesResponse, ListHubsRequest, ListHubsRequestOrderBy, ListHubsResponse, ListNetworksRequest, ListNetworksRequestOrderBy, ListNetworksResponse, ListRoutesRequest, ListRoutesRequestOrderBy, ListRoutesResponse, ListTwinDocumentsRequest, ListTwinDocumentsResponse, ListTwinDocumentsResponseDocumentSummary, Network, NetworkNetworkType, PatchTwinDocumentRequest, PutTwinDocumentRequest, RenewDeviceCertificateRequest, RenewDeviceCertificateResponse, Route, RouteDatabaseConfig, RouteDatabaseConfigEngine, RouteRestConfig, RouteRestConfigHttpVerb, RouteRouteType, RouteS3Config, RouteS3ConfigS3Strategy, RouteSummary, SetDeviceCertificateRequest, SetDeviceCertificateResponse, SetHubCARequest, TwinDocument, UpdateDeviceRequest, UpdateHubRequest, UpdateRouteRequest, UpdateRouteRequestDatabaseConfig, UpdateRouteRequestRestConfig, UpdateRouteRequestS3Config, } from './types.gen';