@blues-inc/notehub-js 6.7.0-beta.3 → 6.7.0-beta.30
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 +149 -146
- package/dist/ApiClient.js +2 -2
- package/dist/api/AlertApi.js +1 -1
- package/dist/api/AuthorizationApi.js +3 -3
- package/dist/api/DescriptionApi.js +1 -1
- package/dist/api/DeviceApi.js +9 -9
- package/dist/api/EventApi.js +21 -166
- package/dist/api/ExternalDevicesApi.js +1 -1
- package/dist/api/JobsApi.js +1 -1
- package/dist/api/MonitorApi.js +1 -1
- package/dist/api/OrganizationApi.js +9 -9
- package/dist/api/ProjectApi.js +13 -13
- package/dist/api/RouteApi.js +5 -5
- package/dist/api/SkillsApi.js +279 -0
- package/dist/api/UsageApi.js +15 -15
- package/dist/api/WebhookApi.js +17 -17
- package/dist/index.js +77 -49
- package/dist/model/AWSRoleConfig.js +1 -1
- package/dist/model/AddDeviceToFleetsRequest.js +1 -1
- package/dist/model/Alert.js +4 -4
- package/dist/model/AlertDataInner.js +1 -1
- package/dist/model/AlertNotificationsInner.js +1 -1
- package/dist/model/ArchiveStats.js +1 -1
- package/dist/model/AwsRoute.js +1 -1
- package/dist/model/AzureRoute.js +1 -1
- package/dist/model/BatchJobNoteRequest.js +1 -1
- package/dist/model/BatchJobRequests.js +5 -5
- package/dist/model/BillingAccount.js +1 -1
- package/dist/model/BlynkRoute.js +1 -1
- package/dist/model/Body.js +1 -1
- package/dist/model/CancelJobRun200Response.js +1 -1
- package/dist/model/CellularPlan.js +1 -1
- package/dist/model/CloneProjectRequest.js +3 -3
- package/dist/model/Contact.js +1 -1
- package/dist/model/CreateFleetRequest.js +1 -1
- package/dist/model/CreateJob201Response.js +1 -1
- package/dist/model/CreateMonitor.js +1 -1
- package/dist/model/CreateProductRequest.js +1 -1
- package/dist/model/CreateProjectRequest.js +3 -3
- package/dist/model/CreateProjectSecretRequest.js +1 -1
- package/dist/model/CreateUpdateRepository.js +2 -1
- package/dist/model/CreatedRepository.js +1 -1
- package/dist/model/CurrentFirmware.js +1 -1
- package/dist/model/DFUEnv.js +1 -1
- package/dist/model/DFUState.js +1 -1
- package/dist/model/DataField.js +1 -1
- package/dist/model/DataSet.js +1 -1
- package/dist/model/DataSetField.js +1 -1
- package/dist/model/DataUsage.js +1 -1
- package/dist/model/DatacakeRoute.js +1 -1
- package/dist/model/DatasetReloadProgress.js +1 -1
- package/dist/model/DeleteDeviceFromFleetsRequest.js +1 -1
- package/dist/model/DeleteJob200Response.js +1 -1
- package/dist/model/DeleteNotefilesRequest.js +1 -1
- package/dist/model/DescriptionRecord.js +1 -1
- package/dist/model/DescriptionRecordList.js +1 -1
- package/dist/model/Device.js +2 -2
- package/dist/model/DeviceDfuHistory.js +2 -2
- package/dist/model/DeviceDfuHistoryCurrent.js +1 -1
- package/dist/model/DeviceDfuHistoryPage.js +1 -1
- package/dist/model/DeviceDfuStateMachine.js +1 -1
- package/dist/model/DeviceDfuStateMachineNode.js +1 -1
- package/dist/model/DeviceDfuStatus.js +2 -2
- package/dist/model/DeviceDfuStatusPage.js +1 -1
- package/dist/model/DeviceSensor.js +1 -1
- package/dist/model/DeviceSession.js +5 -5
- package/dist/model/DeviceTowerInfo.js +1 -1
- package/dist/model/DeviceUsage.js +1 -1
- package/dist/model/DfuActionRequest.js +1 -1
- package/dist/model/EmailNotification.js +1 -1
- package/dist/model/EnvTreeJsonNode.js +1 -1
- package/dist/model/EnvVar.js +1 -1
- package/dist/model/EnvironmentVariables.js +1 -1
- package/dist/model/Error.js +1 -1
- package/dist/model/Event.js +7 -7
- package/dist/model/Filter.js +1 -1
- package/dist/model/Firmware.js +1 -1
- package/dist/model/FirmwareInfo.js +1 -1
- package/dist/model/Fleet.js +3 -3
- package/dist/model/FleetConnectivityAssurance.js +1 -1
- package/dist/model/GetAlerts200Response.js +1 -1
- package/dist/model/GetApiUsage200Response.js +1 -1
- package/dist/model/GetDataUsage200Response.js +1 -1
- package/dist/model/GetDataUsage200ResponseDataInner.js +3 -3
- package/dist/model/GetDbNote200Response.js +1 -1
- package/dist/model/GetDeviceEnvironmentVariablesByPin200Response.js +1 -1
- package/dist/model/GetDeviceFleets200Response.js +1 -1
- package/dist/model/GetDeviceHealthLog200Response.js +1 -1
- package/dist/model/GetDeviceJourney200Response.js +1 -1
- package/dist/model/GetDeviceJourney200ResponseJourney.js +1 -1
- package/dist/model/GetDeviceJourneys200Response.js +1 -1
- package/dist/model/GetDeviceJourneys200ResponseJourneysInner.js +1 -1
- package/dist/model/GetDeviceLatestEvents200Response.js +1 -1
- package/dist/model/GetDevicePlans200Response.js +1 -1
- package/dist/model/GetDevicePublicKey200Response.js +1 -1
- package/dist/model/GetDevicePublicKeys200Response.js +1 -1
- package/dist/model/GetDevicePublicKeys200ResponseDevicePublicKeysInner.js +1 -1
- package/dist/model/GetDeviceSessions200Response.js +1 -1
- package/dist/model/GetDevices200Response.js +1 -1
- package/dist/model/GetEvents200Response.js +1 -1
- package/dist/model/GetJobRuns200Response.js +1 -1
- package/dist/model/GetJobs200Response.js +1 -1
- package/dist/model/GetNotefile200Response.js +1 -1
- package/dist/model/{GetBillingAccount200Response.js → GetOrganization200Response.js} +28 -28
- package/dist/model/{GetBillingAccount200ResponsePlan.js → GetOrganization200ResponsePlan.js} +24 -24
- package/dist/model/{GetBillingAccountBalanceHistory200Response.js → GetOrganizationBalanceHistory200Response.js} +22 -22
- package/dist/model/{GetBillingAccountBalanceHistory200ResponseDataInner.js → GetOrganizationBalanceHistory200ResponseDataInner.js} +22 -22
- package/dist/model/GetOrganizations200Response.js +1 -1
- package/dist/model/GetProducts200Response.js +1 -1
- package/dist/model/GetProjectMembers200Response.js +1 -1
- package/dist/model/GetProjectSecretsResponse.js +1 -1
- package/dist/model/GetProjects200Response.js +1 -1
- package/dist/model/GetRouteLogsUsage200Response.js +1 -1
- package/dist/model/GetSessionsUsage200Response.js +1 -1
- package/dist/model/GetWebhooks200Response.js +1 -1
- package/dist/model/GoogleRoute.js +1 -1
- package/dist/model/HealthLog.js +1 -1
- package/dist/model/HttpRoute.js +1 -1
- package/dist/model/Job.js +1 -1
- package/dist/model/JobDefinition.js +2 -2
- package/dist/model/JobDefinitionReportOptions.js +1 -1
- package/dist/model/JobDefinitionSelect.js +3 -3
- package/dist/model/JobDetail.js +1 -1
- package/dist/model/JobDetailAllOf.js +1 -1
- package/dist/model/JobRun.js +1 -1
- package/dist/model/Location.js +1 -1
- package/dist/model/Login200Response.js +1 -1
- package/dist/model/LoginRequest.js +1 -1
- package/dist/model/Monitor.js +1 -1
- package/dist/model/MonitorAlertRoutesInner.js +1 -1
- package/dist/model/MqttRoute.js +1 -1
- package/dist/model/Note.js +1 -1
- package/dist/model/NoteInput.js +1 -1
- package/dist/model/Notefile.js +1 -1
- package/dist/model/NotefileSchema.js +1 -1
- package/dist/model/NotehubRoute.js +1 -1
- package/dist/model/NotehubRouteSummary.js +1 -1
- package/dist/model/OAuth2Error.js +1 -1
- package/dist/model/OAuth2TokenResponse.js +1 -1
- package/dist/model/Organization.js +1 -1
- package/dist/model/Product.js +1 -1
- package/dist/model/Project.js +1 -1
- package/dist/model/ProjectMember.js +1 -1
- package/dist/model/ProjectSecret.js +1 -1
- package/dist/model/ProvisionDeviceRequest.js +1 -1
- package/dist/model/ProxyRoute.js +1 -1
- package/dist/model/QubitroRoute.js +1 -1
- package/dist/model/RadRoute.js +1 -1
- package/dist/model/Repository.js +1 -1
- package/dist/model/RepositoryListResponse.js +1 -1
- package/dist/model/RepositoryTokenRequest.js +1 -1
- package/dist/model/RepositoryTokenResponse.js +1 -1
- package/dist/model/RouteLog.js +3 -3
- package/dist/model/RouteTransformSettings.js +1 -1
- package/dist/model/RunJob200Response.js +1 -1
- package/dist/model/S3ArchiveRoute.js +1 -1
- package/dist/model/SatelliteDataUsage.js +1 -1
- package/dist/model/SatellitePlan.js +1 -1
- package/dist/model/SchemaProperty.js +1 -1
- package/dist/model/SignalDevice200Response.js +1 -1
- package/dist/model/SimUsage.js +1 -1
- package/dist/model/Skill.js +207 -0
- package/dist/model/{GetBillingAccounts200Response.js → SkillLinks.js} +59 -40
- package/dist/model/{GetEventsByCursor200Response.js → SkillSet.js} +75 -51
- package/dist/model/SkillSummary.js +205 -0
- package/dist/model/SkillWrite.js +128 -0
- package/dist/model/SkillWriteResult.js +153 -0
- package/dist/model/SlackBearerNotification.js +1 -1
- package/dist/model/SlackRoute.js +1 -1
- package/dist/model/SlackWebHookNotification.js +1 -1
- package/dist/model/SnowflakeRoute.js +1 -1
- package/dist/model/SnowpipeStreamingRoute.js +1 -1
- package/dist/model/ThingworxRoute.js +1 -1
- package/dist/model/TowerLocation.js +1 -1
- package/dist/model/TwilioRoute.js +1 -1
- package/dist/model/UpdateFleetRequest.js +1 -1
- package/dist/model/UpdateHostFirmwareRequest.js +1 -1
- package/dist/model/UpdateProjectSecretRequest.js +1 -1
- package/dist/model/UploadMetadata.js +1 -1
- package/dist/model/UsageApiData.js +1 -1
- package/dist/model/UsageData.js +1 -1
- package/dist/model/UsageEventsData.js +1 -1
- package/dist/model/UsageEventsResponse.js +1 -1
- package/dist/model/UsageRouteLogsData.js +2 -2
- package/dist/model/UsageSessionsData.js +1 -1
- package/dist/model/UserDfuStateMachine.js +1 -1
- package/dist/model/UserDfuStateMachineStatus.js +1 -1
- package/dist/model/UserFirmwareInfo.js +1 -1
- package/dist/model/WebhookSettings.js +1 -1
- package/package.json +1 -1
- package/dist/api/BillingAccountApi.js +0 -167
package/dist/api/RouteApi.js
CHANGED
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* Route service.
|
|
32
32
|
* @module api/RouteApi
|
|
33
|
-
* @version 6.7.0-beta.
|
|
33
|
+
* @version 6.7.0-beta.30
|
|
34
34
|
*/
|
|
35
35
|
var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -183,14 +183,14 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
183
183
|
}
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
|
-
* Get Route Logs by
|
|
186
|
+
* Get Route Logs by RouteUID
|
|
187
187
|
* @param {String} projectOrProductUID
|
|
188
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)
|
|
192
192
|
* @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
|
|
193
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
193
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
194
194
|
* @param {module:model/String} opts.sortBy (default to 'date')
|
|
195
195
|
* @param {module:model/String} opts.sortOrder (default to 'desc')
|
|
196
196
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -244,14 +244,14 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
244
244
|
}
|
|
245
245
|
|
|
246
246
|
/**
|
|
247
|
-
* Get Route Logs by
|
|
247
|
+
* Get Route Logs by RouteUID
|
|
248
248
|
* @param {String} projectOrProductUID
|
|
249
249
|
* @param {String} routeUID
|
|
250
250
|
* @param {Object} opts Optional parameters
|
|
251
251
|
* @param {Number} opts.pageSize (default to 50)
|
|
252
252
|
* @param {Number} opts.pageNum (default to 1)
|
|
253
253
|
* @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
|
|
254
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
254
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
255
255
|
* @param {module:model/String} opts.sortBy (default to 'date')
|
|
256
256
|
* @param {module:model/String} opts.sortOrder (default to 'desc')
|
|
257
257
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
@@ -0,0 +1,279 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = void 0;
|
|
7
|
+
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _Error = _interopRequireDefault(require("../model/Error"));
|
|
9
|
+
var _Skill = _interopRequireDefault(require("../model/Skill"));
|
|
10
|
+
var _SkillSet = _interopRequireDefault(require("../model/SkillSet"));
|
|
11
|
+
var _SkillWrite = _interopRequireDefault(require("../model/SkillWrite"));
|
|
12
|
+
var _SkillWriteResult = _interopRequireDefault(require("../model/SkillWriteResult"));
|
|
13
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
14
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
15
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
16
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
17
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
18
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
|
+
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
20
|
+
* Notehub API
|
|
21
|
+
* The OpenAPI definition for the Notehub.io API.
|
|
22
|
+
*
|
|
23
|
+
* The version of the OpenAPI document: 1.2.0
|
|
24
|
+
* Contact: engineering@blues.io
|
|
25
|
+
*
|
|
26
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
27
|
+
* https://openapi-generator.tech
|
|
28
|
+
* Do not edit the class manually.
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
/**
|
|
32
|
+
* Skills service.
|
|
33
|
+
* @module api/SkillsApi
|
|
34
|
+
* @version 6.7.0-beta.30
|
|
35
|
+
*/
|
|
36
|
+
var SkillsApi = exports["default"] = /*#__PURE__*/function () {
|
|
37
|
+
/**
|
|
38
|
+
* Constructs a new SkillsApi.
|
|
39
|
+
* @alias module:api/SkillsApi
|
|
40
|
+
* @class
|
|
41
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
42
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
43
|
+
*/
|
|
44
|
+
function SkillsApi(apiClient) {
|
|
45
|
+
_classCallCheck(this, SkillsApi);
|
|
46
|
+
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Delete a Project Skill (Product Skill)
|
|
51
|
+
* Skill Training: delete a skill and all its stored versions. Requires If-Match: \"revision\" from GetSkill. Subproject writes must target the parent project.
|
|
52
|
+
* @param {String} projectOrProductUID
|
|
53
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
54
|
+
* @param {String} ifMatch Required; use one strong ETag or quoted skill revision. Wildcards and weak tags are rejected.
|
|
55
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
56
|
+
*/
|
|
57
|
+
return _createClass(SkillsApi, [{
|
|
58
|
+
key: "deleteSkillWithHttpInfo",
|
|
59
|
+
value: function deleteSkillWithHttpInfo(projectOrProductUID, skillName, ifMatch) {
|
|
60
|
+
var postBody = null;
|
|
61
|
+
// verify the required parameter 'projectOrProductUID' is set
|
|
62
|
+
if (projectOrProductUID === undefined || projectOrProductUID === null) {
|
|
63
|
+
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling deleteSkill");
|
|
64
|
+
}
|
|
65
|
+
// verify the required parameter 'skillName' is set
|
|
66
|
+
if (skillName === undefined || skillName === null) {
|
|
67
|
+
throw new _Error["default"]("Missing the required parameter 'skillName' when calling deleteSkill");
|
|
68
|
+
}
|
|
69
|
+
// verify the required parameter 'ifMatch' is set
|
|
70
|
+
if (ifMatch === undefined || ifMatch === null) {
|
|
71
|
+
throw new _Error["default"]("Missing the required parameter 'ifMatch' when calling deleteSkill");
|
|
72
|
+
}
|
|
73
|
+
var pathParams = {
|
|
74
|
+
projectOrProductUID: projectOrProductUID,
|
|
75
|
+
skillName: skillName
|
|
76
|
+
};
|
|
77
|
+
var queryParams = {};
|
|
78
|
+
var headerParams = {
|
|
79
|
+
"If-Match": ifMatch
|
|
80
|
+
};
|
|
81
|
+
var formParams = {};
|
|
82
|
+
var authNames = ["personalAccessToken"];
|
|
83
|
+
var contentTypes = [];
|
|
84
|
+
var accepts = ["application/json"];
|
|
85
|
+
var returnType = null;
|
|
86
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/skills/{skillName}", "DELETE", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Delete a Project Skill (Product Skill)
|
|
91
|
+
* Skill Training: delete a skill and all its stored versions. Requires If-Match: \"revision\" from GetSkill. Subproject writes must target the parent project.
|
|
92
|
+
* @param {String} projectOrProductUID
|
|
93
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
94
|
+
* @param {String} ifMatch Required; use one strong ETag or quoted skill revision. Wildcards and weak tags are rejected.
|
|
95
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
96
|
+
*/
|
|
97
|
+
}, {
|
|
98
|
+
key: "deleteSkill",
|
|
99
|
+
value: function deleteSkill(projectOrProductUID, skillName, ifMatch) {
|
|
100
|
+
return this.deleteSkillWithHttpInfo(projectOrProductUID, skillName, ifMatch).then(function (response_and_data) {
|
|
101
|
+
return response_and_data.data;
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Read a Project Skill (Product Skill)
|
|
107
|
+
* Read one skill with metadata and exact Markdown content. Use links.self from GetSkills, or URL-encode the entire skill name as one path parameter. If-Match requires a revision; If-None-Match skips unchanged content.
|
|
108
|
+
* @param {String} projectOrProductUID
|
|
109
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
110
|
+
* @param {Object} opts Optional parameters
|
|
111
|
+
* @param {String} opts.ifMatch Optionally require one strong ETag or quoted skill revision; wildcards and weak tags are rejected.
|
|
112
|
+
* @param {String} opts.ifNoneMatch Return 304 if an ETag for this skill matches, or use * to match any existing skill at this name.
|
|
113
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Skill} and HTTP response
|
|
114
|
+
*/
|
|
115
|
+
}, {
|
|
116
|
+
key: "getSkillWithHttpInfo",
|
|
117
|
+
value: function getSkillWithHttpInfo(projectOrProductUID, skillName, opts) {
|
|
118
|
+
opts = opts || {};
|
|
119
|
+
var postBody = null;
|
|
120
|
+
// verify the required parameter 'projectOrProductUID' is set
|
|
121
|
+
if (projectOrProductUID === undefined || projectOrProductUID === null) {
|
|
122
|
+
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getSkill");
|
|
123
|
+
}
|
|
124
|
+
// verify the required parameter 'skillName' is set
|
|
125
|
+
if (skillName === undefined || skillName === null) {
|
|
126
|
+
throw new _Error["default"]("Missing the required parameter 'skillName' when calling getSkill");
|
|
127
|
+
}
|
|
128
|
+
var pathParams = {
|
|
129
|
+
projectOrProductUID: projectOrProductUID,
|
|
130
|
+
skillName: skillName
|
|
131
|
+
};
|
|
132
|
+
var queryParams = {};
|
|
133
|
+
var headerParams = {
|
|
134
|
+
"If-Match": opts["ifMatch"],
|
|
135
|
+
"If-None-Match": opts["ifNoneMatch"]
|
|
136
|
+
};
|
|
137
|
+
var formParams = {};
|
|
138
|
+
var authNames = ["personalAccessToken"];
|
|
139
|
+
var contentTypes = [];
|
|
140
|
+
var accepts = ["application/json"];
|
|
141
|
+
var returnType = _Skill["default"];
|
|
142
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/skills/{skillName}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Read a Project Skill (Product Skill)
|
|
147
|
+
* Read one skill with metadata and exact Markdown content. Use links.self from GetSkills, or URL-encode the entire skill name as one path parameter. If-Match requires a revision; If-None-Match skips unchanged content.
|
|
148
|
+
* @param {String} projectOrProductUID
|
|
149
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
150
|
+
* @param {Object} opts Optional parameters
|
|
151
|
+
* @param {String} opts.ifMatch Optionally require one strong ETag or quoted skill revision; wildcards and weak tags are rejected.
|
|
152
|
+
* @param {String} opts.ifNoneMatch Return 304 if an ETag for this skill matches, or use * to match any existing skill at this name.
|
|
153
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Skill}
|
|
154
|
+
*/
|
|
155
|
+
}, {
|
|
156
|
+
key: "getSkill",
|
|
157
|
+
value: function getSkill(projectOrProductUID, skillName, opts) {
|
|
158
|
+
return this.getSkillWithHttpInfo(projectOrProductUID, skillName, opts).then(function (response_and_data) {
|
|
159
|
+
return response_and_data.data;
|
|
160
|
+
});
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* List Project Skills (Product Skills)
|
|
165
|
+
* List all skill metadata. Set includeContent=true to include exact Markdown content in one consistent snapshot. No pagination; an empty project returns skills: []. On 413, list metadata and use GetSkill for individual documents. Subprojects read their parent's skills.
|
|
166
|
+
* @param {String} projectOrProductUID
|
|
167
|
+
* @param {Object} opts Optional parameters
|
|
168
|
+
* @param {Boolean} opts.includeContent Use true to include exact Markdown content. Omit or use false for metadata only. (default to false)
|
|
169
|
+
* @param {String} opts.ifNoneMatch Return 304 if an ETag from GetSkills matches, or use * to match any current representation.
|
|
170
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SkillSet} and HTTP response
|
|
171
|
+
*/
|
|
172
|
+
}, {
|
|
173
|
+
key: "getSkillsWithHttpInfo",
|
|
174
|
+
value: function getSkillsWithHttpInfo(projectOrProductUID, opts) {
|
|
175
|
+
opts = opts || {};
|
|
176
|
+
var postBody = null;
|
|
177
|
+
// verify the required parameter 'projectOrProductUID' is set
|
|
178
|
+
if (projectOrProductUID === undefined || projectOrProductUID === null) {
|
|
179
|
+
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getSkills");
|
|
180
|
+
}
|
|
181
|
+
var pathParams = {
|
|
182
|
+
projectOrProductUID: projectOrProductUID
|
|
183
|
+
};
|
|
184
|
+
var queryParams = {
|
|
185
|
+
includeContent: opts["includeContent"]
|
|
186
|
+
};
|
|
187
|
+
var headerParams = {
|
|
188
|
+
"If-None-Match": opts["ifNoneMatch"]
|
|
189
|
+
};
|
|
190
|
+
var formParams = {};
|
|
191
|
+
var authNames = ["personalAccessToken"];
|
|
192
|
+
var contentTypes = [];
|
|
193
|
+
var accepts = ["application/json"];
|
|
194
|
+
var returnType = _SkillSet["default"];
|
|
195
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/skills", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* List Project Skills (Product Skills)
|
|
200
|
+
* List all skill metadata. Set includeContent=true to include exact Markdown content in one consistent snapshot. No pagination; an empty project returns skills: []. On 413, list metadata and use GetSkill for individual documents. Subprojects read their parent's skills.
|
|
201
|
+
* @param {String} projectOrProductUID
|
|
202
|
+
* @param {Object} opts Optional parameters
|
|
203
|
+
* @param {Boolean} opts.includeContent Use true to include exact Markdown content. Omit or use false for metadata only. (default to false)
|
|
204
|
+
* @param {String} opts.ifNoneMatch Return 304 if an ETag from GetSkills matches, or use * to match any current representation.
|
|
205
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SkillSet}
|
|
206
|
+
*/
|
|
207
|
+
}, {
|
|
208
|
+
key: "getSkills",
|
|
209
|
+
value: function getSkills(projectOrProductUID, opts) {
|
|
210
|
+
return this.getSkillsWithHttpInfo(projectOrProductUID, opts).then(function (response_and_data) {
|
|
211
|
+
return response_and_data.data;
|
|
212
|
+
});
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Create or replace a Project Skill (Product Skill)
|
|
217
|
+
* Skill Training: create with If-None-Match: *, or replace with If-Match: \"revision\" from GetSkill. Send content and optional kinds. Omit kinds to preserve them; [] clears them. An identical write returns unchanged. Subproject writes must target the parent project.
|
|
218
|
+
* @param {String} projectOrProductUID
|
|
219
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
220
|
+
* @param {module:model/SkillWrite} skillWrite
|
|
221
|
+
* @param {Object} opts Optional parameters
|
|
222
|
+
* @param {String} opts.ifMatch Required for replacement; use one strong ETag or quoted skill revision. Wildcards and weak tags are rejected.
|
|
223
|
+
* @param {String} opts.ifNoneMatch Use * to create only if the name is absent; cannot be combined with If-Match.
|
|
224
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SkillWriteResult} and HTTP response
|
|
225
|
+
*/
|
|
226
|
+
}, {
|
|
227
|
+
key: "putSkillWithHttpInfo",
|
|
228
|
+
value: function putSkillWithHttpInfo(projectOrProductUID, skillName, skillWrite, opts) {
|
|
229
|
+
opts = opts || {};
|
|
230
|
+
var postBody = skillWrite;
|
|
231
|
+
// verify the required parameter 'projectOrProductUID' is set
|
|
232
|
+
if (projectOrProductUID === undefined || projectOrProductUID === null) {
|
|
233
|
+
throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling putSkill");
|
|
234
|
+
}
|
|
235
|
+
// verify the required parameter 'skillName' is set
|
|
236
|
+
if (skillName === undefined || skillName === null) {
|
|
237
|
+
throw new _Error["default"]("Missing the required parameter 'skillName' when calling putSkill");
|
|
238
|
+
}
|
|
239
|
+
// verify the required parameter 'skillWrite' is set
|
|
240
|
+
if (skillWrite === undefined || skillWrite === null) {
|
|
241
|
+
throw new _Error["default"]("Missing the required parameter 'skillWrite' when calling putSkill");
|
|
242
|
+
}
|
|
243
|
+
var pathParams = {
|
|
244
|
+
projectOrProductUID: projectOrProductUID,
|
|
245
|
+
skillName: skillName
|
|
246
|
+
};
|
|
247
|
+
var queryParams = {};
|
|
248
|
+
var headerParams = {
|
|
249
|
+
"If-Match": opts["ifMatch"],
|
|
250
|
+
"If-None-Match": opts["ifNoneMatch"]
|
|
251
|
+
};
|
|
252
|
+
var formParams = {};
|
|
253
|
+
var authNames = ["personalAccessToken"];
|
|
254
|
+
var contentTypes = ["application/json"];
|
|
255
|
+
var accepts = ["application/json"];
|
|
256
|
+
var returnType = _SkillWriteResult["default"];
|
|
257
|
+
return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/skills/{skillName}", "PUT", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
/**
|
|
261
|
+
* Create or replace a Project Skill (Product Skill)
|
|
262
|
+
* Skill Training: create with If-None-Match: *, or replace with If-Match: \"revision\" from GetSkill. Send content and optional kinds. Omit kinds to preserve them; [] clears them. An identical write returns unchanged. Subproject writes must target the parent project.
|
|
263
|
+
* @param {String} projectOrProductUID
|
|
264
|
+
* @param {String} skillName Relative .md name, case-insensitive, at most 512 UTF-8 bytes. In URLs, encode the whole name once: references/devices.md becomes references%2Fdevices.md; a literal % becomes %25. Pass the unencoded name to SDKs. Spaces, Unicode and punctuation are allowed. No absolute paths, dot segments, empty segments, backslashes, colons, control characters or surrounding segment whitespace.
|
|
265
|
+
* @param {module:model/SkillWrite} skillWrite
|
|
266
|
+
* @param {Object} opts Optional parameters
|
|
267
|
+
* @param {String} opts.ifMatch Required for replacement; use one strong ETag or quoted skill revision. Wildcards and weak tags are rejected.
|
|
268
|
+
* @param {String} opts.ifNoneMatch Use * to create only if the name is absent; cannot be combined with If-Match.
|
|
269
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SkillWriteResult}
|
|
270
|
+
*/
|
|
271
|
+
}, {
|
|
272
|
+
key: "putSkill",
|
|
273
|
+
value: function putSkill(projectOrProductUID, skillName, skillWrite, opts) {
|
|
274
|
+
return this.putSkillWithHttpInfo(projectOrProductUID, skillName, skillWrite, opts).then(function (response_and_data) {
|
|
275
|
+
return response_and_data.data;
|
|
276
|
+
});
|
|
277
|
+
}
|
|
278
|
+
}]);
|
|
279
|
+
}();
|
package/dist/api/UsageApi.js
CHANGED
|
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
32
32
|
/**
|
|
33
33
|
* Usage service.
|
|
34
34
|
* @module api/UsageApi
|
|
35
|
-
* @version 6.7.0-beta.
|
|
35
|
+
* @version 6.7.0-beta.30
|
|
36
36
|
*/
|
|
37
37
|
var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
38
38
|
/**
|
|
@@ -113,8 +113,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
113
113
|
* @param {Object} opts Optional parameters
|
|
114
114
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
115
115
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
116
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
117
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
116
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
117
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
118
118
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
119
119
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
120
120
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDataUsage200Response} and HTTP response
|
|
@@ -160,8 +160,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
160
160
|
* @param {Object} opts Optional parameters
|
|
161
161
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
162
162
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
163
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
164
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
163
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
164
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
165
165
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
166
166
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
167
167
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDataUsage200Response}
|
|
@@ -181,8 +181,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
181
181
|
* @param {Object} opts Optional parameters
|
|
182
182
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
183
183
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
184
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
185
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
184
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
185
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
186
186
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
187
187
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
188
188
|
* @param {Array.<String>} opts.notefile Filter to specific notefiles
|
|
@@ -234,8 +234,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
234
234
|
* @param {Object} opts Optional parameters
|
|
235
235
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
236
236
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
237
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
238
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
237
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
238
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
239
239
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
240
240
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
241
241
|
* @param {Array.<String>} opts.notefile Filter to specific notefiles
|
|
@@ -258,7 +258,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
258
258
|
* @param {Object} opts Optional parameters
|
|
259
259
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
260
260
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
261
|
-
* @param {Array.<String>} opts.routeUID A
|
|
261
|
+
* @param {Array.<String>} opts.routeUID A RouteUID.
|
|
262
262
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
263
263
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
|
|
264
264
|
* @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
|
|
@@ -305,7 +305,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
305
305
|
* @param {Object} opts Optional parameters
|
|
306
306
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
307
307
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
308
|
-
* @param {Array.<String>} opts.routeUID A
|
|
308
|
+
* @param {Array.<String>} opts.routeUID A RouteUID.
|
|
309
309
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
310
310
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
|
|
311
311
|
* @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
|
|
@@ -326,8 +326,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
326
326
|
* @param {Object} opts Optional parameters
|
|
327
327
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
328
328
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
329
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
330
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
329
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
330
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
331
331
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
332
332
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
333
333
|
* @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
|
|
@@ -375,8 +375,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
375
375
|
* @param {Object} opts Optional parameters
|
|
376
376
|
* @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
|
|
377
377
|
* @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
|
|
378
|
-
* @param {Array.<String>} opts.deviceUID A
|
|
379
|
-
* @param {Array.<String>} opts.fleetUID Filter by
|
|
378
|
+
* @param {Array.<String>} opts.deviceUID A DeviceUID.
|
|
379
|
+
* @param {Array.<String>} opts.fleetUID Filter by FleetUID
|
|
380
380
|
* @param {Number} opts.limit Limit the number of data points returned (default to 200000)
|
|
381
381
|
* @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
|
|
382
382
|
* @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
|
package/dist/api/WebhookApi.js
CHANGED
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* Webhook service.
|
|
31
31
|
* @module api/WebhookApi
|
|
32
|
-
* @version 6.7.0-beta.
|
|
32
|
+
* @version 6.7.0-beta.30
|
|
33
33
|
*/
|
|
34
34
|
var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -99,7 +99,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
99
99
|
/**
|
|
100
100
|
* Creates a webhook for the specified product with the given name. The name | must be unique within the project.
|
|
101
101
|
* @param {String} projectOrProductUID
|
|
102
|
-
* @param {String} webhookUID
|
|
102
|
+
* @param {String} webhookUID WebhookUID
|
|
103
103
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
104
104
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
105
105
|
*/
|
|
@@ -136,7 +136,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
136
136
|
/**
|
|
137
137
|
* Creates a webhook for the specified product with the given name. The name | must be unique within the project.
|
|
138
138
|
* @param {String} projectOrProductUID
|
|
139
|
-
* @param {String} webhookUID
|
|
139
|
+
* @param {String} webhookUID WebhookUID
|
|
140
140
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
141
141
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
142
142
|
*/
|
|
@@ -151,7 +151,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
151
151
|
/**
|
|
152
152
|
* Sends an event to be processed by the specified webhook, addressed by productUID, associated with the given device (provisioning it if necessary). The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing.
|
|
153
153
|
* @param {String} productUID
|
|
154
|
-
* @param {String} webhookUID
|
|
154
|
+
* @param {String} webhookUID WebhookUID
|
|
155
155
|
* @param {String} deviceUID
|
|
156
156
|
* @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
|
|
157
157
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
@@ -194,7 +194,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
194
194
|
/**
|
|
195
195
|
* Sends an event to be processed by the specified webhook, addressed by productUID, associated with the given device (provisioning it if necessary). The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing.
|
|
196
196
|
* @param {String} productUID
|
|
197
|
-
* @param {String} webhookUID
|
|
197
|
+
* @param {String} webhookUID WebhookUID
|
|
198
198
|
* @param {String} deviceUID
|
|
199
199
|
* @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
|
|
200
200
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
@@ -210,7 +210,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
210
210
|
/**
|
|
211
211
|
* Sends an event to be processed by the specified webhook, addressed by productUID. The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing. The event is not associated with a specific device.
|
|
212
212
|
* @param {String} productUID
|
|
213
|
-
* @param {String} webhookUID
|
|
213
|
+
* @param {String} webhookUID WebhookUID
|
|
214
214
|
* @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
|
|
215
215
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
216
216
|
*/
|
|
@@ -247,7 +247,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
247
247
|
/**
|
|
248
248
|
* Sends an event to be processed by the specified webhook, addressed by productUID. The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing. The event is not associated with a specific device.
|
|
249
249
|
* @param {String} productUID
|
|
250
|
-
* @param {String} webhookUID
|
|
250
|
+
* @param {String} webhookUID WebhookUID
|
|
251
251
|
* @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
|
|
252
252
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
253
253
|
*/
|
|
@@ -262,7 +262,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
262
262
|
/**
|
|
263
263
|
* Deletes the specified webhook
|
|
264
264
|
* @param {String} projectOrProductUID
|
|
265
|
-
* @param {String} webhookUID
|
|
265
|
+
* @param {String} webhookUID WebhookUID
|
|
266
266
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
267
267
|
*/
|
|
268
268
|
}, {
|
|
@@ -294,7 +294,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
294
294
|
/**
|
|
295
295
|
* Deletes the specified webhook
|
|
296
296
|
* @param {String} projectOrProductUID
|
|
297
|
-
* @param {String} webhookUID
|
|
297
|
+
* @param {String} webhookUID WebhookUID
|
|
298
298
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
299
299
|
*/
|
|
300
300
|
}, {
|
|
@@ -308,7 +308,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
308
308
|
/**
|
|
309
309
|
* Retrieves the configuration settings for the specified webhook
|
|
310
310
|
* @param {String} projectOrProductUID
|
|
311
|
-
* @param {String} webhookUID
|
|
311
|
+
* @param {String} webhookUID WebhookUID
|
|
312
312
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WebhookSettings} and HTTP response
|
|
313
313
|
*/
|
|
314
314
|
}, {
|
|
@@ -340,7 +340,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
340
340
|
/**
|
|
341
341
|
* Retrieves the configuration settings for the specified webhook
|
|
342
342
|
* @param {String} projectOrProductUID
|
|
343
|
-
* @param {String} webhookUID
|
|
343
|
+
* @param {String} webhookUID WebhookUID
|
|
344
344
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WebhookSettings}
|
|
345
345
|
*/
|
|
346
346
|
}, {
|
|
@@ -354,7 +354,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
354
354
|
/**
|
|
355
355
|
* Retrieves the configuration settings for the specified webhook, addressed by productUID.
|
|
356
356
|
* @param {String} productUID
|
|
357
|
-
* @param {String} webhookUID
|
|
357
|
+
* @param {String} webhookUID WebhookUID
|
|
358
358
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WebhookSettings} and HTTP response
|
|
359
359
|
*/
|
|
360
360
|
}, {
|
|
@@ -386,7 +386,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
386
386
|
/**
|
|
387
387
|
* Retrieves the configuration settings for the specified webhook, addressed by productUID.
|
|
388
388
|
* @param {String} productUID
|
|
389
|
-
* @param {String} webhookUID
|
|
389
|
+
* @param {String} webhookUID WebhookUID
|
|
390
390
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WebhookSettings}
|
|
391
391
|
*/
|
|
392
392
|
}, {
|
|
@@ -490,7 +490,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
490
490
|
/**
|
|
491
491
|
* Updates the configuration settings for the specified webhook. | Webhook will be created if it does not exist. Update body will completely replace the existing settings.
|
|
492
492
|
* @param {String} projectOrProductUID
|
|
493
|
-
* @param {String} webhookUID
|
|
493
|
+
* @param {String} webhookUID WebhookUID
|
|
494
494
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
495
495
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
496
496
|
*/
|
|
@@ -527,7 +527,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
527
527
|
/**
|
|
528
528
|
* Updates the configuration settings for the specified webhook. | Webhook will be created if it does not exist. Update body will completely replace the existing settings.
|
|
529
529
|
* @param {String} projectOrProductUID
|
|
530
|
-
* @param {String} webhookUID
|
|
530
|
+
* @param {String} webhookUID WebhookUID
|
|
531
531
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
532
532
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
533
533
|
*/
|
|
@@ -542,7 +542,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
542
542
|
/**
|
|
543
543
|
* Updates the configuration settings for the specified webhook, addressed by productUID. Update body will completely replace the existing settings.
|
|
544
544
|
* @param {String} productUID
|
|
545
|
-
* @param {String} webhookUID
|
|
545
|
+
* @param {String} webhookUID WebhookUID
|
|
546
546
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
547
547
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
548
548
|
*/
|
|
@@ -579,7 +579,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
579
579
|
/**
|
|
580
580
|
* Updates the configuration settings for the specified webhook, addressed by productUID. Update body will completely replace the existing settings.
|
|
581
581
|
* @param {String} productUID
|
|
582
|
-
* @param {String} webhookUID
|
|
582
|
+
* @param {String} webhookUID WebhookUID
|
|
583
583
|
* @param {module:model/WebhookSettings} webhookSettings
|
|
584
584
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
585
585
|
*/
|