@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -14,21 +14,23 @@ export type RouteRouteType = 'unknown' | 's3' | 'database' | 'rest';
 export type RouteS3ConfigS3Strategy = 'unknown' | 'per_topic' | 'per_message';
 export interface DeviceMessageFiltersRule {
     /**
-     * If set to `accept`, all topics in the topics list will be allowed, with all
-     * other topics being denied. If set to `reject`, all topics in the topics
-     * list will be denied, with all other topics being allowed.
+     * If set to `accept`, all topics in the topics list will be allowed, with all other topics being denied.
+  If set to `reject`, all topics in the topics list will be denied, with all other topics being allowed.
      */
     policy: DeviceMessageFiltersRulePolicy;
     /**
-     * List of topics to accept or reject. It must be valid MQTT topics and up to
-     * 65535 characters.
+     * List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters.
      */
     topics?: string[];
 }
 export interface DeviceMessageFilters {
-    /** Filtering rule to restrict topics the device can publish to. */
+    /**
+     * Filtering rule to restrict topics the device can publish to.
+     */
     publish?: DeviceMessageFiltersRule;
-    /** Filtering rule to restrict topics the device can subscribe to. */
+    /**
+     * Filtering rule to restrict topics the device can subscribe to.
+     */
     subscribe?: DeviceMessageFiltersRule;
 }
 export interface HubTwinsGraphiteConfig {
@@ -39,56 +41,87 @@ export interface Certificate {
     key: string;
 }
 export interface Device {
-    /** Device ID, also used as MQTT Client ID or username. */
+    /**
+     * Device ID, also used as MQTT Client ID or username.
+     */
     id: string;
-    /** Device name. */
+    /**
+     * Device name.
+     */
     name: string;
-    /** Device description. */
+    /**
+     * Device description.
+     */
     description: string;
-    /** Device status. */
+    /**
+     * Device status.
+     */
     status: DeviceStatus;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
-    /** Last connection/activity date of a device. */
+    /**
+     * Last connection/activity date of a device.
+     */
     lastActivityAt?: Date;
-    /** Defines whether the device is connected to the Hub. */
+    /**
+     * Defines whether the device is connected to the Hub.
+     */
     isConnected: boolean;
     /**
-     * Defines whether to allow the device to connect to the Hub without TLS
-     * mutual authentication.
+     * Defines whether to allow the device to connect to the Hub without TLS mutual authentication.
      */
     allowInsecure: boolean;
     /**
-     * Defines whether to allow multiple physical devices to connect to the Hub
-     * with this device's credentials.
+     * Defines whether to allow multiple physical devices to connect to the Hub with this device's credentials.
      */
     allowMultipleConnections: boolean;
-    /** Filter-sets to restrict the topics the device can publish/subscribe to. */
+    /**
+     * Filter-sets to restrict the topics the device can publish/subscribe to.
+     */
     messageFilters?: DeviceMessageFilters;
     /**
-     * Assigning a custom certificate allows a device to authenticate using that
-     * specific certificate without checking the Hub's CA certificate.
+     * Assigning a custom certificate allows a device to authenticate using that specific certificate without checking the Hub's CA certificate.
      */
     hasCustomCertificate: boolean;
-    /** Date at which the device was added. */
+    /**
+     * Date at which the device was added.
+     */
     createdAt?: Date;
-    /** Date at which the device was last modified. */
+    /**
+     * Date at which the device was last modified.
+     */
     updatedAt?: Date;
 }
 export interface Network {
-    /** Network ID. */
+    /**
+     * Network ID.
+     */
     id: string;
-    /** Network name. */
+    /**
+     * Network name.
+     */
     name: string;
-    /** Type of network to connect with. */
+    /**
+     * Type of network to connect with.
+     */
     type: NetworkNetworkType;
-    /** Endpoint to use for interacting with the network. */
+    /**
+     * Endpoint to use for interacting with the network.
+     */
     endpoint: string;
-    /** Hub ID to connect the Network to. */
+    /**
+     * Hub ID to connect the Network to.
+     */
     hubId: string;
-    /** Date at which the network was created. */
+    /**
+     * Date at which the network was created.
+     */
     createdAt?: Date;
-    /** This prefix will be prepended to all topics for this Network. */
+    /**
+     * This prefix will be prepended to all topics for this Network.
+     */
     topicPrefix: string;
 }
 export interface CreateRouteRequestDatabaseConfig {
@@ -112,125 +145,176 @@ export interface CreateRouteRequestS3Config {
     strategy: RouteS3ConfigS3Strategy;
 }
 export interface Hub {
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     id: string;
-    /** Hub name. */
+    /**
+     * Hub name.
+     */
     name: string;
-    /** Current status of the Hub. */
+    /**
+     * Current status of the Hub.
+     */
     status: HubStatus;
-    /** Hub feature set. */
+    /**
+     * Hub feature set.
+     */
     productPlan: HubProductPlan;
-    /** Defines whether the hub has been enabled. */
+    /**
+     * Defines whether the hub has been enabled.
+     */
     enabled: boolean;
-    /** Number of registered devices. */
+    /**
+     * Number of registered devices.
+     */
     deviceCount: number;
-    /** Number of currently connected devices. */
+    /**
+     * Number of currently connected devices.
+     */
     connectedDeviceCount: number;
     /**
-     * Devices should be connected to this host. Port may be 1883 (MQTT), 8883
-     * (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over
-     * TLS).
+     * Devices should be connected to this host. Port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over TLS).
      */
     endpoint: string;
-    /** Defines whether to disable Hub events. */
+    /**
+     * Defines whether to disable Hub events.
+     */
     disableEvents: boolean;
-    /** Hub events topic prefix. */
+    /**
+     * Hub events topic prefix.
+     */
     eventsTopicPrefix: string;
-    /** Region of the Hub. */
+    /**
+     * Region of the Hub.
+     */
     region: ScwRegion;
-    /** Hub creation date. */
+    /**
+     * Hub creation date.
+     */
     createdAt?: Date;
-    /** Hub last modification date. */
+    /**
+     * Hub last modification date.
+     */
     updatedAt?: Date;
-    /** Project owning the resource. */
+    /**
+     * Project owning the resource.
+     */
     projectId: string;
-    /** Organization owning the resource. */
+    /**
+     * Organization owning the resource.
+     */
     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 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.
      */
     enableDeviceAutoProvisioning: boolean;
     /**
-     * Flag is automatically set to `false` after Hub creation, as Hub
-     * certificates are managed by Scaleway. Once a custom certificate authority
-     * is set, the flag will be set to `true`.
+     * Flag is automatically set to `false` after Hub creation, as Hub certificates are managed by Scaleway. Once a custom certificate authority is set, the flag will be set to `true`.
      */
     hasCustomCa: boolean;
     /**
      * BETA - not implemented yet.
      *
-     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be
-     * set.
+     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set.
      */
     twinsGraphiteConfig?: HubTwinsGraphiteConfig;
 }
 export interface RouteSummary {
-    /** Route ID. */
+    /**
+     * Route ID.
+     */
     id: string;
-    /** Route name. */
+    /**
+     * Route name.
+     */
     name: string;
-    /** Hub ID of the route. */
+    /**
+     * Hub ID of the route.
+     */
     hubId: string;
     /**
-     * Topic the route subscribes to. It must be a valid MQTT topic and up to
-     * 65535 characters.
+     * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
      */
     topic: string;
-    /** Route type. */
+    /**
+     * Route type.
+     */
     type: RouteRouteType;
-    /** Date at which the route was created. */
+    /**
+     * Date at which the route was created.
+     */
     createdAt?: Date;
-    /** Date at which the route was last updated. */
+    /**
+     * Date at which the route was last updated.
+     */
     updatedAt?: Date;
 }
 export interface ListTwinDocumentsResponseDocumentSummary {
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
 }
 export interface RouteDatabaseConfig {
     /**
-     * Database engine the route will connect to. If not specified, the default
-     * database will be 'PostgreSQL'.
+     * Database engine the route will connect to. If not specified, the default database will be 'PostgreSQL'.
      */
     engine: RouteDatabaseConfigEngine;
-    /** Database host. */
+    /**
+     * Database host.
+     */
     host: string;
-    /** Database port. */
+    /**
+     * Database port.
+     */
     port: number;
-    /** Database name. */
+    /**
+     * Database name.
+     */
     dbname: string;
-    /** Database username. Make sure this account can execute the provided query. */
+    /**
+     * Database username. Make sure this account can execute the provided query.
+     */
     username: string;
-    /** Database password. */
+    /**
+     * Database password.
+     */
     password: string;
     /**
-     * SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see
-     * documentation).
+     * SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see documentation).
      */
     query: string;
 }
 export interface RouteRestConfig {
-    /** HTTP verb used to call REST URI. */
+    /**
+     * HTTP verb used to call REST URI.
+     */
     verb: RouteRestConfigHttpVerb;
-    /** URI of the REST endpoint. */
+    /**
+     * URI of the REST endpoint.
+     */
     uri: string;
-    /** HTTP call extra headers. */
+    /**
+     * HTTP call extra headers.
+     */
     headers: Record<string, string>;
 }
 export interface RouteS3Config {
-    /** Region of the Amazon S3 route's destination bucket (e.g., 'fr-par'). */
+    /**
+     * Region of the Amazon S3 route's destination bucket (e.g., 'fr-par').
+     */
     bucketRegion: string;
-    /** Destination bucket name of the Amazon S3 route. */
+    /**
+     * Destination bucket name of the Amazon S3 route.
+     */
     bucketName: string;
-    /** Optional string to prefix object names with. */
+    /**
+     * Optional string to prefix object names with.
+     */
     objectPrefix: string;
     /**
-     * How the Amazon S3 route's objects will be created: one per topic or one per
-     * message.
+     * How the Amazon S3 route's objects will be created: one per topic or one per message.
      */
     strategy: RouteS3ConfigS3Strategy;
 }
@@ -256,263 +340,305 @@ export interface UpdateRouteRequestS3Config {
 }
 export type CreateDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device name. */
+    /**
+     * Device name.
+     */
     name?: string;
-    /** Hub ID of the device. */
+    /**
+     * Hub ID of the device.
+     */
     hubId: string;
     /**
-     * Defines whether to allow plain and server-authenticated SSL connections in
-     * addition to mutually-authenticated ones.
+     * Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones.
      */
     allowInsecure: boolean;
     /**
-     * Defines whether to allow multiple physical devices to connect with this
-     * device's credentials.
+     * Defines whether to allow multiple physical devices to connect with this device's credentials.
      */
     allowMultipleConnections: boolean;
     /**
-     * Filter-sets to authorize or deny the device to publish/subscribe to
-     * specific topics.
+     * Filter-sets to authorize or deny the device to publish/subscribe to specific topics.
      */
     messageFilters?: DeviceMessageFilters;
-    /** Device description. */
+    /**
+     * Device description.
+     */
     description?: string;
 };
 export interface CreateDeviceResponse {
-    /** Information related to the created device. */
+    /**
+     * Information related to the created device.
+     */
     device?: Device;
-    /** Device certificate. */
+    /**
+     * Device certificate.
+     */
     certificate?: Certificate;
 }
 export type CreateHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub name (up to 255 characters). */
+    /**
+     * Hub name (up to 255 characters).
+     */
     name?: string;
     /**
-     * Project/Organization ID to filter for, only Hubs from this
-     * Project/Organization will be returned.
+     * Project/Organization ID to filter for, only Hubs from this Project/Organization will be returned.
      */
     projectId?: string;
-    /** Hub product plan. */
+    /**
+     * Hub product plan.
+     */
     productPlan: HubProductPlan;
-    /** Disable Hub events. */
+    /**
+     * Disable Hub events.
+     */
     disableEvents?: boolean;
-    /** Topic prefix (default '$SCW/events') of Hub events. */
+    /**
+     * Topic prefix (default '$SCW/events') of Hub events.
+     */
     eventsTopicPrefix?: string;
     /**
      * BETA - not implemented yet.
      *
-     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be
-     * set.
+     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set.
      */
     twinsGraphiteConfig?: HubTwinsGraphiteConfig;
 };
 export type CreateNetworkRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Network name. */
+    /**
+     * Network name.
+     */
     name?: string;
-    /** Type of network to connect with. */
+    /**
+     * Type of network to connect with.
+     */
     type: NetworkNetworkType;
-    /** Hub ID to connect the Network to. */
+    /**
+     * Hub ID to connect the Network to.
+     */
     hubId: string;
-    /** Topic prefix for the Network. */
+    /**
+     * Topic prefix for the Network.
+     */
     topicPrefix: string;
 };
 export interface CreateNetworkResponse {
-    /** Information related to the created network. */
+    /**
+     * Information related to the created network.
+     */
     network?: Network;
-    /** Endpoint Key to keep secret. This cannot be retrieved later. */
+    /**
+     * Endpoint Key to keep secret. This cannot be retrieved later.
+     */
     secret: string;
 }
 export type CreateRouteRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Route name. */
+    /**
+     * Route name.
+     */
     name?: string;
-    /** Hub ID of the route. */
+    /**
+     * Hub ID of the route.
+     */
     hubId: string;
     /**
-     * Topic the route subscribes to. It must be a valid MQTT topic and up to
-     * 65535 characters.
+     * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
      */
     topic: string;
     /**
      * If creating Amazon S3 Routes, Amazon S3-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     s3Config?: CreateRouteRequestS3Config;
     /**
      * If creating Database Route, DB-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     dbConfig?: CreateRouteRequestDatabaseConfig;
     /**
      * If creating Rest Route, Rest-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     restConfig?: CreateRouteRequestRestConfig;
 };
 export type DeleteDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export type DeleteHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
     /**
-     * Defines whether to force the deletion of devices added to this Hub or
-     * reject the operation.
+     * Defines whether to force the deletion of devices added to this Hub or reject the operation.
      */
     deleteDevices?: boolean;
 };
 export type DeleteNetworkRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Network ID. */
+    /**
+     * Network ID.
+     */
     networkId: string;
 };
 export type DeleteRouteRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Route ID. */
+    /**
+     * Route ID.
+     */
     routeId: string;
 };
 export type DeleteTwinDocumentRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
 };
 export type DeleteTwinDocumentsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
 };
 export type DisableDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export type DisableHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
 };
 export type EnableDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export type EnableHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
 };
 export type GetDeviceCertificateRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export interface GetDeviceCertificateResponse {
-    /** Information related to the created device. */
+    /**
+     * Information related to the created device.
+     */
     device?: Device;
-    /** Device certificate. */
+    /**
+     * Device certificate.
+     */
     certificatePem: string;
 }
 export type GetDeviceMetricsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
-    /** Start date used to compute the best scale for the returned metrics. */
+    /**
+     * Start date used to compute the best scale for the returned metrics.
+     */
     startDate?: Date;
 };
 export interface GetDeviceMetricsResponse {
-    /** Metrics for a device over the requested period. */
+    /**
+     * Metrics for a device over the requested period.
+     */
     metrics: TimeSeries[];
 }
 export type GetDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export type GetHubCARequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
     hubId: string;
@@ -522,277 +648,373 @@ export interface GetHubCAResponse {
 }
 export type GetHubMetricsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
-    /** Start date used to compute the best scale for returned metrics. */
+    /**
+     * Start date used to compute the best scale for returned metrics.
+     */
     startDate?: Date;
 };
 export interface GetHubMetricsResponse {
-    /** Metrics for a Hub over the requested period. */
+    /**
+     * Metrics for a Hub over the requested period.
+     */
     metrics: TimeSeries[];
 }
 export type GetHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
 };
 export type GetNetworkRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Network ID. */
+    /**
+     * Network ID.
+     */
     networkId: string;
 };
 export type GetRouteRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Route ID. */
+    /**
+     * Route ID.
+     */
     routeId: string;
 };
 export type GetTwinDocumentRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
 };
 export type ListDevicesRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Page number to return, from the paginated results. */
+    /**
+     * Page number to return, from the paginated results.
+     */
     page?: number;
-    /** Number of devices to return within a page. Maximum value is 100. */
+    /**
+     * Number of devices to return within a page. Maximum value is 100.
+     */
     pageSize?: number;
-    /** Ordering of requested devices. */
+    /**
+     * Ordering of requested devices.
+     */
     orderBy?: ListDevicesRequestOrderBy;
-    /** Name to filter for, only devices with this name will be returned. */
+    /**
+     * Name to filter for, only devices with this name will be returned.
+     */
     name?: string;
-    /** Hub ID to filter for, only devices attached to this Hub will be returned. */
+    /**
+     * Hub ID to filter for, only devices attached to this Hub will be returned.
+     */
     hubId?: string;
-    /** Defines wheter to filter the allow_insecure flag. */
+    /**
+     * Defines wheter to filter the allow_insecure flag.
+     */
     allowInsecure?: boolean;
-    /** Device status (enabled, disabled, etc.). */
+    /**
+     * Device status (enabled, disabled, etc.).
+     */
     status?: DeviceStatus;
 };
 export interface ListDevicesResponse {
-    /** Total number of devices. */
+    /**
+     * Total number of devices.
+     */
     totalCount: number;
-    /** Page of devices. */
+    /**
+     * Page of devices.
+     */
     devices: Device[];
 }
 export type ListHubsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Page number to return, from the paginated results. */
+    /**
+     * Page number to return, from the paginated results.
+     */
     page?: number;
-    /** Number of Hubs to return within a page. Maximum value is 100. */
+    /**
+     * Number of Hubs to return within a page. Maximum value is 100.
+     */
     pageSize?: number;
-    /** Sort order of Hubs in the response. */
+    /**
+     * Sort order of Hubs in the response.
+     */
     orderBy?: ListHubsRequestOrderBy;
-    /** Only list Hubs of this Project ID. */
+    /**
+     * Only list Hubs of this Project ID.
+     */
     projectId?: string;
-    /** Only list Hubs of this Organization ID. */
+    /**
+     * Only list Hubs of this Organization ID.
+     */
     organizationId?: string;
-    /** Hub name. */
+    /**
+     * Hub name.
+     */
     name?: string;
 };
 export interface ListHubsResponse {
-    /** Total number of Hubs. */
+    /**
+     * Total number of Hubs.
+     */
     totalCount: number;
-    /** A page of hubs. */
+    /**
+     * A page of hubs.
+     */
     hubs: Hub[];
 }
 export type ListNetworksRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Page number to return, from the paginated results. */
+    /**
+     * Page number to return, from the paginated results.
+     */
     page?: number;
-    /** Number of networks to return. The maximum value is 100. */
+    /**
+     * Number of networks to return. The maximum value is 100.
+     */
     pageSize?: number;
-    /** Ordering of requested routes. */
+    /**
+     * Ordering of requested routes.
+     */
     orderBy?: ListNetworksRequestOrderBy;
-    /** Network name to filter for. */
+    /**
+     * Network name to filter for.
+     */
     name?: string;
-    /** Hub ID to filter for. */
+    /**
+     * Hub ID to filter for.
+     */
     hubId?: string;
-    /** Topic prefix to filter for. */
+    /**
+     * Topic prefix to filter for.
+     */
     topicPrefix?: string;
 };
 export interface ListNetworksResponse {
-    /** Total number of Networks. */
+    /**
+     * Total number of Networks.
+     */
     totalCount: number;
-    /** Page of networks. */
+    /**
+     * Page of networks.
+     */
     networks: Network[];
 }
 export type ListRoutesRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Page number to return, from the paginated results. */
+    /**
+     * Page number to return, from the paginated results.
+     */
     page?: number;
-    /** Number of routes to return within a page. Maximum value is 100. */
+    /**
+     * Number of routes to return within a page. Maximum value is 100.
+     */
     pageSize?: number;
-    /** Ordering of requested routes. */
+    /**
+     * Ordering of requested routes.
+     */
     orderBy?: ListRoutesRequestOrderBy;
-    /** Hub ID to filter for. */
+    /**
+     * Hub ID to filter for.
+     */
     hubId?: string;
-    /** Route name to filter for. */
+    /**
+     * Route name to filter for.
+     */
     name?: string;
 };
 export interface ListRoutesResponse {
-    /** Total number of routes. */
+    /**
+     * Total number of routes.
+     */
     totalCount: number;
-    /** Page of routes. */
+    /**
+     * Page of routes.
+     */
     routes: RouteSummary[];
 }
 export type ListTwinDocumentsRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
 };
 export interface ListTwinDocumentsResponse {
-    /** List of the twin document. */
+    /**
+     * List of the twin document.
+     */
     documents: ListTwinDocumentsResponseDocumentSummary[];
 }
 export type PatchTwinDocumentRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
     /**
-     * If set, ensures that the current version of the document matches before
-     * persisting the update.
+     * If set, ensures that the current version of the document matches before persisting the update.
      */
     version?: number;
     /**
-     * A json data that will be applied on the document's current data. Patching
-     * rules: The patch goes recursively through the patch objects. If the patch
-     * object property is null, it is removed from the final object. If the patch
-     * object property is a value (number, strings, bool, arrays), it is replaced.
-     * If the patch object property is an object, the previous rules will be
-     * applied recursively on it.
+     * A json data that will be applied on the document's current data.
+  Patching rules:
+  * The patch goes recursively through the patch objects.
+  * If the patch object property is null, it is removed from the final object.
+  * If the patch object property is a value (number, strings, bool, arrays), it is replaced.
+  * If the patch object property is an object, the previous rules will be applied recursively on it.
      */
     data?: Record<string, unknown>;
 };
 export type PutTwinDocumentRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Twin ID. */
+    /**
+     * Twin ID.
+     */
     twinId: string;
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
     /**
-     * If set, ensures that the current version of the document matches before
-     * persisting the update.
+     * If set, ensures that the current version of the document matches before persisting the update.
      */
     version?: number;
-    /** New data that will replace the contents of the document. */
+    /**
+     * New data that will replace the contents of the document.
+     */
     data?: Record<string, unknown>;
 };
 export type RenewDeviceCertificateRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
 };
 export interface RenewDeviceCertificateResponse {
-    /** Information related to the created device. */
+    /**
+     * Information related to the created device.
+     */
     device?: Device;
-    /** Device certificate. */
+    /**
+     * Device certificate.
+     */
     certificate?: Certificate;
 }
 export interface Route {
-    /** Route ID. */
+    /**
+     * Route ID.
+     */
     id: string;
-    /** Route name. */
+    /**
+     * Route name.
+     */
     name: string;
-    /** Hub ID of the route. */
+    /**
+     * Hub ID of the route.
+     */
     hubId: string;
     /**
-     * Topic the route subscribes to. It must be a valid MQTT topic and up to
-     * 65535 characters.
+     * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
      */
     topic: string;
-    /** Route type. */
+    /**
+     * Route type.
+     */
     type: RouteRouteType;
-    /** Date at which the route was created. */
+    /**
+     * Date at which the route was created.
+     */
     createdAt?: Date;
     /**
      * When using Amazon S3 Routes, Amazon S3-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     s3Config?: RouteS3Config;
     /**
      * When using Database Route, DB-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     dbConfig?: RouteDatabaseConfig;
     /**
      * When using Rest Route, Rest-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     restConfig?: RouteRestConfig;
-    /** Date at which the route was last updated. */
+    /**
+     * Date at which the route was last updated.
+     */
     updatedAt?: Date;
 }
 export type SetDeviceCertificateRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
-    /** PEM-encoded custom certificate. */
+    /**
+     * PEM-encoded custom certificate.
+     */
     certificatePem: string;
 };
 export interface SetDeviceCertificateResponse {
@@ -801,116 +1023,139 @@ export interface SetDeviceCertificateResponse {
 }
 export type SetHubCARequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Hub ID. */
+    /**
+     * Hub ID.
+     */
     hubId: string;
-    /** CA's PEM-encoded certificate. */
+    /**
+     * CA's PEM-encoded certificate.
+     */
     caCertPem: string;
     /**
-     * Challenge is a PEM-encoded certificate that acts as proof of possession of
-     * the CA. It must be signed by the CA, and have a Common Name equal to the
-     * Hub ID.
+     * Challenge is a PEM-encoded certificate that acts as proof of possession of the CA. It must be signed by the CA, and have a Common Name equal to the Hub ID.
      */
     challengeCertPem: string;
 };
 export interface TwinDocument {
-    /** Parent twin ID of the document. */
+    /**
+     * Parent twin ID of the document.
+     */
     twinId: string;
-    /** Name of the document. */
+    /**
+     * Name of the document.
+     */
     documentName: string;
-    /** New version of the document. */
+    /**
+     * New version of the document.
+     */
     version: number;
-    /** New data related to the document. */
+    /**
+     * New data related to the document.
+     */
     data?: Record<string, unknown>;
 }
 export type UpdateDeviceRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Device ID. */
+    /**
+     * Device ID.
+     */
     deviceId: string;
-    /** Description for the device. */
+    /**
+     * Description for the device.
+     */
     description?: string;
     /**
-     * Defines whether to allow plain and server-authenticated SSL connections in
-     * addition to mutually-authenticated ones.
+     * Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones.
      */
     allowInsecure?: boolean;
     /**
-     * Defines whether to allow multiple physical devices to connect with this
-     * device's credentials.
+     * Defines whether to allow multiple physical devices to connect with this device's credentials.
      */
     allowMultipleConnections?: boolean;
-    /** Filter-sets to restrict the topics the device can publish/subscribe to. */
+    /**
+     * Filter-sets to restrict the topics the device can publish/subscribe to.
+     */
     messageFilters?: DeviceMessageFilters;
-    /** Change Hub for this device, additional fees may apply, see IoT Hub pricing. */
+    /**
+     * Change Hub for this device, additional fees may apply, see IoT Hub pricing.
+     */
     hubId?: string;
 };
 export type UpdateHubRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** ID of the Hub you want to update. */
+    /**
+     * ID of the Hub you want to update.
+     */
     hubId: string;
-    /** Hub name (up to 255 characters). */
+    /**
+     * Hub name (up to 255 characters).
+     */
     name?: string;
-    /** Hub product plan. */
+    /**
+     * Hub product plan.
+     */
     productPlan?: HubProductPlan;
-    /** Disable Hub events. */
+    /**
+     * Disable Hub events.
+     */
     disableEvents?: boolean;
-    /** Topic prefix of Hub events. */
+    /**
+     * Topic prefix of Hub events.
+     */
     eventsTopicPrefix?: string;
-    /** Enable device auto provisioning. */
+    /**
+     * Enable device auto provisioning.
+     */
     enableDeviceAutoProvisioning?: boolean;
     /**
      * BETA - not implemented yet.
      *
-     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be
-     * set.
+     * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set.
      */
     twinsGraphiteConfig?: HubTwinsGraphiteConfig;
 };
 export type UpdateRouteRequest = {
     /**
-     * Region to target. If none is passed will use default region from the
-     * config.
+     * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
-    /** Route id. */
+    /**
+     * Route id.
+     */
     routeId: string;
-    /** Route name. */
+    /**
+     * Route name.
+     */
     name?: string;
     /**
-     * Topic the route subscribes to. It must be a valid MQTT topic and up to
-     * 65535 characters.
+     * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.
      */
     topic?: string;
     /**
      * When updating Amazon S3 Route, Amazon S3-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     s3Config?: UpdateRouteRequestS3Config;
     /**
      * When updating Database Route, DB-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     dbConfig?: UpdateRouteRequestDatabaseConfig;
     /**
      * When updating Rest Route, Rest-specific configuration fields.
      *
-     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
-     * could be set.
+     * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.
      */
     restConfig?: UpdateRouteRequestRestConfig;
 };