pescheck-client 0.0.5

Pescheck API

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

• API version: 2.0.0
• Package version: 0.0.5
• 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:

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:

import pescheck

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pescheck

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	POST /api/v2/jwt/generate/
AuthenticationApi	jwt_create	POST /api/jwt/
AuthenticationApi	jwt_refresh_create	POST /api/jwt/refresh/
ChecksApi	v2_checks_list	GET /api/v2/checks/
ChecksApi	v2_checks_retrieve	GET /api/v2/checks/{check_type}/
DivisionsApi	v2_organisations_divisions_create	POST /api/v2/organisations/divisions/
DivisionsApi	v2_organisations_divisions_list	GET /api/v2/organisations/divisions/
DivisionsApi	v2_organisations_divisions_partial_update	PATCH /api/v2/organisations/divisions/{id}/
DivisionsApi	v2_organisations_divisions_retrieve	GET /api/v2/organisations/divisions/{id}/
DivisionsApi	v2_organisations_divisions_update	PUT /api/v2/organisations/divisions/{id}/
OAuthApi	create_o_auth_application2	POST /api/v2/oauth/applications/
OAuthApi	delete_o_auth_application2	DELETE /api/v2/oauth/applications/{application_id}/
OAuthApi	list_o_auth_applications2	GET /api/v2/oauth/applications/list/
ProfilesApi	v2_profiles_create	POST /api/v2/profiles/
ProfilesApi	v2_profiles_destroy	DELETE /api/v2/profiles/{id}/
ProfilesApi	v2_profiles_list	GET /api/v2/profiles/
ProfilesApi	v2_profiles_partial_update	PATCH /api/v2/profiles/{id}/
ProfilesApi	v2_profiles_retrieve	GET /api/v2/profiles/{id}/
ProfilesApi	v2_profiles_update	PUT /api/v2/profiles/{id}/
ScreeningsApi	v2_screenings_create	POST /api/v2/screenings/
ScreeningsApi	v2_screenings_documents_list	GET /api/v2/screenings/{id}/documents/	Retrieve screening documents
ScreeningsApi	v2_screenings_list	GET /api/v2/screenings/
ScreeningsApi	v2_screenings_retrieve	GET /api/v2/screenings/{id}/
WebhooksApi	create_webhook2	POST /api/v2/webhooks/
WebhooksApi	delete_webhook2	DELETE /api/v2/webhooks/{webhook_id}/
WebhooksApi	list_webhooks2	GET /api/v2/webhooks/list/
WebhooksApi	verify_webhook2	POST /api/v2/webhooks/{webhook_id}/verify/

Documentation For Models

• CustomTokenObtainPair
• DivisionReadOnly
• DivisionWrite
• JWTGeneration
• JWTResponse
• OAuthApplication
• OAuthApplicationResponse
• PaginatedDivisionReadOnlyList
• PaginatedV2ProfileListItemList
• PaginatedV2ScreeningListItemList
• PatchedDivisionWrite
• PatchedV2ProfilePartialUpdate
• TokenRefresh
• V2Candidate
• V2CheckField
• V2CheckInfo
• V2Document
• V2DocumentContent
• V2Money
• V2ProfileCheck
• V2ProfileCheckEntry
• V2ProfileCreate
• V2ProfileDetail
• V2ProfileListItem
• V2ProfileUpdate
• V2ProfileUpdateCheck
• V2ScreeningCheck
• V2ScreeningCheckEntry
• V2ScreeningCheckListItem
• V2ScreeningCreate
• V2ScreeningDetail
• V2ScreeningDetailProfile
• V2ScreeningListItem
• VerifyWebhook
• Webhook
• WebhookResponse

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

Author