@scaleway/sdk-iot 2.6.1 → 2.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/v1/api.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
|
|
2
1
|
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
|
+
import type { WaitForOptions, ApiLocality } from '@scaleway/sdk-client';
|
|
3
3
|
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';
|
|
4
4
|
/**
|
|
5
5
|
* IoT Hub API.
|
|
@@ -44,7 +44,7 @@ export declare class API extends ParentAPI {
|
|
|
44
44
|
* @param options - The waiting options
|
|
45
45
|
* @returns A Promise of Hub
|
|
46
46
|
*/
|
|
47
|
-
waitForHub: (request: Readonly<GetHubRequest>, options?: Readonly<WaitForOptions<Hub>>
|
|
47
|
+
waitForHub: (request: Readonly<GetHubRequest>, options?: Readonly<WaitForOptions<Hub>>) => Promise<Hub>;
|
|
48
48
|
/**
|
|
49
49
|
* Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID.
|
|
50
50
|
*
|
|
@@ -234,14 +234,14 @@ export declare class API extends ParentAPI {
|
|
|
234
234
|
[Symbol.asyncIterator]: () => AsyncGenerator<Network[], void, void>;
|
|
235
235
|
};
|
|
236
236
|
/**
|
|
237
|
-
* Create a new network. Create a new network for an existing hub.
|
|
237
|
+
* 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.
|
|
238
238
|
*
|
|
239
239
|
* @param request - The request {@link CreateNetworkRequest}
|
|
240
240
|
* @returns A Promise of CreateNetworkResponse
|
|
241
241
|
*/
|
|
242
242
|
createNetwork: (request: Readonly<CreateNetworkRequest>) => Promise<CreateNetworkResponse>;
|
|
243
243
|
/**
|
|
244
|
-
* Retrieve a specific network. Retrieve an existing network, specified by its network ID.
|
|
244
|
+
* 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.
|
|
245
245
|
*
|
|
246
246
|
* @param request - The request {@link GetNetworkRequest}
|
|
247
247
|
* @returns A Promise of Network
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '@scaleway/sdk-client';
|
|
2
|
-
import type {
|
|
2
|
+
import type { Device, Network, Hub, CreateDeviceResponse, CreateNetworkResponse, GetDeviceCertificateResponse, GetDeviceMetricsResponse, GetHubCAResponse, GetHubMetricsResponse, ListDevicesResponse, ListHubsResponse, ListNetworksResponse, ListRoutesResponse, ListTwinDocumentsResponse, RenewDeviceCertificateResponse, Route, SetDeviceCertificateResponse, TwinDocument, CreateDeviceRequest, CreateHubRequest, CreateNetworkRequest, CreateRouteRequest, PatchTwinDocumentRequest, PutTwinDocumentRequest, SetDeviceCertificateRequest, SetHubCARequest, UpdateDeviceRequest, UpdateHubRequest, UpdateRouteRequest } from './types.gen.js';
|
|
3
3
|
export declare const unmarshalDevice: (data: unknown) => Device;
|
|
4
4
|
export declare const unmarshalNetwork: (data: unknown) => Network;
|
|
5
5
|
export declare const unmarshalHub: (data: unknown) => Hub;
|
|
@@ -1,144 +1,144 @@
|
|
|
1
1
|
export declare const queriesMetadata: {
|
|
2
|
-
readonly namespace:
|
|
3
|
-
readonly version:
|
|
4
|
-
readonly folderName:
|
|
2
|
+
readonly namespace: 'iot';
|
|
3
|
+
readonly version: 'v1';
|
|
4
|
+
readonly folderName: 'iotv1';
|
|
5
5
|
readonly services: readonly [{
|
|
6
|
-
readonly apiClass:
|
|
6
|
+
readonly apiClass: 'API';
|
|
7
7
|
readonly methods: readonly [{
|
|
8
|
-
readonly methodName:
|
|
9
|
-
readonly protoName:
|
|
10
|
-
readonly paramsType:
|
|
11
|
-
readonly returnType:
|
|
8
|
+
readonly methodName: 'listHubs';
|
|
9
|
+
readonly protoName: 'ListHubs';
|
|
10
|
+
readonly paramsType: 'ListHubsRequest';
|
|
11
|
+
readonly returnType: 'ListHubsResponse';
|
|
12
12
|
readonly isList: true;
|
|
13
|
-
readonly paginationType:
|
|
14
|
-
readonly pageParamKey:
|
|
15
|
-
readonly listItemType:
|
|
13
|
+
readonly paginationType: 'offset';
|
|
14
|
+
readonly pageParamKey: 'page';
|
|
15
|
+
readonly listItemType: 'Hub';
|
|
16
16
|
readonly isPrivate: false;
|
|
17
|
-
readonly description: "
|
|
17
|
+
readonly description: '"';
|
|
18
18
|
}, {
|
|
19
|
-
readonly methodName:
|
|
20
|
-
readonly protoName:
|
|
21
|
-
readonly paramsType:
|
|
22
|
-
readonly returnType:
|
|
19
|
+
readonly methodName: 'getHub';
|
|
20
|
+
readonly protoName: 'GetHub';
|
|
21
|
+
readonly paramsType: 'GetHubRequest';
|
|
22
|
+
readonly returnType: 'Hub';
|
|
23
23
|
readonly isList: false;
|
|
24
|
-
readonly paginationType:
|
|
24
|
+
readonly paginationType: 'none';
|
|
25
25
|
readonly isPrivate: false;
|
|
26
|
-
readonly description: "
|
|
26
|
+
readonly description: '"';
|
|
27
27
|
readonly hasWaiter: true;
|
|
28
28
|
}, {
|
|
29
|
-
readonly methodName:
|
|
30
|
-
readonly protoName:
|
|
31
|
-
readonly paramsType:
|
|
32
|
-
readonly returnType:
|
|
29
|
+
readonly methodName: 'getHubMetrics';
|
|
30
|
+
readonly protoName: 'GetHubMetrics';
|
|
31
|
+
readonly paramsType: 'GetHubMetricsRequest';
|
|
32
|
+
readonly returnType: 'GetHubMetricsResponse';
|
|
33
33
|
readonly isList: false;
|
|
34
|
-
readonly paginationType:
|
|
34
|
+
readonly paginationType: 'none';
|
|
35
35
|
readonly isPrivate: false;
|
|
36
|
-
readonly description: "
|
|
36
|
+
readonly description: '"';
|
|
37
37
|
}, {
|
|
38
|
-
readonly methodName:
|
|
39
|
-
readonly protoName:
|
|
40
|
-
readonly paramsType:
|
|
41
|
-
readonly returnType:
|
|
38
|
+
readonly methodName: 'getHubCA';
|
|
39
|
+
readonly protoName: 'GetHubCA';
|
|
40
|
+
readonly paramsType: 'GetHubCARequest';
|
|
41
|
+
readonly returnType: 'GetHubCAResponse';
|
|
42
42
|
readonly isList: false;
|
|
43
|
-
readonly paginationType:
|
|
43
|
+
readonly paginationType: 'none';
|
|
44
44
|
readonly isPrivate: false;
|
|
45
|
-
readonly description: "
|
|
45
|
+
readonly description: '"';
|
|
46
46
|
}, {
|
|
47
|
-
readonly methodName:
|
|
48
|
-
readonly protoName:
|
|
49
|
-
readonly paramsType:
|
|
50
|
-
readonly returnType:
|
|
47
|
+
readonly methodName: 'listDevices';
|
|
48
|
+
readonly protoName: 'ListDevices';
|
|
49
|
+
readonly paramsType: 'ListDevicesRequest';
|
|
50
|
+
readonly returnType: 'ListDevicesResponse';
|
|
51
51
|
readonly isList: true;
|
|
52
|
-
readonly paginationType:
|
|
53
|
-
readonly pageParamKey:
|
|
54
|
-
readonly listItemType:
|
|
52
|
+
readonly paginationType: 'offset';
|
|
53
|
+
readonly pageParamKey: 'page';
|
|
54
|
+
readonly listItemType: 'Device';
|
|
55
55
|
readonly isPrivate: false;
|
|
56
|
-
readonly description: "
|
|
56
|
+
readonly description: '"';
|
|
57
57
|
}, {
|
|
58
|
-
readonly methodName:
|
|
59
|
-
readonly protoName:
|
|
60
|
-
readonly paramsType:
|
|
61
|
-
readonly returnType:
|
|
58
|
+
readonly methodName: 'getDevice';
|
|
59
|
+
readonly protoName: 'GetDevice';
|
|
60
|
+
readonly paramsType: 'GetDeviceRequest';
|
|
61
|
+
readonly returnType: 'Device';
|
|
62
62
|
readonly isList: false;
|
|
63
|
-
readonly paginationType:
|
|
63
|
+
readonly paginationType: 'none';
|
|
64
64
|
readonly isPrivate: false;
|
|
65
|
-
readonly description: "
|
|
65
|
+
readonly description: '"';
|
|
66
66
|
}, {
|
|
67
|
-
readonly methodName:
|
|
68
|
-
readonly protoName:
|
|
69
|
-
readonly paramsType:
|
|
70
|
-
readonly returnType:
|
|
67
|
+
readonly methodName: 'getDeviceCertificate';
|
|
68
|
+
readonly protoName: 'GetDeviceCertificate';
|
|
69
|
+
readonly paramsType: 'GetDeviceCertificateRequest';
|
|
70
|
+
readonly returnType: 'GetDeviceCertificateResponse';
|
|
71
71
|
readonly isList: false;
|
|
72
|
-
readonly paginationType:
|
|
72
|
+
readonly paginationType: 'none';
|
|
73
73
|
readonly isPrivate: false;
|
|
74
|
-
readonly description: "
|
|
74
|
+
readonly description: '"';
|
|
75
75
|
}, {
|
|
76
|
-
readonly methodName:
|
|
77
|
-
readonly protoName:
|
|
78
|
-
readonly paramsType:
|
|
79
|
-
readonly returnType:
|
|
76
|
+
readonly methodName: 'getDeviceMetrics';
|
|
77
|
+
readonly protoName: 'GetDeviceMetrics';
|
|
78
|
+
readonly paramsType: 'GetDeviceMetricsRequest';
|
|
79
|
+
readonly returnType: 'GetDeviceMetricsResponse';
|
|
80
80
|
readonly isList: false;
|
|
81
|
-
readonly paginationType:
|
|
81
|
+
readonly paginationType: 'none';
|
|
82
82
|
readonly isPrivate: false;
|
|
83
|
-
readonly description: "
|
|
83
|
+
readonly description: '"';
|
|
84
84
|
}, {
|
|
85
|
-
readonly methodName:
|
|
86
|
-
readonly protoName:
|
|
87
|
-
readonly paramsType:
|
|
88
|
-
readonly returnType:
|
|
85
|
+
readonly methodName: 'listRoutes';
|
|
86
|
+
readonly protoName: 'ListRoutes';
|
|
87
|
+
readonly paramsType: 'ListRoutesRequest';
|
|
88
|
+
readonly returnType: 'ListRoutesResponse';
|
|
89
89
|
readonly isList: true;
|
|
90
|
-
readonly paginationType:
|
|
91
|
-
readonly pageParamKey:
|
|
92
|
-
readonly listItemType:
|
|
90
|
+
readonly paginationType: 'offset';
|
|
91
|
+
readonly pageParamKey: 'page';
|
|
92
|
+
readonly listItemType: 'RouteSummary';
|
|
93
93
|
readonly isPrivate: false;
|
|
94
|
-
readonly description: "
|
|
94
|
+
readonly description: '"';
|
|
95
95
|
}, {
|
|
96
|
-
readonly methodName:
|
|
97
|
-
readonly protoName:
|
|
98
|
-
readonly paramsType:
|
|
99
|
-
readonly returnType:
|
|
96
|
+
readonly methodName: 'getRoute';
|
|
97
|
+
readonly protoName: 'GetRoute';
|
|
98
|
+
readonly paramsType: 'GetRouteRequest';
|
|
99
|
+
readonly returnType: 'Route';
|
|
100
100
|
readonly isList: false;
|
|
101
|
-
readonly paginationType:
|
|
101
|
+
readonly paginationType: 'none';
|
|
102
102
|
readonly isPrivate: false;
|
|
103
|
-
readonly description: "
|
|
103
|
+
readonly description: '"';
|
|
104
104
|
}, {
|
|
105
|
-
readonly methodName:
|
|
106
|
-
readonly protoName:
|
|
107
|
-
readonly paramsType:
|
|
108
|
-
readonly returnType:
|
|
105
|
+
readonly methodName: 'listNetworks';
|
|
106
|
+
readonly protoName: 'ListNetworks';
|
|
107
|
+
readonly paramsType: 'ListNetworksRequest';
|
|
108
|
+
readonly returnType: 'ListNetworksResponse';
|
|
109
109
|
readonly isList: true;
|
|
110
|
-
readonly paginationType:
|
|
111
|
-
readonly pageParamKey:
|
|
112
|
-
readonly listItemType:
|
|
110
|
+
readonly paginationType: 'offset';
|
|
111
|
+
readonly pageParamKey: 'page';
|
|
112
|
+
readonly listItemType: 'Network';
|
|
113
113
|
readonly isPrivate: false;
|
|
114
|
-
readonly description: "
|
|
114
|
+
readonly description: '"';
|
|
115
115
|
}, {
|
|
116
|
-
readonly methodName:
|
|
117
|
-
readonly protoName:
|
|
118
|
-
readonly paramsType:
|
|
119
|
-
readonly returnType:
|
|
116
|
+
readonly methodName: 'getNetwork';
|
|
117
|
+
readonly protoName: 'GetNetwork';
|
|
118
|
+
readonly paramsType: 'GetNetworkRequest';
|
|
119
|
+
readonly returnType: 'Network';
|
|
120
120
|
readonly isList: false;
|
|
121
|
-
readonly paginationType:
|
|
121
|
+
readonly paginationType: 'none';
|
|
122
122
|
readonly isPrivate: false;
|
|
123
|
-
readonly description: "
|
|
123
|
+
readonly description: '"';
|
|
124
124
|
}, {
|
|
125
|
-
readonly methodName:
|
|
126
|
-
readonly protoName:
|
|
127
|
-
readonly paramsType:
|
|
128
|
-
readonly returnType:
|
|
125
|
+
readonly methodName: 'getTwinDocument';
|
|
126
|
+
readonly protoName: 'GetTwinDocument';
|
|
127
|
+
readonly paramsType: 'GetTwinDocumentRequest';
|
|
128
|
+
readonly returnType: 'TwinDocument';
|
|
129
129
|
readonly isList: false;
|
|
130
|
-
readonly paginationType:
|
|
130
|
+
readonly paginationType: 'none';
|
|
131
131
|
readonly isPrivate: false;
|
|
132
|
-
readonly description: "
|
|
132
|
+
readonly description: '"';
|
|
133
133
|
}, {
|
|
134
|
-
readonly methodName:
|
|
135
|
-
readonly protoName:
|
|
136
|
-
readonly paramsType:
|
|
137
|
-
readonly returnType:
|
|
134
|
+
readonly methodName: 'listTwinDocuments';
|
|
135
|
+
readonly protoName: 'ListTwinDocuments';
|
|
136
|
+
readonly paramsType: 'ListTwinDocumentsRequest';
|
|
137
|
+
readonly returnType: 'ListTwinDocumentsResponse';
|
|
138
138
|
readonly isList: false;
|
|
139
|
-
readonly paginationType:
|
|
139
|
+
readonly paginationType: 'none';
|
|
140
140
|
readonly isPrivate: false;
|
|
141
|
-
readonly description: "
|
|
141
|
+
readonly description: '"';
|
|
142
142
|
}];
|
|
143
143
|
}];
|
|
144
144
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleway/sdk-iot",
|
|
3
|
-
"version": "2.6.
|
|
3
|
+
"version": "2.6.3",
|
|
4
4
|
"description": "Scaleway SDK iot",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -32,17 +32,17 @@
|
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@scaleway/random-name": "5.1.4",
|
|
35
|
-
"@scaleway/sdk-std": "2.4.
|
|
35
|
+
"@scaleway/sdk-std": "2.4.2"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@scaleway/sdk-client": "^2.
|
|
38
|
+
"@scaleway/sdk-client": "^2.4.0",
|
|
39
39
|
"@repo/configs": "^0.1.1"
|
|
40
40
|
},
|
|
41
41
|
"peerDependencies": {
|
|
42
|
-
"@scaleway/sdk-client": "^2.
|
|
42
|
+
"@scaleway/sdk-client": "^2.4.0"
|
|
43
43
|
},
|
|
44
44
|
"engines": {
|
|
45
|
-
"node": ">=20.
|
|
45
|
+
"node": ">=20.20.2"
|
|
46
46
|
},
|
|
47
47
|
"scripts": {
|
|
48
48
|
"package:check": "pnpm publint",
|