npm package: 6aika-paatos-client
Description: API_for_distributing_data_about_decisions_and_people_behind_those_decisions
Author: Metatavu Oy
Latest version: 0.0.2

# 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](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.0.5
- Package version: 0.0.1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your 6aika-paatos-client from, and run:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

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


## Documentation for Models

 - [6aikaPaatosClient.Action](docs/Action.md)
 - [6aikaPaatosClient.Area](docs/Area.md)
 - [6aikaPaatosClient.Attachment](docs/Attachment.md)
 - [6aikaPaatosClient.CaseRelatedCases](docs/CaseRelatedCases.md)
 - [6aikaPaatosClient.CaseSummary](docs/CaseSummary.md)
 - [6aikaPaatosClient.CaseTitle](docs/CaseTitle.md)
 - [6aikaPaatosClient.Content](docs/Content.md)
 - [6aikaPaatosClient.ContentHypertext](docs/ContentHypertext.md)
 - [6aikaPaatosClient.Event](docs/Event.md)
 - [6aikaPaatosClient.InlineResponse200](docs/InlineResponse200.md)
 - [6aikaPaatosClient.InlineResponse2001](docs/InlineResponse2001.md)
 - [6aikaPaatosClient.InlineResponse2002](docs/InlineResponse2002.md)
 - [6aikaPaatosClient.InlineResponse2003](docs/InlineResponse2003.md)
 - [6aikaPaatosClient.InlineResponse2004](docs/InlineResponse2004.md)
 - [6aikaPaatosClient.InlineResponse2005](docs/InlineResponse2005.md)
 - [6aikaPaatosClient.Membership](docs/Membership.md)
 - [6aikaPaatosClient.Meta](docs/Meta.md)
 - [6aikaPaatosClient.ModelCase](docs/ModelCase.md)
 - [6aikaPaatosClient.Organization](docs/Organization.md)
 - [6aikaPaatosClient.Person](docs/Person.md)
 - [6aikaPaatosClient.Post](docs/Post.md)
 - [6aikaPaatosClient.VoteCount](docs/VoteCount.md)
 - [6aikaPaatosClient.VoteEvent](docs/VoteEvent.md)


## Documentation for Authorization

 All endpoints do not require authorization.