@pescheckit/pescheck-client 0.0.5

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

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