Metadata-Version: 2.4
Name: pescheck-client
Version: 0.0.6
Summary: Pescheck API
Home-page: https://pescheck.io
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/pescheckit/pescheck-clients
Keywords: OpenAPI,OpenAPI-Generator,Pescheck API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# pescheck-client
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 Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.0
- Package version: 0.0.6
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/pescheckit/pescheck-clients.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/pescheckit/pescheck-clients.git`)

Then import the package:
```python
import pescheck
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import pescheck
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import pescheck
from pescheck.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.pescheck.io
# See configuration.py for a list of all supported configuration parameters.
configuration = pescheck.Configuration(
    host = "https://api.pescheck.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with pescheck.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pescheck.AuthenticationApi(api_client)
    jwt_generation = pescheck.JWTGeneration() # JWTGeneration | 

    try:
        api_response = api_instance.generate_jwt_token2(jwt_generation)
        print("The response of AuthenticationApi->generate_jwt_token2:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->generate_jwt_token2: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.pescheck.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthenticationApi* | [**generate_jwt_token2**](docs/AuthenticationApi.md#generate_jwt_token2) | **POST** /api/v2/jwt/generate/ | 
*AuthenticationApi* | [**jwt_create**](docs/AuthenticationApi.md#jwt_create) | **POST** /api/jwt/ | 
*AuthenticationApi* | [**jwt_refresh_create**](docs/AuthenticationApi.md#jwt_refresh_create) | **POST** /api/jwt/refresh/ | 
*ChecksApi* | [**v2_checks_list**](docs/ChecksApi.md#v2_checks_list) | **GET** /api/v2/checks/ | 
*ChecksApi* | [**v2_checks_retrieve**](docs/ChecksApi.md#v2_checks_retrieve) | **GET** /api/v2/checks/{check_type}/ | 
*DivisionsApi* | [**v2_organisations_divisions_create**](docs/DivisionsApi.md#v2_organisations_divisions_create) | **POST** /api/v2/organisations/divisions/ | 
*DivisionsApi* | [**v2_organisations_divisions_list**](docs/DivisionsApi.md#v2_organisations_divisions_list) | **GET** /api/v2/organisations/divisions/ | 
*DivisionsApi* | [**v2_organisations_divisions_partial_update**](docs/DivisionsApi.md#v2_organisations_divisions_partial_update) | **PATCH** /api/v2/organisations/divisions/{id}/ | 
*DivisionsApi* | [**v2_organisations_divisions_retrieve**](docs/DivisionsApi.md#v2_organisations_divisions_retrieve) | **GET** /api/v2/organisations/divisions/{id}/ | 
*DivisionsApi* | [**v2_organisations_divisions_update**](docs/DivisionsApi.md#v2_organisations_divisions_update) | **PUT** /api/v2/organisations/divisions/{id}/ | 
*OAuthApi* | [**create_o_auth_application2**](docs/OAuthApi.md#create_o_auth_application2) | **POST** /api/v2/oauth/applications/ | 
*OAuthApi* | [**delete_o_auth_application2**](docs/OAuthApi.md#delete_o_auth_application2) | **DELETE** /api/v2/oauth/applications/{application_id}/ | 
*OAuthApi* | [**list_o_auth_applications2**](docs/OAuthApi.md#list_o_auth_applications2) | **GET** /api/v2/oauth/applications/list/ | 
*ProfilesApi* | [**v2_profiles_create**](docs/ProfilesApi.md#v2_profiles_create) | **POST** /api/v2/profiles/ | 
*ProfilesApi* | [**v2_profiles_destroy**](docs/ProfilesApi.md#v2_profiles_destroy) | **DELETE** /api/v2/profiles/{id}/ | 
*ProfilesApi* | [**v2_profiles_list**](docs/ProfilesApi.md#v2_profiles_list) | **GET** /api/v2/profiles/ | 
*ProfilesApi* | [**v2_profiles_partial_update**](docs/ProfilesApi.md#v2_profiles_partial_update) | **PATCH** /api/v2/profiles/{id}/ | 
*ProfilesApi* | [**v2_profiles_retrieve**](docs/ProfilesApi.md#v2_profiles_retrieve) | **GET** /api/v2/profiles/{id}/ | 
*ProfilesApi* | [**v2_profiles_update**](docs/ProfilesApi.md#v2_profiles_update) | **PUT** /api/v2/profiles/{id}/ | 
*ScreeningsApi* | [**v2_screenings_create**](docs/ScreeningsApi.md#v2_screenings_create) | **POST** /api/v2/screenings/ | 
*ScreeningsApi* | [**v2_screenings_documents_list**](docs/ScreeningsApi.md#v2_screenings_documents_list) | **GET** /api/v2/screenings/{id}/documents/ | Retrieve screening documents
*ScreeningsApi* | [**v2_screenings_list**](docs/ScreeningsApi.md#v2_screenings_list) | **GET** /api/v2/screenings/ | 
*ScreeningsApi* | [**v2_screenings_retrieve**](docs/ScreeningsApi.md#v2_screenings_retrieve) | **GET** /api/v2/screenings/{id}/ | 
*WebhooksApi* | [**create_webhook2**](docs/WebhooksApi.md#create_webhook2) | **POST** /api/v2/webhooks/ | 
*WebhooksApi* | [**delete_webhook2**](docs/WebhooksApi.md#delete_webhook2) | **DELETE** /api/v2/webhooks/{webhook_id}/ | 
*WebhooksApi* | [**list_webhooks2**](docs/WebhooksApi.md#list_webhooks2) | **GET** /api/v2/webhooks/list/ | 
*WebhooksApi* | [**verify_webhook2**](docs/WebhooksApi.md#verify_webhook2) | **POST** /api/v2/webhooks/{webhook_id}/verify/ | 


## Documentation For Models

 - [CustomTokenObtainPair](docs/CustomTokenObtainPair.md)
 - [DivisionReadOnly](docs/DivisionReadOnly.md)
 - [DivisionWrite](docs/DivisionWrite.md)
 - [JWTGeneration](docs/JWTGeneration.md)
 - [JWTResponse](docs/JWTResponse.md)
 - [OAuthApplication](docs/OAuthApplication.md)
 - [OAuthApplicationResponse](docs/OAuthApplicationResponse.md)
 - [PaginatedDivisionReadOnlyList](docs/PaginatedDivisionReadOnlyList.md)
 - [PaginatedV2ProfileListItemList](docs/PaginatedV2ProfileListItemList.md)
 - [PaginatedV2ScreeningListItemList](docs/PaginatedV2ScreeningListItemList.md)
 - [PatchedDivisionWrite](docs/PatchedDivisionWrite.md)
 - [PatchedV2ProfilePartialUpdate](docs/PatchedV2ProfilePartialUpdate.md)
 - [TokenRefresh](docs/TokenRefresh.md)
 - [V2Candidate](docs/V2Candidate.md)
 - [V2CheckField](docs/V2CheckField.md)
 - [V2CheckInfo](docs/V2CheckInfo.md)
 - [V2Document](docs/V2Document.md)
 - [V2DocumentContent](docs/V2DocumentContent.md)
 - [V2Money](docs/V2Money.md)
 - [V2ProfileCheck](docs/V2ProfileCheck.md)
 - [V2ProfileCheckEntry](docs/V2ProfileCheckEntry.md)
 - [V2ProfileCreate](docs/V2ProfileCreate.md)
 - [V2ProfileDetail](docs/V2ProfileDetail.md)
 - [V2ProfileListItem](docs/V2ProfileListItem.md)
 - [V2ProfileUpdate](docs/V2ProfileUpdate.md)
 - [V2ProfileUpdateCheck](docs/V2ProfileUpdateCheck.md)
 - [V2ScreeningCheck](docs/V2ScreeningCheck.md)
 - [V2ScreeningCheckEntry](docs/V2ScreeningCheckEntry.md)
 - [V2ScreeningCheckListItem](docs/V2ScreeningCheckListItem.md)
 - [V2ScreeningCreate](docs/V2ScreeningCreate.md)
 - [V2ScreeningDetail](docs/V2ScreeningDetail.md)
 - [V2ScreeningDetailProfile](docs/V2ScreeningDetailProfile.md)
 - [V2ScreeningListItem](docs/V2ScreeningListItem.md)
 - [VerifyWebhook](docs/VerifyWebhook.md)
 - [Webhook](docs/Webhook.md)
 - [WebhookResponse](docs/WebhookResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="cookieAuth"></a>
### cookieAuth

- **Type**: API key
- **API key parameter name**: __Secure-sessionid
- **Location**: 

<a id="jwtAuth"></a>
### jwtAuth

- **Type**: Bearer authentication (JWT)

<a id="oauth2"></a>
### oauth2

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **read:api**: read groups
 - **create:api**: create groups
 - **update:api**: update groups


## Author




