@pescheckit/pescheck-client 0.0.5

package/dist/esm/apis/ChecksApi.js

@@ -0,0 +1,112 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { V2CheckInfoFromJSON, } from '../models/V2CheckInfo';
+/**
+ *
+ */
+export class ChecksApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for v2ChecksList without sending the request
+     */
+    v2ChecksListRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['checkType'] != null) {
+                queryParameters['check_type'] = requestParameters['checkType'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/checks/`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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.
+     */
+    v2ChecksListRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ChecksListRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(V2CheckInfoFromJSON));
+        });
+    }
+    /**
+     * 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.
+     */
+    v2ChecksList() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.v2ChecksListRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2ChecksRetrieve without sending the request
+     */
+    v2ChecksRetrieveRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['checkType'] == null) {
+                throw new runtime.RequiredError('checkType', 'Required parameter "checkType" was null or undefined when calling v2ChecksRetrieve().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/checks/{check_type}/`;
+            urlPath = urlPath.replace('{check_type}', encodeURIComponent(String(requestParameters['checkType'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    v2ChecksRetrieveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ChecksRetrieveRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => V2CheckInfoFromJSON(jsonValue));
+        });
+    }
+    /**
+     */
+    v2ChecksRetrieve(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2ChecksRetrieveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/DivisionsApi.d.ts

@@ -0,0 +1,211 @@
+/**
+ * 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 DivisionReadOnly } from '../models/DivisionReadOnly';
+import { type DivisionWrite } from '../models/DivisionWrite';
+import { type PaginatedDivisionReadOnlyList } from '../models/PaginatedDivisionReadOnlyList';
+import { type PatchedDivisionWrite } from '../models/PatchedDivisionWrite';
+export interface V2OrganisationsDivisionsCreateRequest {
+    divisionWrite: Omit<DivisionWrite, 'id'>;
+}
+export interface V2OrganisationsDivisionsListRequest {
+    page?: number;
+    pageSize?: number;
+    paginate?: boolean;
+}
+export interface V2OrganisationsDivisionsPartialUpdateRequest {
+    id: string;
+    patchedDivisionWrite?: Omit<PatchedDivisionWrite, 'id'>;
+}
+export interface V2OrganisationsDivisionsRetrieveRequest {
+    id: string;
+}
+export interface V2OrganisationsDivisionsUpdateRequest {
+    id: string;
+    divisionWrite: Omit<DivisionWrite, 'id'>;
+}
+/**
+ * DivisionsApi - interface
+ *
+ * @export
+ * @interface DivisionsApiInterface
+ */
+export interface DivisionsApiInterface {
+    /**
+     * Creates request options for v2OrganisationsDivisionsCreate without sending the request
+     * @param {DivisionWrite} divisionWrite
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsCreateRequestOpts(requestParameters: V2OrganisationsDivisionsCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @param {DivisionWrite} divisionWrite
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsCreateRaw(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<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.
+     */
+    v2OrganisationsDivisionsCreate(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsList without sending the request
+     * @param {number} [page] A page number within the paginated result set.
+     * @param {number} [pageSize] Number of results to return per page.
+     * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsListRequestOpts(requestParameters: V2OrganisationsDivisionsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     * @param {number} [page] A page number within the paginated result set.
+     * @param {number} [pageSize] Number of results to return per page.
+     * @param {boolean} [paginate] Enable/disable pagination. When false, max 500 records returned.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsListRaw(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDivisionReadOnlyList>>;
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     */
+    v2OrganisationsDivisionsList(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDivisionReadOnlyList>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
+     * @param {string} id A UUID string identifying this organisation.
+     * @param {PatchedDivisionWrite} [patchedDivisionWrite]
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @param {string} id A UUID string identifying this organisation.
+     * @param {PatchedDivisionWrite} [patchedDivisionWrite]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsPartialUpdateRaw(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsPartialUpdate(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
+     * @param {string} id A UUID string identifying this organisation.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters: V2OrganisationsDivisionsRetrieveRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @param {string} id A UUID string identifying this organisation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsRetrieveRaw(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionReadOnly>>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsRetrieve(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionReadOnly>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
+     * @param {string} id A UUID string identifying this organisation.
+     * @param {DivisionWrite} divisionWrite
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     * @param {string} id A UUID string identifying this organisation.
+     * @param {DivisionWrite} divisionWrite
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DivisionsApiInterface
+     */
+    v2OrganisationsDivisionsUpdateRaw(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     */
+    v2OrganisationsDivisionsUpdate(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+}
+/**
+ *
+ */
+export declare class DivisionsApi extends runtime.BaseAPI implements DivisionsApiInterface {
+    /**
+     * Creates request options for v2OrganisationsDivisionsCreate without sending the request
+     */
+    v2OrganisationsDivisionsCreateRequestOpts(requestParameters: V2OrganisationsDivisionsCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsCreateRaw(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<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.
+     */
+    v2OrganisationsDivisionsCreate(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsList without sending the request
+     */
+    v2OrganisationsDivisionsListRequestOpts(requestParameters: V2OrganisationsDivisionsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     */
+    v2OrganisationsDivisionsListRaw(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDivisionReadOnlyList>>;
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     */
+    v2OrganisationsDivisionsList(requestParameters?: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDivisionReadOnlyList>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
+     */
+    v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsPartialUpdateRaw(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsPartialUpdate(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
+     */
+    v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters: V2OrganisationsDivisionsRetrieveRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsRetrieveRaw(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionReadOnly>>;
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsRetrieve(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionReadOnly>;
+    /**
+     * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
+     */
+    v2OrganisationsDivisionsUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     */
+    v2OrganisationsDivisionsUpdateRaw(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>>;
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     */
+    v2OrganisationsDivisionsUpdate(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite>;
+}

package/dist/esm/apis/DivisionsApi.js

@@ -0,0 +1,260 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { DivisionReadOnlyFromJSON, } from '../models/DivisionReadOnly';
+import { DivisionWriteFromJSON, DivisionWriteToJSON, } from '../models/DivisionWrite';
+import { PaginatedDivisionReadOnlyListFromJSON, } from '../models/PaginatedDivisionReadOnlyList';
+import { PatchedDivisionWriteToJSON, } from '../models/PatchedDivisionWrite';
+/**
+ *
+ */
+export class DivisionsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for v2OrganisationsDivisionsCreate without sending the request
+     */
+    v2OrganisationsDivisionsCreateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['divisionWrite'] == null) {
+                throw new runtime.RequiredError('divisionWrite', 'Required parameter "divisionWrite" was null or undefined when calling v2OrganisationsDivisionsCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/organisations/divisions/`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DivisionWriteToJSON(requestParameters['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.
+     */
+    v2OrganisationsDivisionsCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2OrganisationsDivisionsCreateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DivisionWriteFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2OrganisationsDivisionsCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2OrganisationsDivisionsList without sending the request
+     */
+    v2OrganisationsDivisionsListRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['page_size'] = requestParameters['pageSize'];
+            }
+            if (requestParameters['paginate'] != null) {
+                queryParameters['paginate'] = requestParameters['paginate'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/organisations/divisions/`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     */
+    v2OrganisationsDivisionsListRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2OrganisationsDivisionsListRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedDivisionReadOnlyListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List method that handles both paginated and unpaginated responses and enforces the max_total_records limit (500).
+     */
+    v2OrganisationsDivisionsList() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.v2OrganisationsDivisionsListRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
+     */
+    v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2OrganisationsDivisionsPartialUpdate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/organisations/divisions/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PatchedDivisionWriteToJSON(requestParameters['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.
+     */
+    v2OrganisationsDivisionsPartialUpdateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DivisionWriteFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsPartialUpdate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2OrganisationsDivisionsPartialUpdateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
+     */
+    v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2OrganisationsDivisionsRetrieve().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/organisations/divisions/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsRetrieveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DivisionReadOnlyFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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.
+     */
+    v2OrganisationsDivisionsRetrieve(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2OrganisationsDivisionsRetrieveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
+     */
+    v2OrganisationsDivisionsUpdateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling v2OrganisationsDivisionsUpdate().');
+            }
+            if (requestParameters['divisionWrite'] == null) {
+                throw new runtime.RequiredError('divisionWrite', 'Required parameter "divisionWrite" was null or undefined when calling v2OrganisationsDivisionsUpdate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                // oauth required
+                headerParameters["Authorization"] = `Bearer ${yield this.configuration.accessToken("oauth2", ["read:api", "create:api", "update:api"])}`;
+            }
+            let urlPath = `/api/v2/organisations/divisions/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DivisionWriteToJSON(requestParameters['divisionWrite']),
+            };
+        });
+    }
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     */
+    v2OrganisationsDivisionsUpdateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2OrganisationsDivisionsUpdateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DivisionWriteFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update an existing division\'s contact, billing, and address details.  Override also triggers a webhook on successful PUT and PATCH requests.
+     */
+    v2OrganisationsDivisionsUpdate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2OrganisationsDivisionsUpdateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}