@blues-inc/notehub-js 2.0.0 → 2.1.0-beta.1

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.
Files changed (135) hide show
  1. package/README.md +241 -232
  2. package/dist/ApiClient.js +154 -154
  3. package/dist/api/AlertApi.js +22 -22
  4. package/dist/api/AuthorizationApi.js +31 -31
  5. package/dist/api/BillingAccountApi.js +14 -14
  6. package/dist/api/DeviceApi.js +362 -362
  7. package/dist/api/EventApi.js +118 -118
  8. package/dist/api/ExternalDevicesApi.js +41 -41
  9. package/dist/api/MonitorApi.js +52 -52
  10. package/dist/api/ProjectApi.js +452 -406
  11. package/dist/api/RouteApi.js +77 -77
  12. package/dist/api/UsageApi.js +67 -58
  13. package/dist/api/WebhookApi.js +51 -51
  14. package/dist/index.js +7 -7
  15. package/dist/model/Alert.js +76 -74
  16. package/dist/model/AlertDataInner.js +35 -35
  17. package/dist/model/AlertNotificationsInner.js +18 -18
  18. package/dist/model/Aws.js +65 -65
  19. package/dist/model/AwsFilter.js +19 -19
  20. package/dist/model/AwsTransform.js +20 -20
  21. package/dist/model/Azure.js +43 -43
  22. package/dist/model/BillingAccount.js +21 -21
  23. package/dist/model/BillingAccountRole.js +9 -9
  24. package/dist/model/Body.js +5 -5
  25. package/dist/model/CloneProjectRequest.js +20 -20
  26. package/dist/model/Contact.js +22 -22
  27. package/dist/model/CreateFleetRequest.js +12 -12
  28. package/dist/model/CreateMonitor.js +126 -125
  29. package/dist/model/CreateProductRequest.js +22 -22
  30. package/dist/model/CreateProjectRequest.js +16 -16
  31. package/dist/model/CreateUpdateRepository.js +17 -17
  32. package/dist/model/CurrentFirmware.js +12 -12
  33. package/dist/model/DFUEnv.js +12 -12
  34. package/dist/model/DFUState.js +65 -65
  35. package/dist/model/DataField.js +7 -7
  36. package/dist/model/DataSetField.js +19 -19
  37. package/dist/model/DeleteDeviceFleetsRequest.js +8 -8
  38. package/dist/model/Device.js +102 -101
  39. package/dist/model/DeviceDfuHistory.js +20 -19
  40. package/dist/model/DeviceDfuHistoryCurrent.js +32 -32
  41. package/dist/model/DeviceDfuHistoryPage.js +13 -12
  42. package/dist/model/DeviceDfuStateMachine.js +25 -24
  43. package/dist/model/DeviceDfuStateMachineNode.js +22 -22
  44. package/dist/model/DeviceDfuStatus.js +20 -20
  45. package/dist/model/DeviceDfuStatusPage.js +13 -12
  46. package/dist/model/DeviceSession.js +221 -221
  47. package/dist/model/DeviceTowerInfo.js +14 -14
  48. package/dist/model/DeviceUsage.js +32 -32
  49. package/dist/model/DfuActionRequest.js +7 -7
  50. package/dist/model/EmailNotification.js +7 -7
  51. package/dist/model/EnvTreeJsonNode.js +69 -67
  52. package/dist/model/EnvVar.js +18 -18
  53. package/dist/model/EnvironmentVariables.js +8 -8
  54. package/dist/model/Error.js +31 -31
  55. package/dist/model/Event.js +248 -248
  56. package/dist/model/Firmware.js +49 -49
  57. package/dist/model/FirmwareInfo.js +60 -60
  58. package/dist/model/Fleet.js +30 -30
  59. package/dist/model/GetAlerts200Response.js +15 -14
  60. package/dist/model/GetBillingAccounts200Response.js +10 -9
  61. package/dist/model/GetDeviceEnvironmentVariablesByPin200Response.js +16 -16
  62. package/dist/model/GetDeviceFleets200Response.js +12 -11
  63. package/dist/model/GetDeviceHealthLog200Response.js +12 -11
  64. package/dist/model/GetDeviceHealthLog200ResponseHealthLogInner.js +19 -19
  65. package/dist/model/GetDeviceLatest200Response.js +10 -9
  66. package/dist/model/GetDevicePublicKey200Response.js +16 -16
  67. package/dist/model/GetDeviceSessions200Response.js +17 -16
  68. package/dist/model/{GetProjectProducts200Response.js → GetProducts200Response.js} +26 -25
  69. package/dist/model/GetProjectDevicePublicKeys200Response.js +17 -16
  70. package/dist/model/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.js +12 -12
  71. package/dist/model/GetProjectDevices200Response.js +17 -16
  72. package/dist/model/GetProjectEvents200Response.js +21 -20
  73. package/dist/model/GetProjectEventsByCursor200Response.js +24 -23
  74. package/dist/model/GetProjectMembers200Response.js +12 -11
  75. package/dist/model/GetProjects200Response.js +10 -9
  76. package/dist/model/GetWebhooks200Response.js +10 -9
  77. package/dist/model/Google.js +33 -33
  78. package/dist/model/HandleNoteChanges200Response.js +11 -11
  79. package/dist/model/HandleNoteGet200Response.js +13 -13
  80. package/dist/model/HandleNoteSignal200Response.js +5 -5
  81. package/dist/model/HandleNotefileChanges200Response.js +11 -11
  82. package/dist/model/HandleNotefileChangesPending200Response.js +14 -14
  83. package/dist/model/HandleNotefileDeleteRequest.js +7 -7
  84. package/dist/model/Http.js +35 -35
  85. package/dist/model/Location.js +40 -40
  86. package/dist/model/Login200Response.js +7 -7
  87. package/dist/model/LoginRequest.js +12 -12
  88. package/dist/model/Monitor.js +100 -99
  89. package/dist/model/MonitorAlertRoutesInner.js +9 -10
  90. package/dist/model/Mqtt.js +66 -66
  91. package/dist/model/Note.js +10 -10
  92. package/dist/model/NotefileSchema.js +19 -18
  93. package/dist/model/NotehubRoute.js +36 -36
  94. package/dist/model/NotehubRouteSchema.js +45 -46
  95. package/dist/model/OAuth2Error.js +20 -20
  96. package/dist/model/OAuth2TokenResponse.js +23 -23
  97. package/dist/model/PersonalAccessToken.js +34 -34
  98. package/dist/model/PersonalAccessTokenCreatedBy.js +17 -17
  99. package/dist/model/PersonalAccessTokenInfo.js +18 -18
  100. package/dist/model/PersonalAccessTokenSecret.js +12 -12
  101. package/dist/model/PostProvisionProjectDeviceRequest.js +18 -18
  102. package/dist/model/Product.js +26 -26
  103. package/dist/model/Project.js +34 -34
  104. package/dist/model/ProjectMember.js +22 -22
  105. package/dist/model/Proxy.js +24 -24
  106. package/dist/model/PutDeviceFleetsRequest.js +8 -8
  107. package/dist/model/Radresponder.js +25 -25
  108. package/dist/model/Repository.js +22 -22
  109. package/dist/model/Role.js +9 -9
  110. package/dist/model/RouteLog.js +38 -38
  111. package/dist/model/SchemaProperty.js +38 -36
  112. package/dist/model/SimUsage.js +19 -19
  113. package/dist/model/Slack.js +53 -53
  114. package/dist/model/SlackBearerNotification.js +25 -25
  115. package/dist/model/SlackTransform.js +12 -12
  116. package/dist/model/SlackWebHookNotification.js +20 -20
  117. package/dist/model/Snowflake.js +45 -45
  118. package/dist/model/Thingworx.js +33 -33
  119. package/dist/model/TowerLocation.js +54 -54
  120. package/dist/model/Twilio.js +43 -43
  121. package/dist/model/UpdateFleetRequest.js +25 -25
  122. package/dist/model/UploadMetadata.js +64 -64
  123. package/dist/model/UsageData.js +18 -18
  124. package/dist/model/UsageEventsData.js +38 -28
  125. package/dist/model/UsageEventsResponse.js +12 -11
  126. package/dist/model/UsageRouteLogsData.js +35 -36
  127. package/dist/model/UsageRouteLogsResponse.js +12 -11
  128. package/dist/model/UsageSessionsData.js +38 -28
  129. package/dist/model/UsageSessionsResponse.js +12 -11
  130. package/dist/model/UserDbRoute.js +25 -25
  131. package/dist/model/UserDfuStateMachine.js +20 -20
  132. package/dist/model/UserDfuStateMachineStatus.js +20 -20
  133. package/dist/model/UserFirmwareInfo.js +12 -12
  134. package/dist/model/WebhookSettings.js +15 -15
  135. package/package.json +3 -3
@@ -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 2.0.0
34
- */
31
+ * Route service.
32
+ * @module api/RouteApi
33
+ * @version 2.1.0-beta.1
34
+ */
35
35
  var RouteApi = exports["default"] = /*#__PURE__*/function () {
36
36
  /**
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
- */
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 = ["personalAccessToken"];
73
- var contentTypes = ["application/json"];
74
- var accepts = ["application/json"];
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("/v1/projects/{projectOrProductUID}/routes", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
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 data of type {@link Object} and 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 = ["personalAccessToken"];
118
+ var authNames = ['personalAccessToken'];
119
119
  var contentTypes = [];
120
- var accepts = ["application/json"];
120
+ var accepts = ['application/json'];
121
121
  var returnType = Object;
122
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "DELETE", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
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}, with data of type {@link Object}
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 = ["personalAccessToken"];
164
+ var authNames = ['personalAccessToken'];
165
165
  var contentTypes = [];
166
- var accepts = ["application/json"];
166
+ var accepts = ['application/json'];
167
167
  var returnType = _NotehubRoute["default"];
168
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
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,9 @@ 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
200
  * @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
201
  */
202
202
  }, {
@@ -213,34 +213,34 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
213
213
  throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRouteLogsByRoute");
214
214
  }
215
215
  var pathParams = {
216
- projectOrProductUID: projectOrProductUID,
217
- routeUID: routeUID
216
+ 'projectOrProductUID': projectOrProductUID,
217
+ 'routeUID': routeUID
218
218
  };
219
219
  var queryParams = {
220
- pageSize: opts["pageSize"],
221
- pageNum: opts["pageNum"],
222
- deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
223
- sortBy: opts["sortBy"],
224
- sortOrder: opts["sortOrder"],
225
- startDate: opts["startDate"],
226
- endDate: opts["endDate"],
227
- systemFilesOnly: opts["systemFilesOnly"],
228
- mostRecentOnly: opts["mostRecentOnly"],
229
- files: opts["files"]
220
+ 'pageSize': opts['pageSize'],
221
+ 'pageNum': opts['pageNum'],
222
+ 'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
223
+ 'sortBy': opts['sortBy'],
224
+ 'sortOrder': opts['sortOrder'],
225
+ 'startDate': opts['startDate'],
226
+ 'endDate': opts['endDate'],
227
+ 'systemFilesOnly': opts['systemFilesOnly'],
228
+ 'mostRecentOnly': opts['mostRecentOnly'],
229
+ 'files': opts['files']
230
230
  };
231
231
  var headerParams = {};
232
232
  var formParams = {};
233
- var authNames = ["personalAccessToken"];
233
+ var authNames = ['personalAccessToken'];
234
234
  var contentTypes = [];
235
- var accepts = ["application/json"];
235
+ var accepts = ['application/json'];
236
236
  var returnType = [_RouteLog["default"]];
237
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
237
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
238
238
  }
239
239
 
240
240
  /**
241
241
  * Get Route Logs by Route UID
242
- * @param {String} projectOrProductUID
243
- * @param {String} routeUID
242
+ * @param {String} projectOrProductUID
243
+ * @param {String} routeUID
244
244
  * @param {Object} opts Optional parameters
245
245
  * @param {Number} opts.pageSize (default to 50)
246
246
  * @param {Number} opts.pageNum (default to 1)
@@ -249,9 +249,9 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
249
249
  * @param {module:model/String} opts.sortOrder (default to 'desc')
250
250
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
251
251
  * @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
252
+ * @param {Boolean} opts.systemFilesOnly
253
+ * @param {Boolean} opts.mostRecentOnly
254
+ * @param {String} opts.files
255
255
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/RouteLog>}
256
256
  */
257
257
  }, {
@@ -264,7 +264,7 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
264
264
 
265
265
  /**
266
266
  * Get all Routes within a Project
267
- * @param {String} projectOrProductUID
267
+ * @param {String} projectOrProductUID
268
268
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/UserDbRoute>} and HTTP response
269
269
  */
270
270
  }, {
@@ -276,21 +276,21 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
276
276
  throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getRoutes");
277
277
  }
278
278
  var pathParams = {
279
- projectOrProductUID: projectOrProductUID
279
+ 'projectOrProductUID': projectOrProductUID
280
280
  };
281
281
  var queryParams = {};
282
282
  var headerParams = {};
283
283
  var formParams = {};
284
- var authNames = ["personalAccessToken"];
284
+ var authNames = ['personalAccessToken'];
285
285
  var contentTypes = [];
286
- var accepts = ["application/json"];
286
+ var accepts = ['application/json'];
287
287
  var returnType = [_UserDbRoute["default"]];
288
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
288
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
289
289
  }
290
290
 
291
291
  /**
292
292
  * Get all Routes within a Project
293
- * @param {String} projectOrProductUID
293
+ * @param {String} projectOrProductUID
294
294
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/UserDbRoute>}
295
295
  */
296
296
  }, {
@@ -303,8 +303,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
303
303
 
304
304
  /**
305
305
  * Update route by UID
306
- * @param {String} projectOrProductUID
307
- * @param {String} routeUID
306
+ * @param {String} projectOrProductUID
307
+ * @param {String} routeUID
308
308
  * @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
309
309
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
310
310
  */
@@ -325,23 +325,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
325
325
  throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling updateRoute");
326
326
  }
327
327
  var pathParams = {
328
- projectOrProductUID: projectOrProductUID,
329
- routeUID: routeUID
328
+ 'projectOrProductUID': projectOrProductUID,
329
+ 'routeUID': routeUID
330
330
  };
331
331
  var queryParams = {};
332
332
  var headerParams = {};
333
333
  var formParams = {};
334
- var authNames = ["personalAccessToken"];
335
- var contentTypes = ["application/json"];
336
- var accepts = ["application/json"];
334
+ var authNames = ['personalAccessToken'];
335
+ var contentTypes = ['application/json'];
336
+ var accepts = ['application/json'];
337
337
  var returnType = _NotehubRoute["default"];
338
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "PUT", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
338
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
339
339
  }
340
340
 
341
341
  /**
342
342
  * Update route by UID
343
- * @param {String} projectOrProductUID
344
- * @param {String} routeUID
343
+ * @param {String} projectOrProductUID
344
+ * @param {String} routeUID
345
345
  * @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
346
346
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
347
347
  */
@@ -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 2.0.0
35
- */
32
+ * Usage service.
33
+ * @module api/UsageApi
34
+ * @version 2.1.0-beta.1
35
+ */
36
36
  var UsageApi = exports["default"] = /*#__PURE__*/function () {
37
37
  /**
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
- */
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,12 +48,13 @@ 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
55
55
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
56
56
  * @param {Array.<String>} opts.deviceUID A Device UID.
57
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
57
58
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<Object>} and HTTP response
58
59
  */
59
60
  return _createClass(UsageApi, [{
@@ -70,31 +71,33 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
70
71
  throw new _Error["default"]("Missing the required parameter 'period' when calling getProjectDataUsage");
71
72
  }
72
73
  var pathParams = {
73
- projectOrProductUID: projectOrProductUID
74
+ 'projectOrProductUID': projectOrProductUID
74
75
  };
75
76
  var queryParams = {
76
- startDate: opts["startDate"],
77
- endDate: opts["endDate"],
78
- deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
79
- period: period
77
+ 'startDate': opts['startDate'],
78
+ 'endDate': opts['endDate'],
79
+ 'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
80
+ 'period': period,
81
+ 'aggregate': opts['aggregate']
80
82
  };
81
83
  var headerParams = {};
82
84
  var formParams = {};
83
85
  var authNames = [];
84
86
  var contentTypes = [];
85
- var accepts = ["application/json"];
87
+ var accepts = ['application/json'];
86
88
  var returnType = [Object];
87
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/data", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
89
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/data', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
88
90
  }
89
91
 
90
92
  /**
91
93
  * Get data usage in bytes for a project with time range and period aggregation
92
- * @param {String} projectOrProductUID
94
+ * @param {String} projectOrProductUID
93
95
  * @param {module:model/String} period Period type for aggregation
94
96
  * @param {Object} opts Optional parameters
95
97
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
96
98
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
97
99
  * @param {Array.<String>} opts.deviceUID A Device UID.
100
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
98
101
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<Object>}
99
102
  */
100
103
  }, {
@@ -106,13 +109,14 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
106
109
  }
107
110
 
108
111
  /**
109
- * Get events usage for a project with time range and period aggregation
110
- * @param {String} projectOrProductUID
112
+ * Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
113
+ * @param {String} projectOrProductUID
111
114
  * @param {module:model/String} period Period type for aggregation
112
115
  * @param {Object} opts Optional parameters
113
116
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
114
117
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
115
118
  * @param {Array.<String>} opts.deviceUID A Device UID.
119
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
116
120
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UsageEventsResponse} and HTTP response
117
121
  */
118
122
  }, {
@@ -129,31 +133,33 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
129
133
  throw new _Error["default"]("Missing the required parameter 'period' when calling getProjectEventsUsage");
130
134
  }
131
135
  var pathParams = {
132
- projectOrProductUID: projectOrProductUID
136
+ 'projectOrProductUID': projectOrProductUID
133
137
  };
134
138
  var queryParams = {
135
- startDate: opts["startDate"],
136
- endDate: opts["endDate"],
137
- deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
138
- period: period
139
+ 'startDate': opts['startDate'],
140
+ 'endDate': opts['endDate'],
141
+ 'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
142
+ 'period': period,
143
+ 'aggregate': opts['aggregate']
139
144
  };
140
145
  var headerParams = {};
141
146
  var formParams = {};
142
- var authNames = ["personalAccessToken"];
147
+ var authNames = ['personalAccessToken'];
143
148
  var contentTypes = [];
144
- var accepts = ["application/json"];
149
+ var accepts = ['application/json'];
145
150
  var returnType = _UsageEventsResponse["default"];
146
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/events", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
151
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
147
152
  }
148
153
 
149
154
  /**
150
- * Get events usage for a project with time range and period aggregation
151
- * @param {String} projectOrProductUID
155
+ * Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
156
+ * @param {String} projectOrProductUID
152
157
  * @param {module:model/String} period Period type for aggregation
153
158
  * @param {Object} opts Optional parameters
154
159
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
155
160
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
156
161
  * @param {Array.<String>} opts.deviceUID A Device UID.
162
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
157
163
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UsageEventsResponse}
158
164
  */
159
165
  }, {
@@ -165,13 +171,13 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
165
171
  }
166
172
 
167
173
  /**
168
- * Get route logs usage for a project with time range and period aggregation
169
- * @param {String} projectOrProductUID
174
+ * Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
175
+ * @param {String} projectOrProductUID
170
176
  * @param {module:model/String} period Period type for aggregation
171
177
  * @param {Object} opts Optional parameters
172
178
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
173
179
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
174
- * @param {Array.<String>} opts.deviceUID A Device UID.
180
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
175
181
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UsageRouteLogsResponse} and HTTP response
176
182
  */
177
183
  }, {
@@ -188,31 +194,31 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
188
194
  throw new _Error["default"]("Missing the required parameter 'period' when calling getRouteLogsUsage");
189
195
  }
190
196
  var pathParams = {
191
- projectOrProductUID: projectOrProductUID
197
+ 'projectOrProductUID': projectOrProductUID
192
198
  };
193
199
  var queryParams = {
194
- startDate: opts["startDate"],
195
- endDate: opts["endDate"],
196
- deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
197
- period: period
200
+ 'startDate': opts['startDate'],
201
+ 'endDate': opts['endDate'],
202
+ 'period': period,
203
+ 'aggregate': opts['aggregate']
198
204
  };
199
205
  var headerParams = {};
200
206
  var formParams = {};
201
- var authNames = ["personalAccessToken"];
207
+ var authNames = ['personalAccessToken'];
202
208
  var contentTypes = [];
203
- var accepts = ["application/json"];
209
+ var accepts = ['application/json'];
204
210
  var returnType = _UsageRouteLogsResponse["default"];
205
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/route-logs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
211
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/route-logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
206
212
  }
207
213
 
208
214
  /**
209
- * Get route logs usage for a project with time range and period aggregation
210
- * @param {String} projectOrProductUID
215
+ * Get route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
216
+ * @param {String} projectOrProductUID
211
217
  * @param {module:model/String} period Period type for aggregation
212
218
  * @param {Object} opts Optional parameters
213
219
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
214
220
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
215
- * @param {Array.<String>} opts.deviceUID A Device UID.
221
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
216
222
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UsageRouteLogsResponse}
217
223
  */
218
224
  }, {
@@ -224,13 +230,14 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
224
230
  }
225
231
 
226
232
  /**
227
- * Get sessions usage for a project with time range and period aggregation
228
- * @param {String} projectOrProductUID
233
+ * Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
234
+ * @param {String} projectOrProductUID
229
235
  * @param {module:model/String} period Period type for aggregation
230
236
  * @param {Object} opts Optional parameters
231
237
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
232
238
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
233
239
  * @param {Array.<String>} opts.deviceUID A Device UID.
240
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
234
241
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UsageSessionsResponse} and HTTP response
235
242
  */
236
243
  }, {
@@ -247,31 +254,33 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
247
254
  throw new _Error["default"]("Missing the required parameter 'period' when calling getSessionsUsage");
248
255
  }
249
256
  var pathParams = {
250
- projectOrProductUID: projectOrProductUID
257
+ 'projectOrProductUID': projectOrProductUID
251
258
  };
252
259
  var queryParams = {
253
- startDate: opts["startDate"],
254
- endDate: opts["endDate"],
255
- deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
256
- period: period
260
+ 'startDate': opts['startDate'],
261
+ 'endDate': opts['endDate'],
262
+ 'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
263
+ 'period': period,
264
+ 'aggregate': opts['aggregate']
257
265
  };
258
266
  var headerParams = {};
259
267
  var formParams = {};
260
- var authNames = ["personalAccessToken"];
268
+ var authNames = ['personalAccessToken'];
261
269
  var contentTypes = [];
262
- var accepts = ["application/json"];
270
+ var accepts = ['application/json'];
263
271
  var returnType = _UsageSessionsResponse["default"];
264
- return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/sessions", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
272
+ return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/usage/sessions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
265
273
  }
266
274
 
267
275
  /**
268
- * Get sessions usage for a project with time range and period aggregation
269
- * @param {String} projectOrProductUID
276
+ * Get sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
277
+ * @param {String} projectOrProductUID
270
278
  * @param {module:model/String} period Period type for aggregation
271
279
  * @param {Object} opts Optional parameters
272
280
  * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
273
281
  * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
274
282
  * @param {Array.<String>} opts.deviceUID A Device UID.
283
+ * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
275
284
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UsageSessionsResponse}
276
285
  */
277
286
  }, {