@pescheckit/pescheck-client 0.0.5

package/src/models/V2CheckField.ts

@@ -0,0 +1,97 @@
+/* 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';
+/**
+ * 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 function instanceOfV2CheckField(value: any): value is V2CheckField {
+    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: any): V2CheckField {
+    return V2CheckFieldFromJSONTyped(json, false);
+}
+
+export function V2CheckFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2CheckField {
+    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: any): V2CheckField {
+    return V2CheckFieldToJSONTyped(json, false);
+}
+
+export function V2CheckFieldToJSONTyped(value?: Omit<V2CheckField, 'name'|'type'|'required'|'choices'|'help_text'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/V2CheckInfo.ts

@@ -0,0 +1,168 @@
+/* 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 { V2CheckField } from './V2CheckField';
+import {
+    V2CheckFieldFromJSON,
+    V2CheckFieldFromJSONTyped,
+    V2CheckFieldToJSON,
+    V2CheckFieldToJSONTyped,
+} from './V2CheckField';
+import type { V2Money } from './V2Money';
+import {
+    V2MoneyFromJSON,
+    V2MoneyFromJSONTyped,
+    V2MoneyToJSON,
+    V2MoneyToJSONTyped,
+} 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 function instanceOfV2CheckInfo(value: any): value is V2CheckInfo {
+    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: any): V2CheckInfo {
+    return V2CheckInfoFromJSONTyped(json, false);
+}
+
+export function V2CheckInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2CheckInfo {
+    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'] as Array<any>).map(V2CheckFieldFromJSON)),
+        'inputFields': ((json['input_fields'] as Array<any>).map(V2CheckFieldFromJSON)),
+        'candidateFields': ((json['candidate_fields'] as Array<any>).map(V2CheckFieldFromJSON)),
+    };
+}
+
+export function V2CheckInfoToJSON(json: any): V2CheckInfo {
+    return V2CheckInfoToJSONTyped(json, false);
+}
+
+export 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 = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/V2Document.ts

@@ -0,0 +1,166 @@
+/* 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 { V2DocumentContent } from './V2DocumentContent';
+import {
+    V2DocumentContentFromJSON,
+    V2DocumentContentFromJSONTyped,
+    V2DocumentContentToJSON,
+    V2DocumentContentToJSONTyped,
+} from './V2DocumentContent';
+
+/**
+ * One document attached to a screening's check. `metadata` carries
+ * check-specific extras and may be empty.
+ * @export
+ * @interface V2Document
+ */
+export interface V2Document {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Document
+     */
+    readonly checkId: string | null;
+    /**
+     * * `addresscheck` - addresscheck
+     * * `adversemediacheck` - adversemediacheck
+     * * `bigcheck` - bigcheck
+     * * `criminalrecordscheck` - criminalrecordscheck
+     * * `criminalrecordsuploadcheck` - criminalrecordsuploadcheck
+     * * `customintegritycheck` - customintegritycheck
+     * * `cvcheck` - cvcheck
+     * * `edrcheck` - edrcheck
+     * * `focumcheck` - focumcheck
+     * * `id2check` - id2check
+     * * `idcheck` - idcheck
+     * * `integritycheck` - integritycheck
+     * * `openhealthcarecheck` - openhealthcarecheck
+     * * `permissioncheck` - permissioncheck
+     * * `pescheckadversemediacheck` - pescheckadversemediacheck
+     * * `qualificationcheck` - qualificationcheck
+     * * `righttoworkcheck` - righttoworkcheck
+     * * `vogcheck` - vogcheck
+     * * `watchlist2check` - watchlist2check
+     * * `watchlistcheck` - watchlistcheck
+     * * `workreferencecheck` - workreferencecheck
+     * * `worldwidecreditcheck` - worldwidecreditcheck
+     * @type {V2DocumentCheckTypeEnum}
+     * @memberof V2Document
+     */
+    readonly checkType: V2DocumentCheckTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Document
+     */
+    readonly filename: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Document
+     */
+    readonly extension: string;
+    /**
+     * 
+     * @type {V2DocumentContent}
+     * @memberof V2Document
+     */
+    readonly content: V2DocumentContent;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof V2Document
+     */
+    readonly metadata: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const V2DocumentCheckTypeEnum = {
+    Addresscheck: 'addresscheck',
+    Adversemediacheck: 'adversemediacheck',
+    Bigcheck: 'bigcheck',
+    Criminalrecordscheck: 'criminalrecordscheck',
+    Criminalrecordsuploadcheck: 'criminalrecordsuploadcheck',
+    Customintegritycheck: 'customintegritycheck',
+    Cvcheck: 'cvcheck',
+    Edrcheck: 'edrcheck',
+    Focumcheck: 'focumcheck',
+    Id2check: 'id2check',
+    Idcheck: 'idcheck',
+    Integritycheck: 'integritycheck',
+    Openhealthcarecheck: 'openhealthcarecheck',
+    Permissioncheck: 'permissioncheck',
+    Pescheckadversemediacheck: 'pescheckadversemediacheck',
+    Qualificationcheck: 'qualificationcheck',
+    Righttoworkcheck: 'righttoworkcheck',
+    Vogcheck: 'vogcheck',
+    Watchlist2check: 'watchlist2check',
+    Watchlistcheck: 'watchlistcheck',
+    Workreferencecheck: 'workreferencecheck',
+    Worldwidecreditcheck: 'worldwidecreditcheck'
+} as const;
+export type V2DocumentCheckTypeEnum = typeof V2DocumentCheckTypeEnum[keyof typeof V2DocumentCheckTypeEnum];
+
+
+/**
+ * Check if a given object implements the V2Document interface.
+ */
+export function instanceOfV2Document(value: any): value is V2Document {
+    if ((!('checkId' in value) && !('check_id' in value)) || (value['checkId'] === undefined && value['check_id'] === undefined)) return false;
+    if ((!('checkType' in value) && !('check_type' in value)) || (value['checkType'] === undefined && value['check_type'] === undefined)) return false;
+    if (!('filename' in value) || value['filename'] === undefined) return false;
+    if (!('extension' in value) || value['extension'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    return true;
+}
+
+export function V2DocumentFromJSON(json: any): V2Document {
+    return V2DocumentFromJSONTyped(json, false);
+}
+
+export function V2DocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2Document {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checkId': json['check_id'],
+        'checkType': json['check_type'],
+        'filename': json['filename'],
+        'extension': json['extension'],
+        'content': V2DocumentContentFromJSON(json['content']),
+        'metadata': json['metadata'],
+    };
+}
+
+export function V2DocumentToJSON(json: any): V2Document {
+    return V2DocumentToJSONTyped(json, false);
+}
+
+export function V2DocumentToJSONTyped(value?: Omit<V2Document, 'check_id'|'check_type'|'filename'|'extension'|'content'|'metadata'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/V2DocumentContent.ts

@@ -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 { mapValues } from '../runtime';
+/**
+ * How the file is delivered. `type` is the discriminator; today it is always
+ * `"base64"` and `data` holds the encoded bytes. Other delivery types may be
+ * added later without breaking this contract.
+ * @export
+ * @interface V2DocumentContent
+ */
+export interface V2DocumentContent {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2DocumentContent
+     */
+    type: string;
+    /**
+     * Base64-encoded file contents (type == base64).
+     * @type {string}
+     * @memberof V2DocumentContent
+     */
+    data?: string;
+}
+
+/**
+ * Check if a given object implements the V2DocumentContent interface.
+ */
+export function instanceOfV2DocumentContent(value: any): value is V2DocumentContent {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function V2DocumentContentFromJSON(json: any): V2DocumentContent {
+    return V2DocumentContentFromJSONTyped(json, false);
+}
+
+export function V2DocumentContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2DocumentContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'data': json['data'] == null ? undefined : json['data'],
+    };
+}
+
+export function V2DocumentContentToJSON(json: any): V2DocumentContent {
+    return V2DocumentContentToJSONTyped(json, false);
+}
+
+export function V2DocumentContentToJSONTyped(value?: V2DocumentContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'data': value['data'],
+    };
+}
+

package/src/models/V2Money.ts

@@ -0,0 +1,75 @@
+/* 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 V2Money
+ */
+export interface V2Money {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Money
+     */
+    amount: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Money
+     */
+    currency: string;
+}
+
+/**
+ * Check if a given object implements the V2Money interface.
+ */
+export function instanceOfV2Money(value: any): value is V2Money {
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    return true;
+}
+
+export function V2MoneyFromJSON(json: any): V2Money {
+    return V2MoneyFromJSONTyped(json, false);
+}
+
+export function V2MoneyFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2Money {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'amount': json['amount'],
+        'currency': json['currency'],
+    };
+}
+
+export function V2MoneyToJSON(json: any): V2Money {
+    return V2MoneyToJSONTyped(json, false);
+}
+
+export function V2MoneyToJSONTyped(value?: V2Money | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'amount': value['amount'],
+        'currency': value['currency'],
+    };
+}
+