@pescheckit/pescheck-client 0.0.5

package/docs/ChecksApi.md

@@ -0,0 +1,150 @@
+# ChecksApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2ChecksList**](ChecksApi.md#v2checkslist) | **GET** /api/v2/checks/ |  |
+| [**v2ChecksRetrieve**](ChecksApi.md#v2checksretrieve) | **GET** /api/v2/checks/{check_type}/ |  |
+
+
+
+## v2ChecksList
+
+> Array<V2CheckInfo> v2ChecksList(checkType)
+
+
+
+List the check types this API supports. The list is bounded metadata about the available check types (not a paginated collection), so the response is a flat array.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChecksApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ChecksListRequest } 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 ChecksApi(config);
+
+  const body = {
+    // string | Restrict the list to a single check type. (optional)
+    checkType: checkType_example,
+  } satisfies V2ChecksListRequest;
+
+  try {
+    const data = await api.v2ChecksList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **checkType** | `string` | Restrict the list to a single check type. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<V2CheckInfo>**](V2CheckInfo.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)
+
+
+## v2ChecksRetrieve
+
+> V2CheckInfo v2ChecksRetrieve(checkType)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChecksApi,
+} from '@pescheckit/pescheck-client';
+import type { V2ChecksRetrieveRequest } 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 ChecksApi(config);
+
+  const body = {
+    // string
+    checkType: checkType_example,
+  } satisfies V2ChecksRetrieveRequest;
+
+  try {
+    const data = await api.v2ChecksRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **checkType** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**V2CheckInfo**](V2CheckInfo.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/CustomTokenObtainPair.md

@@ -0,0 +1,37 @@
+
+# CustomTokenObtainPair
+
+Custom JWT serializer that includes organization information in the token.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+
+## Example
+
+```typescript
+import type { CustomTokenObtainPair } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "password": null,
+} satisfies CustomTokenObtainPair
+
+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 CustomTokenObtainPair
+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/DivisionReadOnly.md

@@ -0,0 +1,62 @@
+
+# DivisionReadOnly
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`parent` | string
+`createdAt` | Date
+`updatedAt` | Date
+`city` | string
+`address` | string
+`postal` | string
+`phone` | string
+`contactName` | string
+`contactEmail` | string
+`invoiceEmail` | string
+`useParentOnEmail` | boolean
+`useParentOnBilling` | boolean
+`useParentOnReport` | boolean
+
+## Example
+
+```typescript
+import type { DivisionReadOnly } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "parent": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "city": null,
+  "address": null,
+  "postal": null,
+  "phone": null,
+  "contactName": null,
+  "contactEmail": null,
+  "invoiceEmail": null,
+  "useParentOnEmail": null,
+  "useParentOnBilling": null,
+  "useParentOnReport": null,
+} satisfies DivisionReadOnly
+
+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 DivisionReadOnly
+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/DivisionWrite.md

@@ -0,0 +1,56 @@
+
+# DivisionWrite
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`city` | string
+`address` | string
+`postal` | string
+`phone` | string
+`contactName` | string
+`contactEmail` | string
+`invoiceEmail` | string
+`useParentOnEmail` | boolean
+`useParentOnBilling` | boolean
+`useParentOnReport` | boolean
+
+## Example
+
+```typescript
+import type { DivisionWrite } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "city": null,
+  "address": null,
+  "postal": null,
+  "phone": null,
+  "contactName": null,
+  "contactEmail": null,
+  "invoiceEmail": null,
+  "useParentOnEmail": null,
+  "useParentOnBilling": null,
+  "useParentOnReport": null,
+} satisfies DivisionWrite
+
+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 DivisionWrite
+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/DivisionsApi.md

@@ -0,0 +1,380 @@
+# DivisionsApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**v2OrganisationsDivisionsCreate**](DivisionsApi.md#v2organisationsdivisionscreate) | **POST** /api/v2/organisations/divisions/ |  |
+| [**v2OrganisationsDivisionsList**](DivisionsApi.md#v2organisationsdivisionslist) | **GET** /api/v2/organisations/divisions/ |  |
+| [**v2OrganisationsDivisionsPartialUpdate**](DivisionsApi.md#v2organisationsdivisionspartialupdate) | **PATCH** /api/v2/organisations/divisions/{id}/ |  |
+| [**v2OrganisationsDivisionsRetrieve**](DivisionsApi.md#v2organisationsdivisionsretrieve) | **GET** /api/v2/organisations/divisions/{id}/ |  |
+| [**v2OrganisationsDivisionsUpdate**](DivisionsApi.md#v2organisationsdivisionsupdate) | **PUT** /api/v2/organisations/divisions/{id}/ |  |
+
+
+
+## v2OrganisationsDivisionsCreate
+
+> DivisionWrite v2OrganisationsDivisionsCreate(divisionWrite)
+
+
+
+Create a division (a child organisation under the current parent org). Divisions are an advanced, rarely-needed feature: create one ONLY when the user has clearly stated they want to manage a separate business unit, location, or legal entity under their account. Do NOT create a division just to organise screenings, for a single-person or single-member organisation, or without an explicit request to do so. When in doubt, ask the user to confirm before calling this tool.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DivisionsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2OrganisationsDivisionsCreateRequest } 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 DivisionsApi(config);
+
+  const body = {
+    // DivisionWrite
+    divisionWrite: ...,
+  } satisfies V2OrganisationsDivisionsCreateRequest;
+
+  try {
+    const data = await api.v2OrganisationsDivisionsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **divisionWrite** | [DivisionWrite](DivisionWrite.md) |  | |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.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)
+
+
+## v2OrganisationsDivisionsList
+
+> PaginatedDivisionReadOnlyList v2OrganisationsDivisionsList(page, pageSize, paginate)
+
+
+
+List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DivisionsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2OrganisationsDivisionsListRequest } 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 DivisionsApi(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 V2OrganisationsDivisionsListRequest;
+
+  try {
+    const data = await api.v2OrganisationsDivisionsList(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
+
+[**PaginatedDivisionReadOnlyList**](PaginatedDivisionReadOnlyList.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)
+
+
+## v2OrganisationsDivisionsPartialUpdate
+
+> DivisionWrite v2OrganisationsDivisionsPartialUpdate(id, patchedDivisionWrite)
+
+
+
+A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DivisionsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2OrganisationsDivisionsPartialUpdateRequest } 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 DivisionsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this organisation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PatchedDivisionWrite (optional)
+    patchedDivisionWrite: ...,
+  } satisfies V2OrganisationsDivisionsPartialUpdateRequest;
+
+  try {
+    const data = await api.v2OrganisationsDivisionsPartialUpdate(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 organisation. | [Defaults to `undefined`] |
+| **patchedDivisionWrite** | [PatchedDivisionWrite](PatchedDivisionWrite.md) |  | [Optional] |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.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 |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## v2OrganisationsDivisionsRetrieve
+
+> DivisionReadOnly v2OrganisationsDivisionsRetrieve(id)
+
+
+
+A division is a child organisation under a parent org, used only when a customer needs to manage genuinely separate business units, locations, or legal entities under one account. The vast majority of organisations operate as a single entity and need no divisions. Only top-level (parent) organisations can have divisions.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DivisionsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2OrganisationsDivisionsRetrieveRequest } 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 DivisionsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this organisation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies V2OrganisationsDivisionsRetrieveRequest;
+
+  try {
+    const data = await api.v2OrganisationsDivisionsRetrieve(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 organisation. | [Defaults to `undefined`] |
+
+### Return type
+
+[**DivisionReadOnly**](DivisionReadOnly.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)
+
+
+## v2OrganisationsDivisionsUpdate
+
+> DivisionWrite v2OrganisationsDivisionsUpdate(id, divisionWrite)
+
+
+
+Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DivisionsApi,
+} from '@pescheckit/pescheck-client';
+import type { V2OrganisationsDivisionsUpdateRequest } 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 DivisionsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this organisation.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // DivisionWrite
+    divisionWrite: ...,
+  } satisfies V2OrganisationsDivisionsUpdateRequest;
+
+  try {
+    const data = await api.v2OrganisationsDivisionsUpdate(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 organisation. | [Defaults to `undefined`] |
+| **divisionWrite** | [DivisionWrite](DivisionWrite.md) |  | |
+
+### Return type
+
+[**DivisionWrite**](DivisionWrite.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 |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+