@blues-inc/notehub-js 4.0.0-beta.9 → 5.0.0
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/README.md +244 -248
- package/dist/ApiClient.js +150 -150
- package/dist/api/AlertApi.js +22 -22
- package/dist/api/AuthorizationApi.js +31 -31
- package/dist/api/BillingAccountApi.js +14 -14
- package/dist/api/DeviceApi.js +359 -359
- package/dist/api/EventApi.js +118 -118
- package/dist/api/ExternalDevicesApi.js +41 -41
- package/dist/api/MonitorApi.js +52 -52
- package/dist/api/ProjectApi.js +387 -381
- package/dist/api/RouteApi.js +83 -77
- package/dist/api/UsageApi.js +63 -63
- package/dist/api/WebhookApi.js +51 -51
- package/dist/index.js +7 -0
- package/dist/model/AddDeviceToFleetsRequest.js +8 -8
- package/dist/model/Alert.js +74 -76
- package/dist/model/AlertDataInner.js +36 -36
- package/dist/model/AlertNotificationsInner.js +18 -18
- package/dist/model/AwsRoute.js +65 -65
- package/dist/model/AzureRoute.js +43 -43
- package/dist/model/BillingAccount.js +21 -21
- package/dist/model/BillingAccountRole.js +9 -9
- package/dist/model/BlynkRoute.js +28 -28
- package/dist/model/Body.js +5 -5
- package/dist/model/CellularPlan.js +34 -34
- package/dist/model/CloneProjectRequest.js +20 -20
- package/dist/model/Contact.js +22 -22
- package/dist/model/CreateFleetRequest.js +20 -20
- package/dist/model/CreateMonitor.js +126 -127
- package/dist/model/CreateProductRequest.js +22 -22
- package/dist/model/CreateProjectRequest.js +16 -16
- package/dist/model/CreateUpdateRepository.js +17 -17
- package/dist/model/CurrentFirmware.js +12 -12
- package/dist/model/DFUEnv.js +12 -12
- package/dist/model/DFUState.js +65 -65
- package/dist/model/DataField.js +7 -7
- package/dist/model/DataSetField.js +19 -19
- package/dist/model/DataUsage.js +14 -14
- package/dist/model/DatacakeRoute.js +35 -35
- package/dist/model/DeleteDeviceFromFleetsRequest.js +8 -8
- package/dist/model/DeleteNotefilesRequest.js +7 -7
- package/dist/model/Device.js +106 -107
- package/dist/model/DeviceDfuHistory.js +19 -20
- package/dist/model/DeviceDfuHistoryCurrent.js +32 -32
- package/dist/model/DeviceDfuHistoryPage.js +12 -13
- package/dist/model/DeviceDfuStateMachine.js +24 -25
- package/dist/model/DeviceDfuStateMachineNode.js +22 -22
- package/dist/model/DeviceDfuStatus.js +20 -20
- package/dist/model/DeviceDfuStatusPage.js +12 -13
- package/dist/model/DeviceSession.js +221 -221
- package/dist/model/DeviceTowerInfo.js +14 -14
- package/dist/model/DeviceUsage.js +32 -32
- package/dist/model/DfuActionRequest.js +7 -7
- package/dist/model/EmailNotification.js +7 -7
- package/dist/model/EnvTreeJsonNode.js +67 -69
- package/dist/model/EnvVar.js +18 -18
- package/dist/model/EnvironmentVariables.js +8 -8
- package/dist/model/Error.js +31 -31
- package/dist/model/Event.js +248 -248
- package/dist/model/Filter.js +16 -16
- package/dist/model/Firmware.js +49 -49
- package/dist/model/FirmwareInfo.js +60 -60
- package/dist/model/Fleet.js +38 -38
- package/dist/model/FleetConnectivityAssurance.js +5 -5
- package/dist/model/GetAlerts200Response.js +14 -15
- package/dist/model/GetBillingAccounts200Response.js +9 -10
- package/dist/model/GetDataUsage200Response.js +9 -10
- package/dist/model/GetDataUsage200ResponseDataInner.js +43 -57
- package/dist/model/GetDbNote200Response.js +13 -13
- package/dist/model/GetDeviceEnvironmentVariablesByPin200Response.js +16 -16
- package/dist/model/GetDeviceFleets200Response.js +11 -12
- package/dist/model/GetDeviceHealthLog200Response.js +11 -12
- package/dist/model/GetDeviceHealthLog200ResponseHealthLogInner.js +19 -19
- package/dist/model/GetDeviceLatestEvents200Response.js +9 -10
- package/dist/model/GetDevicePlans200Response.js +9 -40
- package/dist/model/GetDevicePublicKey200Response.js +16 -16
- package/dist/model/GetDevicePublicKeys200Response.js +16 -17
- package/dist/model/GetDevicePublicKeys200ResponseDevicePublicKeysInner.js +12 -12
- package/dist/model/GetDeviceSessions200Response.js +16 -17
- package/dist/model/GetDevices200Response.js +16 -17
- package/dist/model/GetEvents200Response.js +20 -21
- package/dist/model/GetEventsByCursor200Response.js +23 -24
- package/dist/model/GetNotefile200Response.js +11 -11
- package/dist/model/GetProducts200Response.js +9 -10
- package/dist/model/GetProjectMembers200Response.js +11 -12
- package/dist/model/GetProjects200Response.js +9 -10
- package/dist/model/GetRouteLogsUsage200Response.js +11 -12
- package/dist/model/GetSessionsUsage200Response.js +11 -12
- package/dist/model/GetWebhooks200Response.js +9 -10
- package/dist/model/GoogleRoute.js +33 -33
- package/dist/model/HttpRoute.js +35 -35
- package/dist/model/Location.js +40 -40
- package/dist/model/Login200Response.js +7 -7
- package/dist/model/LoginRequest.js +12 -12
- package/dist/model/Monitor.js +100 -101
- package/dist/model/MonitorAlertRoutesInner.js +10 -9
- package/dist/model/MqttRoute.js +68 -68
- package/dist/model/Note.js +31 -31
- package/dist/model/NoteInput.js +9 -9
- package/dist/model/Notefile.js +22 -23
- package/dist/model/NotefileSchema.js +18 -19
- package/dist/model/NotehubRoute.js +103 -103
- package/dist/model/NotehubRouteSummary.js +23 -23
- package/dist/model/OAuth2Error.js +20 -20
- package/dist/model/OAuth2TokenResponse.js +23 -23
- package/dist/model/PersonalAccessToken.js +34 -34
- package/dist/model/PersonalAccessTokenCreatedBy.js +17 -17
- package/dist/model/PersonalAccessTokenInfo.js +18 -18
- package/dist/model/PersonalAccessTokenSecret.js +12 -12
- package/dist/model/Product.js +26 -26
- package/dist/model/Project.js +34 -34
- package/dist/model/ProjectMember.js +22 -22
- package/dist/model/ProvisionDeviceRequest.js +18 -18
- package/dist/model/ProxyRoute.js +29 -29
- package/dist/model/QubitroRoute.js +33 -33
- package/dist/model/RadRoute.js +31 -31
- package/dist/model/Repository.js +22 -22
- package/dist/model/Role.js +9 -9
- package/dist/model/RouteLog.js +38 -38
- package/dist/model/RouteTransformSettings.js +18 -18
- package/dist/model/S3ArchiveRoute.js +79 -79
- package/dist/model/SatelliteDataUsage.js +144 -0
- package/dist/model/SatellitePlan.js +39 -39
- package/dist/model/SchemaProperty.js +36 -38
- package/dist/model/SignalDevice200Response.js +5 -5
- package/dist/model/SimUsage.js +19 -19
- package/dist/model/SlackBearerNotification.js +25 -25
- package/dist/model/SlackRoute.js +48 -48
- package/dist/model/SlackWebHookNotification.js +20 -20
- package/dist/model/SnowflakeRoute.js +45 -45
- package/dist/model/SnowpipeStreamingRoute.js +60 -60
- package/dist/model/ThingworxRoute.js +33 -33
- package/dist/model/TowerLocation.js +54 -54
- package/dist/model/TwilioRoute.js +43 -43
- package/dist/model/UpdateFleetRequest.js +33 -33
- package/dist/model/UploadMetadata.js +64 -64
- package/dist/model/UsageData.js +33 -33
- package/dist/model/UsageEventsData.js +37 -37
- package/dist/model/UsageEventsResponse.js +11 -12
- package/dist/model/UsageRouteLogsData.js +27 -27
- package/dist/model/UsageSessionsData.js +32 -32
- package/dist/model/UserDfuStateMachine.js +20 -20
- package/dist/model/UserDfuStateMachineStatus.js +20 -20
- package/dist/model/UserFirmwareInfo.js +12 -12
- package/dist/model/WebhookSettings.js +15 -15
- package/package.json +3 -3
package/dist/api/RouteApi.js
CHANGED
|
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
17
17
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
18
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
19
19
|
* Notehub API
|
|
20
|
-
* The OpenAPI definition for the Notehub.io API.
|
|
20
|
+
* The OpenAPI definition for the Notehub.io API.
|
|
21
21
|
*
|
|
22
22
|
* The version of the OpenAPI document: 1.2.0
|
|
23
23
|
* Contact: engineering@blues.io
|
|
@@ -28,18 +28,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
/**
|
|
31
|
-
* Route service.
|
|
32
|
-
* @module api/RouteApi
|
|
33
|
-
* @version
|
|
34
|
-
*/
|
|
31
|
+
* Route service.
|
|
32
|
+
* @module api/RouteApi
|
|
33
|
+
* @version 5.0.0
|
|
34
|
+
*/
|
|
35
35
|
var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
37
|
+
* Constructs a new RouteApi.
|
|
38
|
+
* @alias module:api/RouteApi
|
|
39
|
+
* @class
|
|
40
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
41
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
42
|
+
*/
|
|
43
43
|
function RouteApi(apiClient) {
|
|
44
44
|
_classCallCheck(this, RouteApi);
|
|
45
45
|
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
@@ -47,7 +47,7 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Create Route within a Project
|
|
50
|
-
* @param {String} projectOrProductUID
|
|
50
|
+
* @param {String} projectOrProductUID
|
|
51
51
|
* @param {module:model/NotehubRoute} notehubRoute Route to be created
|
|
52
52
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
|
|
53
53
|
*/
|
|
@@ -64,21 +64,21 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
64
64
|
throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling createRoute");
|
|
65
65
|
}
|
|
66
66
|
var pathParams = {
|
|
67
|
-
|
|
67
|
+
projectOrProductUID: projectOrProductUID
|
|
68
68
|
};
|
|
69
69
|
var queryParams = {};
|
|
70
70
|
var headerParams = {};
|
|
71
71
|
var formParams = {};
|
|
72
|
-
var authNames = [
|
|
73
|
-
var contentTypes = [
|
|
74
|
-
var accepts = [
|
|
72
|
+
var authNames = ["personalAccessToken"];
|
|
73
|
+
var contentTypes = ["application/json"];
|
|
74
|
+
var accepts = ["application/json"];
|
|
75
75
|
var returnType = _NotehubRoute["default"];
|
|
76
|
-
return this.apiClient.callApi(
|
|
76
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
77
77
|
}
|
|
78
78
|
|
|
79
79
|
/**
|
|
80
80
|
* Create Route within a Project
|
|
81
|
-
* @param {String} projectOrProductUID
|
|
81
|
+
* @param {String} projectOrProductUID
|
|
82
82
|
* @param {module:model/NotehubRoute} notehubRoute Route to be created
|
|
83
83
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
|
|
84
84
|
*/
|
|
@@ -92,8 +92,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
92
92
|
|
|
93
93
|
/**
|
|
94
94
|
* Delete single route within a project
|
|
95
|
-
* @param {String} projectOrProductUID
|
|
96
|
-
* @param {String} routeUID
|
|
95
|
+
* @param {String} projectOrProductUID
|
|
96
|
+
* @param {String} routeUID
|
|
97
97
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
98
98
|
*/
|
|
99
99
|
}, {
|
|
@@ -109,23 +109,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
109
109
|
throw new _Error["default"]("Missing the required parameter 'routeUID' when calling deleteRoute");
|
|
110
110
|
}
|
|
111
111
|
var pathParams = {
|
|
112
|
-
|
|
113
|
-
|
|
112
|
+
projectOrProductUID: projectOrProductUID,
|
|
113
|
+
routeUID: routeUID
|
|
114
114
|
};
|
|
115
115
|
var queryParams = {};
|
|
116
116
|
var headerParams = {};
|
|
117
117
|
var formParams = {};
|
|
118
|
-
var authNames = [
|
|
118
|
+
var authNames = ["personalAccessToken"];
|
|
119
119
|
var contentTypes = [];
|
|
120
|
-
var accepts = [
|
|
120
|
+
var accepts = ["application/json"];
|
|
121
121
|
var returnType = null;
|
|
122
|
-
return this.apiClient.callApi(
|
|
122
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "DELETE", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
123
123
|
}
|
|
124
124
|
|
|
125
125
|
/**
|
|
126
126
|
* Delete single route within a project
|
|
127
|
-
* @param {String} projectOrProductUID
|
|
128
|
-
* @param {String} routeUID
|
|
127
|
+
* @param {String} projectOrProductUID
|
|
128
|
+
* @param {String} routeUID
|
|
129
129
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
130
130
|
*/
|
|
131
131
|
}, {
|
|
@@ -138,8 +138,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
140
|
* Get single route within a project
|
|
141
|
-
* @param {String} projectOrProductUID
|
|
142
|
-
* @param {String} routeUID
|
|
141
|
+
* @param {String} projectOrProductUID
|
|
142
|
+
* @param {String} routeUID
|
|
143
143
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
|
|
144
144
|
*/
|
|
145
145
|
}, {
|
|
@@ -155,23 +155,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
155
155
|
throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRoute");
|
|
156
156
|
}
|
|
157
157
|
var pathParams = {
|
|
158
|
-
|
|
159
|
-
|
|
158
|
+
projectOrProductUID: projectOrProductUID,
|
|
159
|
+
routeUID: routeUID
|
|
160
160
|
};
|
|
161
161
|
var queryParams = {};
|
|
162
162
|
var headerParams = {};
|
|
163
163
|
var formParams = {};
|
|
164
|
-
var authNames = [
|
|
164
|
+
var authNames = ["personalAccessToken"];
|
|
165
165
|
var contentTypes = [];
|
|
166
|
-
var accepts = [
|
|
166
|
+
var accepts = ["application/json"];
|
|
167
167
|
var returnType = _NotehubRoute["default"];
|
|
168
|
-
return this.apiClient.callApi(
|
|
168
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
169
169
|
}
|
|
170
170
|
|
|
171
171
|
/**
|
|
172
172
|
* Get single route within a project
|
|
173
|
-
* @param {String} projectOrProductUID
|
|
174
|
-
* @param {String} routeUID
|
|
173
|
+
* @param {String} projectOrProductUID
|
|
174
|
+
* @param {String} routeUID
|
|
175
175
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
|
|
176
176
|
*/
|
|
177
177
|
}, {
|
|
@@ -184,8 +184,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
186
|
* Get Route Logs by Route UID
|
|
187
|
-
* @param {String} projectOrProductUID
|
|
188
|
-
* @param {String} routeUID
|
|
187
|
+
* @param {String} projectOrProductUID
|
|
188
|
+
* @param {String} routeUID
|
|
189
189
|
* @param {Object} opts Optional parameters
|
|
190
190
|
* @param {Number} opts.pageSize (default to 50)
|
|
191
191
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -194,9 +194,11 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
194
194
|
* @param {module:model/String} opts.sortOrder (default to 'desc')
|
|
195
195
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
196
196
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
197
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
198
|
-
* @param {Boolean} opts.mostRecentOnly
|
|
199
|
-
* @param {String} opts.files
|
|
197
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
198
|
+
* @param {Boolean} opts.mostRecentOnly
|
|
199
|
+
* @param {String} opts.files
|
|
200
|
+
* @param {Array.<module:model/String>} opts.routingStatus
|
|
201
|
+
* @param {Array.<String>} opts.responseStatus
|
|
200
202
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/RouteLog>} and HTTP response
|
|
201
203
|
*/
|
|
202
204
|
}, {
|
|
@@ -213,34 +215,36 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
213
215
|
throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRouteLogsByRoute");
|
|
214
216
|
}
|
|
215
217
|
var pathParams = {
|
|
216
|
-
|
|
217
|
-
|
|
218
|
+
projectOrProductUID: projectOrProductUID,
|
|
219
|
+
routeUID: routeUID
|
|
218
220
|
};
|
|
219
221
|
var queryParams = {
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
222
|
+
pageSize: opts["pageSize"],
|
|
223
|
+
pageNum: opts["pageNum"],
|
|
224
|
+
deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
|
|
225
|
+
sortBy: opts["sortBy"],
|
|
226
|
+
sortOrder: opts["sortOrder"],
|
|
227
|
+
startDate: opts["startDate"],
|
|
228
|
+
endDate: opts["endDate"],
|
|
229
|
+
systemFilesOnly: opts["systemFilesOnly"],
|
|
230
|
+
mostRecentOnly: opts["mostRecentOnly"],
|
|
231
|
+
files: opts["files"],
|
|
232
|
+
routingStatus: this.apiClient.buildCollectionParam(opts["routingStatus"], "multi"),
|
|
233
|
+
responseStatus: this.apiClient.buildCollectionParam(opts["responseStatus"], "multi")
|
|
230
234
|
};
|
|
231
235
|
var headerParams = {};
|
|
232
236
|
var formParams = {};
|
|
233
|
-
var authNames = [
|
|
237
|
+
var authNames = ["personalAccessToken"];
|
|
234
238
|
var contentTypes = [];
|
|
235
|
-
var accepts = [
|
|
239
|
+
var accepts = ["application/json"];
|
|
236
240
|
var returnType = [_RouteLog["default"]];
|
|
237
|
-
return this.apiClient.callApi(
|
|
241
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
238
242
|
}
|
|
239
243
|
|
|
240
244
|
/**
|
|
241
245
|
* Get Route Logs by Route UID
|
|
242
|
-
* @param {String} projectOrProductUID
|
|
243
|
-
* @param {String} routeUID
|
|
246
|
+
* @param {String} projectOrProductUID
|
|
247
|
+
* @param {String} routeUID
|
|
244
248
|
* @param {Object} opts Optional parameters
|
|
245
249
|
* @param {Number} opts.pageSize (default to 50)
|
|
246
250
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -249,9 +253,11 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
249
253
|
* @param {module:model/String} opts.sortOrder (default to 'desc')
|
|
250
254
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
251
255
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
252
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
253
|
-
* @param {Boolean} opts.mostRecentOnly
|
|
254
|
-
* @param {String} opts.files
|
|
256
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
257
|
+
* @param {Boolean} opts.mostRecentOnly
|
|
258
|
+
* @param {String} opts.files
|
|
259
|
+
* @param {Array.<module:model/String>} opts.routingStatus
|
|
260
|
+
* @param {Array.<String>} opts.responseStatus
|
|
255
261
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/RouteLog>}
|
|
256
262
|
*/
|
|
257
263
|
}, {
|
|
@@ -264,7 +270,7 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
264
270
|
|
|
265
271
|
/**
|
|
266
272
|
* Get all Routes within a Project
|
|
267
|
-
* @param {String} projectOrProductUID
|
|
273
|
+
* @param {String} projectOrProductUID
|
|
268
274
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/NotehubRouteSummary>} and HTTP response
|
|
269
275
|
*/
|
|
270
276
|
}, {
|
|
@@ -276,21 +282,21 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
276
282
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getRoutes");
|
|
277
283
|
}
|
|
278
284
|
var pathParams = {
|
|
279
|
-
|
|
285
|
+
projectOrProductUID: projectOrProductUID
|
|
280
286
|
};
|
|
281
287
|
var queryParams = {};
|
|
282
288
|
var headerParams = {};
|
|
283
289
|
var formParams = {};
|
|
284
|
-
var authNames = [
|
|
290
|
+
var authNames = ["personalAccessToken"];
|
|
285
291
|
var contentTypes = [];
|
|
286
|
-
var accepts = [
|
|
292
|
+
var accepts = ["application/json"];
|
|
287
293
|
var returnType = [_NotehubRouteSummary["default"]];
|
|
288
|
-
return this.apiClient.callApi(
|
|
294
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
289
295
|
}
|
|
290
296
|
|
|
291
297
|
/**
|
|
292
298
|
* Get all Routes within a Project
|
|
293
|
-
* @param {String} projectOrProductUID
|
|
299
|
+
* @param {String} projectOrProductUID
|
|
294
300
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/NotehubRouteSummary>}
|
|
295
301
|
*/
|
|
296
302
|
}, {
|
|
@@ -303,8 +309,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
303
309
|
|
|
304
310
|
/**
|
|
305
311
|
* Update route by UID
|
|
306
|
-
* @param {String} projectOrProductUID
|
|
307
|
-
* @param {String} routeUID
|
|
312
|
+
* @param {String} projectOrProductUID
|
|
313
|
+
* @param {String} routeUID
|
|
308
314
|
* @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
|
|
309
315
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
|
|
310
316
|
*/
|
|
@@ -325,23 +331,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
325
331
|
throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling updateRoute");
|
|
326
332
|
}
|
|
327
333
|
var pathParams = {
|
|
328
|
-
|
|
329
|
-
|
|
334
|
+
projectOrProductUID: projectOrProductUID,
|
|
335
|
+
routeUID: routeUID
|
|
330
336
|
};
|
|
331
337
|
var queryParams = {};
|
|
332
338
|
var headerParams = {};
|
|
333
339
|
var formParams = {};
|
|
334
|
-
var authNames = [
|
|
335
|
-
var contentTypes = [
|
|
336
|
-
var accepts = [
|
|
340
|
+
var authNames = ["personalAccessToken"];
|
|
341
|
+
var contentTypes = ["application/json"];
|
|
342
|
+
var accepts = ["application/json"];
|
|
337
343
|
var returnType = _NotehubRoute["default"];
|
|
338
|
-
return this.apiClient.callApi(
|
|
344
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "PUT", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
339
345
|
}
|
|
340
346
|
|
|
341
347
|
/**
|
|
342
348
|
* Update route by UID
|
|
343
|
-
* @param {String} projectOrProductUID
|
|
344
|
-
* @param {String} routeUID
|
|
349
|
+
* @param {String} projectOrProductUID
|
|
350
|
+
* @param {String} routeUID
|
|
345
351
|
* @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
|
|
346
352
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
|
|
347
353
|
*/
|
package/dist/api/UsageApi.js
CHANGED
|
@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
18
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
19
|
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
20
20
|
* Notehub API
|
|
21
|
-
* The OpenAPI definition for the Notehub.io API.
|
|
21
|
+
* The OpenAPI definition for the Notehub.io API.
|
|
22
22
|
*
|
|
23
23
|
* The version of the OpenAPI document: 1.2.0
|
|
24
24
|
* Contact: engineering@blues.io
|
|
@@ -29,18 +29,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
/**
|
|
32
|
-
* Usage service.
|
|
33
|
-
* @module api/UsageApi
|
|
34
|
-
* @version
|
|
35
|
-
*/
|
|
32
|
+
* Usage service.
|
|
33
|
+
* @module api/UsageApi
|
|
34
|
+
* @version 5.0.0
|
|
35
|
+
*/
|
|
36
36
|
var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
38
|
+
* Constructs a new UsageApi.
|
|
39
|
+
* @alias module:api/UsageApi
|
|
40
|
+
* @class
|
|
41
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
42
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
43
|
+
*/
|
|
44
44
|
function UsageApi(apiClient) {
|
|
45
45
|
_classCallCheck(this, UsageApi);
|
|
46
46
|
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
@@ -48,7 +48,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
50
|
* Get data usage in bytes for a project with time range and period aggregation
|
|
51
|
-
* @param {String} projectOrProductUID
|
|
51
|
+
* @param {String} projectOrProductUID
|
|
52
52
|
* @param {module:model/String} period Period type for aggregation
|
|
53
53
|
* @param {Object} opts Optional parameters
|
|
54
54
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -72,28 +72,28 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
72
72
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getDataUsage");
|
|
73
73
|
}
|
|
74
74
|
var pathParams = {
|
|
75
|
-
|
|
75
|
+
projectOrProductUID: projectOrProductUID
|
|
76
76
|
};
|
|
77
77
|
var queryParams = {
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
78
|
+
startDate: opts["startDate"],
|
|
79
|
+
endDate: opts["endDate"],
|
|
80
|
+
deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
|
|
81
|
+
fleetUID: this.apiClient.buildCollectionParam(opts["fleetUID"], "multi"),
|
|
82
|
+
period: period,
|
|
83
|
+
aggregate: opts["aggregate"]
|
|
84
84
|
};
|
|
85
85
|
var headerParams = {};
|
|
86
86
|
var formParams = {};
|
|
87
|
-
var authNames = [
|
|
87
|
+
var authNames = ["personalAccessToken"];
|
|
88
88
|
var contentTypes = [];
|
|
89
|
-
var accepts = [
|
|
89
|
+
var accepts = ["application/json"];
|
|
90
90
|
var returnType = _GetDataUsage200Response["default"];
|
|
91
|
-
return this.apiClient.callApi(
|
|
91
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/data", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
92
92
|
}
|
|
93
93
|
|
|
94
94
|
/**
|
|
95
95
|
* Get data usage in bytes for a project with time range and period aggregation
|
|
96
|
-
* @param {String} projectOrProductUID
|
|
96
|
+
* @param {String} projectOrProductUID
|
|
97
97
|
* @param {module:model/String} period Period type for aggregation
|
|
98
98
|
* @param {Object} opts Optional parameters
|
|
99
99
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -113,7 +113,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
113
113
|
|
|
114
114
|
/**
|
|
115
115
|
* Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
116
|
-
* @param {String} projectOrProductUID
|
|
116
|
+
* @param {String} projectOrProductUID
|
|
117
117
|
* @param {module:model/String} period Period type for aggregation
|
|
118
118
|
* @param {Object} opts Optional parameters
|
|
119
119
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -140,31 +140,31 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
140
140
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getEventsUsage");
|
|
141
141
|
}
|
|
142
142
|
var pathParams = {
|
|
143
|
-
|
|
143
|
+
projectOrProductUID: projectOrProductUID
|
|
144
144
|
};
|
|
145
145
|
var queryParams = {
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
146
|
+
startDate: opts["startDate"],
|
|
147
|
+
endDate: opts["endDate"],
|
|
148
|
+
deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
|
|
149
|
+
fleetUID: this.apiClient.buildCollectionParam(opts["fleetUID"], "multi"),
|
|
150
|
+
period: period,
|
|
151
|
+
aggregate: opts["aggregate"],
|
|
152
|
+
notefile: this.apiClient.buildCollectionParam(opts["notefile"], "multi"),
|
|
153
|
+
skipRecentData: opts["skipRecentData"],
|
|
154
|
+
includeNotefiles: opts["includeNotefiles"]
|
|
155
155
|
};
|
|
156
156
|
var headerParams = {};
|
|
157
157
|
var formParams = {};
|
|
158
|
-
var authNames = [
|
|
158
|
+
var authNames = ["personalAccessToken"];
|
|
159
159
|
var contentTypes = [];
|
|
160
|
-
var accepts = [
|
|
160
|
+
var accepts = ["application/json"];
|
|
161
161
|
var returnType = _UsageEventsResponse["default"];
|
|
162
|
-
return this.apiClient.callApi(
|
|
162
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/events", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
163
163
|
}
|
|
164
164
|
|
|
165
165
|
/**
|
|
166
166
|
* Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
167
|
-
* @param {String} projectOrProductUID
|
|
167
|
+
* @param {String} projectOrProductUID
|
|
168
168
|
* @param {module:model/String} period Period type for aggregation
|
|
169
169
|
* @param {Object} opts Optional parameters
|
|
170
170
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -187,7 +187,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
189
|
* Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
190
|
-
* @param {String} projectOrProductUID
|
|
190
|
+
* @param {String} projectOrProductUID
|
|
191
191
|
* @param {module:model/String} period Period type for aggregation
|
|
192
192
|
* @param {Object} opts Optional parameters
|
|
193
193
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -211,28 +211,28 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
211
211
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getRouteLogsUsage");
|
|
212
212
|
}
|
|
213
213
|
var pathParams = {
|
|
214
|
-
|
|
214
|
+
projectOrProductUID: projectOrProductUID
|
|
215
215
|
};
|
|
216
216
|
var queryParams = {
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
217
|
+
startDate: opts["startDate"],
|
|
218
|
+
endDate: opts["endDate"],
|
|
219
|
+
routeUID: this.apiClient.buildCollectionParam(opts["routeUID"], "multi"),
|
|
220
|
+
period: period,
|
|
221
|
+
aggregate: opts["aggregate"],
|
|
222
|
+
skipRecentData: opts["skipRecentData"]
|
|
223
223
|
};
|
|
224
224
|
var headerParams = {};
|
|
225
225
|
var formParams = {};
|
|
226
|
-
var authNames = [
|
|
226
|
+
var authNames = ["personalAccessToken"];
|
|
227
227
|
var contentTypes = [];
|
|
228
|
-
var accepts = [
|
|
228
|
+
var accepts = ["application/json"];
|
|
229
229
|
var returnType = _GetRouteLogsUsage200Response["default"];
|
|
230
|
-
return this.apiClient.callApi(
|
|
230
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/route-logs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
231
231
|
}
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
234
|
* Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
235
|
-
* @param {String} projectOrProductUID
|
|
235
|
+
* @param {String} projectOrProductUID
|
|
236
236
|
* @param {module:model/String} period Period type for aggregation
|
|
237
237
|
* @param {Object} opts Optional parameters
|
|
238
238
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -252,7 +252,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
252
252
|
|
|
253
253
|
/**
|
|
254
254
|
* Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
255
|
-
* @param {String} projectOrProductUID
|
|
255
|
+
* @param {String} projectOrProductUID
|
|
256
256
|
* @param {module:model/String} period Period type for aggregation
|
|
257
257
|
* @param {Object} opts Optional parameters
|
|
258
258
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -277,29 +277,29 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
277
277
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getSessionsUsage");
|
|
278
278
|
}
|
|
279
279
|
var pathParams = {
|
|
280
|
-
|
|
280
|
+
projectOrProductUID: projectOrProductUID
|
|
281
281
|
};
|
|
282
282
|
var queryParams = {
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
283
|
+
startDate: opts["startDate"],
|
|
284
|
+
endDate: opts["endDate"],
|
|
285
|
+
deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
|
|
286
|
+
fleetUID: this.apiClient.buildCollectionParam(opts["fleetUID"], "multi"),
|
|
287
|
+
period: period,
|
|
288
|
+
aggregate: opts["aggregate"],
|
|
289
|
+
skipRecentData: opts["skipRecentData"]
|
|
290
290
|
};
|
|
291
291
|
var headerParams = {};
|
|
292
292
|
var formParams = {};
|
|
293
|
-
var authNames = [
|
|
293
|
+
var authNames = ["personalAccessToken"];
|
|
294
294
|
var contentTypes = [];
|
|
295
|
-
var accepts = [
|
|
295
|
+
var accepts = ["application/json"];
|
|
296
296
|
var returnType = _GetSessionsUsage200Response["default"];
|
|
297
|
-
return this.apiClient.callApi(
|
|
297
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/sessions", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
298
298
|
}
|
|
299
299
|
|
|
300
300
|
/**
|
|
301
301
|
* Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
302
|
-
* @param {String} projectOrProductUID
|
|
302
|
+
* @param {String} projectOrProductUID
|
|
303
303
|
* @param {module:model/String} period Period type for aggregation
|
|
304
304
|
* @param {Object} opts Optional parameters
|
|
305
305
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|