soteapi-client

SoteapiClient - JavaScript client for soteapi-client SOTE API This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.19
• 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 soteapi-client --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 soteapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('soteapi-client') 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/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, 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 SoteapiClient = require('soteapi-client');

var api = new SoteapiClient.CategoriesApi()

var opts = { 
  'firstResult': 789, // {Number} First result
  'maxResults': 789 // {Number} Max results
};
api.listCategories(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
SoteapiClient.CategoriesApi	listCategories	GET /categories	Lists categories
SoteapiClient.ContentsApi	findContent	GET /contents/{contentId}	Finds content
SoteapiClient.ContentsApi	findContentImage	GET /contents/{contentId}/images/{imageId}	Returns a single content image
SoteapiClient.ContentsApi	getContentImageData	GET /contents/{contentId}/images/{imageId}/data	Returns an content image data
SoteapiClient.ContentsApi	listContentImages	GET /contents/{contentId}/images	Returns a list of content images
SoteapiClient.ContentsApi	listContents	GET /contents	Lists contents
SoteapiClient.EmergencyCongestionStatusesApi	listEmergencyCongestionStatuses	GET /emergencyCongestionStatuses	Lists emergency congestion statuses
SoteapiClient.EventsApi	findEvent	GET /events/{eventId}	Finds event
SoteapiClient.EventsApi	listEvents	GET /events	Lists events

Documentation for Models

• SoteapiClient.BadRequest
• SoteapiClient.Category
• SoteapiClient.Content
• SoteapiClient.ContentImage
• SoteapiClient.EmergencyCongestionStatus
• SoteapiClient.EmergencyCongestionStatusListSort
• SoteapiClient.Event
• SoteapiClient.Forbidden
• SoteapiClient.InternalServerError
• SoteapiClient.LocalizedValue
• SoteapiClient.NotFound
• SoteapiClient.NotImplemented

Documentation for Authorization

All endpoints do not require authorization.