@pescheckit/pescheck-client 0.0.5

package/src/models/V2Candidate.ts

@@ -0,0 +1,649 @@
+/* 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';
+/**
+ * Bucket-level candidate facts. Required-ness varies per profile; serializer is lenient.
+ * 
+ * Note: v2 tightens nationality vs v1 - v1 accepted any free-form string, v2 requires
+ * an ISO 3166-1 alpha-2 code so downstream consumers (watchlist matching, document
+ * readers, etc.) can rely on the value.
+ * @export
+ * @interface V2Candidate
+ */
+export interface V2Candidate {
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    firstName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    lastName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    email: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    initials?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    dateOfBirth?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    gender?: string;
+    /**
+     * ISO 3166-1 alpha-2 country code (e.g. "NL", "DE", "US").
+     * 
+     * * `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
+     * @type {V2CandidateNationalityEnum}
+     * @memberof V2Candidate
+     */
+    nationality?: V2CandidateNationalityEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    postalCode?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    houseNumber?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof V2Candidate
+     */
+    extension?: string;
+}
+
+
+/**
+ * @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: ''
+} as const;
+export type V2CandidateNationalityEnum = typeof V2CandidateNationalityEnum[keyof typeof V2CandidateNationalityEnum];
+
+
+/**
+ * Check if a given object implements the V2Candidate interface.
+ */
+export function instanceOfV2Candidate(value: any): value is V2Candidate {
+    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: any): V2Candidate {
+    return V2CandidateFromJSONTyped(json, false);
+}
+
+export function V2CandidateFromJSONTyped(json: any, ignoreDiscriminator: boolean): V2Candidate {
+    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: any): V2Candidate {
+    return V2CandidateToJSONTyped(json, false);
+}
+
+export function V2CandidateToJSONTyped(value?: V2Candidate | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+