Wise-r-openapi-client NPM

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 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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

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:

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

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

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	GET /v2/changes	Get Changes in Users and Groups.
WiserClient.DocumentsApi	putProcessingAgreement	PUT /v2/documents/processingagreement	Upload a processing agreement
WiserClient.GroupsApi	deleteGroupKey	DELETE /v2/groups/{id}/keys	Delete a key from keyring
WiserClient.GroupsApi	getGroup	GET /v2/groups/{id}	Get Group
WiserClient.GroupsApi	getGroupKey	GET /v2/groups/{id}/keys/client	Get key from keyring
WiserClient.GroupsApi	getGroupKeys	GET /v2/groups/{id}/keys	Get keys from keyring
WiserClient.GroupsApi	getGroupUwlrKey	GET /v2/groups/{id}/keys/uwlr	Get 'UWLR' key from keyring
WiserClient.GroupsApi	getGroups	GET /v2/groups	Get Groups
WiserClient.GroupsApi	putGroupKey	PUT /v2/groups/{id}/keys	Save a key in keyring
WiserClient.LicensesApi	createLicense	POST /v2/licenses	Create a new license
WiserClient.LicensesApi	getLicense	GET /v2/licenses/{id}	Get License
WiserClient.LicensesApi	getLicenses	GET /v2/licenses	Get Licenses
WiserClient.LicensesApi	updateLicense	PUT /v2/licenses	Update an existing license
WiserClient.SchoolsApi	getParentSchool	GET /v2/schoolLocations/parent/{id}	Get School
WiserClient.SchoolsApi	getSchoolLocation	GET /v2/schoolLocations/{id}	Get SchoolLocation
WiserClient.SchoolsApi	getSchoolLocations	GET /v2/schoolLocations	Get Schools
WiserClient.UsersApi	deleteUserKey	DELETE /v2/users/{id}/keys/client	Delete a key from keyring
WiserClient.UsersApi	getUser	GET /v2/users/{id}	Get User
WiserClient.UsersApi	getUserKey	GET /v2/users/{id}/keys/client	Get key from keyring
WiserClient.UsersApi	getUserKeys	GET /v2/users/{id}/keys	Get keys from keyring
WiserClient.UsersApi	getUserUwlrKey	GET /v2/users/{id}/keys/uwlr	Get 'UWLR' key from keyring
WiserClient.UsersApi	getUsers	GET /v2/users	Get Users
WiserClient.UsersApi	putUserKey	PUT /v2/users/{id}/keys/client	Save a key in keyring

Documentation for Models

Documentation for Authorization

oauth_client_credentials

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

superagent

@everything-registry/sub-chunk-3151 wise-r-sync-client @infinitebrahmanuniverse/nolb-wis

5 years ago

6 years ago

7 years ago

7 years ago

7 years ago