@pescheckit/pescheck-client 0.0.5

package/docs/WebhooksApi.md

@@ -0,0 +1,305 @@
+# WebhooksApi
+
+All URIs are relative to *https://api.pescheck.io*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createWebhook2**](WebhooksApi.md#createwebhook2) | **POST** /api/v2/webhooks/ |  |
+| [**deleteWebhook2**](WebhooksApi.md#deletewebhook2) | **DELETE** /api/v2/webhooks/{webhook_id}/ |  |
+| [**listWebhooks2**](WebhooksApi.md#listwebhooks2) | **GET** /api/v2/webhooks/list/ |  |
+| [**verifyWebhook2**](WebhooksApi.md#verifywebhook2) | **POST** /api/v2/webhooks/{webhook_id}/verify/ |  |
+
+
+
+## createWebhook2
+
+> WebhookResponse createWebhook2(webhook, xOrganizationId, organizationId)
+
+
+
+Create webhook for event notifications.          **Authentication Notes:**         - OAuth2: Organization is automatically determined from the OAuth application         - If your OAuth app has no organization set, pass it via `X-Organization-Id` header or `organization_id` query parameter          **Valid Events:**         - `check.started` - Check has been initiated         - `check.completed` - Check has been completed successfully         - `check.failed` - Check has failed         - `screening.created` - New screening has been created         - `screening.completed` - Screening has been completed         - `screening.archived` - Screening has been archived         - `package.created` - New package has been created         - `package.updated` - Package has been updated         - `division.created` - New division has been created         - `division.updated` - Division has been updated          Limited to 5 webhooks per organization/division.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@pescheckit/pescheck-client';
+import type { CreateWebhook2Request } 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 WebhooksApi(config);
+
+  const body = {
+    // Webhook
+    webhook: {"name":"My Event Webhook","url":"https://webhook.site/4a33d2f6-48a8-4b49-b6c4-a7bb044c8cb3","events":["check.completed","screening.created","screening.completed"],"active":true,"division_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},
+    // string | Organization ID (for JWT/Session auth only) (optional)
+    xOrganizationId: xOrganizationId_example,
+    // string | Organization ID (for JWT/Session auth only) (optional)
+    organizationId: organizationId_example,
+  } satisfies CreateWebhook2Request;
+
+  try {
+    const data = await api.createWebhook2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **webhook** | [Webhook](Webhook.md) |  | |
+| **xOrganizationId** | `string` | Organization ID (for JWT/Session auth only) | [Optional] [Defaults to `undefined`] |
+| **organizationId** | `string` | Organization ID (for JWT/Session auth only) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.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 - Organization not found or no permission |  -  |
+| **409** | Conflict - Max webhooks reached |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteWebhook2
+
+> deleteWebhook2(webhookId)
+
+
+
+Delete a webhook
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@pescheckit/pescheck-client';
+import type { DeleteWebhook2Request } 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 WebhooksApi(config);
+
+  const body = {
+    // string | Webhook ID to delete
+    webhookId: webhookId_example,
+  } satisfies DeleteWebhook2Request;
+
+  try {
+    const data = await api.deleteWebhook2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | `string` | Webhook 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** | Webhook deleted |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Webhook 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)
+
+
+## listWebhooks2
+
+> Array<WebhookResponse> listWebhooks2()
+
+
+
+List webhooks for the organization
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@pescheckit/pescheck-client';
+import type { ListWebhooks2Request } 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 WebhooksApi(config);
+
+  try {
+    const data = await api.listWebhooks2();
+    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<WebhookResponse>**](WebhookResponse.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)
+
+
+## verifyWebhook2
+
+> verifyWebhook2(webhookId, verifyWebhook)
+
+
+
+Verify webhook ownership
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhooksApi,
+} from '@pescheckit/pescheck-client';
+import type { VerifyWebhook2Request } 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 WebhooksApi(config);
+
+  const body = {
+    // string | Webhook ID
+    webhookId: webhookId_example,
+    // VerifyWebhook
+    verifyWebhook: ...,
+  } satisfies VerifyWebhook2Request;
+
+  try {
+    const data = await api.verifyWebhook2(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **webhookId** | `string` | Webhook ID | [Defaults to `undefined`] |
+| **verifyWebhook** | [VerifyWebhook](VerifyWebhook.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `multipart/form-data`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Webhook verified |  -  |
+| **400** | Invalid verification code |  -  |
+| **404** | Webhook 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)
+

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@pescheckit/pescheck-client",
+  "version": "0.0.5",
+  "description": "OpenAPI client for @pescheckit/pescheck-client",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pescheckit/pescheck-clients.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  },
+  "homepage": "https://pescheck.io",
+  "bugs": {
+    "url": "https://github.com/pescheckit/pescheck-clients/issues"
+  }
+}

package/src/apis/AuthenticationApi.ts

@@ -0,0 +1,285 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pescheck API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type CustomTokenObtainPair,
+    CustomTokenObtainPairFromJSON,
+    CustomTokenObtainPairToJSON,
+} from '../models/CustomTokenObtainPair';
+import {
+    type JWTGeneration,
+    JWTGenerationFromJSON,
+    JWTGenerationToJSON,
+} from '../models/JWTGeneration';
+import {
+    type JWTResponse,
+    JWTResponseFromJSON,
+    JWTResponseToJSON,
+} from '../models/JWTResponse';
+import {
+    type TokenRefresh,
+    TokenRefreshFromJSON,
+    TokenRefreshToJSON,
+} from '../models/TokenRefresh';
+
+export interface GenerateJWTToken2Request {
+    jWTGeneration: JWTGeneration;
+}
+
+export interface JwtCreateRequest {
+    customTokenObtainPair: CustomTokenObtainPair;
+}
+
+export interface JwtRefreshCreateRequest {
+    tokenRefresh: Omit<TokenRefresh, 'access'>;
+}
+
+/**
+ * AuthenticationApi - interface
+ * 
+ * @export
+ * @interface AuthenticationApiInterface
+ */
+export interface AuthenticationApiInterface {
+    /**
+     * Creates request options for generateJWTToken2 without sending the request
+     * @param {JWTGeneration} jWTGeneration 
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    generateJWTToken2RequestOpts(requestParameters: GenerateJWTToken2Request): Promise<runtime.RequestOpts>;
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org).  For a plain login, use POST /api/jwt/.
+     * @param {JWTGeneration} jWTGeneration 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    generateJWTToken2Raw(requestParameters: GenerateJWTToken2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JWTResponse>>;
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org).  For a plain login, use POST /api/jwt/.
+     */
+    generateJWTToken2(requestParameters: GenerateJWTToken2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JWTResponse>;
+
+    /**
+     * Creates request options for jwtCreate without sending the request
+     * @param {CustomTokenObtainPair} customTokenObtainPair 
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    jwtCreateRequestOpts(requestParameters: JwtCreateRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available).  For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
+     * @param {CustomTokenObtainPair} customTokenObtainPair 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    jwtCreateRaw(requestParameters: JwtCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomTokenObtainPair>>;
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available).  For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
+     */
+    jwtCreate(requestParameters: JwtCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomTokenObtainPair>;
+
+    /**
+     * Creates request options for jwtRefreshCreate without sending the request
+     * @param {TokenRefresh} tokenRefresh 
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    jwtRefreshCreateRequestOpts(requestParameters: JwtRefreshCreateRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+     * @param {TokenRefresh} tokenRefresh 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    jwtRefreshCreateRaw(requestParameters: JwtRefreshCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRefresh>>;
+
+    /**
+     * Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+     */
+    jwtRefreshCreate(requestParameters: JwtRefreshCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRefresh>;
+
+}
+
+/**
+ * 
+ */
+export class AuthenticationApi extends runtime.BaseAPI implements AuthenticationApiInterface {
+
+    /**
+     * Creates request options for generateJWTToken2 without sending the request
+     */
+    async generateJWTToken2RequestOpts(requestParameters: GenerateJWTToken2Request): Promise<runtime.RequestOpts> {
+        if (requestParameters['jWTGeneration'] == null) {
+            throw new runtime.RequiredError(
+                'jWTGeneration',
+                'Required parameter "jWTGeneration" was null or undefined when calling generateJWTToken2().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+        }
+
+
+        let urlPath = `/api/v2/jwt/generate/`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: JWTGenerationToJSON(requestParameters['jWTGeneration']),
+        };
+    }
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org).  For a plain login, use POST /api/jwt/.
+     */
+    async generateJWTToken2Raw(requestParameters: GenerateJWTToken2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<JWTResponse>> {
+        const requestOptions = await this.generateJWTToken2RequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => JWTResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to the organization or division specified by organisation_id/division_id (defaults to your current org).  For a plain login, use POST /api/jwt/.
+     */
+    async generateJWTToken2(requestParameters: GenerateJWTToken2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<JWTResponse> {
+        const response = await this.generateJWTToken2Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for jwtCreate without sending the request
+     */
+    async jwtCreateRequestOpts(requestParameters: JwtCreateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['customTokenObtainPair'] == null) {
+            throw new runtime.RequiredError(
+                'customTokenObtainPair',
+                'Required parameter "customTokenObtainPair" was null or undefined when calling jwtCreate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+        }
+
+
+        let urlPath = `/api/jwt/`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CustomTokenObtainPairToJSON(requestParameters['customTokenObtainPair']),
+        };
+    }
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available).  For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
+     */
+    async jwtCreateRaw(requestParameters: JwtCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomTokenObtainPair>> {
+        const requestOptions = await this.jwtCreateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CustomTokenObtainPairFromJSON(jsonValue));
+    }
+
+    /**
+     * Log in with email + password. Returns a JWT pair scoped to your current organization (last viewed, or first available).  For a token scoped to a specific org or division, use POST /api/v2/jwt/generate/.
+     */
+    async jwtCreate(requestParameters: JwtCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomTokenObtainPair> {
+        const response = await this.jwtCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for jwtRefreshCreate without sending the request
+     */
+    async jwtRefreshCreateRequestOpts(requestParameters: JwtRefreshCreateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tokenRefresh'] == null) {
+            throw new runtime.RequiredError(
+                'tokenRefresh',
+                'Required parameter "tokenRefresh" was null or undefined when calling jwtRefreshCreate().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = `Bearer ${await this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+        }
+
+
+        let urlPath = `/api/jwt/refresh/`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TokenRefreshToJSON(requestParameters['tokenRefresh']),
+        };
+    }
+
+    /**
+     * Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+     */
+    async jwtRefreshCreateRaw(requestParameters: JwtRefreshCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TokenRefresh>> {
+        const requestOptions = await this.jwtRefreshCreateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TokenRefreshFromJSON(jsonValue));
+    }
+
+    /**
+     * Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
+     */
+    async jwtRefreshCreate(requestParameters: JwtRefreshCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TokenRefresh> {
+        const response = await this.jwtRefreshCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}