@pescheckit/pescheck-client 0.0.5

package/src/models/V2ScreeningCreate.ts

@@ -0,0 +1,98 @@
+/* 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 { mapValues } from '../runtime';
+import type { V2Candidate } from './V2Candidate';
+import {
+    V2CandidateFromJSON,
+    V2CandidateFromJSONTyped,
+    V2CandidateToJSON,
+    V2CandidateToJSONTyped,
+} from './V2Candidate';
+import type { V2ScreeningCheck } from './V2ScreeningCheck';
+import {
+    V2ScreeningCheckFromJSON,
+    V2ScreeningCheckFromJSONTyped,
+    V2ScreeningCheckToJSON,
+    V2ScreeningCheckToJSONTyped,
+} from './V2ScreeningCheck';
+
+/**
+ * 
+ * @export
+ * @interface V2ScreeningCreate
+ */
+export interface V2ScreeningCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningCreate
+     */
+    profileId: string;
+    /**
+     * 
+     * @type {V2Candidate}
+     * @memberof V2ScreeningCreate
+     */
+    candidate: V2Candidate;
+    /**
+     * 
+     * @type {Array<V2ScreeningCheck>}
+     * @memberof V2ScreeningCreate
+     */
+    checks?: Array<V2ScreeningCheck>;
+}
+
+/**
+ * Check if a given object implements the V2ScreeningCreate interface.
+ */
+export function instanceOfV2ScreeningCreate(value: any): value is V2ScreeningCreate {
+    if ((!('profileId' in value) && !('profile_id' in value)) || (value['profileId'] === undefined && value['profile_id'] === undefined)) return false;
+    if (!('candidate' in value) || value['candidate'] === undefined) return false;
+    return true;
+}
+
+export function V2ScreeningCreateFromJSON(json: any): V2ScreeningCreate {
+    return V2ScreeningCreateFromJSONTyped(json, false);
+}
+
+export function V2ScreeningCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2ScreeningCreate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'profileId': json['profile_id'],
+        'candidate': V2CandidateFromJSON(json['candidate']),
+        'checks': json['checks'] == null ? undefined : ((json['checks'] as Array<any>).map(V2ScreeningCheckFromJSON)),
+    };
+}
+
+export function V2ScreeningCreateToJSON(json: any): V2ScreeningCreate {
+    return V2ScreeningCreateToJSONTyped(json, false);
+}
+
+export function V2ScreeningCreateToJSONTyped(value?: V2ScreeningCreate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'profile_id': value['profileId'],
+        'candidate': V2CandidateToJSON(value['candidate']),
+        'checks': value['checks'] == null ? undefined : ((value['checks'] as Array<any>).map(V2ScreeningCheckToJSON)),
+    };
+}
+

package/src/models/V2ScreeningDetail.ts

@@ -0,0 +1,152 @@
+/* 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 { mapValues } from '../runtime';
+import type { V2Candidate } from './V2Candidate';
+import {
+    V2CandidateFromJSON,
+    V2CandidateFromJSONTyped,
+    V2CandidateToJSON,
+    V2CandidateToJSONTyped,
+} from './V2Candidate';
+import type { V2ScreeningDetailProfile } from './V2ScreeningDetailProfile';
+import {
+    V2ScreeningDetailProfileFromJSON,
+    V2ScreeningDetailProfileFromJSONTyped,
+    V2ScreeningDetailProfileToJSON,
+    V2ScreeningDetailProfileToJSONTyped,
+} from './V2ScreeningDetailProfile';
+import type { V2ScreeningCheckEntry } from './V2ScreeningCheckEntry';
+import {
+    V2ScreeningCheckEntryFromJSON,
+    V2ScreeningCheckEntryFromJSONTyped,
+    V2ScreeningCheckEntryToJSON,
+    V2ScreeningCheckEntryToJSONTyped,
+} from './V2ScreeningCheckEntry';
+
+/**
+ * 
+ * @export
+ * @interface V2ScreeningDetail
+ */
+export interface V2ScreeningDetail {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningDetail
+     */
+    readonly id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningDetail
+     */
+    readonly status: string;
+    /**
+     * 
+     * @type {V2ScreeningDetailProfile}
+     * @memberof V2ScreeningDetail
+     */
+    profile: V2ScreeningDetailProfile | null;
+    /**
+     * 
+     * @type {V2Candidate}
+     * @memberof V2ScreeningDetail
+     */
+    readonly candidate: V2Candidate;
+    /**
+     * 
+     * @type {Array<V2ScreeningCheckEntry>}
+     * @memberof V2ScreeningDetail
+     */
+    readonly checks: Array<V2ScreeningCheckEntry>;
+    /**
+     * Public wizard URL for the candidate. Null when no check needs candidate input.
+     * @type {string}
+     * @memberof V2ScreeningDetail
+     */
+    readonly candidateWizardUrl: string | null;
+    /**
+     * Dashboard URL for this screening.
+     * @type {string}
+     * @memberof V2ScreeningDetail
+     */
+    readonly dashboardUrl: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof V2ScreeningDetail
+     */
+    readonly createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof V2ScreeningDetail
+     */
+    readonly updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the V2ScreeningDetail interface.
+ */
+export function instanceOfV2ScreeningDetail(value: any): value is V2ScreeningDetail {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('profile' in value) || value['profile'] === undefined) return false;
+    if (!('candidate' in value) || value['candidate'] === undefined) return false;
+    if (!('checks' in value) || value['checks'] === undefined) return false;
+    if ((!('candidateWizardUrl' in value) && !('candidate_wizard_url' in value)) || (value['candidateWizardUrl'] === undefined && value['candidate_wizard_url'] === undefined)) return false;
+    if ((!('dashboardUrl' in value) && !('dashboard_url' in value)) || (value['dashboardUrl'] === undefined && value['dashboard_url'] === undefined)) return false;
+    if ((!('createdAt' in value) && !('created_at' in value)) || (value['createdAt'] === undefined && value['created_at'] === undefined)) return false;
+    if ((!('updatedAt' in value) && !('updated_at' in value)) || (value['updatedAt'] === undefined && value['updated_at'] === undefined)) return false;
+    return true;
+}
+
+export function V2ScreeningDetailFromJSON(json: any): V2ScreeningDetail {
+    return V2ScreeningDetailFromJSONTyped(json, false);
+}
+
+export function V2ScreeningDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2ScreeningDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'profile': V2ScreeningDetailProfileFromJSON(json['profile']),
+        'candidate': V2CandidateFromJSON(json['candidate']),
+        'checks': ((json['checks'] as Array<any>).map(V2ScreeningCheckEntryFromJSON)),
+        'candidateWizardUrl': json['candidate_wizard_url'],
+        'dashboardUrl': json['dashboard_url'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function V2ScreeningDetailToJSON(json: any): V2ScreeningDetail {
+    return V2ScreeningDetailToJSONTyped(json, false);
+}
+
+export function V2ScreeningDetailToJSONTyped(value?: Omit<V2ScreeningDetail, 'id'|'status'|'candidate'|'checks'|'candidate_wizard_url'|'dashboard_url'|'created_at'|'updated_at'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'profile': V2ScreeningDetailProfileToJSON(value['profile']),
+    };
+}
+

package/src/models/V2ScreeningDetailProfile.ts

@@ -0,0 +1,73 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface V2ScreeningDetailProfile
+ */
+export interface V2ScreeningDetailProfile {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningDetailProfile
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningDetailProfile
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the V2ScreeningDetailProfile interface.
+ */
+export function instanceOfV2ScreeningDetailProfile(value: any): value is V2ScreeningDetailProfile {
+    return true;
+}
+
+export function V2ScreeningDetailProfileFromJSON(json: any): V2ScreeningDetailProfile {
+    return V2ScreeningDetailProfileFromJSONTyped(json, false);
+}
+
+export function V2ScreeningDetailProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2ScreeningDetailProfile {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function V2ScreeningDetailProfileToJSON(json: any): V2ScreeningDetailProfile {
+    return V2ScreeningDetailProfileToJSONTyped(json, false);
+}
+
+export function V2ScreeningDetailProfileToJSONTyped(value?: V2ScreeningDetailProfile | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+    };
+}
+

package/src/models/V2ScreeningListItem.ts

@@ -0,0 +1,154 @@
+/* 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 { mapValues } from '../runtime';
+import type { V2Candidate } from './V2Candidate';
+import {
+    V2CandidateFromJSON,
+    V2CandidateFromJSONTyped,
+    V2CandidateToJSON,
+    V2CandidateToJSONTyped,
+} from './V2Candidate';
+import type { V2ScreeningDetailProfile } from './V2ScreeningDetailProfile';
+import {
+    V2ScreeningDetailProfileFromJSON,
+    V2ScreeningDetailProfileFromJSONTyped,
+    V2ScreeningDetailProfileToJSON,
+    V2ScreeningDetailProfileToJSONTyped,
+} from './V2ScreeningDetailProfile';
+import type { V2ScreeningCheckListItem } from './V2ScreeningCheckListItem';
+import {
+    V2ScreeningCheckListItemFromJSON,
+    V2ScreeningCheckListItemFromJSONTyped,
+    V2ScreeningCheckListItemToJSON,
+    V2ScreeningCheckListItemToJSONTyped,
+} from './V2ScreeningCheckListItem';
+
+/**
+ * List shape for GET /screenings/. Same candidate as detail; the only thing
+ * we slim here is per-check info (status only), since config/input/output are
+ * heavy and rarely needed at list time.
+ * @export
+ * @interface V2ScreeningListItem
+ */
+export interface V2ScreeningListItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningListItem
+     */
+    readonly id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningListItem
+     */
+    status?: string;
+    /**
+     * 
+     * @type {V2ScreeningDetailProfile}
+     * @memberof V2ScreeningListItem
+     */
+    profile: V2ScreeningDetailProfile | null;
+    /**
+     * 
+     * @type {V2Candidate}
+     * @memberof V2ScreeningListItem
+     */
+    readonly candidate: V2Candidate;
+    /**
+     * 
+     * @type {Array<V2ScreeningCheckListItem>}
+     * @memberof V2ScreeningListItem
+     */
+    readonly checks: Array<V2ScreeningCheckListItem>;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningListItem
+     */
+    readonly candidateWizardUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2ScreeningListItem
+     */
+    readonly dashboardUrl: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof V2ScreeningListItem
+     */
+    readonly createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof V2ScreeningListItem
+     */
+    readonly updatedAt: Date;
+}
+
+/**
+ * Check if a given object implements the V2ScreeningListItem interface.
+ */
+export function instanceOfV2ScreeningListItem(value: any): value is V2ScreeningListItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('profile' in value) || value['profile'] === undefined) return false;
+    if (!('candidate' in value) || value['candidate'] === undefined) return false;
+    if (!('checks' in value) || value['checks'] === undefined) return false;
+    if ((!('candidateWizardUrl' in value) && !('candidate_wizard_url' in value)) || (value['candidateWizardUrl'] === undefined && value['candidate_wizard_url'] === undefined)) return false;
+    if ((!('dashboardUrl' in value) && !('dashboard_url' in value)) || (value['dashboardUrl'] === undefined && value['dashboard_url'] === undefined)) return false;
+    if ((!('createdAt' in value) && !('created_at' in value)) || (value['createdAt'] === undefined && value['created_at'] === undefined)) return false;
+    if ((!('updatedAt' in value) && !('updated_at' in value)) || (value['updatedAt'] === undefined && value['updated_at'] === undefined)) return false;
+    return true;
+}
+
+export function V2ScreeningListItemFromJSON(json: any): V2ScreeningListItem {
+    return V2ScreeningListItemFromJSONTyped(json, false);
+}
+
+export function V2ScreeningListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2ScreeningListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'profile': V2ScreeningDetailProfileFromJSON(json['profile']),
+        'candidate': V2CandidateFromJSON(json['candidate']),
+        'checks': ((json['checks'] as Array<any>).map(V2ScreeningCheckListItemFromJSON)),
+        'candidateWizardUrl': json['candidate_wizard_url'],
+        'dashboardUrl': json['dashboard_url'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function V2ScreeningListItemToJSON(json: any): V2ScreeningListItem {
+    return V2ScreeningListItemToJSONTyped(json, false);
+}
+
+export function V2ScreeningListItemToJSONTyped(value?: Omit<V2ScreeningListItem, 'id'|'candidate'|'checks'|'candidate_wizard_url'|'dashboard_url'|'created_at'|'updated_at'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'profile': V2ScreeningDetailProfileToJSON(value['profile']),
+    };
+}
+

package/src/models/VerifyWebhook.ts

@@ -0,0 +1,68 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Body shape for POST /webhooks/{id}/verify/. The verification code is the
+ * one sent to the webhook URL when the webhook was created; the receiver POSTs
+ * it back here to confirm ownership.
+ * @export
+ * @interface VerifyWebhook
+ */
+export interface VerifyWebhook {
+    /**
+     * The verification code delivered to the webhook URL on creation.
+     * @type {string}
+     * @memberof VerifyWebhook
+     */
+    verificationCode: string;
+}
+
+/**
+ * Check if a given object implements the VerifyWebhook interface.
+ */
+export function instanceOfVerifyWebhook(value: any): value is VerifyWebhook {
+    if ((!('verificationCode' in value) && !('verification_code' in value)) || (value['verificationCode'] === undefined && value['verification_code'] === undefined)) return false;
+    return true;
+}
+
+export function VerifyWebhookFromJSON(json: any): VerifyWebhook {
+    return VerifyWebhookFromJSONTyped(json, false);
+}
+
+export function VerifyWebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerifyWebhook {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'verificationCode': json['verification_code'],
+    };
+}
+
+export function VerifyWebhookToJSON(json: any): VerifyWebhook {
+    return VerifyWebhookToJSONTyped(json, false);
+}
+
+export function VerifyWebhookToJSONTyped(value?: VerifyWebhook | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'verification_code': value['verificationCode'],
+    };
+}
+

package/src/models/Webhook.ts

@@ -0,0 +1,118 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Serializer for webhook creation/update requests
+ * @export
+ * @interface Webhook
+ */
+export interface Webhook {
+    /**
+     * Descriptive name for this webhook
+     * @type {string}
+     * @memberof Webhook
+     */
+    name: string;
+    /**
+     * HTTPS URL where webhook events will be sent
+     * @type {string}
+     * @memberof Webhook
+     */
+    url: string;
+    /**
+     * List of events to subscribe to. Valid events: check.status_changed, screening.status_changed, screening.archived, package.created, package.updated, profile.created, profile.updated, division.created, division.updated
+     * @type {Array<WebhookEventsEnum>}
+     * @memberof Webhook
+     */
+    events: Array<WebhookEventsEnum>;
+    /**
+     * Whether the webhook is active
+     * @type {boolean}
+     * @memberof Webhook
+     */
+    active?: boolean;
+    /**
+     * Division ID to create webhook for (optional)
+     * @type {string}
+     * @memberof Webhook
+     */
+    divisionId?: string;
+}
+
+
+/**
+ * @export
+ */
+export const WebhookEventsEnum = {
+    CheckStatusChanged: 'check.status_changed',
+    ScreeningStatusChanged: 'screening.status_changed',
+    ScreeningArchived: 'screening.archived',
+    PackageCreated: 'package.created',
+    PackageUpdated: 'package.updated',
+    ProfileCreated: 'profile.created',
+    ProfileUpdated: 'profile.updated',
+    DivisionCreated: 'division.created',
+    DivisionUpdated: 'division.updated'
+} as const;
+export type WebhookEventsEnum = typeof WebhookEventsEnum[keyof typeof WebhookEventsEnum];
+
+
+/**
+ * Check if a given object implements the Webhook interface.
+ */
+export function instanceOfWebhook(value: any): value is Webhook {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('events' in value) || value['events'] === undefined) return false;
+    return true;
+}
+
+export function WebhookFromJSON(json: any): Webhook {
+    return WebhookFromJSONTyped(json, false);
+}
+
+export function WebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): Webhook {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'url': json['url'],
+        'events': json['events'],
+        'active': json['active'] == null ? undefined : json['active'],
+        'divisionId': json['division_id'] == null ? undefined : json['division_id'],
+    };
+}
+
+export function WebhookToJSON(json: any): Webhook {
+    return WebhookToJSONTyped(json, false);
+}
+
+export function WebhookToJSONTyped(value?: Webhook | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'url': value['url'],
+        'events': value['events'],
+        'active': value['active'],
+        'division_id': value['divisionId'],
+    };
+}
+