easycalc-api-client

v1.0.1

Published

3 years ago

JS API client generated by OpenAPI Generator

Downloads

0High
0Medium
0Low

tiois

pbergevin

easycalc-api-client

EasycalcApiClient - JavaScript client for easycalc-api-client 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.0
Package version: 1.0.1
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 easycalc-api-client --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 easycalc-api-client 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 EasycalcApiClient = require('easycalc-api-client');

var defaultClient = EasycalcApiClient.ApiClient.instance;
// Configure API key authorization: secure_token
var secure_token = defaultClient.authentications['secure_token'];
secure_token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//secure_token.apiKeyPrefix['X-EASYCALC-TOKEN'] = "Token"

var api = new EasycalcApiClient.CategoryApi()
api.getCategories().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 http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EasycalcApiClient.CategoryApi | getCategories | GET /rest/categories | Get category list EasycalcApiClient.ConsumptionTypeApi | getConsumptionTypes | GET /rest/consumption-types | Get consumption type list EasycalcApiClient.CountryApi | getCountries | GET /rest/countries | Get country list EasycalcApiClient.CurrencyApi | getCurrencies | GET /rest/currencies | Get currency list EasycalcApiClient.FormulasApi | getFormulaVariables | GET /rest/formula-variables | Get formula variable list EasycalcApiClient.FormulasApi | getGlobalVariables | GET /rest/global-variables | Get global variable list EasycalcApiClient.LanguageApi | getLanguages | GET /rest/languages | Get language list EasycalcApiClient.PHApi | getPhs | GET /rest/phs | Get pH list EasycalcApiClient.ProductApi | getApplicationTypes | GET /rest/application-types | Get Application type list EasycalcApiClient.ProductApi | getProducts | GET /rest/products | Get product list EasycalcApiClient.ProductGroupApi | getProductGroups | GET /rest/productgroups | Get product groups list EasycalcApiClient.ProductGroupApi | productGroupSetPrices | POST /rest/productgroup/prices | Set the prices using the supplied productGroupId EasycalcApiClient.ProtocolApi | getProtocols | GET /rest/protocols | Get Protocol list EasycalcApiClient.QuoteApi | getQuotes | GET /rest/user/quotes | Get quotes list EasycalcApiClient.QuoteApi | setQuotes | POST /rest/user/quotes | Set the quotes for the current user EasycalcApiClient.SingleProductApi | getProduct | GET /rest/product/{productId} | Get a single product EasycalcApiClient.SpeciesApi | getSpecies | GET /rest/species | Get species list EasycalcApiClient.SurfaceApi | getSurfaces | GET /rest/surfaces | Get Surface list EasycalcApiClient.TranslationApi | getTranslations | GET /rest/translations | Get translation list EasycalcApiClient.UnitApi | getUnits | GET /rest/units | Get unit list EasycalcApiClient.UserApi | checkToken | POST /rest/user/check-token | Check if a user token is still valid, and refresh the last login date EasycalcApiClient.UserApi | userLogin | POST /rest/user/login | Login a user with username and password EasycalcApiClient.UserApi | userLoginAD | POST /rest/user/login-azure | Login a user with Azure AD EasycalcApiClient.VersionApi | getVersions | GET /rest/versions | Get version list

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

easycalc-api-client

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

secure_token

user_token