research

Research - JavaScript client for research Customer Information Microservice This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.0.2
Package version: 0.0.2
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 research --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 research 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 Research = require('research');


var api = new Research.CorsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.industryObservableOptions(callback);

Documentation for API Endpoints

All URIs are relative to http://research.vernonkeenan.com:8080/v1

Class	Method	HTTP request	Description
Research.CorsApi	industryObservableOptions	OPTIONS /industries/observable
Research.CorsApi	industryOptions	OPTIONS /industries
Research.CorsApi	topicObservableOptions	OPTIONS /topics/observable
Research.CorsApi	topicOptions	OPTIONS /topics
Research.IndustryApi	getIndustries	GET /industries	Get Industry records
Research.IndustryApi	getIndustriesObservable	GET /industries/observable	Get Taxnexus Companies in an observable array
Research.IndustryApi	postIndustries	POST /industries	Add new companies
Research.TopicApi	getTopics	GET /topics	Get Topic records
Research.TopicApi	getTopicsObservable	GET /topics/observable	Get Taxnexus Companies in an observable array
Research.TopicApi	postTopics	POST /topics	Add new companies

Documentation for Models

Documentation for Authorization

ApiKeyAuth

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

5.0 KiB Raw Blame History