@blues-inc/notehub-js 1.0.9 → 1.0.11
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 +181 -178
- package/dist/ApiClient.js +157 -154
- package/dist/api/AuthorizationApi.js +63 -18
- package/dist/api/BillingAccountApi.js +15 -15
- package/dist/api/DeviceApi.js +159 -159
- package/dist/api/DevicesApi.js +58 -58
- package/dist/api/EnvironmentVariablesApi.js +110 -110
- package/dist/api/EventApi.js +94 -94
- package/dist/api/FilesApi.js +42 -42
- package/dist/api/FleetApi.js +160 -160
- package/dist/api/NotesApi.js +105 -105
- package/dist/api/ProductApi.js +29 -29
- package/dist/api/ProjectApi.js +139 -139
- package/dist/api/RouteApi.js +51 -51
- package/dist/index.js +7 -0
- package/dist/model/Aws.js +65 -64
- package/dist/model/Azure.js +51 -37
- package/dist/model/BillingAccount.js +20 -20
- package/dist/model/Body.js +4 -4
- package/dist/model/Contact.js +21 -21
- package/dist/model/CreateFleetRequest.js +6 -6
- package/dist/model/CreateProductRequest.js +21 -21
- package/dist/model/CreateProjectRequest.js +13 -13
- package/dist/model/DFUEnv.js +11 -11
- package/dist/model/DFUState.js +64 -64
- package/dist/model/DeleteDeviceFleetsRequest.js +7 -7
- package/dist/model/Device.js +82 -82
- package/dist/model/DeviceSession.js +181 -181
- package/dist/model/DeviceTowerInfo.js +13 -13
- package/dist/model/DeviceUsage.js +31 -31
- package/dist/model/EnvironmentVariables.js +7 -7
- package/dist/model/Error.js +30 -30
- package/dist/model/Event.js +222 -222
- package/dist/model/Fleet.js +20 -20
- package/dist/model/GenerateAuthToken200Response.js +114 -0
- package/dist/model/GetBillingAccounts200Response.js +8 -9
- package/dist/model/GetDeviceEnvironmentVariables200Response.js +11 -11
- package/dist/model/GetDeviceHealthLog200Response.js +10 -11
- package/dist/model/GetDeviceHealthLog200ResponseHealthLogInner.js +18 -18
- package/dist/model/GetDeviceLatest200Response.js +8 -9
- package/dist/model/GetDevicePublicKey200Response.js +15 -15
- package/dist/model/GetDeviceSessions200Response.js +15 -16
- package/dist/model/GetProjectDevicePublicKeys200Response.js +15 -16
- package/dist/model/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.js +11 -11
- package/dist/model/GetProjectDevices200Response.js +15 -16
- package/dist/model/GetProjectEvents200Response.js +20 -21
- package/dist/model/GetProjectEventsByCursor200Response.js +22 -23
- package/dist/model/GetProjectFleets200Response.js +10 -11
- package/dist/model/GetProjectMembers200Response.js +10 -11
- package/dist/model/GetProjectProducts200Response.js +8 -9
- package/dist/model/GetProjects200Response.js +8 -9
- package/dist/model/Google.js +27 -27
- package/dist/model/HandleNoteChanges200Response.js +10 -10
- package/dist/model/HandleNoteGet200Response.js +12 -12
- package/dist/model/HandleNoteSignal200Response.js +4 -4
- package/dist/model/HandleNotefileChanges200Response.js +10 -10
- package/dist/model/HandleNotefileChangesPending200Response.js +13 -13
- package/dist/model/HandleNotefileDeleteRequest.js +6 -6
- package/dist/model/Http.js +34 -34
- package/dist/model/HttpFilter.js +18 -18
- package/dist/model/HttpTransform.js +19 -19
- package/dist/model/Location.js +39 -39
- package/dist/model/Login200Response.js +6 -6
- package/dist/model/LoginRequest.js +11 -11
- package/dist/model/Mqtt.js +70 -71
- package/dist/model/Note.js +9 -9
- package/dist/model/Product.js +25 -25
- package/dist/model/Project.js +33 -33
- package/dist/model/ProjectMember.js +21 -21
- package/dist/model/Proxy.js +23 -23
- package/dist/model/PutDeviceFleetsRequest.js +7 -7
- package/dist/model/Radresponder.js +25 -25
- package/dist/model/Route.js +35 -35
- package/dist/model/RouteSchema.js +53 -43
- package/dist/model/Snowflake.js +45 -45
- package/dist/model/SnowflakeTransform.js +11 -11
- package/dist/model/Thingworx.js +33 -32
- package/dist/model/TowerLocation.js +51 -51
- package/dist/model/Twilio.js +43 -43
- package/dist/model/UpdateFleetRequest.js +16 -16
- package/dist/model/UserDbRoute.js +24 -24
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@ The OpenAPI definition for the Notehub.io API.
|
|
|
6
6
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
7
7
|
|
|
8
8
|
- API version: 1.0.0
|
|
9
|
-
- Package version: 1.0.
|
|
9
|
+
- Package version: 1.0.11
|
|
10
10
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
11
|
-
For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
|
|
11
|
+
For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
@@ -69,13 +69,13 @@ then install it via:
|
|
|
69
69
|
|
|
70
70
|
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
|
|
71
71
|
the above steps with Node.js and installing browserify with `npm install -g browserify`,
|
|
72
|
-
perform the following (assuming
|
|
72
|
+
perform the following (assuming _main.js_ is your entry file):
|
|
73
73
|
|
|
74
74
|
```shell
|
|
75
75
|
browserify main.js > bundle.js
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Then include
|
|
78
|
+
Then include _bundle.js_ in the HTML pages.
|
|
79
79
|
|
|
80
80
|
### Webpack Configuration
|
|
81
81
|
|
|
@@ -88,10 +88,10 @@ module: {
|
|
|
88
88
|
rules: [
|
|
89
89
|
{
|
|
90
90
|
parser: {
|
|
91
|
-
amd: false
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
]
|
|
91
|
+
amd: false,
|
|
92
|
+
},
|
|
93
|
+
},
|
|
94
|
+
];
|
|
95
95
|
}
|
|
96
96
|
```
|
|
97
97
|
|
|
@@ -100,198 +100,201 @@ module: {
|
|
|
100
100
|
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
101
101
|
|
|
102
102
|
```javascript
|
|
103
|
-
var NotehubJs = require(
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
var
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
103
|
+
var NotehubJs = require("@blues-inc/notehub-js");
|
|
104
|
+
|
|
105
|
+
var api = new NotehubJs.AuthorizationApi();
|
|
106
|
+
var opts = {
|
|
107
|
+
grantType: "grantType_example", // {String}
|
|
108
|
+
clientId: "clientId_example", // {String}
|
|
109
|
+
clientSecret: "clientSecret_example", // {String}
|
|
110
|
+
};
|
|
111
|
+
api.generateAuthToken(opts).then(
|
|
112
|
+
function (data) {
|
|
113
|
+
console.log(
|
|
114
|
+
"API called successfully. Returned data: " + JSON.stringify(data)
|
|
115
|
+
);
|
|
116
|
+
},
|
|
117
|
+
function (error) {
|
|
118
|
+
console.error(error);
|
|
119
|
+
}
|
|
120
|
+
);
|
|
115
121
|
```
|
|
116
122
|
|
|
117
123
|
## Documentation for API Endpoints
|
|
118
124
|
|
|
119
125
|
All URIs are relative to *https://api.notefile.net*
|
|
120
126
|
|
|
121
|
-
Class
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
127
|
+
| Class | Method | HTTP request | Description |
|
|
128
|
+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ----------- |
|
|
129
|
+
| _NotehubJs.AuthorizationApi_ | [**generateAuthToken**](docs/AuthorizationApi.md#generateAuthToken) | **POST** /oauth2/token |
|
|
130
|
+
| _NotehubJs.AuthorizationApi_ | [**login**](docs/AuthorizationApi.md#login) | **POST** /auth/login |
|
|
131
|
+
| _NotehubJs.BillingAccountApi_ | [**getBillingAccounts**](docs/BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts |
|
|
132
|
+
| _NotehubJs.DeviceApi_ | [**deleteDeviceEnvironmentVariable**](docs/DeviceApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} |
|
|
133
|
+
| _NotehubJs.DeviceApi_ | [**deleteDeviceFleets**](docs/DeviceApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
134
|
+
| _NotehubJs.DeviceApi_ | [**disableDevice**](docs/DeviceApi.md#disableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/disable |
|
|
135
|
+
| _NotehubJs.DeviceApi_ | [**enableDevice**](docs/DeviceApi.md#enableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/enable |
|
|
136
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceEnvironmentVariables**](docs/DeviceApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
137
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
138
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceFleets**](docs/DeviceApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
139
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceHealthLog**](docs/DeviceApi.md#getDeviceHealthLog) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/health-log |
|
|
140
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceLatest**](docs/DeviceApi.md#getDeviceLatest) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/latest |
|
|
141
|
+
| _NotehubJs.DeviceApi_ | [**getDevicePublicKey**](docs/DeviceApi.md#getDevicePublicKey) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/public-key |
|
|
142
|
+
| _NotehubJs.DeviceApi_ | [**getDeviceSessions**](docs/DeviceApi.md#getDeviceSessions) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/sessions |
|
|
143
|
+
| _NotehubJs.DeviceApi_ | [**handleNoteSignal**](docs/DeviceApi.md#handleNoteSignal) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/signal |
|
|
144
|
+
| _NotehubJs.DeviceApi_ | [**putDeviceEnvironmentVariables**](docs/DeviceApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
145
|
+
| _NotehubJs.DeviceApi_ | [**putDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
146
|
+
| _NotehubJs.DeviceApi_ | [**putDeviceFleets**](docs/DeviceApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
147
|
+
| _NotehubJs.DevicesApi_ | [**deleteProjectDevice**](docs/DevicesApi.md#deleteProjectDevice) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID} |
|
|
148
|
+
| _NotehubJs.DevicesApi_ | [**getDevice**](docs/DevicesApi.md#getDevice) | **GET** /v1/projects/{projectUID}/devices/{deviceUID} |
|
|
149
|
+
| _NotehubJs.DevicesApi_ | [**getProjectDevicePublicKeys**](docs/DevicesApi.md#getProjectDevicePublicKeys) | **GET** /v1/projects/{projectUID}/devices/public-keys |
|
|
150
|
+
| _NotehubJs.DevicesApi_ | [**getProjectDevices**](docs/DevicesApi.md#getProjectDevices) | **GET** /v1/projects/{projectUID}/devices |
|
|
151
|
+
| _NotehubJs.DevicesApi_ | [**getProjectFleetDevices**](docs/DevicesApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
152
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**deleteDeviceEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} |
|
|
153
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**deleteFleetEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} |
|
|
154
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**deleteProjectEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
|
|
155
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**getDeviceEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
156
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**getDeviceEnvironmentVariablesByPin**](docs/EnvironmentVariablesApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
157
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**getFleetEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
158
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**getProjectEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables |
|
|
159
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**putDeviceEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
160
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**putDeviceEnvironmentVariablesByPin**](docs/EnvironmentVariablesApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
161
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**putFleetEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
162
|
+
| _NotehubJs.EnvironmentVariablesApi_ | [**putProjectEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables |
|
|
163
|
+
| _NotehubJs.EventApi_ | [**getFleetEvents**](docs/EventApi.md#getFleetEvents) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events |
|
|
164
|
+
| _NotehubJs.EventApi_ | [**getFleetEventsByCursor**](docs/EventApi.md#getFleetEventsByCursor) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor |
|
|
165
|
+
| _NotehubJs.EventApi_ | [**getProjectEvents**](docs/EventApi.md#getProjectEvents) | **GET** /v1/projects/{projectUID}/events |
|
|
166
|
+
| _NotehubJs.EventApi_ | [**getProjectEventsByCursor**](docs/EventApi.md#getProjectEventsByCursor) | **GET** /v1/projects/{projectUID}/events-cursor |
|
|
167
|
+
| _NotehubJs.FilesApi_ | [**handleNotefileChanges**](docs/FilesApi.md#handleNotefileChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes |
|
|
168
|
+
| _NotehubJs.FilesApi_ | [**handleNotefileChangesPending**](docs/FilesApi.md#handleNotefileChangesPending) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes/pending |
|
|
169
|
+
| _NotehubJs.FilesApi_ | [**handleNotefileDelete**](docs/FilesApi.md#handleNotefileDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/files |
|
|
170
|
+
| _NotehubJs.FleetApi_ | [**createFleet**](docs/FleetApi.md#createFleet) | **POST** /v1/projects/{projectUID}/fleets |
|
|
171
|
+
| _NotehubJs.FleetApi_ | [**deleteDeviceFleets**](docs/FleetApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
172
|
+
| _NotehubJs.FleetApi_ | [**deleteFleet**](docs/FleetApi.md#deleteFleet) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID} |
|
|
173
|
+
| _NotehubJs.FleetApi_ | [**deleteFleetEnvironmentVariable**](docs/FleetApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} |
|
|
174
|
+
| _NotehubJs.FleetApi_ | [**getDeviceFleets**](docs/FleetApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
175
|
+
| _NotehubJs.FleetApi_ | [**getFleetEnvironmentVariables**](docs/FleetApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
176
|
+
| _NotehubJs.FleetApi_ | [**getFleetEvents**](docs/FleetApi.md#getFleetEvents) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events |
|
|
177
|
+
| _NotehubJs.FleetApi_ | [**getFleetEventsByCursor**](docs/FleetApi.md#getFleetEventsByCursor) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor |
|
|
178
|
+
| _NotehubJs.FleetApi_ | [**getProjectFleetDevices**](docs/FleetApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
179
|
+
| _NotehubJs.FleetApi_ | [**getProjectFleets**](docs/FleetApi.md#getProjectFleets) | **GET** /v1/projects/{projectUID}/fleets |
|
|
180
|
+
| _NotehubJs.FleetApi_ | [**putDeviceFleets**](docs/FleetApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
181
|
+
| _NotehubJs.FleetApi_ | [**putFleetEnvironmentVariables**](docs/FleetApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
182
|
+
| _NotehubJs.FleetApi_ | [**updateFleet**](docs/FleetApi.md#updateFleet) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID} |
|
|
183
|
+
| _NotehubJs.NotesApi_ | [**handleNoteAdd**](docs/NotesApi.md#handleNoteAdd) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID} |
|
|
184
|
+
| _NotehubJs.NotesApi_ | [**handleNoteChanges**](docs/NotesApi.md#handleNoteChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/changes |
|
|
185
|
+
| _NotehubJs.NotesApi_ | [**handleNoteCreateAdd**](docs/NotesApi.md#handleNoteCreateAdd) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
186
|
+
| _NotehubJs.NotesApi_ | [**handleNoteDelete**](docs/NotesApi.md#handleNoteDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
187
|
+
| _NotehubJs.NotesApi_ | [**handleNoteGet**](docs/NotesApi.md#handleNoteGet) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
188
|
+
| _NotehubJs.NotesApi_ | [**handleNoteUpdate**](docs/NotesApi.md#handleNoteUpdate) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
189
|
+
| _NotehubJs.ProductApi_ | [**createProduct**](docs/ProductApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
|
|
190
|
+
| _NotehubJs.ProductApi_ | [**getProjectByProduct**](docs/ProductApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project |
|
|
191
|
+
| _NotehubJs.ProductApi_ | [**getProjectProducts**](docs/ProductApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products |
|
|
192
|
+
| _NotehubJs.ProjectApi_ | [**createProduct**](docs/ProjectApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
|
|
193
|
+
| _NotehubJs.ProjectApi_ | [**createProject**](docs/ProjectApi.md#createProject) | **POST** /v1/projects |
|
|
194
|
+
| _NotehubJs.ProjectApi_ | [**deleteProjectEnvironmentVariable**](docs/ProjectApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
|
|
195
|
+
| _NotehubJs.ProjectApi_ | [**getProject**](docs/ProjectApi.md#getProject) | **GET** /v1/projects/{projectUID} |
|
|
196
|
+
| _NotehubJs.ProjectApi_ | [**getProjectByProduct**](docs/ProjectApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project |
|
|
197
|
+
| _NotehubJs.ProjectApi_ | [**getProjectDevicePublicKeys**](docs/ProjectApi.md#getProjectDevicePublicKeys) | **GET** /v1/projects/{projectUID}/devices/public-keys |
|
|
198
|
+
| _NotehubJs.ProjectApi_ | [**getProjectDevices**](docs/ProjectApi.md#getProjectDevices) | **GET** /v1/projects/{projectUID}/devices |
|
|
199
|
+
| _NotehubJs.ProjectApi_ | [**getProjectEnvironmentVariables**](docs/ProjectApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables |
|
|
200
|
+
| _NotehubJs.ProjectApi_ | [**getProjectEvents**](docs/ProjectApi.md#getProjectEvents) | **GET** /v1/projects/{projectUID}/events |
|
|
201
|
+
| _NotehubJs.ProjectApi_ | [**getProjectEventsByCursor**](docs/ProjectApi.md#getProjectEventsByCursor) | **GET** /v1/projects/{projectUID}/events-cursor |
|
|
202
|
+
| _NotehubJs.ProjectApi_ | [**getProjectFleetDevices**](docs/ProjectApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
203
|
+
| _NotehubJs.ProjectApi_ | [**getProjectMembers**](docs/ProjectApi.md#getProjectMembers) | **GET** /v1/projects/{projectUID}/members |
|
|
204
|
+
| _NotehubJs.ProjectApi_ | [**getProjectProducts**](docs/ProjectApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products |
|
|
205
|
+
| _NotehubJs.ProjectApi_ | [**getProjects**](docs/ProjectApi.md#getProjects) | **GET** /v1/projects |
|
|
206
|
+
| _NotehubJs.ProjectApi_ | [**putProjectEnvironmentVariables**](docs/ProjectApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables |
|
|
207
|
+
| _NotehubJs.RouteApi_ | [**createRoute**](docs/RouteApi.md#createRoute) | **POST** /v1/projects/{projectUID}/routes |
|
|
208
|
+
| _NotehubJs.RouteApi_ | [**deleteRoute**](docs/RouteApi.md#deleteRoute) | **DELETE** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
209
|
+
| _NotehubJs.RouteApi_ | [**getRoute**](docs/RouteApi.md#getRoute) | **GET** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
210
|
+
| _NotehubJs.RouteApi_ | [**getRoutes**](docs/RouteApi.md#getRoutes) | **GET** /v1/projects/{projectUID}/routes |
|
|
211
|
+
| _NotehubJs.RouteApi_ | [**updateRoute**](docs/RouteApi.md#updateRoute) | **PUT** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
206
212
|
|
|
207
213
|
## Documentation for Models
|
|
208
214
|
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
215
|
+
- [NotehubJs.Aws](docs/Aws.md)
|
|
216
|
+
- [NotehubJs.Azure](docs/Azure.md)
|
|
217
|
+
- [NotehubJs.BillingAccount](docs/BillingAccount.md)
|
|
218
|
+
- [NotehubJs.BillingAccountRole](docs/BillingAccountRole.md)
|
|
219
|
+
- [NotehubJs.Body](docs/Body.md)
|
|
220
|
+
- [NotehubJs.Contact](docs/Contact.md)
|
|
221
|
+
- [NotehubJs.CreateFleetRequest](docs/CreateFleetRequest.md)
|
|
222
|
+
- [NotehubJs.CreateProductRequest](docs/CreateProductRequest.md)
|
|
223
|
+
- [NotehubJs.CreateProjectRequest](docs/CreateProjectRequest.md)
|
|
224
|
+
- [NotehubJs.DFUEnv](docs/DFUEnv.md)
|
|
225
|
+
- [NotehubJs.DFUState](docs/DFUState.md)
|
|
226
|
+
- [NotehubJs.DeleteDeviceFleetsRequest](docs/DeleteDeviceFleetsRequest.md)
|
|
227
|
+
- [NotehubJs.Device](docs/Device.md)
|
|
228
|
+
- [NotehubJs.DeviceSession](docs/DeviceSession.md)
|
|
229
|
+
- [NotehubJs.DeviceTowerInfo](docs/DeviceTowerInfo.md)
|
|
230
|
+
- [NotehubJs.DeviceUsage](docs/DeviceUsage.md)
|
|
231
|
+
- [NotehubJs.EnvironmentVariables](docs/EnvironmentVariables.md)
|
|
232
|
+
- [NotehubJs.Error](docs/Error.md)
|
|
233
|
+
- [NotehubJs.Event](docs/Event.md)
|
|
234
|
+
- [NotehubJs.Fleet](docs/Fleet.md)
|
|
235
|
+
- [NotehubJs.GenerateAuthToken200Response](docs/GenerateAuthToken200Response.md)
|
|
236
|
+
- [NotehubJs.GetBillingAccounts200Response](docs/GetBillingAccounts200Response.md)
|
|
237
|
+
- [NotehubJs.GetDeviceEnvironmentVariables200Response](docs/GetDeviceEnvironmentVariables200Response.md)
|
|
238
|
+
- [NotehubJs.GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)
|
|
239
|
+
- [NotehubJs.GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)
|
|
240
|
+
- [NotehubJs.GetDeviceLatest200Response](docs/GetDeviceLatest200Response.md)
|
|
241
|
+
- [NotehubJs.GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)
|
|
242
|
+
- [NotehubJs.GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)
|
|
243
|
+
- [NotehubJs.GetProjectDevicePublicKeys200Response](docs/GetProjectDevicePublicKeys200Response.md)
|
|
244
|
+
- [NotehubJs.GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md)
|
|
245
|
+
- [NotehubJs.GetProjectDevices200Response](docs/GetProjectDevices200Response.md)
|
|
246
|
+
- [NotehubJs.GetProjectEvents200Response](docs/GetProjectEvents200Response.md)
|
|
247
|
+
- [NotehubJs.GetProjectEventsByCursor200Response](docs/GetProjectEventsByCursor200Response.md)
|
|
248
|
+
- [NotehubJs.GetProjectFleets200Response](docs/GetProjectFleets200Response.md)
|
|
249
|
+
- [NotehubJs.GetProjectMembers200Response](docs/GetProjectMembers200Response.md)
|
|
250
|
+
- [NotehubJs.GetProjectProducts200Response](docs/GetProjectProducts200Response.md)
|
|
251
|
+
- [NotehubJs.GetProjects200Response](docs/GetProjects200Response.md)
|
|
252
|
+
- [NotehubJs.Google](docs/Google.md)
|
|
253
|
+
- [NotehubJs.HandleNoteChanges200Response](docs/HandleNoteChanges200Response.md)
|
|
254
|
+
- [NotehubJs.HandleNoteGet200Response](docs/HandleNoteGet200Response.md)
|
|
255
|
+
- [NotehubJs.HandleNoteSignal200Response](docs/HandleNoteSignal200Response.md)
|
|
256
|
+
- [NotehubJs.HandleNotefileChanges200Response](docs/HandleNotefileChanges200Response.md)
|
|
257
|
+
- [NotehubJs.HandleNotefileChangesPending200Response](docs/HandleNotefileChangesPending200Response.md)
|
|
258
|
+
- [NotehubJs.HandleNotefileDeleteRequest](docs/HandleNotefileDeleteRequest.md)
|
|
259
|
+
- [NotehubJs.Http](docs/Http.md)
|
|
260
|
+
- [NotehubJs.HttpFilter](docs/HttpFilter.md)
|
|
261
|
+
- [NotehubJs.HttpTransform](docs/HttpTransform.md)
|
|
262
|
+
- [NotehubJs.Location](docs/Location.md)
|
|
263
|
+
- [NotehubJs.Login200Response](docs/Login200Response.md)
|
|
264
|
+
- [NotehubJs.LoginRequest](docs/LoginRequest.md)
|
|
265
|
+
- [NotehubJs.Mqtt](docs/Mqtt.md)
|
|
266
|
+
- [NotehubJs.Note](docs/Note.md)
|
|
267
|
+
- [NotehubJs.Product](docs/Product.md)
|
|
268
|
+
- [NotehubJs.Project](docs/Project.md)
|
|
269
|
+
- [NotehubJs.ProjectMember](docs/ProjectMember.md)
|
|
270
|
+
- [NotehubJs.Proxy](docs/Proxy.md)
|
|
271
|
+
- [NotehubJs.PutDeviceFleetsRequest](docs/PutDeviceFleetsRequest.md)
|
|
272
|
+
- [NotehubJs.Radresponder](docs/Radresponder.md)
|
|
273
|
+
- [NotehubJs.Role](docs/Role.md)
|
|
274
|
+
- [NotehubJs.Route](docs/Route.md)
|
|
275
|
+
- [NotehubJs.RouteSchema](docs/RouteSchema.md)
|
|
276
|
+
- [NotehubJs.Snowflake](docs/Snowflake.md)
|
|
277
|
+
- [NotehubJs.SnowflakeTransform](docs/SnowflakeTransform.md)
|
|
278
|
+
- [NotehubJs.Thingworx](docs/Thingworx.md)
|
|
279
|
+
- [NotehubJs.TowerLocation](docs/TowerLocation.md)
|
|
280
|
+
- [NotehubJs.Twilio](docs/Twilio.md)
|
|
281
|
+
- [NotehubJs.UpdateFleetRequest](docs/UpdateFleetRequest.md)
|
|
282
|
+
- [NotehubJs.UserDbRoute](docs/UserDbRoute.md)
|
|
277
283
|
|
|
278
284
|
## Documentation for Authorization
|
|
279
285
|
|
|
280
|
-
|
|
281
|
-
|
|
282
286
|
### api_key
|
|
283
287
|
|
|
284
|
-
|
|
285
288
|
- **Type**: API key
|
|
286
289
|
- **API key parameter name**: X-Session-Token
|
|
287
290
|
- **Location**: HTTP header
|
|
288
291
|
|
|
292
|
+
### bearer_access_token
|
|
289
293
|
|
|
294
|
+
- **Type**: Bearer authentication
|
|
290
295
|
|
|
291
296
|
### pin
|
|
292
297
|
|
|
293
|
-
|
|
294
298
|
- **Type**: API key
|
|
295
299
|
- **API key parameter name**: X-Auth-Token
|
|
296
300
|
- **Location**: HTTP header
|
|
297
|
-
|