@pescheckit/pescheck-client 0.0.5

package/dist/esm/models/V2Candidate.js

@@ -0,0 +1,318 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const V2CandidateNationalityEnum = {
+    Ad: 'AD',
+    Ae: 'AE',
+    Af: 'AF',
+    Ag: 'AG',
+    Ai: 'AI',
+    Al: 'AL',
+    Am: 'AM',
+    An: 'AN',
+    Ao: 'AO',
+    Aq: 'AQ',
+    Ar: 'AR',
+    As: 'AS',
+    At: 'AT',
+    Au: 'AU',
+    Aw: 'AW',
+    Ax: 'AX',
+    Az: 'AZ',
+    Ba: 'BA',
+    Bb: 'BB',
+    Bd: 'BD',
+    Be: 'BE',
+    Bf: 'BF',
+    Bg: 'BG',
+    Bh: 'BH',
+    Bi: 'BI',
+    Bj: 'BJ',
+    Bl: 'BL',
+    Bm: 'BM',
+    Bn: 'BN',
+    Bo: 'BO',
+    Br: 'BR',
+    Bs: 'BS',
+    Bt: 'BT',
+    Bv: 'BV',
+    Bw: 'BW',
+    By: 'BY',
+    Bz: 'BZ',
+    Ca: 'CA',
+    Cc: 'CC',
+    Cd: 'CD',
+    Cf: 'CF',
+    Cg: 'CG',
+    Ch: 'CH',
+    Ci: 'CI',
+    Ck: 'CK',
+    Cl: 'CL',
+    Cm: 'CM',
+    Cn: 'CN',
+    Co: 'CO',
+    Cr: 'CR',
+    Cu: 'CU',
+    Cv: 'CV',
+    Cw: 'CW',
+    Cx: 'CX',
+    Cy: 'CY',
+    Cz: 'CZ',
+    De: 'DE',
+    Dj: 'DJ',
+    Dk: 'DK',
+    Dm: 'DM',
+    Do: 'DO',
+    Dz: 'DZ',
+    Ec: 'EC',
+    Ee: 'EE',
+    Eg: 'EG',
+    Eh: 'EH',
+    Er: 'ER',
+    Es: 'ES',
+    Et: 'ET',
+    Fi: 'FI',
+    Fj: 'FJ',
+    Fk: 'FK',
+    Fm: 'FM',
+    Fo: 'FO',
+    Fr: 'FR',
+    Ga: 'GA',
+    Gb: 'GB',
+    Gd: 'GD',
+    Ge: 'GE',
+    Gf: 'GF',
+    Gg: 'GG',
+    Gh: 'GH',
+    Gi: 'GI',
+    Gl: 'GL',
+    Gm: 'GM',
+    Gn: 'GN',
+    Gp: 'GP',
+    Gq: 'GQ',
+    Gr: 'GR',
+    Gs: 'GS',
+    Gt: 'GT',
+    Gu: 'GU',
+    Gw: 'GW',
+    Gy: 'GY',
+    Hk: 'HK',
+    Hm: 'HM',
+    Hn: 'HN',
+    Hr: 'HR',
+    Ht: 'HT',
+    Hu: 'HU',
+    Id: 'ID',
+    Ie: 'IE',
+    Il: 'IL',
+    Im: 'IM',
+    In: 'IN',
+    Io: 'IO',
+    Iq: 'IQ',
+    Ir: 'IR',
+    Is: 'IS',
+    It: 'IT',
+    Je: 'JE',
+    Jm: 'JM',
+    Jo: 'JO',
+    Jp: 'JP',
+    Ke: 'KE',
+    Kg: 'KG',
+    Kh: 'KH',
+    Ki: 'KI',
+    Km: 'KM',
+    Kn: 'KN',
+    Kp: 'KP',
+    Kr: 'KR',
+    Kw: 'KW',
+    Ky: 'KY',
+    Kz: 'KZ',
+    La: 'LA',
+    Lb: 'LB',
+    Lc: 'LC',
+    Li: 'LI',
+    Lk: 'LK',
+    Lr: 'LR',
+    Ls: 'LS',
+    Lt: 'LT',
+    Lu: 'LU',
+    Lv: 'LV',
+    Ly: 'LY',
+    Ma: 'MA',
+    Mc: 'MC',
+    Md: 'MD',
+    Me: 'ME',
+    Mg: 'MG',
+    Mh: 'MH',
+    Mk: 'MK',
+    Ml: 'ML',
+    Mm: 'MM',
+    Mn: 'MN',
+    Mo: 'MO',
+    Mp: 'MP',
+    Mq: 'MQ',
+    Mr: 'MR',
+    Ms: 'MS',
+    Mt: 'MT',
+    Mu: 'MU',
+    Mv: 'MV',
+    Mw: 'MW',
+    Mx: 'MX',
+    My: 'MY',
+    Mz: 'MZ',
+    Na: 'NA',
+    Nc: 'NC',
+    Ne: 'NE',
+    Nf: 'NF',
+    Ng: 'NG',
+    Ni: 'NI',
+    Nl: 'NL',
+    No: 'NO',
+    Np: 'NP',
+    Nr: 'NR',
+    Nu: 'NU',
+    Nz: 'NZ',
+    Om: 'OM',
+    Pa: 'PA',
+    Pe: 'PE',
+    Pf: 'PF',
+    Pg: 'PG',
+    Ph: 'PH',
+    Pk: 'PK',
+    Pl: 'PL',
+    Pm: 'PM',
+    Pn: 'PN',
+    Pr: 'PR',
+    Ps: 'PS',
+    Pt: 'PT',
+    Pw: 'PW',
+    Py: 'PY',
+    Qa: 'QA',
+    Re: 'RE',
+    Ro: 'RO',
+    Rs: 'RS',
+    Ru: 'RU',
+    Rw: 'RW',
+    Sa: 'SA',
+    Sb: 'SB',
+    Sc: 'SC',
+    Sd: 'SD',
+    Se: 'SE',
+    Sg: 'SG',
+    Sh: 'SH',
+    Si: 'SI',
+    Sj: 'SJ',
+    Sk: 'SK',
+    Sl: 'SL',
+    Sm: 'SM',
+    Sn: 'SN',
+    So: 'SO',
+    Sr: 'SR',
+    St: 'ST',
+    Sv: 'SV',
+    Sy: 'SY',
+    Sz: 'SZ',
+    Tc: 'TC',
+    Td: 'TD',
+    Tf: 'TF',
+    Tg: 'TG',
+    Th: 'TH',
+    Tj: 'TJ',
+    Tk: 'TK',
+    Tl: 'TL',
+    Tm: 'TM',
+    Tn: 'TN',
+    To: 'TO',
+    Tr: 'TR',
+    Tt: 'TT',
+    Tv: 'TV',
+    Tw: 'TW',
+    Tz: 'TZ',
+    Ua: 'UA',
+    Ug: 'UG',
+    Um: 'UM',
+    Us: 'US',
+    Uy: 'UY',
+    Uz: 'UZ',
+    Va: 'VA',
+    Vc: 'VC',
+    Ve: 'VE',
+    Vg: 'VG',
+    Vi: 'VI',
+    Vn: 'VN',
+    Vu: 'VU',
+    Wf: 'WF',
+    Ws: 'WS',
+    Xk: 'XK',
+    Ye: 'YE',
+    Yt: 'YT',
+    Za: 'ZA',
+    Zm: 'ZM',
+    Zw: 'ZW',
+    Empty: ''
+};
+/**
+ * Check if a given object implements the V2Candidate interface.
+ */
+export function instanceOfV2Candidate(value) {
+    if ((!('firstName' in value) && !('first_name' in value)) || (value['firstName'] === undefined && value['first_name'] === undefined))
+        return false;
+    if ((!('lastName' in value) && !('last_name' in value)) || (value['lastName'] === undefined && value['last_name'] === undefined))
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    return true;
+}
+export function V2CandidateFromJSON(json) {
+    return V2CandidateFromJSONTyped(json, false);
+}
+export function V2CandidateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'email': json['email'],
+        'initials': json['initials'] == null ? undefined : json['initials'],
+        'dateOfBirth': json['date_of_birth'] == null ? undefined : json['date_of_birth'],
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'postalCode': json['postal_code'] == null ? undefined : json['postal_code'],
+        'houseNumber': json['house_number'] == null ? undefined : json['house_number'],
+        'extension': json['extension'] == null ? undefined : json['extension'],
+    };
+}
+export function V2CandidateToJSON(json) {
+    return V2CandidateToJSONTyped(json, false);
+}
+export function V2CandidateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'email': value['email'],
+        'initials': value['initials'],
+        'date_of_birth': value['dateOfBirth'],
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'postal_code': value['postalCode'],
+        'house_number': value['houseNumber'],
+        'extension': value['extension'],
+    };
+}

package/dist/esm/models/V2CheckField.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ * One config or input field a check accepts via the API.
+ * @export
+ * @interface V2CheckField
+ */
+export interface V2CheckField {
+    /**
+     *
+     * @type {string}
+     * @memberof V2CheckField
+     */
+    readonly name: string;
+    /**
+     * "string" | "integer" | "number" | "boolean" | "array" | "object"
+     * @type {string}
+     * @memberof V2CheckField
+     */
+    readonly type: string;
+    /**
+     * Whether the request body must include this field.
+     * @type {boolean}
+     * @memberof V2CheckField
+     */
+    readonly required: boolean;
+    /**
+     * Allowed values, or null if the field isn't constrained to a set.
+     * @type {Array<string>}
+     * @memberof V2CheckField
+     */
+    readonly choices: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof V2CheckField
+     */
+    readonly helpText: string | null;
+}
+/**
+ * Check if a given object implements the V2CheckField interface.
+ */
+export declare function instanceOfV2CheckField(value: any): value is V2CheckField;
+export declare function V2CheckFieldFromJSON(json: any): V2CheckField;
+export declare function V2CheckFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2CheckField;
+export declare function V2CheckFieldToJSON(json: any): V2CheckField;
+export declare function V2CheckFieldToJSONTyped(value?: Omit<V2CheckField, 'name' | 'type' | 'required' | 'choices' | 'help_text'> | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/V2CheckField.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the V2CheckField interface.
+ */
+export function instanceOfV2CheckField(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('required' in value) || value['required'] === undefined)
+        return false;
+    if (!('choices' in value) || value['choices'] === undefined)
+        return false;
+    if ((!('helpText' in value) && !('help_text' in value)) || (value['helpText'] === undefined && value['help_text'] === undefined))
+        return false;
+    return true;
+}
+export function V2CheckFieldFromJSON(json) {
+    return V2CheckFieldFromJSONTyped(json, false);
+}
+export function V2CheckFieldFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'type': json['type'],
+        'required': json['required'],
+        'choices': json['choices'] == null ? null : json['choices'],
+        'helpText': json['help_text'],
+    };
+}
+export function V2CheckFieldToJSON(json) {
+    return V2CheckFieldToJSONTyped(json, false);
+}
+export function V2CheckFieldToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {};
+}

package/dist/esm/models/V2CheckInfo.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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 type { V2CheckField } from './V2CheckField';
+import type { V2Money } from './V2Money';
+/**
+ * Everything a client needs to know to use a check type via the API.
+ * @export
+ * @interface V2CheckInfo
+ */
+export interface V2CheckInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof V2CheckInfo
+     */
+    readonly checkType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V2CheckInfo
+     */
+    readonly displayName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof V2CheckInfo
+     */
+    readonly description: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof V2CheckInfo
+     */
+    readonly hasConfig: boolean;
+    /**
+     * True for checks added automatically (e.g. as a dependency) - clients neither add nor configure these.
+     * @type {boolean}
+     * @memberof V2CheckInfo
+     */
+    readonly isSystemManaged: boolean;
+    /**
+     * Other check types this check pulls in automatically when added.
+     * @type {Array<string>}
+     * @memberof V2CheckInfo
+     */
+    readonly requiresChecks: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof V2CheckInfo
+     */
+    readonly supportedCountriesOfWork: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof V2CheckInfo
+     */
+    readonly supportedCountriesOfResidence: Array<string>;
+    /**
+     *
+     * @type {V2Money}
+     * @memberof V2CheckInfo
+     */
+    readonly defaultPrice: V2Money | null;
+    /**
+     *
+     * @type {Array<V2CheckField>}
+     * @memberof V2CheckInfo
+     */
+    readonly configFields: Array<V2CheckField>;
+    /**
+     *
+     * @type {Array<V2CheckField>}
+     * @memberof V2CheckInfo
+     */
+    readonly inputFields: Array<V2CheckField>;
+    /**
+     * Screening-level candidate facts this check needs (name, email, sometimes date of birth, etc.).
+     * @type {Array<V2CheckField>}
+     * @memberof V2CheckInfo
+     */
+    readonly candidateFields: Array<V2CheckField>;
+}
+/**
+ * Check if a given object implements the V2CheckInfo interface.
+ */
+export declare function instanceOfV2CheckInfo(value: any): value is V2CheckInfo;
+export declare function V2CheckInfoFromJSON(json: any): V2CheckInfo;
+export declare function V2CheckInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2CheckInfo;
+export declare function V2CheckInfoToJSON(json: any): V2CheckInfo;
+export declare function V2CheckInfoToJSONTyped(value?: Omit<V2CheckInfo, 'check_type' | 'display_name' | 'description' | 'has_config' | 'is_system_managed' | 'requires_checks' | 'supported_countries_of_work' | 'supported_countries_of_residence' | 'default_price' | 'config_fields' | 'input_fields' | 'candidate_fields'> | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/V2CheckInfo.js

@@ -0,0 +1,76 @@
+/* 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 { V2CheckFieldFromJSON, } from './V2CheckField';
+import { V2MoneyFromJSON, } from './V2Money';
+/**
+ * Check if a given object implements the V2CheckInfo interface.
+ */
+export function instanceOfV2CheckInfo(value) {
+    if ((!('checkType' in value) && !('check_type' in value)) || (value['checkType'] === undefined && value['check_type'] === undefined))
+        return false;
+    if ((!('displayName' in value) && !('display_name' in value)) || (value['displayName'] === undefined && value['display_name'] === undefined))
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if ((!('hasConfig' in value) && !('has_config' in value)) || (value['hasConfig'] === undefined && value['has_config'] === undefined))
+        return false;
+    if ((!('isSystemManaged' in value) && !('is_system_managed' in value)) || (value['isSystemManaged'] === undefined && value['is_system_managed'] === undefined))
+        return false;
+    if ((!('requiresChecks' in value) && !('requires_checks' in value)) || (value['requiresChecks'] === undefined && value['requires_checks'] === undefined))
+        return false;
+    if ((!('supportedCountriesOfWork' in value) && !('supported_countries_of_work' in value)) || (value['supportedCountriesOfWork'] === undefined && value['supported_countries_of_work'] === undefined))
+        return false;
+    if ((!('supportedCountriesOfResidence' in value) && !('supported_countries_of_residence' in value)) || (value['supportedCountriesOfResidence'] === undefined && value['supported_countries_of_residence'] === undefined))
+        return false;
+    if ((!('defaultPrice' in value) && !('default_price' in value)) || (value['defaultPrice'] === undefined && value['default_price'] === undefined))
+        return false;
+    if ((!('configFields' in value) && !('config_fields' in value)) || (value['configFields'] === undefined && value['config_fields'] === undefined))
+        return false;
+    if ((!('inputFields' in value) && !('input_fields' in value)) || (value['inputFields'] === undefined && value['input_fields'] === undefined))
+        return false;
+    if ((!('candidateFields' in value) && !('candidate_fields' in value)) || (value['candidateFields'] === undefined && value['candidate_fields'] === undefined))
+        return false;
+    return true;
+}
+export function V2CheckInfoFromJSON(json) {
+    return V2CheckInfoFromJSONTyped(json, false);
+}
+export function V2CheckInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checkType': json['check_type'],
+        'displayName': json['display_name'],
+        'description': json['description'],
+        'hasConfig': json['has_config'],
+        'isSystemManaged': json['is_system_managed'],
+        'requiresChecks': json['requires_checks'],
+        'supportedCountriesOfWork': json['supported_countries_of_work'],
+        'supportedCountriesOfResidence': json['supported_countries_of_residence'],
+        'defaultPrice': V2MoneyFromJSON(json['default_price']),
+        'configFields': (json['config_fields'].map(V2CheckFieldFromJSON)),
+        'inputFields': (json['input_fields'].map(V2CheckFieldFromJSON)),
+        'candidateFields': (json['candidate_fields'].map(V2CheckFieldFromJSON)),
+    };
+}
+export function V2CheckInfoToJSON(json) {
+    return V2CheckInfoToJSONTyped(json, false);
+}
+export function V2CheckInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {};
+}