carbon_aware_web_api v1.0.0
carbon_aware_web_api
CarbonAwareWebApi - JavaScript client for carbon_aware_web_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.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 carbon_aware_web_api --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 carbon_aware_web_api 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 CarbonAwareWebApi = require('carbon_aware_web_api');
var api = new CarbonAwareWebApi.CarbonAwareApi()
var opts = {
'emissionsForecastBatchDTO': [new CarbonAwareWebApi.EmissionsForecastBatchDTO()] // {[EmissionsForecastBatchDTO]} Array of requested forecasts.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.batchForecastDataAsync(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
CarbonAwareWebApi.CarbonAwareApi | batchForecastDataAsync | POST /emissions/forecasts/batch | Given an array of historical forecasts, retrieves the data that contains forecasts metadata, the optimal forecast and a range of forecasts filtered by the attributes start...end if provided. |
CarbonAwareWebApi.CarbonAwareApi | getAverageCarbonIntensity | GET /emissions/average-carbon-intensity | Retrieves the measured carbon intensity data between the time boundaries and calculates the average carbon intensity during that period. |
CarbonAwareWebApi.CarbonAwareApi | getAverageCarbonIntensityBatch | POST /emissions/average-carbon-intensity/batch | Given an array of request objects, each with their own location and time boundaries, calculate the average carbon intensity for that location and time period and return an array of carbon intensity objects. |
CarbonAwareWebApi.CarbonAwareApi | getBestEmissionsDataForLocationsByTime | GET /emissions/bylocations/best | Calculate the best emission data by list of locations for a specified time period. |
CarbonAwareWebApi.CarbonAwareApi | getCurrentForecastData | GET /emissions/forecasts/current | Retrieves the most recent forecasted data and calculates the optimal marginal carbon intensity window. |
CarbonAwareWebApi.CarbonAwareApi | getEmissionsDataForLocationByTime | GET /emissions/bylocation | Calculate the best emission data by location for a specified time period. |
CarbonAwareWebApi.CarbonAwareApi | getEmissionsDataForLocationsByTime | GET /emissions/bylocations | Calculate the observed emission data by list of locations for a specified time period. |
Documentation for Models
- CarbonAwareWebApi.CarbonIntensityBatchDTO
- CarbonAwareWebApi.CarbonIntensityDTO
- CarbonAwareWebApi.EmissionsData
- CarbonAwareWebApi.EmissionsDataDTO
- CarbonAwareWebApi.EmissionsForecastBatchDTO
- CarbonAwareWebApi.EmissionsForecastDTO
- CarbonAwareWebApi.ValidationProblemDetails
Documentation for Authorization
All endpoints do not require authorization.
2 years ago