@blues-inc/notehub-js 6.2.0-beta.2 → 6.2.0-beta.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/README.md +285 -293
- 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 +30 -30
- package/dist/api/DeviceApi.js +354 -354
- package/dist/api/EventApi.js +118 -118
- package/dist/api/ExternalDevicesApi.js +41 -41
- package/dist/api/JobsApi.js +127 -74
- package/dist/api/MonitorApi.js +52 -52
- package/dist/api/ProjectApi.js +403 -702
- package/dist/api/RouteApi.js +83 -83
- package/dist/api/UsageApi.js +67 -67
- package/dist/api/WebhookApi.js +51 -51
- package/dist/index.js +0 -35
- package/dist/model/AWSRoleConfig.js +14 -14
- package/dist/model/AddDeviceToFleetsRequest.js +8 -8
- package/dist/model/Alert.js +76 -74
- package/dist/model/AlertDataInner.js +36 -36
- package/dist/model/AlertNotificationsInner.js +18 -18
- package/dist/model/AwsRoute.js +70 -70
- 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/CancelJobRun200Response.js +6 -6
- 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/CreateJob201Response.js +8 -8
- package/dist/model/CreateMonitor.js +128 -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/DeleteJob200Response.js +6 -6
- package/dist/model/DeleteNotefilesRequest.js +7 -7
- package/dist/model/Device.js +107 -106
- package/dist/model/DeviceDfuHistory.js +20 -19
- package/dist/model/DeviceDfuHistoryCurrent.js +32 -32
- package/dist/model/DeviceDfuHistoryPage.js +13 -12
- package/dist/model/DeviceDfuStateMachine.js +25 -24
- package/dist/model/DeviceDfuStateMachineNode.js +22 -22
- package/dist/model/DeviceDfuStatus.js +20 -20
- package/dist/model/DeviceDfuStatusPage.js +13 -12
- 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 +69 -67
- 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 +68 -68
- package/dist/model/Fleet.js +38 -38
- package/dist/model/FleetConnectivityAssurance.js +5 -5
- package/dist/model/GetAlerts200Response.js +15 -14
- package/dist/model/GetBillingAccount200Response.js +25 -25
- package/dist/model/GetBillingAccount200ResponsePlan.js +22 -22
- package/dist/model/GetBillingAccountBalanceHistory200Response.js +10 -9
- package/dist/model/GetBillingAccountBalanceHistory200ResponseDataInner.js +17 -17
- package/dist/model/GetBillingAccounts200Response.js +10 -9
- package/dist/model/GetDataUsage200Response.js +13 -12
- package/dist/model/GetDataUsage200ResponseDataInner.js +44 -43
- package/dist/model/GetDbNote200Response.js +13 -13
- package/dist/model/GetDeviceEnvironmentVariablesByPin200Response.js +16 -16
- package/dist/model/GetDeviceFleets200Response.js +12 -11
- package/dist/model/GetDeviceHealthLog200Response.js +12 -11
- package/dist/model/GetDeviceHealthLog200ResponseHealthLogInner.js +19 -19
- package/dist/model/GetDeviceLatestEvents200Response.js +10 -9
- package/dist/model/GetDevicePlans200Response.js +10 -9
- package/dist/model/GetDevicePublicKey200Response.js +16 -16
- package/dist/model/GetDevicePublicKeys200Response.js +17 -16
- package/dist/model/GetDevicePublicKeys200ResponseDevicePublicKeysInner.js +12 -12
- package/dist/model/GetDeviceSessions200Response.js +17 -16
- package/dist/model/GetDevices200Response.js +17 -16
- package/dist/model/GetEvents200Response.js +21 -20
- package/dist/model/GetEventsByCursor200Response.js +24 -23
- package/dist/model/GetJobRuns200Response.js +12 -11
- package/dist/model/GetJobs200Response.js +12 -11
- package/dist/model/GetNotefile200Response.js +11 -11
- package/dist/model/GetProducts200Response.js +10 -9
- package/dist/model/GetProjectMembers200Response.js +12 -11
- package/dist/model/GetProjects200Response.js +10 -9
- package/dist/model/GetRouteLogsUsage200Response.js +15 -14
- package/dist/model/GetSessionsUsage200Response.js +16 -15
- package/dist/model/GetWebhooks200Response.js +10 -9
- package/dist/model/GoogleRoute.js +33 -33
- package/dist/model/HttpRoute.js +35 -35
- package/dist/model/Job.js +50 -28
- package/dist/model/JobRun.js +57 -57
- 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 +102 -101
- package/dist/model/MonitorAlertRoutesInner.js +9 -10
- 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 +23 -22
- package/dist/model/NotefileSchema.js +19 -18
- 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/RunJob200Response.js +8 -8
- package/dist/model/S3ArchiveRoute.js +79 -79
- package/dist/model/SatelliteDataUsage.js +18 -18
- package/dist/model/SatellitePlan.js +29 -29
- package/dist/model/SchemaProperty.js +38 -36
- 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 +49 -49
- package/dist/model/UsageEventsResponse.js +15 -14
- package/dist/model/UsageRouteLogsData.js +30 -30
- package/dist/model/UsageSessionsData.js +43 -43
- 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/model/CreateProjectSecretRequest.js +0 -130
- package/dist/model/GetProjectSecretsResponse.js +0 -131
- package/dist/model/ProjectSecret.js +0 -164
- package/dist/model/UpdateHostFirmwareRequest.js +0 -117
- package/dist/model/UpdateProjectSecretRequest.js +0 -115
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
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
31
|
+
* Route service.
|
|
32
|
+
* @module api/RouteApi
|
|
33
|
+
* @version 6.2.0-beta.3
|
|
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
|
-
projectOrProductUID: projectOrProductUID
|
|
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
|
-
projectOrProductUID: projectOrProductUID,
|
|
113
|
-
routeUID: routeUID
|
|
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
|
-
projectOrProductUID: projectOrProductUID,
|
|
159
|
-
routeUID: routeUID
|
|
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,11 +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
|
|
200
|
-
* @param {Array.<module:model/String>} opts.routingStatus
|
|
201
|
-
* @param {Array.<String>} opts.responseStatus
|
|
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
|
|
202
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
|
|
203
203
|
*/
|
|
204
204
|
}, {
|
|
@@ -215,36 +215,36 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
215
215
|
throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRouteLogsByRoute");
|
|
216
216
|
}
|
|
217
217
|
var pathParams = {
|
|
218
|
-
projectOrProductUID: projectOrProductUID,
|
|
219
|
-
routeUID: routeUID
|
|
218
|
+
'projectOrProductUID': projectOrProductUID,
|
|
219
|
+
'routeUID': routeUID
|
|
220
220
|
};
|
|
221
221
|
var queryParams = {
|
|
222
|
-
pageSize: opts[
|
|
223
|
-
pageNum: opts[
|
|
224
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
225
|
-
sortBy: opts[
|
|
226
|
-
sortOrder: opts[
|
|
227
|
-
startDate: opts[
|
|
228
|
-
endDate: opts[
|
|
229
|
-
systemFilesOnly: opts[
|
|
230
|
-
mostRecentOnly: opts[
|
|
231
|
-
files: opts[
|
|
232
|
-
routingStatus: this.apiClient.buildCollectionParam(opts[
|
|
233
|
-
responseStatus: this.apiClient.buildCollectionParam(opts[
|
|
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')
|
|
234
234
|
};
|
|
235
235
|
var headerParams = {};
|
|
236
236
|
var formParams = {};
|
|
237
|
-
var authNames = [
|
|
237
|
+
var authNames = ['personalAccessToken'];
|
|
238
238
|
var contentTypes = [];
|
|
239
|
-
var accepts = [
|
|
239
|
+
var accepts = ['application/json'];
|
|
240
240
|
var returnType = [_RouteLog["default"]];
|
|
241
|
-
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);
|
|
242
242
|
}
|
|
243
243
|
|
|
244
244
|
/**
|
|
245
245
|
* Get Route Logs by Route UID
|
|
246
|
-
* @param {String} projectOrProductUID
|
|
247
|
-
* @param {String} routeUID
|
|
246
|
+
* @param {String} projectOrProductUID
|
|
247
|
+
* @param {String} routeUID
|
|
248
248
|
* @param {Object} opts Optional parameters
|
|
249
249
|
* @param {Number} opts.pageSize (default to 50)
|
|
250
250
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -253,11 +253,11 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
253
253
|
* @param {module:model/String} opts.sortOrder (default to 'desc')
|
|
254
254
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
255
255
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
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
|
|
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
|
|
261
261
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/RouteLog>}
|
|
262
262
|
*/
|
|
263
263
|
}, {
|
|
@@ -270,7 +270,7 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
270
270
|
|
|
271
271
|
/**
|
|
272
272
|
* Get all Routes within a Project
|
|
273
|
-
* @param {String} projectOrProductUID
|
|
273
|
+
* @param {String} projectOrProductUID
|
|
274
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
|
|
275
275
|
*/
|
|
276
276
|
}, {
|
|
@@ -282,21 +282,21 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
282
282
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getRoutes");
|
|
283
283
|
}
|
|
284
284
|
var pathParams = {
|
|
285
|
-
projectOrProductUID: projectOrProductUID
|
|
285
|
+
'projectOrProductUID': projectOrProductUID
|
|
286
286
|
};
|
|
287
287
|
var queryParams = {};
|
|
288
288
|
var headerParams = {};
|
|
289
289
|
var formParams = {};
|
|
290
|
-
var authNames = [
|
|
290
|
+
var authNames = ['personalAccessToken'];
|
|
291
291
|
var contentTypes = [];
|
|
292
|
-
var accepts = [
|
|
292
|
+
var accepts = ['application/json'];
|
|
293
293
|
var returnType = [_NotehubRouteSummary["default"]];
|
|
294
|
-
return this.apiClient.callApi(
|
|
294
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
295
295
|
}
|
|
296
296
|
|
|
297
297
|
/**
|
|
298
298
|
* Get all Routes within a Project
|
|
299
|
-
* @param {String} projectOrProductUID
|
|
299
|
+
* @param {String} projectOrProductUID
|
|
300
300
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/NotehubRouteSummary>}
|
|
301
301
|
*/
|
|
302
302
|
}, {
|
|
@@ -309,8 +309,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
309
309
|
|
|
310
310
|
/**
|
|
311
311
|
* Update route by UID
|
|
312
|
-
* @param {String} projectOrProductUID
|
|
313
|
-
* @param {String} routeUID
|
|
312
|
+
* @param {String} projectOrProductUID
|
|
313
|
+
* @param {String} routeUID
|
|
314
314
|
* @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
|
|
315
315
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
|
|
316
316
|
*/
|
|
@@ -331,23 +331,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
331
331
|
throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling updateRoute");
|
|
332
332
|
}
|
|
333
333
|
var pathParams = {
|
|
334
|
-
projectOrProductUID: projectOrProductUID,
|
|
335
|
-
routeUID: routeUID
|
|
334
|
+
'projectOrProductUID': projectOrProductUID,
|
|
335
|
+
'routeUID': routeUID
|
|
336
336
|
};
|
|
337
337
|
var queryParams = {};
|
|
338
338
|
var headerParams = {};
|
|
339
339
|
var formParams = {};
|
|
340
|
-
var authNames = [
|
|
341
|
-
var contentTypes = [
|
|
342
|
-
var accepts = [
|
|
340
|
+
var authNames = ['personalAccessToken'];
|
|
341
|
+
var contentTypes = ['application/json'];
|
|
342
|
+
var accepts = ['application/json'];
|
|
343
343
|
var returnType = _NotehubRoute["default"];
|
|
344
|
-
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);
|
|
345
345
|
}
|
|
346
346
|
|
|
347
347
|
/**
|
|
348
348
|
* Update route by UID
|
|
349
|
-
* @param {String} projectOrProductUID
|
|
350
|
-
* @param {String} routeUID
|
|
349
|
+
* @param {String} projectOrProductUID
|
|
350
|
+
* @param {String} routeUID
|
|
351
351
|
* @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
|
|
352
352
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
|
|
353
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
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
32
|
+
* Usage service.
|
|
33
|
+
* @module api/UsageApi
|
|
34
|
+
* @version 6.2.0-beta.3
|
|
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
|
|
@@ -73,29 +73,29 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
73
73
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getDataUsage");
|
|
74
74
|
}
|
|
75
75
|
var pathParams = {
|
|
76
|
-
projectOrProductUID: projectOrProductUID
|
|
76
|
+
'projectOrProductUID': projectOrProductUID
|
|
77
77
|
};
|
|
78
78
|
var queryParams = {
|
|
79
|
-
startDate: opts[
|
|
80
|
-
endDate: opts[
|
|
81
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
82
|
-
fleetUID: this.apiClient.buildCollectionParam(opts[
|
|
83
|
-
limit: opts[
|
|
84
|
-
period: period,
|
|
85
|
-
aggregate: opts[
|
|
79
|
+
'startDate': opts['startDate'],
|
|
80
|
+
'endDate': opts['endDate'],
|
|
81
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
82
|
+
'fleetUID': this.apiClient.buildCollectionParam(opts['fleetUID'], 'multi'),
|
|
83
|
+
'limit': opts['limit'],
|
|
84
|
+
'period': period,
|
|
85
|
+
'aggregate': opts['aggregate']
|
|
86
86
|
};
|
|
87
87
|
var headerParams = {};
|
|
88
88
|
var formParams = {};
|
|
89
|
-
var authNames = [
|
|
89
|
+
var authNames = ['personalAccessToken'];
|
|
90
90
|
var contentTypes = [];
|
|
91
|
-
var accepts = [
|
|
91
|
+
var accepts = ['application/json'];
|
|
92
92
|
var returnType = _GetDataUsage200Response["default"];
|
|
93
|
-
return this.apiClient.callApi(
|
|
93
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/data', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
94
94
|
}
|
|
95
95
|
|
|
96
96
|
/**
|
|
97
97
|
* Get data usage in bytes for a project with time range and period aggregation
|
|
98
|
-
* @param {String} projectOrProductUID
|
|
98
|
+
* @param {String} projectOrProductUID
|
|
99
99
|
* @param {module:model/String} period Period type for aggregation
|
|
100
100
|
* @param {Object} opts Optional parameters
|
|
101
101
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -116,7 +116,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
116
116
|
|
|
117
117
|
/**
|
|
118
118
|
* Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
119
|
-
* @param {String} projectOrProductUID
|
|
119
|
+
* @param {String} projectOrProductUID
|
|
120
120
|
* @param {module:model/String} period Period type for aggregation
|
|
121
121
|
* @param {Object} opts Optional parameters
|
|
122
122
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -144,32 +144,32 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
144
144
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getEventsUsage");
|
|
145
145
|
}
|
|
146
146
|
var pathParams = {
|
|
147
|
-
projectOrProductUID: projectOrProductUID
|
|
147
|
+
'projectOrProductUID': projectOrProductUID
|
|
148
148
|
};
|
|
149
149
|
var queryParams = {
|
|
150
|
-
startDate: opts[
|
|
151
|
-
endDate: opts[
|
|
152
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
153
|
-
fleetUID: this.apiClient.buildCollectionParam(opts[
|
|
154
|
-
limit: opts[
|
|
155
|
-
period: period,
|
|
156
|
-
aggregate: opts[
|
|
157
|
-
notefile: this.apiClient.buildCollectionParam(opts[
|
|
158
|
-
skipRecentData: opts[
|
|
159
|
-
includeNotefiles: opts[
|
|
150
|
+
'startDate': opts['startDate'],
|
|
151
|
+
'endDate': opts['endDate'],
|
|
152
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
153
|
+
'fleetUID': this.apiClient.buildCollectionParam(opts['fleetUID'], 'multi'),
|
|
154
|
+
'limit': opts['limit'],
|
|
155
|
+
'period': period,
|
|
156
|
+
'aggregate': opts['aggregate'],
|
|
157
|
+
'notefile': this.apiClient.buildCollectionParam(opts['notefile'], 'multi'),
|
|
158
|
+
'skipRecentData': opts['skipRecentData'],
|
|
159
|
+
'includeNotefiles': opts['includeNotefiles']
|
|
160
160
|
};
|
|
161
161
|
var headerParams = {};
|
|
162
162
|
var formParams = {};
|
|
163
|
-
var authNames = [
|
|
163
|
+
var authNames = ['personalAccessToken'];
|
|
164
164
|
var contentTypes = [];
|
|
165
|
-
var accepts = [
|
|
165
|
+
var accepts = ['application/json'];
|
|
166
166
|
var returnType = _UsageEventsResponse["default"];
|
|
167
|
-
return this.apiClient.callApi(
|
|
167
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
168
168
|
}
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
172
|
-
* @param {String} projectOrProductUID
|
|
172
|
+
* @param {String} projectOrProductUID
|
|
173
173
|
* @param {module:model/String} period Period type for aggregation
|
|
174
174
|
* @param {Object} opts Optional parameters
|
|
175
175
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -193,7 +193,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
193
193
|
|
|
194
194
|
/**
|
|
195
195
|
* Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
196
|
-
* @param {String} projectOrProductUID
|
|
196
|
+
* @param {String} projectOrProductUID
|
|
197
197
|
* @param {module:model/String} period Period type for aggregation
|
|
198
198
|
* @param {Object} opts Optional parameters
|
|
199
199
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -218,29 +218,29 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
218
218
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getRouteLogsUsage");
|
|
219
219
|
}
|
|
220
220
|
var pathParams = {
|
|
221
|
-
projectOrProductUID: projectOrProductUID
|
|
221
|
+
'projectOrProductUID': projectOrProductUID
|
|
222
222
|
};
|
|
223
223
|
var queryParams = {
|
|
224
|
-
startDate: opts[
|
|
225
|
-
endDate: opts[
|
|
226
|
-
routeUID: this.apiClient.buildCollectionParam(opts[
|
|
227
|
-
limit: opts[
|
|
228
|
-
period: period,
|
|
229
|
-
aggregate: opts[
|
|
230
|
-
skipRecentData: opts[
|
|
224
|
+
'startDate': opts['startDate'],
|
|
225
|
+
'endDate': opts['endDate'],
|
|
226
|
+
'routeUID': this.apiClient.buildCollectionParam(opts['routeUID'], 'multi'),
|
|
227
|
+
'limit': opts['limit'],
|
|
228
|
+
'period': period,
|
|
229
|
+
'aggregate': opts['aggregate'],
|
|
230
|
+
'skipRecentData': opts['skipRecentData']
|
|
231
231
|
};
|
|
232
232
|
var headerParams = {};
|
|
233
233
|
var formParams = {};
|
|
234
|
-
var authNames = [
|
|
234
|
+
var authNames = ['personalAccessToken'];
|
|
235
235
|
var contentTypes = [];
|
|
236
|
-
var accepts = [
|
|
236
|
+
var accepts = ['application/json'];
|
|
237
237
|
var returnType = _GetRouteLogsUsage200Response["default"];
|
|
238
|
-
return this.apiClient.callApi(
|
|
238
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/route-logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
239
239
|
}
|
|
240
240
|
|
|
241
241
|
/**
|
|
242
242
|
* Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
243
|
-
* @param {String} projectOrProductUID
|
|
243
|
+
* @param {String} projectOrProductUID
|
|
244
244
|
* @param {module:model/String} period Period type for aggregation
|
|
245
245
|
* @param {Object} opts Optional parameters
|
|
246
246
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -261,7 +261,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
261
261
|
|
|
262
262
|
/**
|
|
263
263
|
* Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
264
|
-
* @param {String} projectOrProductUID
|
|
264
|
+
* @param {String} projectOrProductUID
|
|
265
265
|
* @param {module:model/String} period Period type for aggregation
|
|
266
266
|
* @param {Object} opts Optional parameters
|
|
267
267
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -287,30 +287,30 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
287
287
|
throw new _Error["default"]("Missing the required parameter 'period' when calling getSessionsUsage");
|
|
288
288
|
}
|
|
289
289
|
var pathParams = {
|
|
290
|
-
projectOrProductUID: projectOrProductUID
|
|
290
|
+
'projectOrProductUID': projectOrProductUID
|
|
291
291
|
};
|
|
292
292
|
var queryParams = {
|
|
293
|
-
startDate: opts[
|
|
294
|
-
endDate: opts[
|
|
295
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
296
|
-
fleetUID: this.apiClient.buildCollectionParam(opts[
|
|
297
|
-
limit: opts[
|
|
298
|
-
period: period,
|
|
299
|
-
aggregate: opts[
|
|
300
|
-
skipRecentData: opts[
|
|
293
|
+
'startDate': opts['startDate'],
|
|
294
|
+
'endDate': opts['endDate'],
|
|
295
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
296
|
+
'fleetUID': this.apiClient.buildCollectionParam(opts['fleetUID'], 'multi'),
|
|
297
|
+
'limit': opts['limit'],
|
|
298
|
+
'period': period,
|
|
299
|
+
'aggregate': opts['aggregate'],
|
|
300
|
+
'skipRecentData': opts['skipRecentData']
|
|
301
301
|
};
|
|
302
302
|
var headerParams = {};
|
|
303
303
|
var formParams = {};
|
|
304
|
-
var authNames = [
|
|
304
|
+
var authNames = ['personalAccessToken'];
|
|
305
305
|
var contentTypes = [];
|
|
306
|
-
var accepts = [
|
|
306
|
+
var accepts = ['application/json'];
|
|
307
307
|
var returnType = _GetSessionsUsage200Response["default"];
|
|
308
|
-
return this.apiClient.callApi(
|
|
308
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/sessions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
309
309
|
}
|
|
310
310
|
|
|
311
311
|
/**
|
|
312
312
|
* Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
|
|
313
|
-
* @param {String} projectOrProductUID
|
|
313
|
+
* @param {String} projectOrProductUID
|
|
314
314
|
* @param {module:model/String} period Period type for aggregation
|
|
315
315
|
* @param {Object} opts Optional parameters
|
|
316
316
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|