@pescheckit/pescheck-client-js 0.0.5

package/README.md

@@ -0,0 +1,220 @@
+# @pescheckit/pescheck-client-js
+
+PescheckApi - JavaScript client for @pescheckit/pescheck-client-js
+Official client library for the Pescheck API (v2), generated from the OpenAPI specification. Authenticate with OAuth2 client credentials and use the checks, profiles, screenings, webhooks and divisions endpoints. See https://github.com/pescheckit/pescheck-clients for installation and usage.
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0.0
+- Package version: 0.0.5
+- Generator version: 7.23.0
+- Build package: org.openapitools.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 @pescheckit/pescheck-client-js --save
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+##### 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
+```
+
+To use the link you just defined in your project, switch to the directory you want to use your @pescheckit/pescheck-client-js from, and run:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+#### git
+
+If the library is hosted at a git repository, e.g.https://github.com/pescheckit/pescheck-clients
+then install it via:
+
+```shell
+    npm install pescheckit/pescheck-clients --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.
+
+### 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 PescheckApi = require('@pescheckit/pescheck-client-js');
+
+var defaultClient = PescheckApi.ApiClient.instance;
+// Configure OAuth2 access token for authorization: oauth2
+var oauth2 = defaultClient.authentications['oauth2'];
+oauth2.accessToken = "YOUR ACCESS TOKEN"
+
+var api = new PescheckApi.AuthenticationApi()
+var jWTGeneration = new PescheckApi.JWTGeneration(); // {JWTGeneration} 
+api.generateJWTToken2(jWTGeneration).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://api.pescheck.io*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PescheckApi.AuthenticationApi* | [**generateJWTToken2**](docs/AuthenticationApi.md#generateJWTToken2) | **POST** /api/v2/jwt/generate/ | 
+*PescheckApi.AuthenticationApi* | [**jwtCreate**](docs/AuthenticationApi.md#jwtCreate) | **POST** /api/jwt/ | 
+*PescheckApi.AuthenticationApi* | [**jwtRefreshCreate**](docs/AuthenticationApi.md#jwtRefreshCreate) | **POST** /api/jwt/refresh/ | 
+*PescheckApi.ChecksApi* | [**v2ChecksList**](docs/ChecksApi.md#v2ChecksList) | **GET** /api/v2/checks/ | 
+*PescheckApi.ChecksApi* | [**v2ChecksRetrieve**](docs/ChecksApi.md#v2ChecksRetrieve) | **GET** /api/v2/checks/{check_type}/ | 
+*PescheckApi.DivisionsApi* | [**v2OrganisationsDivisionsCreate**](docs/DivisionsApi.md#v2OrganisationsDivisionsCreate) | **POST** /api/v2/organisations/divisions/ | 
+*PescheckApi.DivisionsApi* | [**v2OrganisationsDivisionsList**](docs/DivisionsApi.md#v2OrganisationsDivisionsList) | **GET** /api/v2/organisations/divisions/ | 
+*PescheckApi.DivisionsApi* | [**v2OrganisationsDivisionsPartialUpdate**](docs/DivisionsApi.md#v2OrganisationsDivisionsPartialUpdate) | **PATCH** /api/v2/organisations/divisions/{id}/ | 
+*PescheckApi.DivisionsApi* | [**v2OrganisationsDivisionsRetrieve**](docs/DivisionsApi.md#v2OrganisationsDivisionsRetrieve) | **GET** /api/v2/organisations/divisions/{id}/ | 
+*PescheckApi.DivisionsApi* | [**v2OrganisationsDivisionsUpdate**](docs/DivisionsApi.md#v2OrganisationsDivisionsUpdate) | **PUT** /api/v2/organisations/divisions/{id}/ | 
+*PescheckApi.OAuthApi* | [**createOAuthApplication2**](docs/OAuthApi.md#createOAuthApplication2) | **POST** /api/v2/oauth/applications/ | 
+*PescheckApi.OAuthApi* | [**deleteOAuthApplication2**](docs/OAuthApi.md#deleteOAuthApplication2) | **DELETE** /api/v2/oauth/applications/{application_id}/ | 
+*PescheckApi.OAuthApi* | [**listOAuthApplications2**](docs/OAuthApi.md#listOAuthApplications2) | **GET** /api/v2/oauth/applications/list/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesCreate**](docs/ProfilesApi.md#v2ProfilesCreate) | **POST** /api/v2/profiles/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesDestroy**](docs/ProfilesApi.md#v2ProfilesDestroy) | **DELETE** /api/v2/profiles/{id}/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesList**](docs/ProfilesApi.md#v2ProfilesList) | **GET** /api/v2/profiles/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesPartialUpdate**](docs/ProfilesApi.md#v2ProfilesPartialUpdate) | **PATCH** /api/v2/profiles/{id}/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesRetrieve**](docs/ProfilesApi.md#v2ProfilesRetrieve) | **GET** /api/v2/profiles/{id}/ | 
+*PescheckApi.ProfilesApi* | [**v2ProfilesUpdate**](docs/ProfilesApi.md#v2ProfilesUpdate) | **PUT** /api/v2/profiles/{id}/ | 
+*PescheckApi.ScreeningsApi* | [**v2ScreeningsCreate**](docs/ScreeningsApi.md#v2ScreeningsCreate) | **POST** /api/v2/screenings/ | 
+*PescheckApi.ScreeningsApi* | [**v2ScreeningsDocumentsList**](docs/ScreeningsApi.md#v2ScreeningsDocumentsList) | **GET** /api/v2/screenings/{id}/documents/ | Retrieve screening documents
+*PescheckApi.ScreeningsApi* | [**v2ScreeningsList**](docs/ScreeningsApi.md#v2ScreeningsList) | **GET** /api/v2/screenings/ | 
+*PescheckApi.ScreeningsApi* | [**v2ScreeningsRetrieve**](docs/ScreeningsApi.md#v2ScreeningsRetrieve) | **GET** /api/v2/screenings/{id}/ | 
+*PescheckApi.WebhooksApi* | [**createWebhook2**](docs/WebhooksApi.md#createWebhook2) | **POST** /api/v2/webhooks/ | 
+*PescheckApi.WebhooksApi* | [**deleteWebhook2**](docs/WebhooksApi.md#deleteWebhook2) | **DELETE** /api/v2/webhooks/{webhook_id}/ | 
+*PescheckApi.WebhooksApi* | [**listWebhooks2**](docs/WebhooksApi.md#listWebhooks2) | **GET** /api/v2/webhooks/list/ | 
+*PescheckApi.WebhooksApi* | [**verifyWebhook2**](docs/WebhooksApi.md#verifyWebhook2) | **POST** /api/v2/webhooks/{webhook_id}/verify/ | 
+
+
+## Documentation for Models
+
+ - [PescheckApi.CustomTokenObtainPair](docs/CustomTokenObtainPair.md)
+ - [PescheckApi.DivisionReadOnly](docs/DivisionReadOnly.md)
+ - [PescheckApi.DivisionWrite](docs/DivisionWrite.md)
+ - [PescheckApi.JWTGeneration](docs/JWTGeneration.md)
+ - [PescheckApi.JWTResponse](docs/JWTResponse.md)
+ - [PescheckApi.OAuthApplication](docs/OAuthApplication.md)
+ - [PescheckApi.OAuthApplicationResponse](docs/OAuthApplicationResponse.md)
+ - [PescheckApi.PaginatedDivisionReadOnlyList](docs/PaginatedDivisionReadOnlyList.md)
+ - [PescheckApi.PaginatedV2ProfileListItemList](docs/PaginatedV2ProfileListItemList.md)
+ - [PescheckApi.PaginatedV2ScreeningListItemList](docs/PaginatedV2ScreeningListItemList.md)
+ - [PescheckApi.PatchedDivisionWrite](docs/PatchedDivisionWrite.md)
+ - [PescheckApi.PatchedV2ProfilePartialUpdate](docs/PatchedV2ProfilePartialUpdate.md)
+ - [PescheckApi.TokenRefresh](docs/TokenRefresh.md)
+ - [PescheckApi.V2Candidate](docs/V2Candidate.md)
+ - [PescheckApi.V2CheckField](docs/V2CheckField.md)
+ - [PescheckApi.V2CheckInfo](docs/V2CheckInfo.md)
+ - [PescheckApi.V2Document](docs/V2Document.md)
+ - [PescheckApi.V2DocumentContent](docs/V2DocumentContent.md)
+ - [PescheckApi.V2Money](docs/V2Money.md)
+ - [PescheckApi.V2ProfileCheck](docs/V2ProfileCheck.md)
+ - [PescheckApi.V2ProfileCheckEntry](docs/V2ProfileCheckEntry.md)
+ - [PescheckApi.V2ProfileCreate](docs/V2ProfileCreate.md)
+ - [PescheckApi.V2ProfileDetail](docs/V2ProfileDetail.md)
+ - [PescheckApi.V2ProfileListItem](docs/V2ProfileListItem.md)
+ - [PescheckApi.V2ProfileUpdate](docs/V2ProfileUpdate.md)
+ - [PescheckApi.V2ProfileUpdateCheck](docs/V2ProfileUpdateCheck.md)
+ - [PescheckApi.V2ScreeningCheck](docs/V2ScreeningCheck.md)
+ - [PescheckApi.V2ScreeningCheckEntry](docs/V2ScreeningCheckEntry.md)
+ - [PescheckApi.V2ScreeningCheckListItem](docs/V2ScreeningCheckListItem.md)
+ - [PescheckApi.V2ScreeningCreate](docs/V2ScreeningCreate.md)
+ - [PescheckApi.V2ScreeningDetail](docs/V2ScreeningDetail.md)
+ - [PescheckApi.V2ScreeningDetailProfile](docs/V2ScreeningDetailProfile.md)
+ - [PescheckApi.V2ScreeningListItem](docs/V2ScreeningListItem.md)
+ - [PescheckApi.VerifyWebhook](docs/VerifyWebhook.md)
+ - [PescheckApi.Webhook](docs/Webhook.md)
+ - [PescheckApi.WebhookResponse](docs/WebhookResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### cookieAuth
+
+
+- **Type**: API key
+- **API key parameter name**: __Secure-sessionid
+- **Location**: 
+
+### jwtAuth
+
+- **Type**: Bearer authentication (JWT)
+
+### oauth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  - read:api: read groups
+  - create:api: create groups
+  - update:api: update groups
+