@pescheckit/pescheck-client 0.0.5

package/src/apis/ChecksApi.ts

@@ -0,0 +1,181 @@
+/* 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 V2CheckInfo,
+    V2CheckInfoFromJSON,
+    V2CheckInfoToJSON,
+} from '../models/V2CheckInfo';
+
+export interface V2ChecksListRequest {
+    checkType?: string;
+}
+
+export interface V2ChecksRetrieveRequest {
+    checkType: string;
+}
+
+/**
+ * ChecksApi - interface
+ * 
+ * @export
+ * @interface ChecksApiInterface
+ */
+export interface ChecksApiInterface {
+    /**
+     * Creates request options for v2ChecksList without sending the request
+     * @param {string} [checkType] Restrict the list to a single check type.
+     * @throws {RequiredError}
+     * @memberof ChecksApiInterface
+     */
+    v2ChecksListRequestOpts(requestParameters: V2ChecksListRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 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.
+     * @param {string} [checkType] Restrict the list to a single check type.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChecksApiInterface
+     */
+    v2ChecksListRaw(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2CheckInfo>>>;
+
+    /**
+     * 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(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2CheckInfo>>;
+
+    /**
+     * Creates request options for v2ChecksRetrieve without sending the request
+     * @param {string} checkType 
+     * @throws {RequiredError}
+     * @memberof ChecksApiInterface
+     */
+    v2ChecksRetrieveRequestOpts(requestParameters: V2ChecksRetrieveRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @param {string} checkType 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChecksApiInterface
+     */
+    v2ChecksRetrieveRaw(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2CheckInfo>>;
+
+    /**
+     */
+    v2ChecksRetrieve(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2CheckInfo>;
+
+}
+
+/**
+ * 
+ */
+export class ChecksApi extends runtime.BaseAPI implements ChecksApiInterface {
+
+    /**
+     * Creates request options for v2ChecksList without sending the request
+     */
+    async v2ChecksListRequestOpts(requestParameters: V2ChecksListRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['checkType'] != null) {
+            queryParameters['check_type'] = requestParameters['checkType'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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/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.
+     */
+    async v2ChecksListRaw(requestParameters: V2ChecksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2CheckInfo>>> {
+        const requestOptions = await this.v2ChecksListRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async v2ChecksList(requestParameters: V2ChecksListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2CheckInfo>> {
+        const response = await this.v2ChecksListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2ChecksRetrieve without sending the request
+     */
+    async v2ChecksRetrieveRequestOpts(requestParameters: V2ChecksRetrieveRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['checkType'] == null) {
+            throw new runtime.RequiredError(
+                'checkType',
+                'Required parameter "checkType" was null or undefined when calling v2ChecksRetrieve().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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/checks/{check_type}/`;
+        urlPath = urlPath.replace('{check_type}', encodeURIComponent(String(requestParameters['checkType'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     */
+    async v2ChecksRetrieveRaw(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2CheckInfo>> {
+        const requestOptions = await this.v2ChecksRetrieveRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V2CheckInfoFromJSON(jsonValue));
+    }
+
+    /**
+     */
+    async v2ChecksRetrieve(requestParameters: V2ChecksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2CheckInfo> {
+        const response = await this.v2ChecksRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/DivisionsApi.ts

@@ -0,0 +1,462 @@
+/* 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 DivisionReadOnly,
+    DivisionReadOnlyFromJSON,
+    DivisionReadOnlyToJSON,
+} from '../models/DivisionReadOnly';
+import {
+    type DivisionWrite,
+    DivisionWriteFromJSON,
+    DivisionWriteToJSON,
+} from '../models/DivisionWrite';
+import {
+    type PaginatedDivisionReadOnlyList,
+    PaginatedDivisionReadOnlyListFromJSON,
+    PaginatedDivisionReadOnlyListToJSON,
+} from '../models/PaginatedDivisionReadOnlyList';
+import {
+    type PatchedDivisionWrite,
+    PatchedDivisionWriteFromJSON,
+    PatchedDivisionWriteToJSON,
+} 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 class DivisionsApi extends runtime.BaseAPI implements DivisionsApiInterface {
+
+    /**
+     * Creates request options for v2OrganisationsDivisionsCreate without sending the request
+     */
+    async v2OrganisationsDivisionsCreateRequestOpts(requestParameters: V2OrganisationsDivisionsCreateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['divisionWrite'] == null) {
+            throw new runtime.RequiredError(
+                'divisionWrite',
+                'Required parameter "divisionWrite" was null or undefined when calling v2OrganisationsDivisionsCreate().'
+            );
+        }
+
+        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/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.
+     */
+    async v2OrganisationsDivisionsCreateRaw(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>> {
+        const requestOptions = await this.v2OrganisationsDivisionsCreateRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async v2OrganisationsDivisionsCreate(requestParameters: V2OrganisationsDivisionsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite> {
+        const response = await this.v2OrganisationsDivisionsCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2OrganisationsDivisionsList without sending the request
+     */
+    async v2OrganisationsDivisionsListRequestOpts(requestParameters: V2OrganisationsDivisionsListRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        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: runtime.HTTPHeaders = {};
+
+        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/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).
+     */
+    async v2OrganisationsDivisionsListRaw(requestParameters: V2OrganisationsDivisionsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDivisionReadOnlyList>> {
+        const requestOptions = await this.v2OrganisationsDivisionsListRequestOpts(requestParameters);
+        const response = await 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).
+     */
+    async v2OrganisationsDivisionsList(requestParameters: V2OrganisationsDivisionsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDivisionReadOnlyList> {
+        const response = await this.v2OrganisationsDivisionsListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2OrganisationsDivisionsPartialUpdate without sending the request
+     */
+    async v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling v2OrganisationsDivisionsPartialUpdate().'
+            );
+        }
+
+        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/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.
+     */
+    async v2OrganisationsDivisionsPartialUpdateRaw(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>> {
+        const requestOptions = await this.v2OrganisationsDivisionsPartialUpdateRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async v2OrganisationsDivisionsPartialUpdate(requestParameters: V2OrganisationsDivisionsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite> {
+        const response = await this.v2OrganisationsDivisionsPartialUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2OrganisationsDivisionsRetrieve without sending the request
+     */
+    async v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters: V2OrganisationsDivisionsRetrieveRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling v2OrganisationsDivisionsRetrieve().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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/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.
+     */
+    async v2OrganisationsDivisionsRetrieveRaw(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionReadOnly>> {
+        const requestOptions = await this.v2OrganisationsDivisionsRetrieveRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async v2OrganisationsDivisionsRetrieve(requestParameters: V2OrganisationsDivisionsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionReadOnly> {
+        const response = await this.v2OrganisationsDivisionsRetrieveRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for v2OrganisationsDivisionsUpdate without sending the request
+     */
+    async v2OrganisationsDivisionsUpdateRequestOpts(requestParameters: V2OrganisationsDivisionsUpdateRequest): Promise<runtime.RequestOpts> {
+        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: 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/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.
+     */
+    async v2OrganisationsDivisionsUpdateRaw(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DivisionWrite>> {
+        const requestOptions = await this.v2OrganisationsDivisionsUpdateRequestOpts(requestParameters);
+        const response = await 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.
+     */
+    async v2OrganisationsDivisionsUpdate(requestParameters: V2OrganisationsDivisionsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DivisionWrite> {
+        const response = await this.v2OrganisationsDivisionsUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}