@pescheckit/pescheck-client 0.0.5

package/docs/JWTGeneration.md

@@ -0,0 +1,41 @@
+
+# JWTGeneration
+
+Serializer for JWT token generation for API users
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`password` | string
+`organisationId` | string
+`divisionId` | string
+
+## Example
+
+```typescript
+import type { JWTGeneration } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": null,
+  "password": null,
+  "organisationId": null,
+  "divisionId": null,
+} satisfies JWTGeneration
+
+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 JWTGeneration
+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/JWTResponse.md

@@ -0,0 +1,45 @@
+
+# JWTResponse
+
+Serializer for JWT token response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`refreshToken` | string
+`tokenType` | string
+`expiresIn` | number
+`organisation` | string
+`organisationId` | string
+
+## Example
+
+```typescript
+import type { JWTResponse } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": null,
+  "refreshToken": null,
+  "tokenType": null,
+  "expiresIn": null,
+  "organisation": null,
+  "organisationId": null,
+} satisfies JWTResponse
+
+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 JWTResponse
+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/OAuthApi.md

@@ -0,0 +1,222 @@
+# OAuthApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createOAuthApplication2**](OAuthApi.md#createoauthapplication2) | **POST** /api/v2/oauth/applications/ |  |
+| [**deleteOAuthApplication2**](OAuthApi.md#deleteoauthapplication2) | **DELETE** /api/v2/oauth/applications/{application_id}/ |  |
+| [**listOAuthApplications2**](OAuthApi.md#listoauthapplications2) | **GET** /api/v2/oauth/applications/list/ |  |
+
+
+
+## createOAuthApplication2
+
+> OAuthApplicationResponse createOAuthApplication2(oAuthApplication)
+
+
+
+Create OAuth application for API access
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OAuthApi,
+} from '@pescheckit/pescheck-client';
+import type { CreateOAuthApplication2Request } 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 OAuthApi(config);
+
+  const body = {
+    // OAuthApplication
+    oAuthApplication: ...,
+  } satisfies CreateOAuthApplication2Request;
+
+  try {
+    const data = await api.createOAuthApplication2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **oAuthApplication** | [OAuthApplication](OAuthApplication.md) |  | |
+
+### Return type
+
+[**OAuthApplicationResponse**](OAuthApplicationResponse.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** |  |  -  |
+| **400** | Bad Request |  -  |
+| **403** | Forbidden |  -  |
+| **429** | Rate limit exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteOAuthApplication2
+
+> deleteOAuthApplication2(applicationId)
+
+
+
+Delete an OAuth application
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OAuthApi,
+} from '@pescheckit/pescheck-client';
+import type { DeleteOAuthApplication2Request } 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 OAuthApi(config);
+
+  const body = {
+    // string | Application ID to delete
+    applicationId: applicationId_example,
+  } satisfies DeleteOAuthApplication2Request;
+
+  try {
+    const data = await api.deleteOAuthApplication2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **applicationId** | `string` | Application ID to delete | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Application deleted |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Application not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listOAuthApplications2
+
+> Array<OAuthApplicationResponse> listOAuthApplications2()
+
+
+
+List OAuth applications for the organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OAuthApi,
+} from '@pescheckit/pescheck-client';
+import type { ListOAuthApplications2Request } 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 OAuthApi(config);
+
+  try {
+    const data = await api.listOAuthApplications2();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<OAuthApplicationResponse>**](OAuthApplicationResponse.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** |  |  -  |
+| **403** | Forbidden |  -  |
+
+[[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/OAuthApplication.md

@@ -0,0 +1,43 @@
+
+# OAuthApplication
+
+Serializer for OAuth application creation requests
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`clientType` | string
+`authorizationGrantType` | string
+`redirectUris` | string
+`divisionId` | string
+
+## Example
+
+```typescript
+import type { OAuthApplication } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "clientType": null,
+  "authorizationGrantType": null,
+  "redirectUris": null,
+  "divisionId": null,
+} satisfies OAuthApplication
+
+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 OAuthApplication
+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/OAuthApplicationResponse.md

@@ -0,0 +1,49 @@
+
+# OAuthApplicationResponse
+
+Serializer for OAuth application responses
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`clientId` | string
+`clientSecret` | string
+`clientType` | string
+`authorizationGrantType` | string
+`created` | Date
+`updated` | Date
+
+## Example
+
+```typescript
+import type { OAuthApplicationResponse } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "clientId": null,
+  "clientSecret": null,
+  "clientType": null,
+  "authorizationGrantType": null,
+  "created": null,
+  "updated": null,
+} satisfies OAuthApplicationResponse
+
+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 OAuthApplicationResponse
+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/PaginatedDivisionReadOnlyList.md

@@ -0,0 +1,40 @@
+
+# PaginatedDivisionReadOnlyList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<DivisionReadOnly>](DivisionReadOnly.md)
+
+## Example
+
+```typescript
+import type { PaginatedDivisionReadOnlyList } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": null,
+} satisfies PaginatedDivisionReadOnlyList
+
+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 PaginatedDivisionReadOnlyList
+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/PaginatedV2ProfileListItemList.md

@@ -0,0 +1,40 @@
+
+# PaginatedV2ProfileListItemList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<V2ProfileListItem>](V2ProfileListItem.md)
+
+## Example
+
+```typescript
+import type { PaginatedV2ProfileListItemList } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": null,
+} satisfies PaginatedV2ProfileListItemList
+
+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 PaginatedV2ProfileListItemList
+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/PaginatedV2ScreeningListItemList.md

@@ -0,0 +1,40 @@
+
+# PaginatedV2ScreeningListItemList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<V2ScreeningListItem>](V2ScreeningListItem.md)
+
+## Example
+
+```typescript
+import type { PaginatedV2ScreeningListItemList } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": null,
+} satisfies PaginatedV2ScreeningListItemList
+
+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 PaginatedV2ScreeningListItemList
+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/PatchedDivisionWrite.md

@@ -0,0 +1,56 @@
+
+# PatchedDivisionWrite
+
+
+## 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 { PatchedDivisionWrite } 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 PatchedDivisionWrite
+
+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 PatchedDivisionWrite
+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/PatchedV2ProfilePartialUpdate.md

@@ -0,0 +1,37 @@
+
+# PatchedV2ProfilePartialUpdate
+
+PATCH body. Only name and description are editable. Sending `checks` is explicitly rejected - use PUT to replace the full check list.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { PatchedV2ProfilePartialUpdate } from '@pescheckit/pescheck-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+} satisfies PatchedV2ProfilePartialUpdate
+
+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 PatchedV2ProfilePartialUpdate
+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)
+
+