0.0.2 • Published 6 years ago

testers1 v0.0.2

Weekly downloads
2
License
Unlicense
Repository
-
Last release
6 years ago

tester

Tester - JavaScript client for tester An API depicting the working of EKO platform This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • Build package: io.swagger.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 tester --save
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

Finally, switch to the directory you want to use your tester from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('tester') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/tester then install it via:

    npm install YOUR_USERNAME/tester --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, that's to say your javascript file where you actually use this library):

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 Tester = require('tester');

var defaultClient = Tester.ApiClient.instance;

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

var api = new Tester.CustomersApi()

var customerIdType = "customerIdType_example"; // {String} Your unique API key that will authenticate your request

var customerId = 789; // {Number} Value of customer id

var initiatorId = 789; // {Number} partner id from where the request has been initiated

var developerKey = "developerKey_example"; // {String} Your unique API key that will authenticate your request

var opts = { 
  'secretKey': "secretKey_example", // {String} refer to authentication section
  'secretKeyTimestamp': "secretKeyTimestamp_example" // {String} refer to authentication section
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customersCustomerIdTypecustomerIdGet(customerIdType, customerId, initiatorId, developerKey, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://staging.eko.in:25004/ekoapi/v1

ClassMethodHTTP requestDescription
Tester.CustomersApicustomersCustomerIdTypecustomerIdGetGET /customers/{customer_id_type}:{customer_id}Get Customer Information

Documentation for Models

Documentation for Authorization

developer_key

  • Type: API key
  • API key parameter name: developer_key
  • Location: HTTP header