@blues-inc/notehub-js 2.2.1 → 2.3.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 +250 -241
- package/dist/ApiClient.js +154 -154
- 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 +370 -370
- 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 +44 -44
- package/dist/api/WebhookApi.js +51 -51
- package/dist/index.js +7 -0
- 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 +17 -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/DeleteDeviceFleetsRequest.js +8 -8
- package/dist/model/Device.js +102 -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 +35 -35
- package/dist/model/FleetConnectivityAssurance.js +6 -6
- 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/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/GetDeviceLatest200Response.js +10 -9
- package/dist/model/GetDevicePlans200Response.js +10 -9
- package/dist/model/GetDevicePublicKey200Response.js +16 -16
- package/dist/model/GetDeviceSessions200Response.js +17 -16
- package/dist/model/GetProducts200Response.js +10 -9
- package/dist/model/GetProjectDevicePublicKeys200Response.js +17 -16
- package/dist/model/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.js +12 -12
- package/dist/model/GetProjectDevices200Response.js +17 -16
- package/dist/model/GetProjectEvents200Response.js +21 -20
- package/dist/model/GetProjectEventsByCursor200Response.js +24 -23
- package/dist/model/GetProjectMembers200Response.js +12 -11
- package/dist/model/GetProjects200Response.js +10 -9
- package/dist/model/GetSessionsUsage200Response.js +12 -11
- package/dist/model/GetWebhooks200Response.js +10 -9
- package/dist/model/GoogleRoute.js +33 -33
- package/dist/model/HandleNoteChanges200Response.js +11 -11
- package/dist/model/HandleNoteGet200Response.js +13 -13
- package/dist/model/HandleNoteSignal200Response.js +5 -5
- package/dist/model/HandleNotefileChanges200Response.js +11 -11
- package/dist/model/HandleNotefileChangesPending200Response.js +14 -14
- package/dist/model/HandleNotefileDeleteRequest.js +7 -7
- 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 +10 -10
- package/dist/model/NotefileSchema.js +19 -18
- package/dist/model/NotehubRoute.js +112 -98
- 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/PostProvisionProjectDeviceRequest.js +18 -18
- package/dist/model/Product.js +26 -26
- package/dist/model/Project.js +34 -34
- package/dist/model/ProjectMember.js +22 -22
- package/dist/model/ProxyRoute.js +38 -24
- package/dist/model/PutDeviceFleetsRequest.js +8 -8
- 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 +27 -14
- package/dist/model/S3ArchiveRoute.js +79 -79
- package/dist/model/SatellitePlan.js +26 -26
- package/dist/model/SchemaProperty.js +38 -36
- 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 +223 -0
- 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 +30 -30
- package/dist/model/UploadMetadata.js +64 -64
- package/dist/model/UsageData.js +18 -18
- package/dist/model/UsageEventsData.js +29 -29
- package/dist/model/UsageEventsResponse.js +12 -11
- package/dist/model/UsageRouteLogsData.js +27 -27
- package/dist/model/UsageSessionsData.js +27 -27
- package/dist/model/UserDfuStateMachine.js +20 -20
- package/dist/model/UserDfuStateMachineStatus.js +20 -20
- package/dist/model/UserFirmwareInfo.js +12 -12
- package/dist/model/WebhookSettings.js +15 -15
- package/package.json +3 -3
package/dist/api/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 2.3.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,8 +47,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Get Events of a Fleet
|
|
50
|
-
* @param {String} projectOrProductUID
|
|
51
|
-
* @param {String} fleetUID
|
|
50
|
+
* @param {String} projectOrProductUID
|
|
51
|
+
* @param {String} fleetUID
|
|
52
52
|
* @param {Object} opts Optional parameters
|
|
53
53
|
* @param {Number} opts.pageSize (default to 50)
|
|
54
54
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -58,8 +58,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
58
58
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
59
59
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
60
60
|
* @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')
|
|
61
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
62
|
-
* @param {String} opts.files
|
|
61
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
62
|
+
* @param {String} opts.files
|
|
63
63
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
64
64
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
65
65
|
* @param {Array.<String>} opts.sessionUID Filter by Session UID
|
|
@@ -81,39 +81,39 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
81
81
|
throw new _Error["default"]("Missing the required parameter 'fleetUID' when calling getFleetEvents");
|
|
82
82
|
}
|
|
83
83
|
var pathParams = {
|
|
84
|
-
projectOrProductUID: projectOrProductUID,
|
|
85
|
-
fleetUID: fleetUID
|
|
84
|
+
'projectOrProductUID': projectOrProductUID,
|
|
85
|
+
'fleetUID': fleetUID
|
|
86
86
|
};
|
|
87
87
|
var queryParams = {
|
|
88
|
-
pageSize: opts[
|
|
89
|
-
pageNum: opts[
|
|
90
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
91
|
-
sortBy: opts[
|
|
92
|
-
sortOrder: opts[
|
|
93
|
-
startDate: opts[
|
|
94
|
-
endDate: opts[
|
|
95
|
-
dateType: opts[
|
|
96
|
-
systemFilesOnly: opts[
|
|
97
|
-
files: opts[
|
|
98
|
-
format: opts[
|
|
99
|
-
serialNumber: this.apiClient.buildCollectionParam(opts[
|
|
100
|
-
sessionUID: this.apiClient.buildCollectionParam(opts[
|
|
101
|
-
eventUID: this.apiClient.buildCollectionParam(opts[
|
|
102
|
-
selectFields: opts[
|
|
88
|
+
'pageSize': opts['pageSize'],
|
|
89
|
+
'pageNum': opts['pageNum'],
|
|
90
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
91
|
+
'sortBy': opts['sortBy'],
|
|
92
|
+
'sortOrder': opts['sortOrder'],
|
|
93
|
+
'startDate': opts['startDate'],
|
|
94
|
+
'endDate': opts['endDate'],
|
|
95
|
+
'dateType': opts['dateType'],
|
|
96
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
97
|
+
'files': opts['files'],
|
|
98
|
+
'format': opts['format'],
|
|
99
|
+
'serialNumber': this.apiClient.buildCollectionParam(opts['serialNumber'], 'multi'),
|
|
100
|
+
'sessionUID': this.apiClient.buildCollectionParam(opts['sessionUID'], 'multi'),
|
|
101
|
+
'eventUID': this.apiClient.buildCollectionParam(opts['eventUID'], 'multi'),
|
|
102
|
+
'selectFields': opts['selectFields']
|
|
103
103
|
};
|
|
104
104
|
var headerParams = {};
|
|
105
105
|
var formParams = {};
|
|
106
|
-
var authNames = [
|
|
106
|
+
var authNames = ['personalAccessToken'];
|
|
107
107
|
var contentTypes = [];
|
|
108
|
-
var accepts = [
|
|
108
|
+
var accepts = ['application/json', 'text/csv'];
|
|
109
109
|
var returnType = _GetProjectEvents200Response["default"];
|
|
110
|
-
return this.apiClient.callApi(
|
|
110
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
111
111
|
}
|
|
112
112
|
|
|
113
113
|
/**
|
|
114
114
|
* Get Events of a Fleet
|
|
115
|
-
* @param {String} projectOrProductUID
|
|
116
|
-
* @param {String} fleetUID
|
|
115
|
+
* @param {String} projectOrProductUID
|
|
116
|
+
* @param {String} fleetUID
|
|
117
117
|
* @param {Object} opts Optional parameters
|
|
118
118
|
* @param {Number} opts.pageSize (default to 50)
|
|
119
119
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -123,8 +123,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
123
123
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
124
124
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
125
125
|
* @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')
|
|
126
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
127
|
-
* @param {String} opts.files
|
|
126
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
127
|
+
* @param {String} opts.files
|
|
128
128
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
129
129
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
130
130
|
* @param {Array.<String>} opts.sessionUID Filter by Session UID
|
|
@@ -142,14 +142,14 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
142
142
|
|
|
143
143
|
/**
|
|
144
144
|
* Get Events of a Fleet by cursor
|
|
145
|
-
* @param {String} projectOrProductUID
|
|
146
|
-
* @param {String} fleetUID
|
|
145
|
+
* @param {String} projectOrProductUID
|
|
146
|
+
* @param {String} fleetUID
|
|
147
147
|
* @param {Object} opts Optional parameters
|
|
148
148
|
* @param {Number} opts.limit (default to 50)
|
|
149
|
-
* @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.
|
|
149
|
+
* @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.
|
|
150
150
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
151
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
152
|
-
* @param {String} opts.files
|
|
151
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
152
|
+
* @param {String} opts.files
|
|
153
153
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
154
154
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
155
155
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
@@ -169,38 +169,38 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
169
169
|
throw new _Error["default"]("Missing the required parameter 'fleetUID' when calling getFleetEventsByCursor");
|
|
170
170
|
}
|
|
171
171
|
var pathParams = {
|
|
172
|
-
projectOrProductUID: projectOrProductUID,
|
|
173
|
-
fleetUID: fleetUID
|
|
172
|
+
'projectOrProductUID': projectOrProductUID,
|
|
173
|
+
'fleetUID': fleetUID
|
|
174
174
|
};
|
|
175
175
|
var queryParams = {
|
|
176
|
-
limit: opts[
|
|
177
|
-
cursor: opts[
|
|
178
|
-
sortOrder: opts[
|
|
179
|
-
systemFilesOnly: opts[
|
|
180
|
-
files: opts[
|
|
181
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
182
|
-
startDate: opts[
|
|
183
|
-
endDate: opts[
|
|
176
|
+
'limit': opts['limit'],
|
|
177
|
+
'cursor': opts['cursor'],
|
|
178
|
+
'sortOrder': opts['sortOrder'],
|
|
179
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
180
|
+
'files': opts['files'],
|
|
181
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
182
|
+
'startDate': opts['startDate'],
|
|
183
|
+
'endDate': opts['endDate']
|
|
184
184
|
};
|
|
185
185
|
var headerParams = {};
|
|
186
186
|
var formParams = {};
|
|
187
|
-
var authNames = [
|
|
187
|
+
var authNames = ['personalAccessToken'];
|
|
188
188
|
var contentTypes = [];
|
|
189
|
-
var accepts = [
|
|
189
|
+
var accepts = ['application/json'];
|
|
190
190
|
var returnType = _GetProjectEventsByCursor200Response["default"];
|
|
191
|
-
return this.apiClient.callApi(
|
|
191
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
192
192
|
}
|
|
193
193
|
|
|
194
194
|
/**
|
|
195
195
|
* Get Events of a Fleet by cursor
|
|
196
|
-
* @param {String} projectOrProductUID
|
|
197
|
-
* @param {String} fleetUID
|
|
196
|
+
* @param {String} projectOrProductUID
|
|
197
|
+
* @param {String} fleetUID
|
|
198
198
|
* @param {Object} opts Optional parameters
|
|
199
199
|
* @param {Number} opts.limit (default to 50)
|
|
200
|
-
* @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.
|
|
200
|
+
* @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.
|
|
201
201
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
202
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
203
|
-
* @param {String} opts.files
|
|
202
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
203
|
+
* @param {String} opts.files
|
|
204
204
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
205
205
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
206
206
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
@@ -216,7 +216,7 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
216
216
|
|
|
217
217
|
/**
|
|
218
218
|
* Get Events of a Project
|
|
219
|
-
* @param {String} projectOrProductUID
|
|
219
|
+
* @param {String} projectOrProductUID
|
|
220
220
|
* @param {Object} opts Optional parameters
|
|
221
221
|
* @param {Number} opts.pageSize (default to 50)
|
|
222
222
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -226,8 +226,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
226
226
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
227
227
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
228
228
|
* @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')
|
|
229
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
230
|
-
* @param {String} opts.files
|
|
229
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
230
|
+
* @param {String} opts.files
|
|
231
231
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
232
232
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
233
233
|
* @param {Array.<String>} opts.fleetUID Filter by Fleet UID
|
|
@@ -246,38 +246,38 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
246
246
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getProjectEvents");
|
|
247
247
|
}
|
|
248
248
|
var pathParams = {
|
|
249
|
-
projectOrProductUID: projectOrProductUID
|
|
249
|
+
'projectOrProductUID': projectOrProductUID
|
|
250
250
|
};
|
|
251
251
|
var queryParams = {
|
|
252
|
-
pageSize: opts[
|
|
253
|
-
pageNum: opts[
|
|
254
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
255
|
-
sortBy: opts[
|
|
256
|
-
sortOrder: opts[
|
|
257
|
-
startDate: opts[
|
|
258
|
-
endDate: opts[
|
|
259
|
-
dateType: opts[
|
|
260
|
-
systemFilesOnly: opts[
|
|
261
|
-
files: opts[
|
|
262
|
-
format: opts[
|
|
263
|
-
serialNumber: this.apiClient.buildCollectionParam(opts[
|
|
264
|
-
fleetUID: this.apiClient.buildCollectionParam(opts[
|
|
265
|
-
sessionUID: this.apiClient.buildCollectionParam(opts[
|
|
266
|
-
eventUID: this.apiClient.buildCollectionParam(opts[
|
|
267
|
-
selectFields: opts[
|
|
252
|
+
'pageSize': opts['pageSize'],
|
|
253
|
+
'pageNum': opts['pageNum'],
|
|
254
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
|
|
255
|
+
'sortBy': opts['sortBy'],
|
|
256
|
+
'sortOrder': opts['sortOrder'],
|
|
257
|
+
'startDate': opts['startDate'],
|
|
258
|
+
'endDate': opts['endDate'],
|
|
259
|
+
'dateType': opts['dateType'],
|
|
260
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
261
|
+
'files': opts['files'],
|
|
262
|
+
'format': opts['format'],
|
|
263
|
+
'serialNumber': this.apiClient.buildCollectionParam(opts['serialNumber'], 'multi'),
|
|
264
|
+
'fleetUID': this.apiClient.buildCollectionParam(opts['fleetUID'], 'multi'),
|
|
265
|
+
'sessionUID': this.apiClient.buildCollectionParam(opts['sessionUID'], 'multi'),
|
|
266
|
+
'eventUID': this.apiClient.buildCollectionParam(opts['eventUID'], 'multi'),
|
|
267
|
+
'selectFields': opts['selectFields']
|
|
268
268
|
};
|
|
269
269
|
var headerParams = {};
|
|
270
270
|
var formParams = {};
|
|
271
|
-
var authNames = [
|
|
271
|
+
var authNames = ['personalAccessToken'];
|
|
272
272
|
var contentTypes = [];
|
|
273
|
-
var accepts = [
|
|
273
|
+
var accepts = ['application/json', 'text/csv'];
|
|
274
274
|
var returnType = _GetProjectEvents200Response["default"];
|
|
275
|
-
return this.apiClient.callApi(
|
|
275
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/events', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
276
276
|
}
|
|
277
277
|
|
|
278
278
|
/**
|
|
279
279
|
* Get Events of a Project
|
|
280
|
-
* @param {String} projectOrProductUID
|
|
280
|
+
* @param {String} projectOrProductUID
|
|
281
281
|
* @param {Object} opts Optional parameters
|
|
282
282
|
* @param {Number} opts.pageSize (default to 50)
|
|
283
283
|
* @param {Number} opts.pageNum (default to 1)
|
|
@@ -287,8 +287,8 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
287
287
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
288
288
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
289
289
|
* @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')
|
|
290
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
291
|
-
* @param {String} opts.files
|
|
290
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
291
|
+
* @param {String} opts.files
|
|
292
292
|
* @param {module:model/String} opts.format Response format (JSON or CSV) (default to 'json')
|
|
293
293
|
* @param {Array.<String>} opts.serialNumber Filter by Serial Number
|
|
294
294
|
* @param {Array.<String>} opts.fleetUID Filter by Fleet UID
|
|
@@ -307,14 +307,14 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
307
307
|
|
|
308
308
|
/**
|
|
309
309
|
* Get Events of a Project by cursor
|
|
310
|
-
* @param {String} projectOrProductUID
|
|
310
|
+
* @param {String} projectOrProductUID
|
|
311
311
|
* @param {Object} opts Optional parameters
|
|
312
312
|
* @param {Number} opts.limit (default to 50)
|
|
313
|
-
* @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.
|
|
313
|
+
* @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.
|
|
314
314
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
315
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
316
|
-
* @param {String} opts.files
|
|
317
|
-
* @param {String} opts.fleetUID
|
|
315
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
316
|
+
* @param {String} opts.files
|
|
317
|
+
* @param {String} opts.fleetUID
|
|
318
318
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
319
319
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetProjectEventsByCursor200Response} and HTTP response
|
|
320
320
|
*/
|
|
@@ -328,36 +328,36 @@ var EventApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
328
328
|
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getProjectEventsByCursor");
|
|
329
329
|
}
|
|
330
330
|
var pathParams = {
|
|
331
|
-
projectOrProductUID: projectOrProductUID
|
|
331
|
+
'projectOrProductUID': projectOrProductUID
|
|
332
332
|
};
|
|
333
333
|
var queryParams = {
|
|
334
|
-
limit: opts[
|
|
335
|
-
cursor: opts[
|
|
336
|
-
sortOrder: opts[
|
|
337
|
-
systemFilesOnly: opts[
|
|
338
|
-
files: opts[
|
|
339
|
-
fleetUID: opts[
|
|
340
|
-
deviceUID: this.apiClient.buildCollectionParam(opts[
|
|
334
|
+
'limit': opts['limit'],
|
|
335
|
+
'cursor': opts['cursor'],
|
|
336
|
+
'sortOrder': opts['sortOrder'],
|
|
337
|
+
'systemFilesOnly': opts['systemFilesOnly'],
|
|
338
|
+
'files': opts['files'],
|
|
339
|
+
'fleetUID': opts['fleetUID'],
|
|
340
|
+
'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi')
|
|
341
341
|
};
|
|
342
342
|
var headerParams = {};
|
|
343
343
|
var formParams = {};
|
|
344
|
-
var authNames = [
|
|
344
|
+
var authNames = ['personalAccessToken'];
|
|
345
345
|
var contentTypes = [];
|
|
346
|
-
var accepts = [
|
|
346
|
+
var accepts = ['application/json'];
|
|
347
347
|
var returnType = _GetProjectEventsByCursor200Response["default"];
|
|
348
|
-
return this.apiClient.callApi(
|
|
348
|
+
return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/events-cursor', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
349
349
|
}
|
|
350
350
|
|
|
351
351
|
/**
|
|
352
352
|
* Get Events of a Project by cursor
|
|
353
|
-
* @param {String} projectOrProductUID
|
|
353
|
+
* @param {String} projectOrProductUID
|
|
354
354
|
* @param {Object} opts Optional parameters
|
|
355
355
|
* @param {Number} opts.limit (default to 50)
|
|
356
|
-
* @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
|
+
* @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.
|
|
357
357
|
* @param {module:model/String} opts.sortOrder (default to 'asc')
|
|
358
|
-
* @param {Boolean} opts.systemFilesOnly
|
|
359
|
-
* @param {String} opts.files
|
|
360
|
-
* @param {String} opts.fleetUID
|
|
358
|
+
* @param {Boolean} opts.systemFilesOnly
|
|
359
|
+
* @param {String} opts.files
|
|
360
|
+
* @param {String} opts.fleetUID
|
|
361
361
|
* @param {Array.<String>} opts.deviceUID A Device UID.
|
|
362
362
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetProjectEventsByCursor200Response}
|
|
363
363
|
*/
|
|
@@ -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 2.3.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
|
*/
|