davatiz_api_1

davatiz_api

DavatizApi - JavaScript client for davatiz_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 0.1.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 davatiz_api --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 davatiz_api 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 DavatizApi = require('davatiz_api');


var api = new DavatizApi.DefaultApi()
var UNKNOWN_BASE_TYPE = {"items":["content_id1","content_id2"],"query":{"name":"AND","operand1":{"subject":"content_type","predicate":"=","object":"FILM"},"operand2":{"subject":"production_country","predicate":"=","object":"FR"}}}; // {UNKNOWN_BASE_TYPE} allow criteria checking for a list of content
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkCriteriaPost(UNKNOWN_BASE_TYPE, callback);

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/discoverability/dataviz-api/0.1.0

Class	Method	HTTP request	Description
DavatizApi.DefaultApi	checkCriteriaPost	POST /check_criteria
DavatizApi.DefaultApi	thumbnailsUserIdSessionIdGet	GET /thumbnails/{user_id}/{session_id}
DavatizApi.DefaultApi	usersGet	GET /users

Documentation for Models

• DavatizApi.CheckCriteriaRequest
• DavatizApi.ContentMatchCriteria
• DavatizApi.Criteria
• DavatizApi.LogicalBinaryOperator
• DavatizApi.LogicalUnaryOperator
• DavatizApi.Predicate
• DavatizApi.Subject
• DavatizApi.Thumbnail
• DavatizApi.User

Documentation for Authorization

All endpoints do not require authorization.