@blues-inc/notehub-js 3.0.0 → 4.0.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.
- package/README.md +247 -247
- package/dist/ApiClient.js +150 -155
- 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 +471 -511
- 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 +381 -381
- package/dist/api/RouteApi.js +77 -77
- package/dist/api/UsageApi.js +117 -51
- package/dist/api/WebhookApi.js +51 -51
- package/dist/index.js +21 -14
- package/dist/model/AddDeviceToFleetsRequest.js +8 -8
- package/dist/model/Alert.js +76 -74
- package/dist/model/AlertDataInner.js +35 -35
- 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 +25 -17
- package/dist/model/CreateMonitor.js +126 -125
- 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 +115 -101
- 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 +60 -60
- package/dist/model/Fleet.js +43 -35
- package/dist/model/FleetConnectivityAssurance.js +8 -31
- package/dist/model/GetAlerts200Response.js +15 -14
- package/dist/model/GetBillingAccounts200Response.js +10 -9
- package/dist/model/GetDataUsage200Response.js +10 -9
- package/dist/model/GetDataUsage200ResponseDataInner.js +41 -40
- 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/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 +132 -0
- package/dist/model/GetSessionsUsage200Response.js +12 -11
- package/dist/model/GetWebhooks200Response.js +10 -9
- 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 -99
- package/dist/model/MonitorAlertRoutesInner.js +9 -10
- package/dist/model/MqttRoute.js +68 -68
- package/dist/model/Note.js +95 -15
- package/dist/model/{ListNotefiles200Response.js → NoteInput.js} +30 -37
- package/dist/model/Notefile.js +159 -0
- 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/S3ArchiveRoute.js +79 -79
- package/dist/model/SatellitePlan.js +26 -26
- 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 +38 -30
- package/dist/model/UploadMetadata.js +64 -64
- package/dist/model/UsageData.js +18 -18
- package/dist/model/UsageEventsData.js +48 -37
- package/dist/model/UsageEventsResponse.js +12 -11
- package/dist/model/UsageRouteLogsData.js +27 -27
- package/dist/model/UsageSessionsData.js +41 -31
- 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/ListPendingNotefiles200Response.js +0 -115
package/dist/api/EventApi.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
|
+
* Event service.
|
|
32
|
+
* @module api/EventApi
|
|
33
|
+
* @version 4.0.0-beta.1
|
|
34
|
+
*/
|
|
35
35
|
var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
37
|
+
* Constructs a new EventApi.
|
|
38
|
+
* @alias module:api/EventApi
|
|
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 EventApi(apiClient) {
|
|
44
44
|
_classCallCheck(this, EventApi);
|
|
45
45
|
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
@@ -47,7 +47,7 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Get Events of a Project
|
|
50
|
-
* @param {String} projectOrProductUID
|
|
50
|
+
* @param {String} projectOrProductUID
|
|
51
51
|
* @param {Object} opts Optional parameters
|
|
52
52
|
* @param {Number} opts.pageSize (default to 50)
|
|
53
53
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -57,8 +57,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
57
57
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
58
58
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
59
59
|
* @param {module:model/String} opts.dateType Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (default to 'captured')
|
|
60
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
61
|
-
* @param {String} opts.files
|
|
60
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
61
|
+
* @param {String} opts.files
|
|
62
62
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
63
63
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
64
64
|
* @param {Array.<String>} opts.fleetUID Filter by Fleet UID
|
|
@@ -77,38 +77,38 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
77
77
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getEvents");
|
|
78
78
|
}
|
|
79
79
|
var pathParams = {
|
|
80
|
-
projectOrProductUID: projectOrProductUID
|
|
80
|
+
'projectOrProductUID': projectOrProductUID
|
|
81
81
|
};
|
|
82
82
|
var queryParams = {
|
|
83
|
-
pageSize: opts[
|
|
84
|
-
pageNum: opts[
|
|
85
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
86
|
-
sortBy: opts[
|
|
87
|
-
sortOrder: opts[
|
|
88
|
-
startDate: opts[
|
|
89
|
-
endDate: opts[
|
|
90
|
-
dateType: opts[
|
|
91
|
-
systemFilesOnly: opts[
|
|
92
|
-
files: opts[
|
|
93
|
-
format: opts[
|
|
94
|
-
serialNumber: this.apiClient.buildCollectionParam(opts[
|
|
95
|
-
fleetUID: this.apiClient.buildCollectionParam(opts[
|
|
96
|
-
sessionUID: this.apiClient.buildCollectionParam(opts[
|
|
97
|
-
eventUID: this.apiClient.buildCollectionParam(opts[
|
|
98
|
-
selectFields: opts[
|
|
83
|
+
'pageSize': opts['pageSize'],
|
|
84
|
+
'pageNum': opts['pageNum'],
|
|
85
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
86
|
+
'sortBy': opts['sortBy'],
|
|
87
|
+
'sortOrder': opts['sortOrder'],
|
|
88
|
+
'startDate': opts['startDate'],
|
|
89
|
+
'endDate': opts['endDate'],
|
|
90
|
+
'dateType': opts['dateType'],
|
|
91
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
92
|
+
'files': opts['files'],
|
|
93
|
+
'format': opts['format'],
|
|
94
|
+
'serialNumber': this.apiClient.buildCollectionParam(opts['serialNumber'], 'multi'),
|
|
95
|
+
'fleetUID': this.apiClient.buildCollectionParam(opts['fleetUID'], 'multi'),
|
|
96
|
+
'sessionUID': this.apiClient.buildCollectionParam(opts['sessionUID'], 'multi'),
|
|
97
|
+
'eventUID': this.apiClient.buildCollectionParam(opts['eventUID'], 'multi'),
|
|
98
|
+
'selectFields': opts['selectFields']
|
|
99
99
|
};
|
|
100
100
|
var headerParams = {};
|
|
101
101
|
var formParams = {};
|
|
102
|
-
var authNames = [
|
|
102
|
+
var authNames = ['personalAccessToken'];
|
|
103
103
|
var contentTypes = [];
|
|
104
|
-
var accepts = [
|
|
104
|
+
var accepts = ['application/json', 'text/csv'];
|
|
105
105
|
var returnType = _GetEvents200Response["default"];
|
|
106
|
-
return this.apiClient.callApi(
|
|
106
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
107
107
|
}
|
|
108
108
|
|
|
109
109
|
/**
|
|
110
110
|
* Get Events of a Project
|
|
111
|
-
* @param {String} projectOrProductUID
|
|
111
|
+
* @param {String} projectOrProductUID
|
|
112
112
|
* @param {Object} opts Optional parameters
|
|
113
113
|
* @param {Number} opts.pageSize (default to 50)
|
|
114
114
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -118,8 +118,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
118
118
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
119
119
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
120
120
|
* @param {module:model/String} opts.dateType Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (default to 'captured')
|
|
121
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
122
|
-
* @param {String} opts.files
|
|
121
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
122
|
+
* @param {String} opts.files
|
|
123
123
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
124
124
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
125
125
|
* @param {Array.<String>} opts.fleetUID Filter by Fleet UID
|
|
@@ -138,14 +138,14 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
138
138
|
|
|
139
139
|
/**
|
|
140
140
|
* Get Events of a Project by cursor
|
|
141
|
-
* @param {String} projectOrProductUID
|
|
141
|
+
* @param {String} projectOrProductUID
|
|
142
142
|
* @param {Object} opts Optional parameters
|
|
143
143
|
* @param {Number} opts.limit (default to 50)
|
|
144
|
-
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
144
|
+
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
145
145
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
146
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
147
|
-
* @param {String} opts.files
|
|
148
|
-
* @param {String} opts.fleetUID
|
|
146
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
147
|
+
* @param {String} opts.files
|
|
148
|
+
* @param {String} opts.fleetUID
|
|
149
149
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
150
150
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetEventsByCursor200Response} and HTTP response
|
|
151
151
|
*/
|
|
@@ -159,36 +159,36 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
159
159
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getEventsByCursor");
|
|
160
160
|
}
|
|
161
161
|
var pathParams = {
|
|
162
|
-
projectOrProductUID: projectOrProductUID
|
|
162
|
+
'projectOrProductUID': projectOrProductUID
|
|
163
163
|
};
|
|
164
164
|
var queryParams = {
|
|
165
|
-
limit: opts[
|
|
166
|
-
cursor: opts[
|
|
167
|
-
sortOrder: opts[
|
|
168
|
-
systemFilesOnly: opts[
|
|
169
|
-
files: opts[
|
|
170
|
-
fleetUID: opts[
|
|
171
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
165
|
+
'limit': opts['limit'],
|
|
166
|
+
'cursor': opts['cursor'],
|
|
167
|
+
'sortOrder': opts['sortOrder'],
|
|
168
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
169
|
+
'files': opts['files'],
|
|
170
|
+
'fleetUID': opts['fleetUID'],
|
|
171
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi')
|
|
172
172
|
};
|
|
173
173
|
var headerParams = {};
|
|
174
174
|
var formParams = {};
|
|
175
|
-
var authNames = [
|
|
175
|
+
var authNames = ['personalAccessToken'];
|
|
176
176
|
var contentTypes = [];
|
|
177
|
-
var accepts = [
|
|
177
|
+
var accepts = ['application/json'];
|
|
178
178
|
var returnType = _GetEventsByCursor200Response["default"];
|
|
179
|
-
return this.apiClient.callApi(
|
|
179
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/events-cursor', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
180
180
|
}
|
|
181
181
|
|
|
182
182
|
/**
|
|
183
183
|
* Get Events of a Project by cursor
|
|
184
|
-
* @param {String} projectOrProductUID
|
|
184
|
+
* @param {String} projectOrProductUID
|
|
185
185
|
* @param {Object} opts Optional parameters
|
|
186
186
|
* @param {Number} opts.limit (default to 50)
|
|
187
|
-
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
187
|
+
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
188
188
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
189
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
190
|
-
* @param {String} opts.files
|
|
191
|
-
* @param {String} opts.fleetUID
|
|
189
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
190
|
+
* @param {String} opts.files
|
|
191
|
+
* @param {String} opts.fleetUID
|
|
192
192
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
193
193
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetEventsByCursor200Response}
|
|
194
194
|
*/
|
|
@@ -202,8 +202,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
202
202
|
|
|
203
203
|
/**
|
|
204
204
|
* Get Events of a Fleet
|
|
205
|
-
* @param {String} projectOrProductUID
|
|
206
|
-
* @param {String} fleetUID
|
|
205
|
+
* @param {String} projectOrProductUID
|
|
206
|
+
* @param {String} fleetUID
|
|
207
207
|
* @param {Object} opts Optional parameters
|
|
208
208
|
* @param {Number} opts.pageSize (default to 50)
|
|
209
209
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -213,8 +213,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
213
213
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
214
214
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
215
215
|
* @param {module:model/String} opts.dateType Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (default to 'captured')
|
|
216
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
217
|
-
* @param {String} opts.files
|
|
216
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
217
|
+
* @param {String} opts.files
|
|
218
218
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
219
219
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
220
220
|
* @param {Array.<String>} opts.sessionUID Filter by Session UID
|
|
@@ -236,39 +236,39 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
236
236
|
throw new _Error["default"]("Missing the required parameter 'fleetUID' when calling getFleetEvents");
|
|
237
237
|
}
|
|
238
238
|
var pathParams = {
|
|
239
|
-
projectOrProductUID: projectOrProductUID,
|
|
240
|
-
fleetUID: fleetUID
|
|
239
|
+
'projectOrProductUID': projectOrProductUID,
|
|
240
|
+
'fleetUID': fleetUID
|
|
241
241
|
};
|
|
242
242
|
var queryParams = {
|
|
243
|
-
pageSize: opts[
|
|
244
|
-
pageNum: opts[
|
|
245
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
246
|
-
sortBy: opts[
|
|
247
|
-
sortOrder: opts[
|
|
248
|
-
startDate: opts[
|
|
249
|
-
endDate: opts[
|
|
250
|
-
dateType: opts[
|
|
251
|
-
systemFilesOnly: opts[
|
|
252
|
-
files: opts[
|
|
253
|
-
format: opts[
|
|
254
|
-
serialNumber: this.apiClient.buildCollectionParam(opts[
|
|
255
|
-
sessionUID: this.apiClient.buildCollectionParam(opts[
|
|
256
|
-
eventUID: this.apiClient.buildCollectionParam(opts[
|
|
257
|
-
selectFields: opts[
|
|
243
|
+
'pageSize': opts['pageSize'],
|
|
244
|
+
'pageNum': opts['pageNum'],
|
|
245
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
246
|
+
'sortBy': opts['sortBy'],
|
|
247
|
+
'sortOrder': opts['sortOrder'],
|
|
248
|
+
'startDate': opts['startDate'],
|
|
249
|
+
'endDate': opts['endDate'],
|
|
250
|
+
'dateType': opts['dateType'],
|
|
251
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
252
|
+
'files': opts['files'],
|
|
253
|
+
'format': opts['format'],
|
|
254
|
+
'serialNumber': this.apiClient.buildCollectionParam(opts['serialNumber'], 'multi'),
|
|
255
|
+
'sessionUID': this.apiClient.buildCollectionParam(opts['sessionUID'], 'multi'),
|
|
256
|
+
'eventUID': this.apiClient.buildCollectionParam(opts['eventUID'], 'multi'),
|
|
257
|
+
'selectFields': opts['selectFields']
|
|
258
258
|
};
|
|
259
259
|
var headerParams = {};
|
|
260
260
|
var formParams = {};
|
|
261
|
-
var authNames = [
|
|
261
|
+
var authNames = ['personalAccessToken'];
|
|
262
262
|
var contentTypes = [];
|
|
263
|
-
var accepts = [
|
|
263
|
+
var accepts = ['application/json', 'text/csv'];
|
|
264
264
|
var returnType = _GetEvents200Response["default"];
|
|
265
|
-
return this.apiClient.callApi(
|
|
265
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
266
266
|
}
|
|
267
267
|
|
|
268
268
|
/**
|
|
269
269
|
* Get Events of a Fleet
|
|
270
|
-
* @param {String} projectOrProductUID
|
|
271
|
-
* @param {String} fleetUID
|
|
270
|
+
* @param {String} projectOrProductUID
|
|
271
|
+
* @param {String} fleetUID
|
|
272
272
|
* @param {Object} opts Optional parameters
|
|
273
273
|
* @param {Number} opts.pageSize (default to 50)
|
|
274
274
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -278,8 +278,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
278
278
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
279
279
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
280
280
|
* @param {module:model/String} opts.dateType Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (default to 'captured')
|
|
281
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
282
|
-
* @param {String} opts.files
|
|
281
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
282
|
+
* @param {String} opts.files
|
|
283
283
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
284
284
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
285
285
|
* @param {Array.<String>} opts.sessionUID Filter by Session UID
|
|
@@ -297,14 +297,14 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
297
297
|
|
|
298
298
|
/**
|
|
299
299
|
* Get Events of a Fleet by cursor
|
|
300
|
-
* @param {String} projectOrProductUID
|
|
301
|
-
* @param {String} fleetUID
|
|
300
|
+
* @param {String} projectOrProductUID
|
|
301
|
+
* @param {String} fleetUID
|
|
302
302
|
* @param {Object} opts Optional parameters
|
|
303
303
|
* @param {Number} opts.limit (default to 50)
|
|
304
|
-
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
304
|
+
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
305
305
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
306
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
307
|
-
* @param {String} opts.files
|
|
306
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
307
|
+
* @param {String} opts.files
|
|
308
308
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
309
309
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
310
310
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
@@ -324,38 +324,38 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
324
324
|
throw new _Error["default"]("Missing the required parameter 'fleetUID' when calling getFleetEventsByCursor");
|
|
325
325
|
}
|
|
326
326
|
var pathParams = {
|
|
327
|
-
projectOrProductUID: projectOrProductUID,
|
|
328
|
-
fleetUID: fleetUID
|
|
327
|
+
'projectOrProductUID': projectOrProductUID,
|
|
328
|
+
'fleetUID': fleetUID
|
|
329
329
|
};
|
|
330
330
|
var queryParams = {
|
|
331
|
-
limit: opts[
|
|
332
|
-
cursor: opts[
|
|
333
|
-
sortOrder: opts[
|
|
334
|
-
systemFilesOnly: opts[
|
|
335
|
-
files: opts[
|
|
336
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
337
|
-
startDate: opts[
|
|
338
|
-
endDate: opts[
|
|
331
|
+
'limit': opts['limit'],
|
|
332
|
+
'cursor': opts['cursor'],
|
|
333
|
+
'sortOrder': opts['sortOrder'],
|
|
334
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
335
|
+
'files': opts['files'],
|
|
336
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
337
|
+
'startDate': opts['startDate'],
|
|
338
|
+
'endDate': opts['endDate']
|
|
339
339
|
};
|
|
340
340
|
var headerParams = {};
|
|
341
341
|
var formParams = {};
|
|
342
|
-
var authNames = [
|
|
342
|
+
var authNames = ['personalAccessToken'];
|
|
343
343
|
var contentTypes = [];
|
|
344
|
-
var accepts = [
|
|
344
|
+
var accepts = ['application/json'];
|
|
345
345
|
var returnType = _GetEventsByCursor200Response["default"];
|
|
346
|
-
return this.apiClient.callApi(
|
|
346
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
347
347
|
}
|
|
348
348
|
|
|
349
349
|
/**
|
|
350
350
|
* Get Events of a Fleet by cursor
|
|
351
|
-
* @param {String} projectOrProductUID
|
|
352
|
-
* @param {String} fleetUID
|
|
351
|
+
* @param {String} projectOrProductUID
|
|
352
|
+
* @param {String} fleetUID
|
|
353
353
|
* @param {Object} opts Optional parameters
|
|
354
354
|
* @param {Number} opts.limit (default to 50)
|
|
355
|
-
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
355
|
+
* @param {String} opts.cursor A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included.
|
|
356
356
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
357
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
358
|
-
* @param {String} opts.files
|
|
357
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
358
|
+
* @param {String} opts.files
|
|
359
359
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
360
360
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
361
361
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
@@ -371,8 +371,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
371
371
|
|
|
372
372
|
/**
|
|
373
373
|
* Get Route Logs by Event UID
|
|
374
|
-
* @param {String} projectOrProductUID
|
|
375
|
-
* @param {String} eventUID
|
|
374
|
+
* @param {String} projectOrProductUID
|
|
375
|
+
* @param {String} eventUID
|
|
376
376
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/RouteLog>} and HTTP response
|
|
377
377
|
*/
|
|
378
378
|
}, {
|
|
@@ -388,23 +388,23 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
388
388
|
throw new _Error["default"]("Missing the required parameter 'eventUID' when calling getRouteLogsByEvent");
|
|
389
389
|
}
|
|
390
390
|
var pathParams = {
|
|
391
|
-
projectOrProductUID: projectOrProductUID,
|
|
392
|
-
eventUID: eventUID
|
|
391
|
+
'projectOrProductUID': projectOrProductUID,
|
|
392
|
+
'eventUID': eventUID
|
|
393
393
|
};
|
|
394
394
|
var queryParams = {};
|
|
395
395
|
var headerParams = {};
|
|
396
396
|
var formParams = {};
|
|
397
|
-
var authNames = [
|
|
397
|
+
var authNames = ['personalAccessToken'];
|
|
398
398
|
var contentTypes = [];
|
|
399
|
-
var accepts = [
|
|
399
|
+
var accepts = ['application/json'];
|
|
400
400
|
var returnType = [_RouteLog["default"]];
|
|
401
|
-
return this.apiClient.callApi(
|
|
401
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
402
402
|
}
|
|
403
403
|
|
|
404
404
|
/**
|
|
405
405
|
* Get Route Logs by Event UID
|
|
406
|
-
* @param {String} projectOrProductUID
|
|
407
|
-
* @param {String} eventUID
|
|
406
|
+
* @param {String} projectOrProductUID
|
|
407
|
+
* @param {String} eventUID
|
|
408
408
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/RouteLog>}
|
|
409
409
|
*/
|
|
410
410
|
}, {
|
|
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
16
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
17
|
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); } /**
|
|
18
18
|
* Notehub API
|
|
19
|
-
* The OpenAPI definition for the Notehub.io API.
|
|
19
|
+
* The OpenAPI definition for the Notehub.io API.
|
|
20
20
|
*
|
|
21
21
|
* The version of the OpenAPI document: 1.2.0
|
|
22
22
|
* Contact: engineering@blues.io
|
|
@@ -27,18 +27,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
/**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
30
|
+
* ExternalDevices service.
|
|
31
|
+
* @module api/ExternalDevicesApi
|
|
32
|
+
* @version 4.0.0-beta.1
|
|
33
|
+
*/
|
|
34
34
|
var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
36
|
+
* Constructs a new ExternalDevicesApi.
|
|
37
|
+
* @alias module:api/ExternalDevicesApi
|
|
38
|
+
* @class
|
|
39
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
40
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
41
|
+
*/
|
|
42
42
|
function ExternalDevicesApi(apiClient) {
|
|
43
43
|
_classCallCheck(this, ExternalDevicesApi);
|
|
44
44
|
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
@@ -46,8 +46,8 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
48
|
* Creates an event using specified webhook
|
|
49
|
-
* @param {String} productUID
|
|
50
|
-
* @param {String} deviceUID
|
|
49
|
+
* @param {String} productUID
|
|
50
|
+
* @param {String} deviceUID
|
|
51
51
|
* @param {module:model/Event} event Event Object
|
|
52
52
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
53
53
|
*/
|
|
@@ -68,23 +68,23 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
68
68
|
throw new _Error["default"]("Missing the required parameter 'event' when calling createEventExtDevice");
|
|
69
69
|
}
|
|
70
70
|
var pathParams = {
|
|
71
|
-
productUID: productUID,
|
|
72
|
-
deviceUID: deviceUID
|
|
71
|
+
'productUID': productUID,
|
|
72
|
+
'deviceUID': deviceUID
|
|
73
73
|
};
|
|
74
74
|
var queryParams = {};
|
|
75
75
|
var headerParams = {};
|
|
76
76
|
var formParams = {};
|
|
77
|
-
var authNames = [
|
|
78
|
-
var contentTypes = [
|
|
79
|
-
var accepts = [
|
|
77
|
+
var authNames = ['personalAccessToken'];
|
|
78
|
+
var contentTypes = ['application/json'];
|
|
79
|
+
var accepts = ['application/json'];
|
|
80
80
|
var returnType = null;
|
|
81
|
-
return this.apiClient.callApi(
|
|
81
|
+
return this.apiClient.callApi('/v1/products/{productUID}/ext-devices/{deviceUID}/event', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
82
82
|
}
|
|
83
83
|
|
|
84
84
|
/**
|
|
85
85
|
* Creates an event using specified webhook
|
|
86
|
-
* @param {String} productUID
|
|
87
|
-
* @param {String} deviceUID
|
|
86
|
+
* @param {String} productUID
|
|
87
|
+
* @param {String} deviceUID
|
|
88
88
|
* @param {module:model/Event} event Event Object
|
|
89
89
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
90
90
|
*/
|
|
@@ -98,8 +98,8 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
98
98
|
|
|
99
99
|
/**
|
|
100
100
|
* Closes the session for the specified device if open
|
|
101
|
-
* @param {String} productUID
|
|
102
|
-
* @param {String} deviceUID
|
|
101
|
+
* @param {String} productUID
|
|
102
|
+
* @param {String} deviceUID
|
|
103
103
|
* @param {module:model/DeviceSession} deviceSession Session Object
|
|
104
104
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
105
105
|
*/
|
|
@@ -120,23 +120,23 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
120
120
|
throw new _Error["default"]("Missing the required parameter 'deviceSession' when calling extDeviceSessionClose");
|
|
121
121
|
}
|
|
122
122
|
var pathParams = {
|
|
123
|
-
productUID: productUID,
|
|
124
|
-
deviceUID: deviceUID
|
|
123
|
+
'productUID': productUID,
|
|
124
|
+
'deviceUID': deviceUID
|
|
125
125
|
};
|
|
126
126
|
var queryParams = {};
|
|
127
127
|
var headerParams = {};
|
|
128
128
|
var formParams = {};
|
|
129
|
-
var authNames = [
|
|
130
|
-
var contentTypes = [
|
|
131
|
-
var accepts = [
|
|
129
|
+
var authNames = ['personalAccessToken'];
|
|
130
|
+
var contentTypes = ['application/json'];
|
|
131
|
+
var accepts = ['application/json'];
|
|
132
132
|
var returnType = null;
|
|
133
|
-
return this.apiClient.callApi(
|
|
133
|
+
return this.apiClient.callApi('/v1/products/{productUID}/ext-devices/{deviceUID}/session/close', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
134
134
|
}
|
|
135
135
|
|
|
136
136
|
/**
|
|
137
137
|
* Closes the session for the specified device if open
|
|
138
|
-
* @param {String} productUID
|
|
139
|
-
* @param {String} deviceUID
|
|
138
|
+
* @param {String} productUID
|
|
139
|
+
* @param {String} deviceUID
|
|
140
140
|
* @param {module:model/DeviceSession} deviceSession Session Object
|
|
141
141
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
142
142
|
*/
|
|
@@ -150,8 +150,8 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
150
150
|
|
|
151
151
|
/**
|
|
152
152
|
* Create a Session for the specified device. | If a session is currently open it will be closed and a new one opened.
|
|
153
|
-
* @param {String} productUID
|
|
154
|
-
* @param {String} deviceUID
|
|
153
|
+
* @param {String} productUID
|
|
154
|
+
* @param {String} deviceUID
|
|
155
155
|
* @param {module:model/DeviceSession} deviceSession Session Object
|
|
156
156
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
157
157
|
*/
|
|
@@ -172,23 +172,23 @@ var ExternalDevicesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
172
172
|
throw new _Error["default"]("Missing the required parameter 'deviceSession' when calling extDeviceSessionOpen");
|
|
173
173
|
}
|
|
174
174
|
var pathParams = {
|
|
175
|
-
productUID: productUID,
|
|
176
|
-
deviceUID: deviceUID
|
|
175
|
+
'productUID': productUID,
|
|
176
|
+
'deviceUID': deviceUID
|
|
177
177
|
};
|
|
178
178
|
var queryParams = {};
|
|
179
179
|
var headerParams = {};
|
|
180
180
|
var formParams = {};
|
|
181
|
-
var authNames = [
|
|
182
|
-
var contentTypes = [
|
|
183
|
-
var accepts = [
|
|
181
|
+
var authNames = ['personalAccessToken'];
|
|
182
|
+
var contentTypes = ['application/json'];
|
|
183
|
+
var accepts = ['application/json'];
|
|
184
184
|
var returnType = null;
|
|
185
|
-
return this.apiClient.callApi(
|
|
185
|
+
return this.apiClient.callApi('/v1/products/{productUID}/ext-devices/{deviceUID}/session/open', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
186
186
|
}
|
|
187
187
|
|
|
188
188
|
/**
|
|
189
189
|
* Create a Session for the specified device. | If a session is currently open it will be closed and a new one opened.
|
|
190
|
-
* @param {String} productUID
|
|
191
|
-
* @param {String} deviceUID
|
|
190
|
+
* @param {String} productUID
|
|
191
|
+
* @param {String} deviceUID
|
|
192
192
|
* @param {module:model/DeviceSession} deviceSession Session Object
|
|
193
193
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
194
194
|
*/
|