widget_api

WidgetApi - JavaScript client for widget_api The Widget API is used to store and manage key/value pairs associated with a panel/widget. It is possible to generate client code for this API with curl -X POST -H \"content-type:application/json\" -d '{\"swaggerUrl\":\"[host]/API/docs/widgets/v1/swagger.yaml\"}' https://generator.swagger.io/api/gen/clients/[client_language]. For further information see https://github.com/swagger-api/swagger-codegen#online-generators This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 widget_api --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 widget_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('widget_api') 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/widget_api then install it via:

    npm install YOUR_USERNAME/widget_api --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 WidgetApi = require('widget_api');

var api = new WidgetApi.UsersApi()

var body = new WidgetApi.UserData(); // {UserData} UserData object that needs to be added for this agent.


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

Documentation for API Endpoints

All URIs are relative to https://localhost/API/widgets/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- WidgetApi.UsersApi | addUserData | POST /userdata | Add a new key/value for this agent. WidgetApi.UsersApi | deleteUserDataById | DELETE /userdata/{userDataId} | Delete a single UserData. WidgetApi.UsersApi | deleteUserDataByWidget | DELETE /userdata/user/{userId}/widgetId/{widgetId} | Delete UserData records. WidgetApi.UsersApi | getUser | GET /user | Pull basic user information. WidgetApi.UsersApi | getUserDataById | GET /userdata/{userDataId} | Get a specific UserData by id WidgetApi.UsersApi | getUserDataByUserIdAndWidget | GET /userdata/user/{userId}/widgetId/{widgetId} | Get UserData by userId and the requested widgetId. WidgetApi.UsersApi | updateUserData | PUT /userdata | Update a key/value for this agent. WidgetApi.UsersApi | updateUserDataByForm | PUT /userdata/form | Update a key/value for this agent by form.

Documentation for Models

• WidgetApi.User
• WidgetApi.UserData
• WidgetApi.WidgetExceptionResponse

Documentation for Authorization

All endpoints do not require authorization.