@blues-inc/notehub-js 1.0.4
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 +297 -0
- package/dist/ApiClient.js +699 -0
- package/dist/api/AuthorizationApi.js +74 -0
- package/dist/api/BillingAccountApi.js +68 -0
- package/dist/api/DeviceApi.js +784 -0
- package/dist/api/DevicesApi.js +293 -0
- package/dist/api/EnvironmentVariablesApi.js +567 -0
- package/dist/api/EventApi.js +284 -0
- package/dist/api/FilesApi.js +193 -0
- package/dist/api/FleetApi.js +715 -0
- package/dist/api/NotesApi.js +435 -0
- package/dist/api/ProductApi.js +163 -0
- package/dist/api/ProjectApi.js +716 -0
- package/dist/api/RouteApi.js +266 -0
- package/dist/index.js +566 -0
- package/dist/model/Aws.js +233 -0
- package/dist/model/Azure.js +166 -0
- package/dist/model/BillingAccount.js +130 -0
- package/dist/model/BillingAccountRole.js +42 -0
- package/dist/model/Body.js +78 -0
- package/dist/model/Contact.js +118 -0
- package/dist/model/CreateFleetRequest.js +83 -0
- package/dist/model/CreateProductRequest.js +142 -0
- package/dist/model/CreateProjectRequest.js +119 -0
- package/dist/model/DFUEnv.js +97 -0
- package/dist/model/DFUState.js +276 -0
- package/dist/model/DeleteDeviceFleetsRequest.js +106 -0
- package/dist/model/Device.js +267 -0
- package/dist/model/DeviceSession.js +537 -0
- package/dist/model/DeviceTowerInfo.js +102 -0
- package/dist/model/DeviceUsage.js +150 -0
- package/dist/model/EnvironmentVariables.js +103 -0
- package/dist/model/Error.js +164 -0
- package/dist/model/Event.js +676 -0
- package/dist/model/Fleet.js +129 -0
- package/dist/model/GetBillingAccounts200Response.js +103 -0
- package/dist/model/GetDeviceEnvironmentVariables200Response.js +117 -0
- package/dist/model/GetDeviceHealthLog200Response.js +123 -0
- package/dist/model/GetDeviceHealthLog200ResponseHealthLogInner.js +125 -0
- package/dist/model/GetDeviceLatest200Response.js +104 -0
- package/dist/model/GetDevicePublicKey200Response.js +119 -0
- package/dist/model/GetDeviceSessions200Response.js +133 -0
- package/dist/model/GetProjectDevicePublicKeys200Response.js +133 -0
- package/dist/model/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.js +94 -0
- package/dist/model/GetProjectDevices200Response.js +133 -0
- package/dist/model/GetProjectEvents200Response.js +149 -0
- package/dist/model/GetProjectEventsByCursor200Response.js +149 -0
- package/dist/model/GetProjectFleets200Response.js +123 -0
- package/dist/model/GetProjectMembers200Response.js +123 -0
- package/dist/model/GetProjectProducts200Response.js +103 -0
- package/dist/model/GetProjects200Response.js +103 -0
- package/dist/model/Google.js +142 -0
- package/dist/model/HandleNoteChanges200Response.js +97 -0
- package/dist/model/HandleNoteGet200Response.js +101 -0
- package/dist/model/HandleNoteSignal200Response.js +79 -0
- package/dist/model/HandleNotefileChanges200Response.js +97 -0
- package/dist/model/HandleNotefileChangesPending200Response.js +106 -0
- package/dist/model/HandleNotefileDeleteRequest.js +83 -0
- package/dist/model/Http.js +163 -0
- package/dist/model/HttpFilter.js +128 -0
- package/dist/model/HttpTransform.js +139 -0
- package/dist/model/Location.js +167 -0
- package/dist/model/Login200Response.js +82 -0
- package/dist/model/LoginRequest.js +94 -0
- package/dist/model/Mqtt.js +240 -0
- package/dist/model/Note.js +90 -0
- package/dist/model/Product.js +141 -0
- package/dist/model/Project.js +165 -0
- package/dist/model/ProjectMember.js +131 -0
- package/dist/model/Proxy.js +128 -0
- package/dist/model/PutDeviceFleetsRequest.js +106 -0
- package/dist/model/Radresponder.js +130 -0
- package/dist/model/Role.js +43 -0
- package/dist/model/Route.js +245 -0
- package/dist/model/RouteSchema.js +427 -0
- package/dist/model/Snowflake.js +185 -0
- package/dist/model/SnowflakeTransform.js +97 -0
- package/dist/model/Thingworx.js +154 -0
- package/dist/model/TowerLocation.js +204 -0
- package/dist/model/Twilio.js +181 -0
- package/dist/model/UpdateFleetRequest.js +109 -0
- package/dist/model/UserDbRoute.js +131 -0
- package/package.json +49 -0
package/README.md
ADDED
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
# @blues-inc/notehub-js
|
|
2
|
+
|
|
3
|
+
NotehubJs - JavaScript client for @blues-inc/notehub-js
|
|
4
|
+
The OpenAPI definition for the Notehub.io API.
|
|
5
|
+
|
|
6
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
7
|
+
|
|
8
|
+
- API version: 1.0.0
|
|
9
|
+
- Package version: 1.0.4
|
|
10
|
+
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
11
|
+
For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### For [Node.js](https://nodejs.org/)
|
|
16
|
+
|
|
17
|
+
#### npm
|
|
18
|
+
|
|
19
|
+
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
20
|
+
|
|
21
|
+
Then install it via:
|
|
22
|
+
|
|
23
|
+
```shell
|
|
24
|
+
npm install @blues-inc/notehub-js --save
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Finally, you need to build the module:
|
|
28
|
+
|
|
29
|
+
```shell
|
|
30
|
+
npm run build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
##### Local development
|
|
34
|
+
|
|
35
|
+
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
|
|
36
|
+
|
|
37
|
+
```shell
|
|
38
|
+
npm install
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
|
|
42
|
+
|
|
43
|
+
```shell
|
|
44
|
+
npm link
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
To use the link you just defined in your project, switch to the directory you want to use your @blues-inc/notehub-js from, and run:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Finally, you need to build the module:
|
|
54
|
+
|
|
55
|
+
```shell
|
|
56
|
+
npm run build
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### git
|
|
60
|
+
|
|
61
|
+
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
62
|
+
then install it via:
|
|
63
|
+
|
|
64
|
+
```shell
|
|
65
|
+
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### For browser
|
|
69
|
+
|
|
70
|
+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
|
|
71
|
+
the above steps with Node.js and installing browserify with `npm install -g browserify`,
|
|
72
|
+
perform the following (assuming *main.js* is your entry file):
|
|
73
|
+
|
|
74
|
+
```shell
|
|
75
|
+
browserify main.js > bundle.js
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Then include *bundle.js* in the HTML pages.
|
|
79
|
+
|
|
80
|
+
### Webpack Configuration
|
|
81
|
+
|
|
82
|
+
Using Webpack you may encounter the following error: "Module not found: Error:
|
|
83
|
+
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
|
|
84
|
+
the following section to your webpack config:
|
|
85
|
+
|
|
86
|
+
```javascript
|
|
87
|
+
module: {
|
|
88
|
+
rules: [
|
|
89
|
+
{
|
|
90
|
+
parser: {
|
|
91
|
+
amd: false
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Getting Started
|
|
99
|
+
|
|
100
|
+
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
101
|
+
|
|
102
|
+
```javascript
|
|
103
|
+
var NotehubJs = require('@blues-inc/notehub-js');
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
var api = new NotehubJs.AuthorizationApi()
|
|
107
|
+
var loginRequest = new NotehubJs.LoginRequest(); // {LoginRequest}
|
|
108
|
+
api.login(loginRequest).then(function(data) {
|
|
109
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
110
|
+
}, function(error) {
|
|
111
|
+
console.error(error);
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Documentation for API Endpoints
|
|
118
|
+
|
|
119
|
+
All URIs are relative to *https://api.notefile.net*
|
|
120
|
+
|
|
121
|
+
Class | Method | HTTP request | Description
|
|
122
|
+
------------ | ------------- | ------------- | -------------
|
|
123
|
+
*NotehubJs.AuthorizationApi* | [**login**](docs/AuthorizationApi.md#login) | **POST** /auth/login |
|
|
124
|
+
*NotehubJs.BillingAccountApi* | [**getBillingAccounts**](docs/BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts |
|
|
125
|
+
*NotehubJs.DeviceApi* | [**deleteDeviceEnvironmentVariable**](docs/DeviceApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} |
|
|
126
|
+
*NotehubJs.DeviceApi* | [**deleteDeviceFleets**](docs/DeviceApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
127
|
+
*NotehubJs.DeviceApi* | [**disableDevice**](docs/DeviceApi.md#disableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/disable |
|
|
128
|
+
*NotehubJs.DeviceApi* | [**enableDevice**](docs/DeviceApi.md#enableDevice) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/enable |
|
|
129
|
+
*NotehubJs.DeviceApi* | [**getDeviceEnvironmentVariables**](docs/DeviceApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
130
|
+
*NotehubJs.DeviceApi* | [**getDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
131
|
+
*NotehubJs.DeviceApi* | [**getDeviceFleets**](docs/DeviceApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
132
|
+
*NotehubJs.DeviceApi* | [**getDeviceHealthLog**](docs/DeviceApi.md#getDeviceHealthLog) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/health-log |
|
|
133
|
+
*NotehubJs.DeviceApi* | [**getDeviceLatest**](docs/DeviceApi.md#getDeviceLatest) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/latest |
|
|
134
|
+
*NotehubJs.DeviceApi* | [**getDevicePublicKey**](docs/DeviceApi.md#getDevicePublicKey) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/public-key |
|
|
135
|
+
*NotehubJs.DeviceApi* | [**getDeviceSessions**](docs/DeviceApi.md#getDeviceSessions) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/sessions |
|
|
136
|
+
*NotehubJs.DeviceApi* | [**handleNoteSignal**](docs/DeviceApi.md#handleNoteSignal) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/signal |
|
|
137
|
+
*NotehubJs.DeviceApi* | [**putDeviceEnvironmentVariables**](docs/DeviceApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
138
|
+
*NotehubJs.DeviceApi* | [**putDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
139
|
+
*NotehubJs.DeviceApi* | [**putDeviceFleets**](docs/DeviceApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
140
|
+
*NotehubJs.DevicesApi* | [**deleteProjectDevice**](docs/DevicesApi.md#deleteProjectDevice) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID} |
|
|
141
|
+
*NotehubJs.DevicesApi* | [**getDevice**](docs/DevicesApi.md#getDevice) | **GET** /v1/projects/{projectUID}/devices/{deviceUID} |
|
|
142
|
+
*NotehubJs.DevicesApi* | [**getProjectDevicePublicKeys**](docs/DevicesApi.md#getProjectDevicePublicKeys) | **GET** /v1/projects/{projectUID}/devices/public-keys |
|
|
143
|
+
*NotehubJs.DevicesApi* | [**getProjectDevices**](docs/DevicesApi.md#getProjectDevices) | **GET** /v1/projects/{projectUID}/devices |
|
|
144
|
+
*NotehubJs.DevicesApi* | [**getProjectFleetDevices**](docs/DevicesApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
145
|
+
*NotehubJs.EnvironmentVariablesApi* | [**deleteDeviceEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key} |
|
|
146
|
+
*NotehubJs.EnvironmentVariablesApi* | [**deleteFleetEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} |
|
|
147
|
+
*NotehubJs.EnvironmentVariablesApi* | [**deleteProjectEnvironmentVariable**](docs/EnvironmentVariablesApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
|
|
148
|
+
*NotehubJs.EnvironmentVariablesApi* | [**getDeviceEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
149
|
+
*NotehubJs.EnvironmentVariablesApi* | [**getDeviceEnvironmentVariablesByPin**](docs/EnvironmentVariablesApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
150
|
+
*NotehubJs.EnvironmentVariablesApi* | [**getFleetEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
151
|
+
*NotehubJs.EnvironmentVariablesApi* | [**getProjectEnvironmentVariables**](docs/EnvironmentVariablesApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables |
|
|
152
|
+
*NotehubJs.EnvironmentVariablesApi* | [**putDeviceEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables |
|
|
153
|
+
*NotehubJs.EnvironmentVariablesApi* | [**putDeviceEnvironmentVariablesByPin**](docs/EnvironmentVariablesApi.md#putDeviceEnvironmentVariablesByPin) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin |
|
|
154
|
+
*NotehubJs.EnvironmentVariablesApi* | [**putFleetEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
155
|
+
*NotehubJs.EnvironmentVariablesApi* | [**putProjectEnvironmentVariables**](docs/EnvironmentVariablesApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables |
|
|
156
|
+
*NotehubJs.EventApi* | [**getFleetEvents**](docs/EventApi.md#getFleetEvents) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events |
|
|
157
|
+
*NotehubJs.EventApi* | [**getFleetEventsByCursor**](docs/EventApi.md#getFleetEventsByCursor) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor |
|
|
158
|
+
*NotehubJs.EventApi* | [**getProjectEvents**](docs/EventApi.md#getProjectEvents) | **GET** /v1/projects/{projectUID}/events |
|
|
159
|
+
*NotehubJs.EventApi* | [**getProjectEventsByCursor**](docs/EventApi.md#getProjectEventsByCursor) | **GET** /v1/projects/{projectUID}/events-cursor |
|
|
160
|
+
*NotehubJs.FilesApi* | [**handleNotefileChanges**](docs/FilesApi.md#handleNotefileChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes |
|
|
161
|
+
*NotehubJs.FilesApi* | [**handleNotefileChangesPending**](docs/FilesApi.md#handleNotefileChangesPending) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/files/changes/pending |
|
|
162
|
+
*NotehubJs.FilesApi* | [**handleNotefileDelete**](docs/FilesApi.md#handleNotefileDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/files |
|
|
163
|
+
*NotehubJs.FleetApi* | [**createFleet**](docs/FleetApi.md#createFleet) | **POST** /v1/projects/{projectUID}/fleets |
|
|
164
|
+
*NotehubJs.FleetApi* | [**deleteDeviceFleets**](docs/FleetApi.md#deleteDeviceFleets) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
165
|
+
*NotehubJs.FleetApi* | [**deleteFleet**](docs/FleetApi.md#deleteFleet) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID} |
|
|
166
|
+
*NotehubJs.FleetApi* | [**deleteFleetEnvironmentVariable**](docs/FleetApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key} |
|
|
167
|
+
*NotehubJs.FleetApi* | [**getDeviceFleets**](docs/FleetApi.md#getDeviceFleets) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
168
|
+
*NotehubJs.FleetApi* | [**getFleetEnvironmentVariables**](docs/FleetApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
169
|
+
*NotehubJs.FleetApi* | [**getFleetEvents**](docs/FleetApi.md#getFleetEvents) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events |
|
|
170
|
+
*NotehubJs.FleetApi* | [**getFleetEventsByCursor**](docs/FleetApi.md#getFleetEventsByCursor) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor |
|
|
171
|
+
*NotehubJs.FleetApi* | [**getProjectFleetDevices**](docs/FleetApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
172
|
+
*NotehubJs.FleetApi* | [**getProjectFleets**](docs/FleetApi.md#getProjectFleets) | **GET** /v1/projects/{projectUID}/fleets |
|
|
173
|
+
*NotehubJs.FleetApi* | [**putDeviceFleets**](docs/FleetApi.md#putDeviceFleets) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/fleets |
|
|
174
|
+
*NotehubJs.FleetApi* | [**putFleetEnvironmentVariables**](docs/FleetApi.md#putFleetEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables |
|
|
175
|
+
*NotehubJs.FleetApi* | [**updateFleet**](docs/FleetApi.md#updateFleet) | **PUT** /v1/projects/{projectUID}/fleets/{fleetUID} |
|
|
176
|
+
*NotehubJs.NotesApi* | [**handleNoteAdd**](docs/NotesApi.md#handleNoteAdd) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID} |
|
|
177
|
+
*NotehubJs.NotesApi* | [**handleNoteChanges**](docs/NotesApi.md#handleNoteChanges) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/changes |
|
|
178
|
+
*NotehubJs.NotesApi* | [**handleNoteCreateAdd**](docs/NotesApi.md#handleNoteCreateAdd) | **POST** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
179
|
+
*NotehubJs.NotesApi* | [**handleNoteDelete**](docs/NotesApi.md#handleNoteDelete) | **DELETE** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
180
|
+
*NotehubJs.NotesApi* | [**handleNoteGet**](docs/NotesApi.md#handleNoteGet) | **GET** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
181
|
+
*NotehubJs.NotesApi* | [**handleNoteUpdate**](docs/NotesApi.md#handleNoteUpdate) | **PUT** /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
|
|
182
|
+
*NotehubJs.ProductApi* | [**createProduct**](docs/ProductApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
|
|
183
|
+
*NotehubJs.ProductApi* | [**getProjectByProduct**](docs/ProductApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project |
|
|
184
|
+
*NotehubJs.ProductApi* | [**getProjectProducts**](docs/ProductApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products |
|
|
185
|
+
*NotehubJs.ProjectApi* | [**createProduct**](docs/ProjectApi.md#createProduct) | **POST** /v1/projects/{projectUID}/products |
|
|
186
|
+
*NotehubJs.ProjectApi* | [**createProject**](docs/ProjectApi.md#createProject) | **POST** /v1/projects |
|
|
187
|
+
*NotehubJs.ProjectApi* | [**deleteProjectEnvironmentVariable**](docs/ProjectApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectUID}/environment_variables/{key} |
|
|
188
|
+
*NotehubJs.ProjectApi* | [**getProject**](docs/ProjectApi.md#getProject) | **GET** /v1/projects/{projectUID} |
|
|
189
|
+
*NotehubJs.ProjectApi* | [**getProjectByProduct**](docs/ProjectApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project |
|
|
190
|
+
*NotehubJs.ProjectApi* | [**getProjectDevicePublicKeys**](docs/ProjectApi.md#getProjectDevicePublicKeys) | **GET** /v1/projects/{projectUID}/devices/public-keys |
|
|
191
|
+
*NotehubJs.ProjectApi* | [**getProjectDevices**](docs/ProjectApi.md#getProjectDevices) | **GET** /v1/projects/{projectUID}/devices |
|
|
192
|
+
*NotehubJs.ProjectApi* | [**getProjectEnvironmentVariables**](docs/ProjectApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectUID}/environment_variables |
|
|
193
|
+
*NotehubJs.ProjectApi* | [**getProjectEvents**](docs/ProjectApi.md#getProjectEvents) | **GET** /v1/projects/{projectUID}/events |
|
|
194
|
+
*NotehubJs.ProjectApi* | [**getProjectEventsByCursor**](docs/ProjectApi.md#getProjectEventsByCursor) | **GET** /v1/projects/{projectUID}/events-cursor |
|
|
195
|
+
*NotehubJs.ProjectApi* | [**getProjectFleetDevices**](docs/ProjectApi.md#getProjectFleetDevices) | **GET** /v1/projects/{projectUID}/fleets/{fleetUID}/devices |
|
|
196
|
+
*NotehubJs.ProjectApi* | [**getProjectMembers**](docs/ProjectApi.md#getProjectMembers) | **GET** /v1/projects/{projectUID}/members |
|
|
197
|
+
*NotehubJs.ProjectApi* | [**getProjectProducts**](docs/ProjectApi.md#getProjectProducts) | **GET** /v1/projects/{projectUID}/products |
|
|
198
|
+
*NotehubJs.ProjectApi* | [**getProjects**](docs/ProjectApi.md#getProjects) | **GET** /v1/projects |
|
|
199
|
+
*NotehubJs.ProjectApi* | [**putProjectEnvironmentVariables**](docs/ProjectApi.md#putProjectEnvironmentVariables) | **PUT** /v1/projects/{projectUID}/environment_variables |
|
|
200
|
+
*NotehubJs.RouteApi* | [**createRoute**](docs/RouteApi.md#createRoute) | **POST** /v1/projects/{projectUID}/routes |
|
|
201
|
+
*NotehubJs.RouteApi* | [**deleteRoute**](docs/RouteApi.md#deleteRoute) | **DELETE** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
202
|
+
*NotehubJs.RouteApi* | [**getRoute**](docs/RouteApi.md#getRoute) | **GET** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
203
|
+
*NotehubJs.RouteApi* | [**getRoutes**](docs/RouteApi.md#getRoutes) | **GET** /v1/projects/{projectUID}/routes |
|
|
204
|
+
*NotehubJs.RouteApi* | [**updateRoute**](docs/RouteApi.md#updateRoute) | **PUT** /v1/projects/{projectUID}/routes/{routeUID} |
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
## Documentation for Models
|
|
208
|
+
|
|
209
|
+
- [NotehubJs.Aws](docs/Aws.md)
|
|
210
|
+
- [NotehubJs.Azure](docs/Azure.md)
|
|
211
|
+
- [NotehubJs.BillingAccount](docs/BillingAccount.md)
|
|
212
|
+
- [NotehubJs.BillingAccountRole](docs/BillingAccountRole.md)
|
|
213
|
+
- [NotehubJs.Body](docs/Body.md)
|
|
214
|
+
- [NotehubJs.Contact](docs/Contact.md)
|
|
215
|
+
- [NotehubJs.CreateFleetRequest](docs/CreateFleetRequest.md)
|
|
216
|
+
- [NotehubJs.CreateProductRequest](docs/CreateProductRequest.md)
|
|
217
|
+
- [NotehubJs.CreateProjectRequest](docs/CreateProjectRequest.md)
|
|
218
|
+
- [NotehubJs.DFUEnv](docs/DFUEnv.md)
|
|
219
|
+
- [NotehubJs.DFUState](docs/DFUState.md)
|
|
220
|
+
- [NotehubJs.DeleteDeviceFleetsRequest](docs/DeleteDeviceFleetsRequest.md)
|
|
221
|
+
- [NotehubJs.Device](docs/Device.md)
|
|
222
|
+
- [NotehubJs.DeviceSession](docs/DeviceSession.md)
|
|
223
|
+
- [NotehubJs.DeviceTowerInfo](docs/DeviceTowerInfo.md)
|
|
224
|
+
- [NotehubJs.DeviceUsage](docs/DeviceUsage.md)
|
|
225
|
+
- [NotehubJs.EnvironmentVariables](docs/EnvironmentVariables.md)
|
|
226
|
+
- [NotehubJs.Error](docs/Error.md)
|
|
227
|
+
- [NotehubJs.Event](docs/Event.md)
|
|
228
|
+
- [NotehubJs.Fleet](docs/Fleet.md)
|
|
229
|
+
- [NotehubJs.GetBillingAccounts200Response](docs/GetBillingAccounts200Response.md)
|
|
230
|
+
- [NotehubJs.GetDeviceEnvironmentVariables200Response](docs/GetDeviceEnvironmentVariables200Response.md)
|
|
231
|
+
- [NotehubJs.GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)
|
|
232
|
+
- [NotehubJs.GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)
|
|
233
|
+
- [NotehubJs.GetDeviceLatest200Response](docs/GetDeviceLatest200Response.md)
|
|
234
|
+
- [NotehubJs.GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)
|
|
235
|
+
- [NotehubJs.GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)
|
|
236
|
+
- [NotehubJs.GetProjectDevicePublicKeys200Response](docs/GetProjectDevicePublicKeys200Response.md)
|
|
237
|
+
- [NotehubJs.GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md)
|
|
238
|
+
- [NotehubJs.GetProjectDevices200Response](docs/GetProjectDevices200Response.md)
|
|
239
|
+
- [NotehubJs.GetProjectEvents200Response](docs/GetProjectEvents200Response.md)
|
|
240
|
+
- [NotehubJs.GetProjectEventsByCursor200Response](docs/GetProjectEventsByCursor200Response.md)
|
|
241
|
+
- [NotehubJs.GetProjectFleets200Response](docs/GetProjectFleets200Response.md)
|
|
242
|
+
- [NotehubJs.GetProjectMembers200Response](docs/GetProjectMembers200Response.md)
|
|
243
|
+
- [NotehubJs.GetProjectProducts200Response](docs/GetProjectProducts200Response.md)
|
|
244
|
+
- [NotehubJs.GetProjects200Response](docs/GetProjects200Response.md)
|
|
245
|
+
- [NotehubJs.Google](docs/Google.md)
|
|
246
|
+
- [NotehubJs.HandleNoteChanges200Response](docs/HandleNoteChanges200Response.md)
|
|
247
|
+
- [NotehubJs.HandleNoteGet200Response](docs/HandleNoteGet200Response.md)
|
|
248
|
+
- [NotehubJs.HandleNoteSignal200Response](docs/HandleNoteSignal200Response.md)
|
|
249
|
+
- [NotehubJs.HandleNotefileChanges200Response](docs/HandleNotefileChanges200Response.md)
|
|
250
|
+
- [NotehubJs.HandleNotefileChangesPending200Response](docs/HandleNotefileChangesPending200Response.md)
|
|
251
|
+
- [NotehubJs.HandleNotefileDeleteRequest](docs/HandleNotefileDeleteRequest.md)
|
|
252
|
+
- [NotehubJs.Http](docs/Http.md)
|
|
253
|
+
- [NotehubJs.HttpFilter](docs/HttpFilter.md)
|
|
254
|
+
- [NotehubJs.HttpTransform](docs/HttpTransform.md)
|
|
255
|
+
- [NotehubJs.Location](docs/Location.md)
|
|
256
|
+
- [NotehubJs.Login200Response](docs/Login200Response.md)
|
|
257
|
+
- [NotehubJs.LoginRequest](docs/LoginRequest.md)
|
|
258
|
+
- [NotehubJs.Mqtt](docs/Mqtt.md)
|
|
259
|
+
- [NotehubJs.Note](docs/Note.md)
|
|
260
|
+
- [NotehubJs.Product](docs/Product.md)
|
|
261
|
+
- [NotehubJs.Project](docs/Project.md)
|
|
262
|
+
- [NotehubJs.ProjectMember](docs/ProjectMember.md)
|
|
263
|
+
- [NotehubJs.Proxy](docs/Proxy.md)
|
|
264
|
+
- [NotehubJs.PutDeviceFleetsRequest](docs/PutDeviceFleetsRequest.md)
|
|
265
|
+
- [NotehubJs.Radresponder](docs/Radresponder.md)
|
|
266
|
+
- [NotehubJs.Role](docs/Role.md)
|
|
267
|
+
- [NotehubJs.Route](docs/Route.md)
|
|
268
|
+
- [NotehubJs.RouteSchema](docs/RouteSchema.md)
|
|
269
|
+
- [NotehubJs.Snowflake](docs/Snowflake.md)
|
|
270
|
+
- [NotehubJs.SnowflakeTransform](docs/SnowflakeTransform.md)
|
|
271
|
+
- [NotehubJs.Thingworx](docs/Thingworx.md)
|
|
272
|
+
- [NotehubJs.TowerLocation](docs/TowerLocation.md)
|
|
273
|
+
- [NotehubJs.Twilio](docs/Twilio.md)
|
|
274
|
+
- [NotehubJs.UpdateFleetRequest](docs/UpdateFleetRequest.md)
|
|
275
|
+
- [NotehubJs.UserDbRoute](docs/UserDbRoute.md)
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
## Documentation for Authorization
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
### api_key
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
- **Type**: API key
|
|
286
|
+
- **API key parameter name**: X-Session-Token
|
|
287
|
+
- **Location**: HTTP header
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
### pin
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
- **Type**: API key
|
|
295
|
+
- **API key parameter name**: X-Auth-Token
|
|
296
|
+
- **Location**: HTTP header
|
|
297
|
+
|