@pescheckit/pescheck-client 0.0.5

package/dist/esm/apis/ProfilesApi.js

@@ -0,0 +1,330 @@
+/* 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 { PaginatedV2ProfileListItemListFromJSON, } from '../models/PaginatedV2ProfileListItemList';
+import { PatchedV2ProfilePartialUpdateToJSON, } from '../models/PatchedV2ProfilePartialUpdate';
+import { V2ProfileCreateToJSON, } from '../models/V2ProfileCreate';
+import { V2ProfileDetailFromJSON, } from '../models/V2ProfileDetail';
+import { V2ProfileUpdateToJSON, } from '../models/V2ProfileUpdate';
+/**
+ *
+ */
+export class ProfilesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for v2ProfilesCreate without sending the request
+     */
+    v2ProfilesCreateRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['v2ProfileCreate'] == null) {
+                throw new runtime.RequiredError('v2ProfileCreate', 'Required parameter "v2ProfileCreate" was null or undefined when calling v2ProfilesCreate().');
+            }
+            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/profiles/`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: V2ProfileCreateToJSON(requestParameters['v2ProfileCreate']),
+            };
+        });
+    }
+    /**
+     */
+    v2ProfilesCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesCreateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     */
+    v2ProfilesCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2ProfilesCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2ProfilesDestroy without sending the request
+     */
+    v2ProfilesDestroyRequestOpts(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 v2ProfilesDestroy().');
+            }
+            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/profiles/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    v2ProfilesDestroyRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesDestroyRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     */
+    v2ProfilesDestroy(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.v2ProfilesDestroyRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for v2ProfilesList without sending the request
+     */
+    v2ProfilesListRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['checkType'] != null) {
+                queryParameters['check_type'] = requestParameters['checkType'];
+            }
+            if (requestParameters['isCustom'] != null) {
+                queryParameters['is_custom'] = requestParameters['isCustom'];
+            }
+            if (requestParameters['name'] != null) {
+                queryParameters['name'] = requestParameters['name'];
+            }
+            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'];
+            }
+            if (requestParameters['sort'] != null) {
+                queryParameters['sort'] = requestParameters['sort'];
+            }
+            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/profiles/`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    v2ProfilesListRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesListRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedV2ProfileListItemListFromJSON(jsonValue));
+        });
+    }
+    /**
+     */
+    v2ProfilesList() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.v2ProfilesListRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2ProfilesPartialUpdate without sending the request
+     */
+    v2ProfilesPartialUpdateRequestOpts(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 v2ProfilesPartialUpdate().');
+            }
+            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/profiles/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PatchedV2ProfilePartialUpdateToJSON(requestParameters['patchedV2ProfilePartialUpdate']),
+            };
+        });
+    }
+    /**
+     * Update name and/or description only. Use PUT to change the check list.
+     */
+    v2ProfilesPartialUpdateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesPartialUpdateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update name and/or description only. Use PUT to change the check list.
+     */
+    v2ProfilesPartialUpdate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2ProfilesPartialUpdateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2ProfilesRetrieve without sending the request
+     */
+    v2ProfilesRetrieveRequestOpts(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 v2ProfilesRetrieve().');
+            }
+            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/profiles/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     */
+    v2ProfilesRetrieveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesRetrieveRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     */
+    v2ProfilesRetrieve(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2ProfilesRetrieveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for v2ProfilesUpdate without sending the request
+     */
+    v2ProfilesUpdateRequestOpts(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 v2ProfilesUpdate().');
+            }
+            if (requestParameters['v2ProfileUpdate'] == null) {
+                throw new runtime.RequiredError('v2ProfileUpdate', 'Required parameter "v2ProfileUpdate" was null or undefined when calling v2ProfilesUpdate().');
+            }
+            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/profiles/{id}/`;
+            urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: V2ProfileUpdateToJSON(requestParameters['v2ProfileUpdate']),
+            };
+        });
+    }
+    /**
+     * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
+     */
+    v2ProfilesUpdateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.v2ProfilesUpdateRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => V2ProfileDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Replace the profile. Checks matched by profile_check_id are updated in place; entries without one are added; existing checks not referenced in the request are removed.
+     */
+    v2ProfilesUpdate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.v2ProfilesUpdateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const V2ProfilesListCheckTypeEnum = {
+    Addresscheck: 'addresscheck',
+    Adversemediacheck: 'adversemediacheck',
+    Bigcheck: 'bigcheck',
+    Criminalrecordscheck: 'criminalrecordscheck',
+    Criminalrecordsuploadcheck: 'criminalrecordsuploadcheck',
+    Customintegritycheck: 'customintegritycheck',
+    Cvcheck: 'cvcheck',
+    Edrcheck: 'edrcheck',
+    Id2check: 'id2check',
+    Integritycheck: 'integritycheck',
+    Openhealthcarecheck: 'openhealthcarecheck',
+    Qualificationcheck: 'qualificationcheck',
+    Righttoworkcheck: 'righttoworkcheck',
+    Vogcheck: 'vogcheck',
+    Watchlist2check: 'watchlist2check',
+    Watchlistcheck: 'watchlistcheck',
+    Workreferencecheck: 'workreferencecheck',
+    Worldwidecreditcheck: 'worldwidecreditcheck'
+};

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

@@ -0,0 +1,172 @@
+/**
+ * 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 PaginatedV2ScreeningListItemList } from '../models/PaginatedV2ScreeningListItemList';
+import { type V2Document } from '../models/V2Document';
+import { type V2ScreeningCreate } from '../models/V2ScreeningCreate';
+import { type V2ScreeningDetail } from '../models/V2ScreeningDetail';
+export interface V2ScreeningsCreateRequest {
+    v2ScreeningCreate: V2ScreeningCreate;
+}
+export interface V2ScreeningsDocumentsListRequest {
+    id: string;
+    checkId?: string;
+    checkType?: string;
+}
+export interface V2ScreeningsListRequest {
+    page?: number;
+    pageSize?: number;
+    paginate?: boolean;
+}
+export interface V2ScreeningsRetrieveRequest {
+    id: string;
+}
+/**
+ * ScreeningsApi - interface
+ *
+ * @export
+ * @interface ScreeningsApiInterface
+ */
+export interface ScreeningsApiInterface {
+    /**
+     * Creates request options for v2ScreeningsCreate without sending the request
+     * @param {V2ScreeningCreate} v2ScreeningCreate
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsCreateRequestOpts(requestParameters: V2ScreeningsCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {V2ScreeningCreate} v2ScreeningCreate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsCreateRaw(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
+    /**
+     */
+    v2ScreeningsCreate(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
+    /**
+     * Creates request options for v2ScreeningsDocumentsList without sending the request
+     * @param {string} id
+     * @param {string} [checkId] Only documents from the check with this id.
+     * @param {string} [checkType] Only documents from checks of this type.
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsDocumentsListRequestOpts(requestParameters: V2ScreeningsDocumentsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+     * @summary Retrieve screening documents
+     * @param {string} id
+     * @param {string} [checkId] Only documents from the check with this id.
+     * @param {string} [checkType] Only documents from checks of this type.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsDocumentsListRaw(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2Document>>>;
+    /**
+     * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+     * Retrieve screening documents
+     */
+    v2ScreeningsDocumentsList(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2Document>>;
+    /**
+     * Creates request options for v2ScreeningsList 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 ScreeningsApiInterface
+     */
+    v2ScreeningsListRequestOpts(requestParameters: V2ScreeningsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @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 ScreeningsApiInterface
+     */
+    v2ScreeningsListRaw(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ScreeningListItemList>>;
+    /**
+     */
+    v2ScreeningsList(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ScreeningListItemList>;
+    /**
+     * Creates request options for v2ScreeningsRetrieve without sending the request
+     * @param {string} id A UUID string identifying this screening.
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsRetrieveRequestOpts(requestParameters: V2ScreeningsRetrieveRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @param {string} id A UUID string identifying this screening.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ScreeningsApiInterface
+     */
+    v2ScreeningsRetrieveRaw(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
+    /**
+     */
+    v2ScreeningsRetrieve(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
+}
+/**
+ *
+ */
+export declare class ScreeningsApi extends runtime.BaseAPI implements ScreeningsApiInterface {
+    /**
+     * Creates request options for v2ScreeningsCreate without sending the request
+     */
+    v2ScreeningsCreateRequestOpts(requestParameters: V2ScreeningsCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    v2ScreeningsCreateRaw(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
+    /**
+     */
+    v2ScreeningsCreate(requestParameters: V2ScreeningsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
+    /**
+     * Creates request options for v2ScreeningsDocumentsList without sending the request
+     */
+    v2ScreeningsDocumentsListRequestOpts(requestParameters: V2ScreeningsDocumentsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+     * Retrieve screening documents
+     */
+    v2ScreeningsDocumentsListRaw(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<V2Document>>>;
+    /**
+     * Documents attached to the screening\'s checks. Files are delivered inline as Base64 in `content`. Narrow the result with `check_id` or `check_type`.
+     * Retrieve screening documents
+     */
+    v2ScreeningsDocumentsList(requestParameters: V2ScreeningsDocumentsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<V2Document>>;
+    /**
+     * Creates request options for v2ScreeningsList without sending the request
+     */
+    v2ScreeningsListRequestOpts(requestParameters: V2ScreeningsListRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    v2ScreeningsListRaw(requestParameters: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedV2ScreeningListItemList>>;
+    /**
+     */
+    v2ScreeningsList(requestParameters?: V2ScreeningsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedV2ScreeningListItemList>;
+    /**
+     * Creates request options for v2ScreeningsRetrieve without sending the request
+     */
+    v2ScreeningsRetrieveRequestOpts(requestParameters: V2ScreeningsRetrieveRequest): Promise<runtime.RequestOpts>;
+    /**
+     */
+    v2ScreeningsRetrieveRaw(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V2ScreeningDetail>>;
+    /**
+     */
+    v2ScreeningsRetrieve(requestParameters: V2ScreeningsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V2ScreeningDetail>;
+}