@scaleway/sdk-iot 2.6.3 → 2.6.5
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/LICENSE +191 -0
- package/package.json +9 -8
- package/dist/.vite/license.md +0 -3
- package/dist/_virtual/_rolldown/runtime.js +0 -13
- package/dist/index.gen.d.ts +0 -5
- package/dist/index.gen.js +0 -2
- package/dist/metadata.gen.d.ts +0 -12
- package/dist/metadata.gen.js +0 -13
- package/dist/v1/api.gen.d.ts +0 -296
- package/dist/v1/api.gen.js +0 -208
- package/dist/v1/content.gen.d.ts +0 -3
- package/dist/v1/content.gen.js +0 -5
- package/dist/v1/index.gen.d.ts +0 -4
- package/dist/v1/index.gen.js +0 -40
- package/dist/v1/marshalling.gen.d.ts +0 -31
- package/dist/v1/marshalling.gen.js +0 -377
- package/dist/v1/metadata.gen.d.ts +0 -145
- package/dist/v1/metadata.gen.js +0 -162
- package/dist/v1/types.gen.d.ts +0 -1177
- package/dist/v1/types.gen.js +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
https://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
Copyright 2019 Scaleway.
|
|
180
|
+
|
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
+
you may not use this file except in compliance with the License.
|
|
183
|
+
You may obtain a copy of the License at
|
|
184
|
+
|
|
185
|
+
https://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
+
|
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
+
See the License for the specific language governing permissions and
|
|
191
|
+
limitations under the License.
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleway/sdk-iot",
|
|
3
|
-
"version": "2.6.
|
|
3
|
+
"version": "2.6.5",
|
|
4
4
|
"description": "Scaleway SDK iot",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
+
"url": "https://github.com/scaleway/scaleway-sdk-js.git",
|
|
8
9
|
"directory": "packages_generated/iot"
|
|
9
10
|
},
|
|
10
11
|
"files": [
|
|
@@ -31,23 +32,23 @@
|
|
|
31
32
|
}
|
|
32
33
|
},
|
|
33
34
|
"dependencies": {
|
|
34
|
-
"@scaleway/random-name": "
|
|
35
|
-
"@scaleway/sdk-std": "2.4.
|
|
35
|
+
"@scaleway/random-name": "6.0.2",
|
|
36
|
+
"@scaleway/sdk-std": "2.4.4"
|
|
36
37
|
},
|
|
37
38
|
"devDependencies": {
|
|
38
|
-
"@
|
|
39
|
-
"@
|
|
39
|
+
"@repo/configs": "^0.1.1",
|
|
40
|
+
"@scaleway/sdk-client": "^2.5.0"
|
|
40
41
|
},
|
|
41
42
|
"peerDependencies": {
|
|
42
|
-
"@scaleway/sdk-client": "^2.
|
|
43
|
+
"@scaleway/sdk-client": "^2.5.0"
|
|
43
44
|
},
|
|
44
45
|
"engines": {
|
|
45
46
|
"node": ">=20.20.2"
|
|
46
47
|
},
|
|
47
48
|
"scripts": {
|
|
48
49
|
"package:check": "pnpm publint",
|
|
49
|
-
"typecheck": "
|
|
50
|
-
"type:generate": "
|
|
50
|
+
"typecheck": "tsc --noEmit",
|
|
51
|
+
"type:generate": "tsc --declaration -p tsconfig.build.json",
|
|
51
52
|
"build": "vite build --config vite.config.ts && pnpm run type:generate",
|
|
52
53
|
"build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
|
|
53
54
|
}
|
package/dist/.vite/license.md
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
//#region \0rolldown/runtime.js
|
|
2
|
-
var __defProp = Object.defineProperty;
|
|
3
|
-
var __exportAll = (all, no_symbols) => {
|
|
4
|
-
let target = {};
|
|
5
|
-
for (var name in all) __defProp(target, name, {
|
|
6
|
-
get: all[name],
|
|
7
|
-
enumerable: true
|
|
8
|
-
});
|
|
9
|
-
if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
|
|
10
|
-
return target;
|
|
11
|
-
};
|
|
12
|
-
//#endregion
|
|
13
|
-
export { __exportAll };
|
package/dist/index.gen.d.ts
DELETED
package/dist/index.gen.js
DELETED
package/dist/metadata.gen.d.ts
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file is automatically generated
|
|
3
|
-
* PLEASE DO NOT EDIT HERE
|
|
4
|
-
*/
|
|
5
|
-
export declare const pkgMetadata: {
|
|
6
|
-
readonly name: "@scaleway/sdk-iot";
|
|
7
|
-
readonly namespace: "iot";
|
|
8
|
-
readonly displayName: "Iot";
|
|
9
|
-
readonly versions: readonly ["v1"];
|
|
10
|
-
};
|
|
11
|
-
export type Metadata = typeof pkgMetadata;
|
|
12
|
-
export default pkgMetadata;
|
package/dist/metadata.gen.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
//#region src/metadata.gen.ts
|
|
2
|
-
/**
|
|
3
|
-
* This file is automatically generated
|
|
4
|
-
* PLEASE DO NOT EDIT HERE
|
|
5
|
-
*/
|
|
6
|
-
const pkgMetadata = {
|
|
7
|
-
name: "@scaleway/sdk-iot",
|
|
8
|
-
namespace: "iot",
|
|
9
|
-
displayName: "Iot",
|
|
10
|
-
versions: ["v1"]
|
|
11
|
-
};
|
|
12
|
-
//#endregion
|
|
13
|
-
export { pkgMetadata as default, pkgMetadata };
|
package/dist/v1/api.gen.d.ts
DELETED
|
@@ -1,296 +0,0 @@
|
|
|
1
|
-
import { API as ParentAPI } from '@scaleway/sdk-client';
|
|
2
|
-
import type { WaitForOptions, ApiLocality } from '@scaleway/sdk-client';
|
|
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
|
-
/**
|
|
5
|
-
* IoT Hub API.
|
|
6
|
-
|
|
7
|
-
This API allows you to manage your IoT hubs and devices.
|
|
8
|
-
*/
|
|
9
|
-
export declare class API extends ParentAPI {
|
|
10
|
-
/**
|
|
11
|
-
* Locality of this API.
|
|
12
|
-
* type ∈ {'zone','region','global','unspecified'}
|
|
13
|
-
*/
|
|
14
|
-
static readonly LOCALITY: ApiLocality;
|
|
15
|
-
protected pageOfListHubs: (request?: Readonly<ListHubsRequest>) => Promise<ListHubsResponse>;
|
|
16
|
-
/**
|
|
17
|
-
* 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.
|
|
18
|
-
*
|
|
19
|
-
* @param request - The request {@link ListHubsRequest}
|
|
20
|
-
* @returns A Promise of ListHubsResponse
|
|
21
|
-
*/
|
|
22
|
-
listHubs: (request?: Readonly<ListHubsRequest>) => Promise<ListHubsResponse> & {
|
|
23
|
-
all: () => Promise<Hub[]>;
|
|
24
|
-
[Symbol.asyncIterator]: () => AsyncGenerator<Hub[], void, void>;
|
|
25
|
-
};
|
|
26
|
-
/**
|
|
27
|
-
* Create a hub. Create a new Hub in the targeted region, specifying its configuration including name and product plan.
|
|
28
|
-
*
|
|
29
|
-
* @param request - The request {@link CreateHubRequest}
|
|
30
|
-
* @returns A Promise of Hub
|
|
31
|
-
*/
|
|
32
|
-
createHub: (request: Readonly<CreateHubRequest>) => Promise<Hub>;
|
|
33
|
-
/**
|
|
34
|
-
* 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.
|
|
35
|
-
*
|
|
36
|
-
* @param request - The request {@link GetHubRequest}
|
|
37
|
-
* @returns A Promise of Hub
|
|
38
|
-
*/
|
|
39
|
-
getHub: (request: Readonly<GetHubRequest>) => Promise<Hub>;
|
|
40
|
-
/**
|
|
41
|
-
* Waits for {@link Hub} to be in a final state.
|
|
42
|
-
*
|
|
43
|
-
* @param request - The request {@link GetHubRequest}
|
|
44
|
-
* @param options - The waiting options
|
|
45
|
-
* @returns A Promise of Hub
|
|
46
|
-
*/
|
|
47
|
-
waitForHub: (request: Readonly<GetHubRequest>, options?: Readonly<WaitForOptions<Hub>>) => Promise<Hub>;
|
|
48
|
-
/**
|
|
49
|
-
* Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID.
|
|
50
|
-
*
|
|
51
|
-
* @param request - The request {@link UpdateHubRequest}
|
|
52
|
-
* @returns A Promise of Hub
|
|
53
|
-
*/
|
|
54
|
-
updateHub: (request: Readonly<UpdateHubRequest>) => Promise<Hub>;
|
|
55
|
-
/**
|
|
56
|
-
* Enable a hub. Enable an existing IoT Hub, specified by its Hub ID.
|
|
57
|
-
*
|
|
58
|
-
* @param request - The request {@link EnableHubRequest}
|
|
59
|
-
* @returns A Promise of Hub
|
|
60
|
-
*/
|
|
61
|
-
enableHub: (request: Readonly<EnableHubRequest>) => Promise<Hub>;
|
|
62
|
-
/**
|
|
63
|
-
* Disable a hub. Disable an existing IoT Hub, specified by its Hub ID.
|
|
64
|
-
*
|
|
65
|
-
* @param request - The request {@link DisableHubRequest}
|
|
66
|
-
* @returns A Promise of Hub
|
|
67
|
-
*/
|
|
68
|
-
disableHub: (request: Readonly<DisableHubRequest>) => Promise<Hub>;
|
|
69
|
-
/**
|
|
70
|
-
* Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone.
|
|
71
|
-
*
|
|
72
|
-
* @param request - The request {@link DeleteHubRequest}
|
|
73
|
-
*/
|
|
74
|
-
deleteHub: (request: Readonly<DeleteHubRequest>) => Promise<void>;
|
|
75
|
-
/**
|
|
76
|
-
* Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID.
|
|
77
|
-
*
|
|
78
|
-
* @deprecated
|
|
79
|
-
* @param request - The request {@link GetHubMetricsRequest}
|
|
80
|
-
* @returns A Promise of GetHubMetricsResponse
|
|
81
|
-
*/
|
|
82
|
-
getHubMetrics: (request: Readonly<GetHubMetricsRequest>) => Promise<GetHubMetricsResponse>;
|
|
83
|
-
/**
|
|
84
|
-
* Set the certificate authority of a hub. Set a particular PEM-encoded certificate, specified by the Hub ID.
|
|
85
|
-
*
|
|
86
|
-
* @param request - The request {@link SetHubCARequest}
|
|
87
|
-
* @returns A Promise of Hub
|
|
88
|
-
*/
|
|
89
|
-
setHubCA: (request: Readonly<SetHubCARequest>) => Promise<Hub>;
|
|
90
|
-
/**
|
|
91
|
-
* Get the certificate authority of a hub. Get information for a particular PEM-encoded certificate, specified by the Hub ID.
|
|
92
|
-
*
|
|
93
|
-
* @param request - The request {@link GetHubCARequest}
|
|
94
|
-
* @returns A Promise of GetHubCAResponse
|
|
95
|
-
*/
|
|
96
|
-
getHubCA: (request: Readonly<GetHubCARequest>) => Promise<GetHubCAResponse>;
|
|
97
|
-
protected pageOfListDevices: (request?: Readonly<ListDevicesRequest>) => Promise<ListDevicesResponse>;
|
|
98
|
-
/**
|
|
99
|
-
* 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.
|
|
100
|
-
*
|
|
101
|
-
* @param request - The request {@link ListDevicesRequest}
|
|
102
|
-
* @returns A Promise of ListDevicesResponse
|
|
103
|
-
*/
|
|
104
|
-
listDevices: (request?: Readonly<ListDevicesRequest>) => Promise<ListDevicesResponse> & {
|
|
105
|
-
all: () => Promise<Device[]>;
|
|
106
|
-
[Symbol.asyncIterator]: () => AsyncGenerator<Device[], void, void>;
|
|
107
|
-
};
|
|
108
|
-
/**
|
|
109
|
-
* Add a device. Attach a device to a given Hub.
|
|
110
|
-
*
|
|
111
|
-
* @param request - The request {@link CreateDeviceRequest}
|
|
112
|
-
* @returns A Promise of CreateDeviceResponse
|
|
113
|
-
*/
|
|
114
|
-
createDevice: (request: Readonly<CreateDeviceRequest>) => Promise<CreateDeviceResponse>;
|
|
115
|
-
/**
|
|
116
|
-
* 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.
|
|
117
|
-
*
|
|
118
|
-
* @param request - The request {@link GetDeviceRequest}
|
|
119
|
-
* @returns A Promise of Device
|
|
120
|
-
*/
|
|
121
|
-
getDevice: (request: Readonly<GetDeviceRequest>) => Promise<Device>;
|
|
122
|
-
/**
|
|
123
|
-
* Update a device. Update the parameters of an existing device, specified by its device ID.
|
|
124
|
-
*
|
|
125
|
-
* @param request - The request {@link UpdateDeviceRequest}
|
|
126
|
-
* @returns A Promise of Device
|
|
127
|
-
*/
|
|
128
|
-
updateDevice: (request: Readonly<UpdateDeviceRequest>) => Promise<Device>;
|
|
129
|
-
/**
|
|
130
|
-
* Enable a device. Enable a specific device, specified by its device ID.
|
|
131
|
-
*
|
|
132
|
-
* @param request - The request {@link EnableDeviceRequest}
|
|
133
|
-
* @returns A Promise of Device
|
|
134
|
-
*/
|
|
135
|
-
enableDevice: (request: Readonly<EnableDeviceRequest>) => Promise<Device>;
|
|
136
|
-
/**
|
|
137
|
-
* Disable a device. Disable an existing device, specified by its device ID.
|
|
138
|
-
*
|
|
139
|
-
* @param request - The request {@link DisableDeviceRequest}
|
|
140
|
-
* @returns A Promise of Device
|
|
141
|
-
*/
|
|
142
|
-
disableDevice: (request: Readonly<DisableDeviceRequest>) => Promise<Device>;
|
|
143
|
-
/**
|
|
144
|
-
* Renew a device certificate. Renew the certificate of an existing device, specified by its device ID.
|
|
145
|
-
*
|
|
146
|
-
* @param request - The request {@link RenewDeviceCertificateRequest}
|
|
147
|
-
* @returns A Promise of RenewDeviceCertificateResponse
|
|
148
|
-
*/
|
|
149
|
-
renewDeviceCertificate: (request: Readonly<RenewDeviceCertificateRequest>) => Promise<RenewDeviceCertificateResponse>;
|
|
150
|
-
/**
|
|
151
|
-
* Set a custom certificate on a device. Switch the existing certificate of a given device with an EM-encoded custom certificate.
|
|
152
|
-
*
|
|
153
|
-
* @param request - The request {@link SetDeviceCertificateRequest}
|
|
154
|
-
* @returns A Promise of SetDeviceCertificateResponse
|
|
155
|
-
*/
|
|
156
|
-
setDeviceCertificate: (request: Readonly<SetDeviceCertificateRequest>) => Promise<SetDeviceCertificateResponse>;
|
|
157
|
-
/**
|
|
158
|
-
* 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.
|
|
159
|
-
*
|
|
160
|
-
* @param request - The request {@link GetDeviceCertificateRequest}
|
|
161
|
-
* @returns A Promise of GetDeviceCertificateResponse
|
|
162
|
-
*/
|
|
163
|
-
getDeviceCertificate: (request: Readonly<GetDeviceCertificateRequest>) => Promise<GetDeviceCertificateResponse>;
|
|
164
|
-
/**
|
|
165
|
-
* Remove a device. Remove a specific device from the specific Hub it is attached to.
|
|
166
|
-
*
|
|
167
|
-
* @param request - The request {@link DeleteDeviceRequest}
|
|
168
|
-
*/
|
|
169
|
-
deleteDevice: (request: Readonly<DeleteDeviceRequest>) => Promise<void>;
|
|
170
|
-
/**
|
|
171
|
-
* Get a device's metrics. Get the metrics of an existing device, specified by its device ID.
|
|
172
|
-
*
|
|
173
|
-
* @deprecated
|
|
174
|
-
* @param request - The request {@link GetDeviceMetricsRequest}
|
|
175
|
-
* @returns A Promise of GetDeviceMetricsResponse
|
|
176
|
-
*/
|
|
177
|
-
getDeviceMetrics: (request: Readonly<GetDeviceMetricsRequest>) => Promise<GetDeviceMetricsResponse>;
|
|
178
|
-
protected pageOfListRoutes: (request?: Readonly<ListRoutesRequest>) => Promise<ListRoutesResponse>;
|
|
179
|
-
/**
|
|
180
|
-
* 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.
|
|
181
|
-
*
|
|
182
|
-
* @param request - The request {@link ListRoutesRequest}
|
|
183
|
-
* @returns A Promise of ListRoutesResponse
|
|
184
|
-
*/
|
|
185
|
-
listRoutes: (request?: Readonly<ListRoutesRequest>) => Promise<ListRoutesResponse> & {
|
|
186
|
-
all: () => Promise<import("./types.gen.js").RouteSummary[]>;
|
|
187
|
-
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").RouteSummary[], void, void>;
|
|
188
|
-
};
|
|
189
|
-
/**
|
|
190
|
-
* Create a route. Multiple kinds of routes can be created, such as:
|
|
191
|
-
- Database Route
|
|
192
|
-
Create a route that will record subscribed MQTT messages into your database.
|
|
193
|
-
<b>You need to manage the database by yourself</b>.
|
|
194
|
-
- REST Route.
|
|
195
|
-
Create a route that will call a REST API on received subscribed MQTT messages.
|
|
196
|
-
- Amazon S3 Routes.
|
|
197
|
-
Create a route that will put subscribed MQTT messages into an Object Storage bucket.
|
|
198
|
-
You need to create the bucket yourself and grant write access.
|
|
199
|
-
Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
|
|
200
|
-
*
|
|
201
|
-
* @param request - The request {@link CreateRouteRequest}
|
|
202
|
-
* @returns A Promise of Route
|
|
203
|
-
*/
|
|
204
|
-
createRoute: (request: Readonly<CreateRouteRequest>) => Promise<Route>;
|
|
205
|
-
/**
|
|
206
|
-
* Update a route. Update the parameters of an existing route, specified by its route ID.
|
|
207
|
-
*
|
|
208
|
-
* @param request - The request {@link UpdateRouteRequest}
|
|
209
|
-
* @returns A Promise of Route
|
|
210
|
-
*/
|
|
211
|
-
updateRoute: (request: Readonly<UpdateRouteRequest>) => Promise<Route>;
|
|
212
|
-
/**
|
|
213
|
-
* 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.
|
|
214
|
-
*
|
|
215
|
-
* @param request - The request {@link GetRouteRequest}
|
|
216
|
-
* @returns A Promise of Route
|
|
217
|
-
*/
|
|
218
|
-
getRoute: (request: Readonly<GetRouteRequest>) => Promise<Route>;
|
|
219
|
-
/**
|
|
220
|
-
* Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone.
|
|
221
|
-
*
|
|
222
|
-
* @param request - The request {@link DeleteRouteRequest}
|
|
223
|
-
*/
|
|
224
|
-
deleteRoute: (request: Readonly<DeleteRouteRequest>) => Promise<void>;
|
|
225
|
-
protected pageOfListNetworks: (request?: Readonly<ListNetworksRequest>) => Promise<ListNetworksResponse>;
|
|
226
|
-
/**
|
|
227
|
-
* List the networks.
|
|
228
|
-
*
|
|
229
|
-
* @param request - The request {@link ListNetworksRequest}
|
|
230
|
-
* @returns A Promise of ListNetworksResponse
|
|
231
|
-
*/
|
|
232
|
-
listNetworks: (request?: Readonly<ListNetworksRequest>) => Promise<ListNetworksResponse> & {
|
|
233
|
-
all: () => Promise<Network[]>;
|
|
234
|
-
[Symbol.asyncIterator]: () => AsyncGenerator<Network[], void, void>;
|
|
235
|
-
};
|
|
236
|
-
/**
|
|
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
|
-
*
|
|
239
|
-
* @param request - The request {@link CreateNetworkRequest}
|
|
240
|
-
* @returns A Promise of CreateNetworkResponse
|
|
241
|
-
*/
|
|
242
|
-
createNetwork: (request: Readonly<CreateNetworkRequest>) => Promise<CreateNetworkResponse>;
|
|
243
|
-
/**
|
|
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
|
-
*
|
|
246
|
-
* @param request - The request {@link GetNetworkRequest}
|
|
247
|
-
* @returns A Promise of Network
|
|
248
|
-
*/
|
|
249
|
-
getNetwork: (request: Readonly<GetNetworkRequest>) => Promise<Network>;
|
|
250
|
-
/**
|
|
251
|
-
* Delete a Network. Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone.
|
|
252
|
-
*
|
|
253
|
-
* @param request - The request {@link DeleteNetworkRequest}
|
|
254
|
-
*/
|
|
255
|
-
deleteNetwork: (request: Readonly<DeleteNetworkRequest>) => Promise<void>;
|
|
256
|
-
/**
|
|
257
|
-
* BETA - Get a Cloud Twin Document.
|
|
258
|
-
*
|
|
259
|
-
* @param request - The request {@link GetTwinDocumentRequest}
|
|
260
|
-
* @returns A Promise of TwinDocument
|
|
261
|
-
*/
|
|
262
|
-
getTwinDocument: (request: Readonly<GetTwinDocumentRequest>) => Promise<TwinDocument>;
|
|
263
|
-
/**
|
|
264
|
-
* BETA - Update a Cloud Twin Document.
|
|
265
|
-
*
|
|
266
|
-
* @param request - The request {@link PutTwinDocumentRequest}
|
|
267
|
-
* @returns A Promise of TwinDocument
|
|
268
|
-
*/
|
|
269
|
-
putTwinDocument: (request: Readonly<PutTwinDocumentRequest>) => Promise<TwinDocument>;
|
|
270
|
-
/**
|
|
271
|
-
* BETA - Patch a Cloud Twin Document.
|
|
272
|
-
*
|
|
273
|
-
* @param request - The request {@link PatchTwinDocumentRequest}
|
|
274
|
-
* @returns A Promise of TwinDocument
|
|
275
|
-
*/
|
|
276
|
-
patchTwinDocument: (request: Readonly<PatchTwinDocumentRequest>) => Promise<TwinDocument>;
|
|
277
|
-
/**
|
|
278
|
-
* BETA - Delete a Cloud Twin Document.
|
|
279
|
-
*
|
|
280
|
-
* @param request - The request {@link DeleteTwinDocumentRequest}
|
|
281
|
-
*/
|
|
282
|
-
deleteTwinDocument: (request: Readonly<DeleteTwinDocumentRequest>) => Promise<void>;
|
|
283
|
-
/**
|
|
284
|
-
* BETA - List the documents of a Cloud Twin.
|
|
285
|
-
*
|
|
286
|
-
* @param request - The request {@link ListTwinDocumentsRequest}
|
|
287
|
-
* @returns A Promise of ListTwinDocumentsResponse
|
|
288
|
-
*/
|
|
289
|
-
listTwinDocuments: (request: Readonly<ListTwinDocumentsRequest>) => Promise<ListTwinDocumentsResponse>;
|
|
290
|
-
/**
|
|
291
|
-
* BETA - Delete all the documents of a Cloud Twin.
|
|
292
|
-
*
|
|
293
|
-
* @param request - The request {@link DeleteTwinDocumentsRequest}
|
|
294
|
-
*/
|
|
295
|
-
deleteTwinDocuments: (request: Readonly<DeleteTwinDocumentsRequest>) => Promise<void>;
|
|
296
|
-
}
|