@scaleway/sdk-iot 1.1.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-iot
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-iot.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Iot API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-iot @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-iot @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-iot @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Iot } from '@scaleway/sdk-iot'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Iot.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Iot } from '@scaleway/sdk-iot'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Iot.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Iot API Documentation](https://www.scaleway.com/en/developers/api/iot/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateDeviceRequest, CreateDeviceResponse, CreateHubRequest, CreateNetworkRequest, CreateNetworkResponse, CreateRouteRequest, DeleteDeviceRequest, DeleteHubRequest, DeleteNetworkRequest, DeleteRouteRequest, DeleteTwinDocumentRequest, DeleteTwinDocumentsRequest, Device, DisableDeviceRequest, DisableHubRequest, EnableDeviceRequest, EnableHubRequest, GetDeviceCertificateRequest, GetDeviceCertificateResponse, GetDeviceMetricsRequest, GetDeviceMetricsResponse, GetDeviceRequest, GetHubCARequest, GetHubCAResponse, GetHubMetricsRequest, GetHubMetricsResponse, GetHubRequest, GetNetworkRequest, GetRouteRequest, GetTwinDocumentRequest, Hub, ListDevicesRequest, ListDevicesResponse, ListHubsRequest, ListHubsResponse, ListNetworksRequest, ListNetworksResponse, ListRoutesRequest, ListRoutesResponse, ListTwinDocumentsRequest, ListTwinDocumentsResponse, Network, PatchTwinDocumentRequest, PutTwinDocumentRequest, RenewDeviceCertificateRequest, RenewDeviceCertificateResponse, Route, SetDeviceCertificateRequest, SetDeviceCertificateResponse, SetHubCARequest, TwinDocument, UpdateDeviceRequest, UpdateHubRequest, UpdateRouteRequest } from './types.gen.js';
 /**
  * IoT Hub API.

package/dist/v1/api.gen.js

@@ -10,7 +10,9 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par"]
+    regions: [
+      "fr-par"
+    ]
   });
   pageOfListHubs = (request = {}) => this.client.fetch(
     {
@@ -21,10 +23,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -132,11 +131,15 @@ class API extends API$1 {
    *
    * @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])
-  });
+  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.
    *
@@ -148,7 +151,9 @@ class API extends API$1 {
     {
       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])
+      urlParams: urlParams(
+        ["start_date", request.startDate]
+      )
     },
     unmarshalGetHubMetricsResponse
   );
@@ -192,10 +197,7 @@ class API extends API$1 {
         ["name", request.name],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["status", request.status]
       )
     },
@@ -335,10 +337,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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.
    *
@@ -350,7 +354,9 @@ class API extends API$1 {
     {
       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])
+      urlParams: urlParams(
+        ["start_date", request.startDate]
+      )
     },
     unmarshalGetDeviceMetricsResponse
   );
@@ -363,10 +369,7 @@ class API extends API$1 {
         ["name", request.name],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListRoutesResponse
@@ -439,10 +442,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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",
@@ -452,10 +457,7 @@ class API extends API$1 {
         ["name", request.name],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["topic_prefix", request.topicPrefix]
       )
     },
@@ -503,10 +505,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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.
    *
@@ -559,10 +563,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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.
    *
@@ -581,10 +587,12 @@ class API extends API$1 {
    *
    * @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)}`
-  });
+  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.js

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

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

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 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.js';

package/dist/v1/marshalling.gen.js

@@ -251,10 +251,7 @@ const unmarshalListTwinDocumentsResponse = (data) => {
     );
   }
   return {
-    documents: unmarshalArrayOfObject(
-      data.documents,
-      unmarshalListTwinDocumentsResponseDocumentSummary
-    )
+    documents: unmarshalArrayOfObject(data.documents, unmarshalListTwinDocumentsResponseDocumentSummary)
   };
 };
 const unmarshalRenewDeviceCertificateResponse = (data) => {

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

@@ -214,7 +214,7 @@ export interface Hub {
      */
     organizationId: string;
     /**
-     * When an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certifcate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority.
+     * When an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certificate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority.
      */
     enableDeviceAutoProvisioning: boolean;
     /**

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-iot",
-  "version": "1.1.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK iot",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/iot"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1/index.gen.cjs");
-exports.Iotv1 = index_gen;