@corrily/live-price

CorrilyLivePrice - JavaScript client for @corrily/live-price Corrily's LivePrice lets you to interact with Corrily's localization and dynamic pricing models to localize and optimize your prices in real-time.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.1.4
Package version: 0.0.5
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 @corrily/live-price --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 @corrily/live-price 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 CorrilyLivePrice = require('@corrily/live-price');

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

var api = new CorrilyLivePrice.DefaultApi()
var opts = {
  'body': new CorrilyLivePrice.GetBatchRequest() // {GetBatchRequest} The same as Get Price but does the localization and/or optimization across a batch of products. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBatch(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://app.corrily.com/v1

Class	Method	HTTP request	Description
CorrilyLivePrice.DefaultApi	getBatch	POST /prices/getBatch	Get batch of prices
CorrilyLivePrice.DefaultApi	getPrice	POST /prices/get	Get price
CorrilyLivePrice.DefaultApi	setSuccess	POST /prices/setSuccess	Set success

Documentation for Models

Documentation for Authorization

corrily_auth

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header