Open_book_api_reference NPM

open_book_api_reference

OpenBookApiReference - JavaScript client for open_book_api_reference API for using OpenBook. to fetch your api keys go to https://openbook-playground.botpress.tools/api-tokens This SDK is automatically generated by the Swagger Codegen project:

API version: 0.1.0
Package version: 0.1.0
Build package: io.swagger.codegen.v3.generators.javascript.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 open_book_api_reference --save

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 OpenBookApiReference = require('open_book_api_reference');

var api = new OpenBookApiReference.DefaultApi()
var body = new OpenBookApiReference.V1CompileBody(); // {V1CompileBody} 
var authorization = "authorization_example"; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.compileBook(body, authorization, callback);

Documentation for API Endpoints

All URIs are relative to https://api.openbook.botpress.cloud

Class	Method	HTTP request
OpenBookApiReference.DefaultApi	compileBook	POST /v1/compile
OpenBookApiReference.DefaultApi	getArtifactState	GET /v1/artifacts/{artifact_id}
OpenBookApiReference.DefaultApi	getInfo	GET /v1/info
OpenBookApiReference.DefaultApi	listArtifacts	GET /v1/artifacts
OpenBookApiReference.DefaultApi	queryArtifact	POST /v1/artifacts/{artifact_id}/query
OpenBookApiReference.DefaultApi	sendFeedback	POST /v1/artifacts/{artifact_id}/feedback

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

@infinitebrahmanuniverse/nolb-open_@everything-registry/sub-chunk-2381 @zalastax/nolb-open_

0.1.0

2 years ago