> **Official Pescheck API client** - part of the [pescheck-clients](https://github.com/pescheckit/pescheck-clients) SDKs.

# Rust API client for 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.


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 2.0.0
- Package version: 0.1.0
- Generator version: 7.23.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `pescheck-client` and add the following to `Cargo.toml` under `[dependencies]`:

```
pescheck-client = { path = "./pescheck-client" }
```

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


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author



