sowilo_back v1.0.0
sowilo_back
SowiloBack - JavaScript client for sowilo_back Backend api for sowilo webapp This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install sowilo_back --save
Finally, you need to build the module:
npm run build
Local development
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:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your sowilo_back from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var SowiloBack = require('sowilo_back');
var api = new SowiloBack.MeasurementsApi()
var inlineObject1 = new SowiloBack.InlineObject1(); // {InlineObject1}
api.createCurrent(inlineObject1).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://sowilo.drew-chorney.com/api
Class | Method | HTTP request | Description |
---|---|---|---|
SowiloBack.MeasurementsApi | createCurrent | POST /current | add a new current measurement |
SowiloBack.MeasurementsApi | createTemperature | POST /temperature | add a new temperature measurement |
SowiloBack.MeasurementsApi | createVoltage | POST /voltage | add a new voltage measurement |
SowiloBack.MeasurementsApi | flushCurrents | DELETE /current | flush current measurements |
SowiloBack.MeasurementsApi | flushTemperatures | DELETE /temperature | flush temperature measurements |
SowiloBack.MeasurementsApi | flushVoltages | DELETE /voltage | flush voltage measurements |
SowiloBack.MeasurementsApi | getCurrents | GET /current | retreive current measurements |
SowiloBack.MeasurementsApi | getTemperatures | GET /temperature | retreive temperature measurements |
SowiloBack.MeasurementsApi | getVoltages | GET /voltage | retreive voltage measurements |
SowiloBack.MeasurementsApi | updateCurrent | PUT /current/{currentId} | updates a current measurement |
SowiloBack.MeasurementsApi | updateTemperature | PUT /temperature/{temperatureId} | updates a temperature measurement |
SowiloBack.MeasurementsApi | updateVoltage | PUT /voltage/{voltageId} | updates a voltage measurement |
SowiloBack.OtaApi | createBinary | POST /ota/binary | upload a new binary |
SowiloBack.OtaApi | getBinaries | GET /ota/binary | retreive available binaries |
SowiloBack.OtaApi | pollForLatestBinary | GET /ota/binary/poll | poll for the latest binary. Returns the latest version given the user and the required imageType. |
SowiloBack.OtaApi | removeBinary | DELETE /ota/binary/{binaryId} | remove a binary |
SowiloBack.OtaApi | updateBinary | PATCH /ota/binary/{binaryId} | updates an existing binary |
SowiloBack.UsersApi | getUsers | GET /users | returns the users for application |
SowiloBack.UsersApi | updateUser | PATCH /users/{userId} | updates a user |
SowiloBack.UsersApi | userApplyForAccess | GET /users/{userId}/apply | user applies for access to the application |
Documentation for Models
- SowiloBack.Binary
- SowiloBack.Current
- SowiloBack.InlineObject
- SowiloBack.InlineObject1
- SowiloBack.InlineObject2
- SowiloBack.InlineObject3
- SowiloBack.InlineObject4
- SowiloBack.InlineObject5
- SowiloBack.InlineObject6
- SowiloBack.InlineObject7
- SowiloBack.InlineObject8
- SowiloBack.Temperature
- SowiloBack.User
- SowiloBack.Voltage
Documentation for Authorization
sowiloCookieAuth
- Type: API key
- API key parameter name: sowilo
- Location:
sowiloCookieAuthSig
- Type: API key
- API key parameter name: sowilo.sig
- Location:
4 years ago