Skip to content

Latest commit

 

History

History
145 lines (101 loc) · 4.54 KB

README.md

File metadata and controls

145 lines (101 loc) · 4.54 KB
Raw

diffbot-enhance-client

DiffbotEnhanceClient - JavaScript client for diffbot-enhance-client Enhance is an API to find a person or organization in the Knowledge Graph using partial data This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v1.0.0
  • Package version: 1.0.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 diffbot-enhance-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 diffbot-enhance-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/diffbot/enhance-client-js then install it via:

    npm install diffbot/enhance-client-js --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 DiffbotEnhanceClient = require('diffbot-enhance-client');


var api = new DiffbotEnhanceClient.BulkEnhanceEndpointApi()
var bulkjobId = "bulkjobId_example"; // {String} Bulkjob Id
var opts = {
  'token': "token_example" // {String} Diffbot Token
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulkjobStatus(bulkjobId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://kg.diffbot.com

Class Method HTTP request Description
DiffbotEnhanceClient.BulkEnhanceEndpointApi bulkjobStatus GET /kg/enhance_endpoint/bulk/{bulkjobId}/status Bulk Enhance Status Endpoint
DiffbotEnhanceClient.BulkEnhanceEndpointApi enhanceBulkjob POST /kg/enhance_endpoint/bulk Bulk Enhance Endpoint
DiffbotEnhanceClient.BulkEnhanceEndpointApi pollBulkjob GET /kg/enhance_endpoint/bulk/{bulkjobId} Bulk Enhance Poll Endpoint
DiffbotEnhanceClient.BulkEnhanceEndpointApi stopBulkjob GET /kg/enhance_endpoint/bulk/{bulkjobId}/stop Bulkjob stop
DiffbotEnhanceClient.EnhanceLiveEndpointApi enhance GET /kg/enhance_endpoint Live Enhance Endpoint

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.