@influxenergydata/cloud-service-autogen v0.37.10
@influxenergydata/cloud-service-autogen
@InfluxenergydataCloudServiceAutogen - JavaScript client for @influxenergydata/cloud-service-autogen This document outlines all the public APIs that Influx provides for 3rd-party intergration. This SDK is automatically generated by the OpenAPI Generator project:
- API version: 0.1
- Package version: 0.37.10
- 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 @influxenergydata/cloud-service-autogen --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 @influxenergydata/cloud-service-autogen 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 @InfluxenergydataCloudServiceAutogen = require('@influxenergydata/cloud-service-autogen');
var api = new @InfluxenergydataCloudServiceAutogen.AuthApi()
var usernamePassword = new @InfluxenergydataCloudServiceAutogen.UsernamePassword(); // {UsernamePassword}
api.login(usernamePassword).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://auth.influxdata.cloud
Class | Method | HTTP request | Description |
---|---|---|---|
@InfluxenergydataCloudServiceAutogen.AuthApi | login | POST /auth/login | |
@InfluxenergydataCloudServiceAutogen.DiscorecoApi | createDiscorecoTask | PUT /discoreco/org/{orgName}/task/create | |
@InfluxenergydataCloudServiceAutogen.DiscorecoApi | getMetersByIcp | GET /discoreco/org/{orgName}/icp/{icp}/meters | |
@InfluxenergydataCloudServiceAutogen.DiscorecoApi | getTasksByOrg | GET /discoreco/org/{orgName}/task | |
@InfluxenergydataCloudServiceAutogen.DiscorecoApi | getTasksByStatus | GET /discoreco/task/status/{status} | |
@InfluxenergydataCloudServiceAutogen.DiscorecoApi | getTermsOfService | GET /discoreco/org/{orgName}/termsOfService |
Documentation for Models
- @InfluxenergydataCloudServiceAutogen.AuthToken
- @InfluxenergydataCloudServiceAutogen.CreateDiscorecoTaskRequest
- @InfluxenergydataCloudServiceAutogen.CreateDiscorecoTaskRequestMeters
- @InfluxenergydataCloudServiceAutogen.DiscorecoTaskId
- @InfluxenergydataCloudServiceAutogen.DiscorecoTasks
- @InfluxenergydataCloudServiceAutogen.DiscorecoTasksData
- @InfluxenergydataCloudServiceAutogen.DiscorecoTasksDataMeters
- @InfluxenergydataCloudServiceAutogen.InlineResponse200
- @InfluxenergydataCloudServiceAutogen.Meter
- @InfluxenergydataCloudServiceAutogen.TermsOfService
- @InfluxenergydataCloudServiceAutogen.UsernamePassword
Documentation for Authorization
bearerAuth
- Type: Bearer authentication (JWT)