# pakkasmarja-rest-client

> REST_API_for_Pakkasmarja

Latest version **0.0.15** (published 2019-04-26) · gpl-3.0 license · 0 weekly downloads

## Install

```sh
npm install pakkasmarja-rest-client
pnpm add pakkasmarja-rest-client
yarn add pakkasmarja-rest-client
bun add pakkasmarja-rest-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2019-04-26 |
| First published | 2018-02-23 |
| Weekly downloads | 0 |
| License | gpl-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 327.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Metatavu Oy |
| Maintainers | metatavu |

## Links

- npm: https://www.npmjs.com/package/pakkasmarja-rest-client
- Repository: https://github.com/Metatavu/pakkasmarja-rest-client
- Homepage: https://github.com/Metatavu/pakkasmarja-rest-client#readme
- Issues: https://github.com/Metatavu/pakkasmarja-rest-client/issues
- npm.io page: https://npm.io/package/pakkasmarja-rest-client

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.5.2

## Recent versions

- 0.0.15 (latest) — 2019-04-26
- 0.0.14 — 2018-04-20
- 0.0.13 — 2018-04-05
- 0.0.12 — 2018-04-05
- 0.0.11 — 2018-04-03
- 0.0.10 — 2018-04-03
- 0.0.9 — 2018-03-27
- 0.0.8 — 2018-03-22
- 0.0.7 — 2018-03-15
- 0.0.6 — 2018-03-15
- 0.0.5 — 2018-03-14
- 0.0.4 — 2018-03-01
- 0.0.3 — 2018-02-23

## README

# pakkasmarja-rest-client

PakkasmarjaRestClient - JavaScript client for pakkasmarja-rest-client
REST API for Pakkasmarja
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 0.0.3
- Package version: 0.0.14
- 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 pakkasmarja-rest-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 pakkasmarja-rest-client from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

You should now be able to `require('pakkasmarja-rest-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 PakkasmarjaRestClient = require('pakkasmarja-rest-client');

var defaultClient = PakkasmarjaRestClient.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new PakkasmarjaRestClient.ChatThreadsApi()

var threadId = 789; // {Number} chat thread id

var type = "type_example"; // {String} report type. Accepted values summaryReport

var opts = { 
  'accept': "accept_example" // {String} Expected response format. Accepted values application/vnd.openxmlformats for Excel response
};
api.getChatThreadReport(threadId, type, 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/rest/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PakkasmarjaRestClient.ChatThreadsApi* | [**getChatThreadReport**](docs/ChatThreadsApi.md#getChatThreadReport) | **GET** /chatThreads/{threadId}/reports/{type} | Returns chat thread report
*PakkasmarjaRestClient.ChatThreadsApi* | [**listChatThreads**](docs/ChatThreadsApi.md#listChatThreads) | **GET** /chatThreads | Returns list of chat threads
*PakkasmarjaRestClient.ContactsApi* | [**findContact**](docs/ContactsApi.md#findContact) | **GET** /contacts/{id} | Find contact
*PakkasmarjaRestClient.ContactsApi* | [**listContacts**](docs/ContactsApi.md#listContacts) | **GET** /contacts | Lists contacts
*PakkasmarjaRestClient.ContactsApi* | [**updateContact**](docs/ContactsApi.md#updateContact) | **PUT** /contacts/{id} | Update contact
*PakkasmarjaRestClient.ContactsApi* | [**updateContactCredentials**](docs/ContactsApi.md#updateContactCredentials) | **PUT** /contacts/{id}/credentials | Update contact credentials
*PakkasmarjaRestClient.ContractsApi* | [**createContract**](docs/ContractsApi.md#createContract) | **POST** /contracts | Create contract
*PakkasmarjaRestClient.ContractsApi* | [**createContractDocumentSignRequest**](docs/ContractsApi.md#createContractDocumentSignRequest) | **POST** /contracts/{id}/documents/{type}/signRequests | Requests contract document electronic signing
*PakkasmarjaRestClient.ContractsApi* | [**createContractDocumentTemplate**](docs/ContractsApi.md#createContractDocumentTemplate) | **POST** /contracts/{contractId}/documentTemplates | Create contract document template
*PakkasmarjaRestClient.ContractsApi* | [**findContract**](docs/ContractsApi.md#findContract) | **GET** /contracts/{id} | Find contract
*PakkasmarjaRestClient.ContractsApi* | [**findContractDocumentTemplate**](docs/ContractsApi.md#findContractDocumentTemplate) | **GET** /contracts/{contractId}/documentTemplates/{contractDocumentTemplateId} | Find contract document template
*PakkasmarjaRestClient.ContractsApi* | [**getContractDocument**](docs/ContractsApi.md#getContractDocument) | **GET** /contracts/{id}/documents/{type} | Returns contract document
*PakkasmarjaRestClient.ContractsApi* | [**listContractDocumentTemplates**](docs/ContractsApi.md#listContractDocumentTemplates) | **GET** /contracts/{contractId}/documentTemplates | List contract document templates
*PakkasmarjaRestClient.ContractsApi* | [**listContractPrices**](docs/ContractsApi.md#listContractPrices) | **GET** /contracts/{contractId}/prices | List contract prices
*PakkasmarjaRestClient.ContractsApi* | [**listContracts**](docs/ContractsApi.md#listContracts) | **GET** /contracts | Lists contracts
*PakkasmarjaRestClient.ContractsApi* | [**updateContract**](docs/ContractsApi.md#updateContract) | **PUT** /contracts/{id} | Update contract
*PakkasmarjaRestClient.ContractsApi* | [**updateContractDocumentTemplate**](docs/ContractsApi.md#updateContractDocumentTemplate) | **PUT** /contracts/{contractId}/documentTemplates/{contractDocumentTemplateId} | Updates contract document template
*PakkasmarjaRestClient.DeliveryPlacesApi* | [**findDeliveryPlace**](docs/DeliveryPlacesApi.md#findDeliveryPlace) | **GET** /deliveryPlaces/{id} | Find delivery place
*PakkasmarjaRestClient.DeliveryPlacesApi* | [**listDeliveryPlaces**](docs/DeliveryPlacesApi.md#listDeliveryPlaces) | **GET** /deliveryPlaces | Lists delivery places
*PakkasmarjaRestClient.ItemGroupsApi* | [**createItemGroupPrice**](docs/ItemGroupsApi.md#createItemGroupPrice) | **POST** /itemGroups/{itemGroupId}/prices | Creates item group price
*PakkasmarjaRestClient.ItemGroupsApi* | [**deleteItemGroupPrice**](docs/ItemGroupsApi.md#deleteItemGroupPrice) | **DELETE** /itemGroups/{itemGroupId}/prices/{priceId} | Delete item group price
*PakkasmarjaRestClient.ItemGroupsApi* | [**findItemGroup**](docs/ItemGroupsApi.md#findItemGroup) | **GET** /itemGroups/{id} | Find item group
*PakkasmarjaRestClient.ItemGroupsApi* | [**findItemGroupDocumentTemplate**](docs/ItemGroupsApi.md#findItemGroupDocumentTemplate) | **GET** /itemGroups/{itemGroupId}/documentTemplates/{id} | Find item group document template
*PakkasmarjaRestClient.ItemGroupsApi* | [**findItemGroupPrice**](docs/ItemGroupsApi.md#findItemGroupPrice) | **GET** /itemGroups/{itemGroupId}/prices/{priceId} | Find item group price
*PakkasmarjaRestClient.ItemGroupsApi* | [**listItemGroupDocumentTemplates**](docs/ItemGroupsApi.md#listItemGroupDocumentTemplates) | **GET** /itemGroups/{itemGroupId}/documentTemplates | List item group document templates
*PakkasmarjaRestClient.ItemGroupsApi* | [**listItemGroupPrices**](docs/ItemGroupsApi.md#listItemGroupPrices) | **GET** /itemGroups/{itemGroupId}/prices | List item group prices
*PakkasmarjaRestClient.ItemGroupsApi* | [**listItemGroups**](docs/ItemGroupsApi.md#listItemGroups) | **GET** /itemGroups | Lists item groups
*PakkasmarjaRestClient.ItemGroupsApi* | [**updateItemGroupDocumentTemplate**](docs/ItemGroupsApi.md#updateItemGroupDocumentTemplate) | **PUT** /itemGroups/{itemGroupId}/documentTemplates/{id} | Updates item group document template
*PakkasmarjaRestClient.ItemGroupsApi* | [**updateItemGroupPrice**](docs/ItemGroupsApi.md#updateItemGroupPrice) | **PUT** /itemGroups/{itemGroupId}/prices/{priceId} | Update item group price
*PakkasmarjaRestClient.OperationReportsApi* | [**findOperationReport**](docs/OperationReportsApi.md#findOperationReport) | **GET** /operationReports/{id} | Find operation report
*PakkasmarjaRestClient.OperationReportsApi* | [**listOperationReportItems**](docs/OperationReportsApi.md#listOperationReportItems) | **GET** /operationReports/{id}/items | List operation report items
*PakkasmarjaRestClient.OperationReportsApi* | [**listOperationReports**](docs/OperationReportsApi.md#listOperationReports) | **GET** /operationReports | List operation reports
*PakkasmarjaRestClient.OperationsApi* | [**createOperation**](docs/OperationsApi.md#createOperation) | **POST** /operations | Creates new operation
*PakkasmarjaRestClient.SignAuthenticationServicesApi* | [**listSignAuthenticationServices**](docs/SignAuthenticationServicesApi.md#listSignAuthenticationServices) | **GET** /signAuthenticationServices | List sign authentication services


## Documentation for Models

 - [PakkasmarjaRestClient.Address](docs/Address.md)
 - [PakkasmarjaRestClient.AreaDetail](docs/AreaDetail.md)
 - [PakkasmarjaRestClient.BadRequest](docs/BadRequest.md)
 - [PakkasmarjaRestClient.ChatThread](docs/ChatThread.md)
 - [PakkasmarjaRestClient.Contact](docs/Contact.md)
 - [PakkasmarjaRestClient.Contract](docs/Contract.md)
 - [PakkasmarjaRestClient.ContractDocumentSignRequest](docs/ContractDocumentSignRequest.md)
 - [PakkasmarjaRestClient.ContractDocumentTemplate](docs/ContractDocumentTemplate.md)
 - [PakkasmarjaRestClient.Credentials](docs/Credentials.md)
 - [PakkasmarjaRestClient.DeliveryPlace](docs/DeliveryPlace.md)
 - [PakkasmarjaRestClient.Forbidden](docs/Forbidden.md)
 - [PakkasmarjaRestClient.InternalServerError](docs/InternalServerError.md)
 - [PakkasmarjaRestClient.ItemGroup](docs/ItemGroup.md)
 - [PakkasmarjaRestClient.ItemGroupDocumentTemplate](docs/ItemGroupDocumentTemplate.md)
 - [PakkasmarjaRestClient.NotFound](docs/NotFound.md)
 - [PakkasmarjaRestClient.NotImplemented](docs/NotImplemented.md)
 - [PakkasmarjaRestClient.Operation](docs/Operation.md)
 - [PakkasmarjaRestClient.OperationReport](docs/OperationReport.md)
 - [PakkasmarjaRestClient.OperationReportItem](docs/OperationReportItem.md)
 - [PakkasmarjaRestClient.Price](docs/Price.md)
 - [PakkasmarjaRestClient.SignAuthenticationService](docs/SignAuthenticationService.md)


## Documentation for Authorization


### bearer

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

---
_Source: https://npm.io/package/pakkasmarja-rest-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._