6aika-paatos-client

6aikaPaatosClient - JavaScript client for 6aika-paatos-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.1
• 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 6aika-paatos-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 6aika-paatos-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

var api = new 6aikaPaatosClient.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 ------------ | ------------- | ------------- | ------------- 6aikaPaatosClient.ActionsApi | actionsList | GET /action/ | Retrieve a list of actions 6aikaPaatosClient.ActionsApi | actionsRetrieve | GET /action/{id}/ | Retrieve a single video by ID 6aikaPaatosClient.CasesApi | casesList | GET /case/ | Retrieve a list of cases 6aikaPaatosClient.CasesApi | videoDetail | GET /case/{id}/ | Retrieve a single case video by ID 6aikaPaatosClient.Decision_makersApi | membershipsList | GET /membership/ | Retrieve a list of memberships 6aikaPaatosClient.Decision_makersApi | membershipsRetrieve | GET /membership/{id}/ | Retrieve a single membership record 6aikaPaatosClient.Decision_makersApi | organizationsList | GET /organization/ | Retrieve a list of organizations 6aikaPaatosClient.Decision_makersApi | organizationsRetrieve | GET /organization/{id}/ | Retrieve a single person record 6aikaPaatosClient.Decision_makersApi | personsList | GET /person/ | Retrieve a list of persons 6aikaPaatosClient.Decision_makersApi | personsRetrieve | GET /person/{id}/ | Retrieve a single person record 6aikaPaatosClient.Decision_makersApi | postsList | GET /post/ | Retrieve a list of posts 6aikaPaatosClient.Decision_makersApi | postsRetrieve | GET /post/{id}/ | Retrieve a single post record 6aikaPaatosClient.MembershipsApi | membershipsList | GET /membership/ | Retrieve a list of memberships 6aikaPaatosClient.MembershipsApi | membershipsRetrieve | GET /membership/{id}/ | Retrieve a single membership record 6aikaPaatosClient.OrganizationsApi | organizationsList | GET /organization/ | Retrieve a list of organizations 6aikaPaatosClient.OrganizationsApi | organizationsRetrieve | GET /organization/{id}/ | Retrieve a single person record 6aikaPaatosClient.PersonsApi | personsList | GET /person/ | Retrieve a list of persons 6aikaPaatosClient.PersonsApi | personsRetrieve | GET /person/{id}/ | Retrieve a single person record 6aikaPaatosClient.PostsApi | postsList | GET /post/ | Retrieve a list of posts 6aikaPaatosClient.PostsApi | postsRetrieve | GET /post/{id}/ | Retrieve a single post record

Documentation for Models

• 6aikaPaatosClient.Action
• 6aikaPaatosClient.Area
• 6aikaPaatosClient.Attachment
• 6aikaPaatosClient.CaseRelatedCases
• 6aikaPaatosClient.CaseSummary
• 6aikaPaatosClient.CaseTitle
• 6aikaPaatosClient.Content
• 6aikaPaatosClient.ContentHypertext
• 6aikaPaatosClient.Event
• 6aikaPaatosClient.InlineResponse200
• 6aikaPaatosClient.InlineResponse2001
• 6aikaPaatosClient.InlineResponse2002
• 6aikaPaatosClient.InlineResponse2003
• 6aikaPaatosClient.InlineResponse2004
• 6aikaPaatosClient.InlineResponse2005
• 6aikaPaatosClient.Membership
• 6aikaPaatosClient.Meta
• 6aikaPaatosClient.ModelCase
• 6aikaPaatosClient.Organization
• 6aikaPaatosClient.Person
• 6aikaPaatosClient.Post
• 6aikaPaatosClient.VoteCount
• 6aikaPaatosClient.VoteEvent

Documentation for Authorization

All endpoints do not require authorization.