@pescheckit/pescheck-client 0.0.5

package/docs/ScreeningsApi.md

@@ -0,0 +1,302 @@
+# ScreeningsApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2ScreeningsCreate**](ScreeningsApi.md#v2screeningscreate) | **POST** /api/v2/screenings/ |  |
+| [**v2ScreeningsDocumentsList**](ScreeningsApi.md#v2screeningsdocumentslist) | **GET** /api/v2/screenings/{id}/documents/ | Retrieve screening documents |
+| [**v2ScreeningsList**](ScreeningsApi.md#v2screeningslist) | **GET** /api/v2/screenings/ |  |
+| [**v2ScreeningsRetrieve**](ScreeningsApi.md#v2screeningsretrieve) | **GET** /api/v2/screenings/{id}/ |  |
+
+
+
+## v2ScreeningsCreate
+
+> V2ScreeningDetail v2ScreeningsCreate(v2ScreeningCreate)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ScreeningsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ScreeningsCreateRequest } from '@pescheckit/pescheck-client';
+
+async function example() {
+  console.log("🚀 Testing @pescheckit/pescheck-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ScreeningsApi(config);
+
+  const body = {
+    // V2ScreeningCreate
+    v2ScreeningCreate: {"profile_id":"018e9f1e-3a73-7eba-b29c-c2c4a8c40c8a","candidate":{"first_name":"Jan","last_name":"de Vries","email":"jan.devries@example.com","date_of_birth":"1985-04-12"}},
+  } satisfies V2ScreeningsCreateRequest;
+
+  try {
+    const data = await api.v2ScreeningsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **v2ScreeningCreate** | [V2ScreeningCreate](V2ScreeningCreate.md) |  | |
+
+### Return type
+
+[**V2ScreeningDetail**](V2ScreeningDetail.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2ScreeningsDocumentsList
+
+> Array<V2Document> v2ScreeningsDocumentsList(id, checkId, checkType)
+
+Retrieve screening documents
+
+Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ScreeningsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ScreeningsDocumentsListRequest } from '@pescheckit/pescheck-client';
+
+async function example() {
+  console.log("🚀 Testing @pescheckit/pescheck-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ScreeningsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Only documents from the check with this id. (optional)
+    checkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Only documents from checks of this type. (optional)
+    checkType: checkType_example,
+  } satisfies V2ScreeningsDocumentsListRequest;
+
+  try {
+    const data = await api.v2ScreeningsDocumentsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **checkId** | `string` | Only documents from the check with this id. | [Optional] [Defaults to `undefined`] |
+| **checkType** | `string` | Only documents from checks of this type. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<V2Document>**](V2Document.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2ScreeningsList
+
+> PaginatedV2ScreeningListItemList v2ScreeningsList(page, pageSize, paginate)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ScreeningsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ScreeningsListRequest } from '@pescheckit/pescheck-client';
+
+async function example() {
+  console.log("🚀 Testing @pescheckit/pescheck-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ScreeningsApi(config);
+
+  const body = {
+    // number | A page number within the paginated result set. (optional)
+    page: 1,
+    // number | Number of results to return per page. (optional)
+    pageSize: 50,
+    // boolean | Enable/disable pagination. When false, max 500 records returned. (optional)
+    paginate: true,
+  } satisfies V2ScreeningsListRequest;
+
+  try {
+    const data = await api.v2ScreeningsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `50`] |
+| **paginate** | `boolean` | Enable/disable pagination. When false, max 500 records returned. | [Optional] [Defaults to `true`] |
+
+### Return type
+
+[**PaginatedV2ScreeningListItemList**](PaginatedV2ScreeningListItemList.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2ScreeningsRetrieve
+
+> V2ScreeningDetail v2ScreeningsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ScreeningsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ScreeningsRetrieveRequest } from '@pescheckit/pescheck-client';
+
+async function example() {
+  console.log("🚀 Testing @pescheckit/pescheck-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new ScreeningsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this screening.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies V2ScreeningsRetrieveRequest;
+
+  try {
+    const data = await api.v2ScreeningsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this screening. | [Defaults to `undefined`] |
+
+### Return type
+
+[**V2ScreeningDetail**](V2ScreeningDetail.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/TokenRefresh.md

@@ -0,0 +1,36 @@
+
+# TokenRefresh
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`access` | string
+`refresh` | string
+
+## Example
+
+```typescript
+import type { TokenRefresh } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "access": null,
+  "refresh": null,
+} satisfies TokenRefresh
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TokenRefresh
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2Candidate.md

@@ -0,0 +1,53 @@
+
+# V2Candidate
+
+Bucket-level candidate facts. Required-ness varies per profile; serializer is lenient.  Note: v2 tightens nationality vs v1 - v1 accepted any free-form string, v2 requires an ISO 3166-1 alpha-2 code so downstream consumers (watchlist matching, document readers, etc.) can rely on the value.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`email` | string
+`initials` | string
+`dateOfBirth` | string
+`gender` | string
+`nationality` | string
+`postalCode` | string
+`houseNumber` | string
+`extension` | string
+
+## Example
+
+```typescript
+import type { V2Candidate } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "initials": null,
+  "dateOfBirth": null,
+  "gender": null,
+  "nationality": null,
+  "postalCode": null,
+  "houseNumber": null,
+  "extension": null,
+} satisfies V2Candidate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2Candidate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2CheckField.md

@@ -0,0 +1,43 @@
+
+# V2CheckField
+
+One config or input field a check accepts via the API.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`type` | string
+`required` | boolean
+`choices` | Array<string>
+`helpText` | string
+
+## Example
+
+```typescript
+import type { V2CheckField } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "type": null,
+  "required": null,
+  "choices": null,
+  "helpText": null,
+} satisfies V2CheckField
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2CheckField
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2CheckInfo.md

@@ -0,0 +1,57 @@
+
+# V2CheckInfo
+
+Everything a client needs to know to use a check type via the API.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkType` | string
+`displayName` | string
+`description` | string
+`hasConfig` | boolean
+`isSystemManaged` | boolean
+`requiresChecks` | Array<string>
+`supportedCountriesOfWork` | Array<string>
+`supportedCountriesOfResidence` | Array<string>
+`defaultPrice` | [V2Money](V2Money.md)
+`configFields` | [Array<V2CheckField>](V2CheckField.md)
+`inputFields` | [Array<V2CheckField>](V2CheckField.md)
+`candidateFields` | [Array<V2CheckField>](V2CheckField.md)
+
+## Example
+
+```typescript
+import type { V2CheckInfo } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkType": null,
+  "displayName": null,
+  "description": null,
+  "hasConfig": null,
+  "isSystemManaged": null,
+  "requiresChecks": null,
+  "supportedCountriesOfWork": null,
+  "supportedCountriesOfResidence": null,
+  "defaultPrice": null,
+  "configFields": null,
+  "inputFields": null,
+  "candidateFields": null,
+} satisfies V2CheckInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2CheckInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2Document.md

@@ -0,0 +1,45 @@
+
+# V2Document
+
+One document attached to a screening\'s check. `metadata` carries check-specific extras and may be empty.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkId` | string
+`checkType` | string
+`filename` | string
+`extension` | string
+`content` | [V2DocumentContent](V2DocumentContent.md)
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { V2Document } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkId": null,
+  "checkType": null,
+  "filename": null,
+  "extension": null,
+  "content": null,
+  "metadata": null,
+} satisfies V2Document
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2Document
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2DocumentContent.md

@@ -0,0 +1,37 @@
+
+# V2DocumentContent
+
+How the file is delivered. `type` is the discriminator; today it is always `\"base64\"` and `data` holds the encoded bytes. Other delivery types may be added later without breaking this contract.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`data` | string
+
+## Example
+
+```typescript
+import type { V2DocumentContent } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "data": null,
+} satisfies V2DocumentContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2DocumentContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2Money.md

@@ -0,0 +1,36 @@
+
+# V2Money
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`amount` | string
+`currency` | string
+
+## Example
+
+```typescript
+import type { V2Money } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "amount": null,
+  "currency": null,
+} satisfies V2Money
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2Money
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2ProfileCheck.md

@@ -0,0 +1,37 @@
+
+# V2ProfileCheck
+
+Input serializer for one `{check_type, config}` profile-check entry.  Used by profile create directly. Subclass with `PARTIAL_CONFIG = True` for screening overrides where only the fields actually being changed should be validated.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkType` | string
+`config` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { V2ProfileCheck } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkType": null,
+  "config": null,
+} satisfies V2ProfileCheck
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2ProfileCheck
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V2ProfileCheckEntry.md

@@ -0,0 +1,46 @@
+
+# V2ProfileCheckEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`checkType` | string
+`displayName` | string
+`configuredPrice` | [V2Money](V2Money.md)
+`config` | { [key: string]: any; }
+`inputFields` | Array<object>
+`isSystemManaged` | boolean
+
+## Example
+
+```typescript
+import type { V2ProfileCheckEntry } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "checkType": null,
+  "displayName": null,
+  "configuredPrice": null,
+  "config": null,
+  "inputFields": null,
+  "isSystemManaged": null,
+} satisfies V2ProfileCheckEntry
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V2ProfileCheckEntry
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+