Paatos-api-client NPM

paatos-api-client

PaatosApiClient - JavaScript client for paatos-api-client API for distributing data about decisions and people behind those decisions This SDK is automatically generated by the Swagger Codegen project:

API version: 0.0.5
Package version: 0.0.7
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 paatos-api-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 paatos-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('paatos-api-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 PaatosApiClient = require('paatos-api-client');

var api = new PaatosApiClient.ActionsApi()

var opts = { 
  'limit': 56, // {Number} Specify the number of element to display per page.
  'offset': 56 // {Number} Specify the offset to start displaying element on a page.
};
api.actionsList(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://paatos-test.6aika.fi/v1

Class	Method	HTTP request	Description
PaatosApiClient.ActionsApi	actionsList	GET /action/	Retrieve a list of actions
PaatosApiClient.ActionsApi	actionsRetrieve	GET /action/{id}/	Retrieve a single action by ID
PaatosApiClient.CasesApi	casesList	GET /case/	Retrieve a list of cases
PaatosApiClient.CasesApi	casesRetrieve	GET /case/{id}/	Retrieve a single case by ID
PaatosApiClient.Decision_makersApi	membershipsList	GET /membership/	Retrieve a list of memberships
PaatosApiClient.Decision_makersApi	membershipsRetrieve	GET /membership/{id}/	Retrieve a single membership record
PaatosApiClient.Decision_makersApi	organizationsList	GET /organization/	Retrieve a list of organizations
PaatosApiClient.Decision_makersApi	organizationsRetrieve	GET /organization/{id}/	Retrieve a single person record
PaatosApiClient.Decision_makersApi	personsList	GET /person/	Retrieve a list of persons
PaatosApiClient.Decision_makersApi	personsRetrieve	GET /person/{id}/	Retrieve a single person record
PaatosApiClient.Decision_makersApi	postsList	GET /post/	Retrieve a list of posts
PaatosApiClient.Decision_makersApi	postsRetrieve	GET /post/{id}/	Retrieve a single post record
PaatosApiClient.EventsApi	eventsList	GET /event/	Retrieve a list of events
PaatosApiClient.EventsApi	eventsRetrieve	GET /event/{id}/	Retrieve a single event by ID
PaatosApiClient.FunctionsApi	functionsList	GET /function/	Retrieve a list of functions
PaatosApiClient.FunctionsApi	functionsRetrieve	GET /function/{id}/	Retrieve a single function by ID
PaatosApiClient.MembershipsApi	membershipsList	GET /membership/	Retrieve a list of memberships
PaatosApiClient.MembershipsApi	membershipsRetrieve	GET /membership/{id}/	Retrieve a single membership record
PaatosApiClient.OrganizationsApi	organizationsList	GET /organization/	Retrieve a list of organizations
PaatosApiClient.OrganizationsApi	organizationsRetrieve	GET /organization/{id}/	Retrieve a single person record
PaatosApiClient.PersonsApi	personsList	GET /person/	Retrieve a list of persons
PaatosApiClient.PersonsApi	personsRetrieve	GET /person/{id}/	Retrieve a single person record
PaatosApiClient.PostsApi	postsList	GET /post/	Retrieve a list of posts
PaatosApiClient.PostsApi	postsRetrieve	GET /post/{id}/	Retrieve a single post record

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@everything-registry/sub-chunk-2398 paatos-ui

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago