1.0.0 • Published 4 years ago

sowilo_back v1.0.0

Weekly downloads
-
License
Apache 2.0
Repository
-
Last release
4 years ago

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

ClassMethodHTTP requestDescription
SowiloBack.MeasurementsApicreateCurrentPOST /currentadd a new current measurement
SowiloBack.MeasurementsApicreateTemperaturePOST /temperatureadd a new temperature measurement
SowiloBack.MeasurementsApicreateVoltagePOST /voltageadd a new voltage measurement
SowiloBack.MeasurementsApiflushCurrentsDELETE /currentflush current measurements
SowiloBack.MeasurementsApiflushTemperaturesDELETE /temperatureflush temperature measurements
SowiloBack.MeasurementsApiflushVoltagesDELETE /voltageflush voltage measurements
SowiloBack.MeasurementsApigetCurrentsGET /currentretreive current measurements
SowiloBack.MeasurementsApigetTemperaturesGET /temperatureretreive temperature measurements
SowiloBack.MeasurementsApigetVoltagesGET /voltageretreive voltage measurements
SowiloBack.MeasurementsApiupdateCurrentPUT /current/{currentId}updates a current measurement
SowiloBack.MeasurementsApiupdateTemperaturePUT /temperature/{temperatureId}updates a temperature measurement
SowiloBack.MeasurementsApiupdateVoltagePUT /voltage/{voltageId}updates a voltage measurement
SowiloBack.OtaApicreateBinaryPOST /ota/binaryupload a new binary
SowiloBack.OtaApigetBinariesGET /ota/binaryretreive available binaries
SowiloBack.OtaApipollForLatestBinaryGET /ota/binary/pollpoll for the latest binary. Returns the latest version given the user and the required imageType.
SowiloBack.OtaApiremoveBinaryDELETE /ota/binary/{binaryId}remove a binary
SowiloBack.OtaApiupdateBinaryPATCH /ota/binary/{binaryId}updates an existing binary
SowiloBack.UsersApigetUsersGET /usersreturns the users for application
SowiloBack.UsersApiupdateUserPATCH /users/{userId}updates a user
SowiloBack.UsersApiuserApplyForAccessGET /users/{userId}/applyuser applies for access to the application

Documentation for Models

Documentation for Authorization

sowiloCookieAuth

  • Type: API key
  • API key parameter name: sowilo
  • Location:

sowiloCookieAuthSig

  • Type: API key
  • API key parameter name: sowilo.sig
  • Location:
1.0.0

4 years ago