# wise-r-openapi-client

> Wise-r OpenAPI Client

Latest version **2.0.2** (published 2019-02-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install wise-r-openapi-client
pnpm add wise-r-openapi-client
yarn add wise-r-openapi-client
bun add wise-r-openapi-client
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2019-02-15 |
| First published | 2016-11-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 323.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wise-r |

## Links

- npm: https://www.npmjs.com/package/wise-r-openapi-client
- npm.io page: https://npm.io/package/wise-r-openapi-client

## Dependencies (1)

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

## Recent versions

- 2.0.2 (latest) — 2019-02-15
- 2.0.1 — 2018-01-31
- 2.0.0-20170228 — 2017-02-28
- 1.0.0-20161222 — 2016-12-23
- 1.0.0-20161129 — 2016-11-29

## README

# wise-r-openapi-client

WiserClient - JavaScript client for wise-r-openapi-client
No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2.0
- Package version: 2.0
- Build date: 2018-01-30T15:54:37.654+01:00
- Build package: class 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 wise-r-openapi-client --save
```

#### 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):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

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

```javascript
var WiserClient = require('wise-r-openapi-client');

var defaultClient = WiserClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth_client_credentials
var oauth_client_credentials = defaultClient.authentications['oauth_client_credentials'];
oauth_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new WiserClient.ChangesApi()

var schoollocations = ["schoollocations_example"]; // {[String]} Filter on schoollocations (required, list of id's)

var opts = { 
  'nextId': 789 // {Integer} ID that was returned the last time when retrieving Changes for this set of schoollocations. When empty, only the last changes will be returned as a starting point for a new synchronisation of a schoollocation
};
api.getChanges(schoollocations, 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/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*WiserClient.ChangesApi* | [**getChanges**](docs/ChangesApi.md#getChanges) | **GET** /v2/changes | Get Changes in Users and Groups.
*WiserClient.DocumentsApi* | [**putProcessingAgreement**](docs/DocumentsApi.md#putProcessingAgreement) | **PUT** /v2/documents/processingagreement | Upload a processing agreement
*WiserClient.GroupsApi* | [**deleteGroupKey**](docs/GroupsApi.md#deleteGroupKey) | **DELETE** /v2/groups/{id}/keys | Delete a key from keyring
*WiserClient.GroupsApi* | [**getGroup**](docs/GroupsApi.md#getGroup) | **GET** /v2/groups/{id} | Get Group
*WiserClient.GroupsApi* | [**getGroupKey**](docs/GroupsApi.md#getGroupKey) | **GET** /v2/groups/{id}/keys/client | Get key from keyring
*WiserClient.GroupsApi* | [**getGroupKeys**](docs/GroupsApi.md#getGroupKeys) | **GET** /v2/groups/{id}/keys | Get keys from keyring
*WiserClient.GroupsApi* | [**getGroupUwlrKey**](docs/GroupsApi.md#getGroupUwlrKey) | **GET** /v2/groups/{id}/keys/uwlr | Get 'UWLR' key from keyring
*WiserClient.GroupsApi* | [**getGroups**](docs/GroupsApi.md#getGroups) | **GET** /v2/groups | Get Groups
*WiserClient.GroupsApi* | [**putGroupKey**](docs/GroupsApi.md#putGroupKey) | **PUT** /v2/groups/{id}/keys | Save a key in keyring
*WiserClient.LicensesApi* | [**createLicense**](docs/LicensesApi.md#createLicense) | **POST** /v2/licenses | Create a new license
*WiserClient.LicensesApi* | [**getLicense**](docs/LicensesApi.md#getLicense) | **GET** /v2/licenses/{id} | Get License
*WiserClient.LicensesApi* | [**getLicenses**](docs/LicensesApi.md#getLicenses) | **GET** /v2/licenses | Get Licenses
*WiserClient.LicensesApi* | [**updateLicense**](docs/LicensesApi.md#updateLicense) | **PUT** /v2/licenses | Update an existing license
*WiserClient.SchoolsApi* | [**getParentSchool**](docs/SchoolsApi.md#getParentSchool) | **GET** /v2/schoolLocations/parent/{id} | Get School
*WiserClient.SchoolsApi* | [**getSchoolLocation**](docs/SchoolsApi.md#getSchoolLocation) | **GET** /v2/schoolLocations/{id} | Get SchoolLocation
*WiserClient.SchoolsApi* | [**getSchoolLocations**](docs/SchoolsApi.md#getSchoolLocations) | **GET** /v2/schoolLocations | Get Schools
*WiserClient.UsersApi* | [**deleteUserKey**](docs/UsersApi.md#deleteUserKey) | **DELETE** /v2/users/{id}/keys/client | Delete a key from keyring
*WiserClient.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /v2/users/{id} | Get User
*WiserClient.UsersApi* | [**getUserKey**](docs/UsersApi.md#getUserKey) | **GET** /v2/users/{id}/keys/client | Get key from keyring
*WiserClient.UsersApi* | [**getUserKeys**](docs/UsersApi.md#getUserKeys) | **GET** /v2/users/{id}/keys | Get keys from keyring
*WiserClient.UsersApi* | [**getUserUwlrKey**](docs/UsersApi.md#getUserUwlrKey) | **GET** /v2/users/{id}/keys/uwlr | Get 'UWLR' key from keyring
*WiserClient.UsersApi* | [**getUsers**](docs/UsersApi.md#getUsers) | **GET** /v2/users | Get Users
*WiserClient.UsersApi* | [**putUserKey**](docs/UsersApi.md#putUserKey) | **PUT** /v2/users/{id}/keys/client | Save a key in keyring


## Documentation for Models

 - [WiserClient.AanbiederIdRestResourceLink](docs/AanbiederIdRestResourceLink.md)
 - [WiserClient.ChangeResourceV2](docs/ChangeResourceV2.md)
 - [WiserClient.ChangeSetV2](docs/ChangeSetV2.md)
 - [WiserClient.EntityTag](docs/EntityTag.md)
 - [WiserClient.GroupResourceV2](docs/GroupResourceV2.md)
 - [WiserClient.KeyValueResourceV2](docs/KeyValueResourceV2.md)
 - [WiserClient.KeyringResourceV2](docs/KeyringResourceV2.md)
 - [WiserClient.License](docs/License.md)
 - [WiserClient.Link](docs/Link.md)
 - [WiserClient.Locale](docs/Locale.md)
 - [WiserClient.MediaType](docs/MediaType.md)
 - [WiserClient.NewCookie](docs/NewCookie.md)
 - [WiserClient.NotAuthorizedOrganisationResponse](docs/NotAuthorizedOrganisationResponse.md)
 - [WiserClient.Response](docs/Response.md)
 - [WiserClient.RestResourceLinkV2](docs/RestResourceLinkV2.md)
 - [WiserClient.SchoolLocationResourceV2](docs/SchoolLocationResourceV2.md)
 - [WiserClient.SchoolResource](docs/SchoolResource.md)
 - [WiserClient.StatusType](docs/StatusType.md)
 - [WiserClient.UriBuilder](docs/UriBuilder.md)
 - [WiserClient.UserResourceV2](docs/UserResourceV2.md)


## Documentation for Authorization


### oauth_client_credentials

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
  - access: Full read access

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