@pescheckit/pescheck-client 0.0.5

package/docs/V2ProfileCreate.md

@@ -0,0 +1,38 @@
+
+# V2ProfileCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`checks` | [Array<V2ProfileCheck>](V2ProfileCheck.md)
+
+## Example
+
+```typescript
+import type { V2ProfileCreate } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "checks": null,
+} satisfies V2ProfileCreate
+
+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 V2ProfileCreate
+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/V2ProfileDetail.md

@@ -0,0 +1,54 @@
+
+# V2ProfileDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`isCustom` | boolean
+`checks` | [Array<V2ProfileCheckEntry>](V2ProfileCheckEntry.md)
+`totalPrice` | [V2Money](V2Money.md)
+`supportedCountriesOfWork` | Array<string>
+`supportedCountriesOfResidence` | Array<string>
+`candidateFields` | Array<object>
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { V2ProfileDetail } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "isCustom": null,
+  "checks": null,
+  "totalPrice": null,
+  "supportedCountriesOfWork": null,
+  "supportedCountriesOfResidence": null,
+  "candidateFields": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies V2ProfileDetail
+
+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 V2ProfileDetail
+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/V2ProfileListItem.md

@@ -0,0 +1,46 @@
+
+# V2ProfileListItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`isCustom` | boolean
+`checkTypes` | Array<string>
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { V2ProfileListItem } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "isCustom": null,
+  "checkTypes": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies V2ProfileListItem
+
+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 V2ProfileListItem
+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/V2ProfileUpdate.md

@@ -0,0 +1,39 @@
+
+# V2ProfileUpdate
+
+Replaces the profile - name, description and full checks list. Entries matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`checks` | [Array<V2ProfileUpdateCheck>](V2ProfileUpdateCheck.md)
+
+## Example
+
+```typescript
+import type { V2ProfileUpdate } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "checks": null,
+} satisfies V2ProfileUpdate
+
+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 V2ProfileUpdate
+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/V2ProfileUpdateCheck.md

@@ -0,0 +1,39 @@
+
+# V2ProfileUpdateCheck
+
+Profile update entry. Same shape as create plus optional profile_check_id for in-place update of an existing check. Absent profile_check_id = add new.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkType` | string
+`config` | { [key: string]: any; }
+`profileCheckId` | string
+
+## Example
+
+```typescript
+import type { V2ProfileUpdateCheck } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkType": null,
+  "config": null,
+  "profileCheckId": null,
+} satisfies V2ProfileUpdateCheck
+
+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 V2ProfileUpdateCheck
+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/V2ScreeningCheck.md

@@ -0,0 +1,41 @@
+
+# V2ScreeningCheck
+
+Per-screening entry: identifies a target ProfileCheck (by check_type when unambiguous, or via profile_check_id when the profile has multiple ProfileChecks of the same type) and supplies optional `config` patch + per-check `input`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkType` | string
+`config` | { [key: string]: any; }
+`profileCheckId` | string
+`input` | any
+
+## Example
+
+```typescript
+import type { V2ScreeningCheck } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkType": null,
+  "config": null,
+  "profileCheckId": null,
+  "input": null,
+} satisfies V2ScreeningCheck
+
+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 V2ScreeningCheck
+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/V2ScreeningCheckEntry.md

@@ -0,0 +1,50 @@
+
+# V2ScreeningCheckEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`profileCheckId` | string
+`checkType` | string
+`displayName` | string
+`status` | string
+`config` | { [key: string]: any; }
+`input` | { [key: string]: any; }
+`output` | { [key: string]: any; }
+`candidateWizardUrl` | string
+
+## Example
+
+```typescript
+import type { V2ScreeningCheckEntry } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "profileCheckId": null,
+  "checkType": null,
+  "displayName": null,
+  "status": null,
+  "config": null,
+  "input": null,
+  "output": null,
+  "candidateWizardUrl": null,
+} satisfies V2ScreeningCheckEntry
+
+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 V2ScreeningCheckEntry
+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/V2ScreeningCheckListItem.md

@@ -0,0 +1,39 @@
+
+# V2ScreeningCheckListItem
+
+Minimal check entry shape for screening list items. No config/input/etc.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`checkType` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { V2ScreeningCheckListItem } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "checkType": null,
+  "status": null,
+} satisfies V2ScreeningCheckListItem
+
+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 V2ScreeningCheckListItem
+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/V2ScreeningCreate.md

@@ -0,0 +1,38 @@
+
+# V2ScreeningCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`profileId` | string
+`candidate` | [V2Candidate](V2Candidate.md)
+`checks` | [Array<V2ScreeningCheck>](V2ScreeningCheck.md)
+
+## Example
+
+```typescript
+import type { V2ScreeningCreate } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "profileId": null,
+  "candidate": null,
+  "checks": null,
+} satisfies V2ScreeningCreate
+
+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 V2ScreeningCreate
+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/V2ScreeningDetail.md

@@ -0,0 +1,50 @@
+
+# V2ScreeningDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`profile` | [V2ScreeningDetailProfile](V2ScreeningDetailProfile.md)
+`candidate` | [V2Candidate](V2Candidate.md)
+`checks` | [Array<V2ScreeningCheckEntry>](V2ScreeningCheckEntry.md)
+`candidateWizardUrl` | string
+`dashboardUrl` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { V2ScreeningDetail } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "profile": null,
+  "candidate": null,
+  "checks": null,
+  "candidateWizardUrl": null,
+  "dashboardUrl": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies V2ScreeningDetail
+
+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 V2ScreeningDetail
+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/V2ScreeningDetailProfile.md

@@ -0,0 +1,36 @@
+
+# V2ScreeningDetailProfile
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { V2ScreeningDetailProfile } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+} satisfies V2ScreeningDetailProfile
+
+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 V2ScreeningDetailProfile
+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/V2ScreeningListItem.md

@@ -0,0 +1,51 @@
+
+# V2ScreeningListItem
+
+List shape for GET /screenings/. Same candidate as detail; the only thing we slim here is per-check info (status only), since config/input/output are heavy and rarely needed at list time.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`profile` | [V2ScreeningDetailProfile](V2ScreeningDetailProfile.md)
+`candidate` | [V2Candidate](V2Candidate.md)
+`checks` | [Array<V2ScreeningCheckListItem>](V2ScreeningCheckListItem.md)
+`candidateWizardUrl` | string
+`dashboardUrl` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { V2ScreeningListItem } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "profile": null,
+  "candidate": null,
+  "checks": null,
+  "candidateWizardUrl": null,
+  "dashboardUrl": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies V2ScreeningListItem
+
+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 V2ScreeningListItem
+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/VerifyWebhook.md

@@ -0,0 +1,35 @@
+
+# VerifyWebhook
+
+Body shape for POST /webhooks/{id}/verify/. The verification code is the one sent to the webhook URL when the webhook was created; the receiver POSTs it back here to confirm ownership.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`verificationCode` | string
+
+## Example
+
+```typescript
+import type { VerifyWebhook } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "verificationCode": null,
+} satisfies VerifyWebhook
+
+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 VerifyWebhook
+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/Webhook.md

@@ -0,0 +1,43 @@
+
+# Webhook
+
+Serializer for webhook creation/update requests
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`url` | string
+`events` | Array<string>
+`active` | boolean
+`divisionId` | string
+
+## Example
+
+```typescript
+import type { Webhook } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "url": null,
+  "events": null,
+  "active": null,
+  "divisionId": null,
+} satisfies Webhook
+
+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 Webhook
+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/WebhookResponse.md

@@ -0,0 +1,53 @@
+
+# WebhookResponse
+
+Serializer for webhook responses
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`url` | string
+`events` | any
+`active` | boolean
+`verified` | boolean
+`token` | string
+`organisationName` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { WebhookResponse } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "url": null,
+  "events": null,
+  "active": null,
+  "verified": null,
+  "token": null,
+  "organisationName": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies WebhookResponse
+
+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 WebhookResponse
+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)
+
+