@trinsic/api 2.3.0-alpha2 → 3.0.1

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

@@ -0,0 +1,90 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Represents a Kenya address as stored in the IPRS (Integrated Population Registration System) database.
+ *
+ * The structure reflects the pre-2010 provincial administration system: District > Division > Location.
+ * Since the 2010 constitutional change to counties, these legacy administrative divisions are still
+ * maintained in IPRS records for historical continuity.
+ *
+ * The raw address from IPRS is a newline-separated string with labeled administrative components.
+ * Example format:
+ *
+ * ```
+ * P O BOX 41842 NAIROBI
+ * PARLIAMENT BUILDINGS
+ * LOCATION - CITY SQUARE
+ * DIVISION - CENTRAL
+ * DISTRICT - NAIROBI
+ * ```
+ *
+ * The first lines contain informal address details (village, P.O. Box) while the suffixed lines
+ * contain official administrative designations prefixed with labels like "LOCATION -", "DIVISION -", "DISTRICT -".
+ * @export
+ * @interface KenyaNidLookup2Address
+ */
+export interface KenyaNidLookup2Address {
+    /**
+     * The district where the person resides.
+     *
+     * This is the highest level of the pre-2010 administrative hierarchy stored in IPRS. Districts were
+     * the primary administrative units under Kenya's provincial system before the change to counties in 2010.
+     * Districts roughly correspond to sub-counties in the current administrative structure.
+     * @type {string}
+     * @memberof KenyaNidLookup2Address
+     */
+    district?: string | null;
+    /**
+     * The division within the district.
+     *
+     * This is the second level of the pre-2010 administrative hierarchy. Divisions were administrative
+     * units between districts and locations.
+     * @type {string}
+     * @memberof KenyaNidLookup2Address
+     */
+    division?: string | null;
+    /**
+     * The location within the division.
+     *
+     * This is the third level of the pre-2010 administrative hierarchy. Locations were the smallest
+     * administrative units.
+     * @type {string}
+     * @memberof KenyaNidLookup2Address
+     */
+    location?: string | null;
+    /**
+     * Additional address lines that appear before the structured administrative parts.
+     *
+     * May include P.O. Box (format: "P O BOX [number] [location]"), village names, estate names,
+     * or other informal locality information.
+     * @type {Array<string>}
+     * @memberof KenyaNidLookup2Address
+     */
+    additionalLines?: Array<string> | null;
+    /**
+     * The raw, unparsed address string as returned from IPRS (Integrated Population Registration System).
+     *
+     * This preserves the original newline-separated format containing both informal address components
+     * (village, P.O. Box) and labeled administrative divisions (LOCATION, DIVISION, DISTRICT).
+     * @type {string}
+     * @memberof KenyaNidLookup2Address
+     */
+    raw?: string | null;
+}
+/**
+ * Check if a given object implements the KenyaNidLookup2Address interface.
+ */
+export declare function instanceOfKenyaNidLookup2Address(value: object): value is KenyaNidLookup2Address;
+export declare function KenyaNidLookup2AddressFromJSON(json: any): KenyaNidLookup2Address;
+export declare function KenyaNidLookup2AddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): KenyaNidLookup2Address;
+export declare function KenyaNidLookup2AddressToJSON(json: any): KenyaNidLookup2Address;
+export declare function KenyaNidLookup2AddressToJSONTyped(value?: KenyaNidLookup2Address | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/KenyaNidLookup2Address.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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 KenyaNidLookup2Address interface.
+ */
+export function instanceOfKenyaNidLookup2Address(value) {
+    return true;
+}
+export function KenyaNidLookup2AddressFromJSON(json) {
+    return KenyaNidLookup2AddressFromJSONTyped(json, false);
+}
+export function KenyaNidLookup2AddressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'district': json['district'] == null ? undefined : json['district'],
+        'division': json['division'] == null ? undefined : json['division'],
+        'location': json['location'] == null ? undefined : json['location'],
+        'additionalLines': json['additionalLines'] == null ? undefined : json['additionalLines'],
+        'raw': json['raw'] == null ? undefined : json['raw'],
+    };
+}
+export function KenyaNidLookup2AddressToJSON(json) {
+    return KenyaNidLookup2AddressToJSONTyped(json, false);
+}
+export function KenyaNidLookup2AddressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'district': value['district'],
+        'division': value['division'],
+        'location': value['location'],
+        'additionalLines': value['additionalLines'],
+        'raw': value['raw'],
+    };
+}

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

@@ -0,0 +1,114 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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 { KenyaNidLookup2Address } from './KenyaNidLookup2Address';
+/**
+ * Exposed properties for the `kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface KenyaNidLookup2ProviderOutput
+ */
+export interface KenyaNidLookup2ProviderOutput {
+    /**
+     * The first name (given name) of the ID holder as recorded in IPRS.
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    firstName: string;
+    /**
+     * The surname (family name) of the ID holder as recorded in IPRS.
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    surname: string;
+    /**
+     * The other name (middle name) of the ID holder as recorded in IPRS.
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    otherName?: string | null;
+    /**
+     * The sex of the ID holder as recorded on the National ID.
+     *
+     * Possible values:
+     * - Male
+     * - Female
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    sex: string;
+    /**
+     * The date of birth of the ID holder as recorded in IPRS.
+     * @type {Date}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * Citizenship status as recorded in the IPRS civil registry database.
+     *
+     * For the Kenya National ID lookup, this value will always be "Kenyan" as the National ID is only
+     * issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification
+     * documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider.
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    citizenship: string;
+    /**
+     * The Kenya National ID Number (Nambari ya Kitambulisho).
+     *
+     * This is the primary unique identifier for Kenyan citizens in all government systems, issued by
+     * the National Registration Bureau (NRB). The format is 1 to 9 numeric digits (regex: /^[0-9]{1,9}$/).
+     * This number is assigned upon first registration at age 18 (or upon naturalization for new citizens)
+     * and remains constant for life.
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    idNumber: string;
+    /**
+     * The physical card serial number printed on the Kenya National ID card.
+     *
+     * This is distinct from the ID Number and serves as a card issuance tracking identifier maintained
+     * by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal).
+     * @type {string}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    serialNumber: string;
+    /**
+     * The date the National ID was issued by the National Registration Bureau (NRB).
+     * @type {Date}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    dateOfIssue?: Date | null;
+    /**
+     * Place of birth as recorded in Kenya's civil registry (IPRS).
+     *
+     * This is structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location).
+     * @type {KenyaNidLookup2Address}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    placeOfBirth?: KenyaNidLookup2Address | null;
+    /**
+     * Current residence address as registered in IPRS.
+     *
+     * This represents the address on file at the time of ID registration or last update, structured
+     * according to Kenya's pre-2010 administrative hierarchy (District > Division > Location).
+     * @type {KenyaNidLookup2Address}
+     * @memberof KenyaNidLookup2ProviderOutput
+     */
+    placeOfResidence?: KenyaNidLookup2Address | null;
+}
+/**
+ * Check if a given object implements the KenyaNidLookup2ProviderOutput interface.
+ */
+export declare function instanceOfKenyaNidLookup2ProviderOutput(value: object): value is KenyaNidLookup2ProviderOutput;
+export declare function KenyaNidLookup2ProviderOutputFromJSON(json: any): KenyaNidLookup2ProviderOutput;
+export declare function KenyaNidLookup2ProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): KenyaNidLookup2ProviderOutput;
+export declare function KenyaNidLookup2ProviderOutputToJSON(json: any): KenyaNidLookup2ProviderOutput;
+export declare function KenyaNidLookup2ProviderOutputToJSONTyped(value?: KenyaNidLookup2ProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/KenyaNidLookup2ProviderOutput.js

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { KenyaNidLookup2AddressFromJSON, KenyaNidLookup2AddressToJSON, } from './KenyaNidLookup2Address';
+/**
+ * Check if a given object implements the KenyaNidLookup2ProviderOutput interface.
+ */
+export function instanceOfKenyaNidLookup2ProviderOutput(value) {
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('surname' in value) || value['surname'] === undefined)
+        return false;
+    if (!('sex' in value) || value['sex'] === undefined)
+        return false;
+    if (!('citizenship' in value) || value['citizenship'] === undefined)
+        return false;
+    if (!('idNumber' in value) || value['idNumber'] === undefined)
+        return false;
+    if (!('serialNumber' in value) || value['serialNumber'] === undefined)
+        return false;
+    return true;
+}
+export function KenyaNidLookup2ProviderOutputFromJSON(json) {
+    return KenyaNidLookup2ProviderOutputFromJSONTyped(json, false);
+}
+export function KenyaNidLookup2ProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['firstName'],
+        'surname': json['surname'],
+        'otherName': json['otherName'] == null ? undefined : json['otherName'],
+        'sex': json['sex'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'citizenship': json['citizenship'],
+        'idNumber': json['idNumber'],
+        'serialNumber': json['serialNumber'],
+        'dateOfIssue': json['dateOfIssue'] == null ? undefined : (new Date(json['dateOfIssue'])),
+        'placeOfBirth': json['placeOfBirth'] == null ? undefined : KenyaNidLookup2AddressFromJSON(json['placeOfBirth']),
+        'placeOfResidence': json['placeOfResidence'] == null ? undefined : KenyaNidLookup2AddressFromJSON(json['placeOfResidence']),
+    };
+}
+export function KenyaNidLookup2ProviderOutputToJSON(json) {
+    return KenyaNidLookup2ProviderOutputToJSONTyped(json, false);
+}
+export function KenyaNidLookup2ProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'firstName': value['firstName'],
+        'surname': value['surname'],
+        'otherName': value['otherName'],
+        'sex': value['sex'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'citizenship': value['citizenship'],
+        'idNumber': value['idNumber'],
+        'serialNumber': value['serialNumber'],
+        'dateOfIssue': value['dateOfIssue'] == null ? undefined : (value['dateOfIssue'].toISOString().substring(0, 10)),
+        'placeOfBirth': KenyaNidLookup2AddressToJSON(value['placeOfBirth']),
+        'placeOfResidence': KenyaNidLookup2AddressToJSON(value['placeOfResidence']),
+    };
+}

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

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { SexV1 } from './SexV1';
+import type { KenyaNidMatch2InputSex } from './KenyaNidMatch2InputSex';
 /**
  *
  * @export
@@ -48,10 +48,10 @@ export interface KenyaNidMatch2Input {
     dateOfBirth?: Date | null;
     /**
      * The user's sex as it appears in their National ID
-     * @type {SexV1}
+     * @type {KenyaNidMatch2InputSex}
      * @memberof KenyaNidMatch2Input
      */
-    sex?: SexV1 | null;
+    sex?: KenyaNidMatch2InputSex | null;
 }
 /**
  * Check if a given object implements the KenyaNidMatch2Input interface.

package/dist/esm/models/KenyaNidMatch2Input.js

@@ -11,7 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { SexV1FromJSON, SexV1ToJSON, } from './SexV1';
+import { KenyaNidMatch2InputSexFromJSON, KenyaNidMatch2InputSexToJSON, } from './KenyaNidMatch2InputSex';
 /**
  * Check if a given object implements the KenyaNidMatch2Input interface.
  */
@@ -31,7 +31,7 @@ export function KenyaNidMatch2InputFromJSONTyped(json, ignoreDiscriminator) {
         'familyName': json['familyName'] == null ? undefined : json['familyName'],
         'middleName': json['middleName'] == null ? undefined : json['middleName'],
         'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
-        'sex': json['sex'] == null ? undefined : SexV1FromJSON(json['sex']),
+        'sex': json['sex'] == null ? undefined : KenyaNidMatch2InputSexFromJSON(json['sex']),
     };
 }
 export function KenyaNidMatch2InputToJSON(json) {
@@ -47,6 +47,6 @@ export function KenyaNidMatch2InputToJSONTyped(value, ignoreDiscriminator = fals
         'familyName': value['familyName'],
         'middleName': value['middleName'],
         'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
-        'sex': SexV1ToJSON(value['sex']),
+        'sex': KenyaNidMatch2InputSexToJSON(value['sex']),
     };
 }

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

@@ -0,0 +1,25 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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 declare const KenyaNidMatch2InputSex: {
+    readonly Male: "Male";
+    readonly Female: "Female";
+};
+export type KenyaNidMatch2InputSex = typeof KenyaNidMatch2InputSex[keyof typeof KenyaNidMatch2InputSex];
+export declare function instanceOfKenyaNidMatch2InputSex(value: any): boolean;
+export declare function KenyaNidMatch2InputSexFromJSON(json: any): KenyaNidMatch2InputSex;
+export declare function KenyaNidMatch2InputSexFromJSONTyped(json: any, ignoreDiscriminator: boolean): KenyaNidMatch2InputSex;
+export declare function KenyaNidMatch2InputSexToJSON(value?: KenyaNidMatch2InputSex | null): any;
+export declare function KenyaNidMatch2InputSexToJSONTyped(value: any, ignoreDiscriminator: boolean): KenyaNidMatch2InputSex;

package/dist/esm/models/KenyaNidMatch2InputSex.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * 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 KenyaNidMatch2InputSex = {
+    Male: 'Male',
+    Female: 'Female'
+};
+export function instanceOfKenyaNidMatch2InputSex(value) {
+    for (const key in KenyaNidMatch2InputSex) {
+        if (Object.prototype.hasOwnProperty.call(KenyaNidMatch2InputSex, key)) {
+            if (KenyaNidMatch2InputSex[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function KenyaNidMatch2InputSexFromJSON(json) {
+    return KenyaNidMatch2InputSexFromJSONTyped(json, false);
+}
+export function KenyaNidMatch2InputSexFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function KenyaNidMatch2InputSexToJSON(value) {
+    return value;
+}
+export function KenyaNidMatch2InputSexToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,148 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Exposed properties for the `usa-louisiana-wallet` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface LaWalletProviderOutput
+ */
+export interface LaWalletProviderOutput {
+    /**
+     * The number of the driver's license used to create the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    driversLicenseNumber: string;
+    /**
+     * The issue date of the driver's license used to create the LA Wallet credential
+     * @type {Date}
+     * @memberof LaWalletProviderOutput
+     */
+    issueDate: Date;
+    /**
+     * The expiration date of the driver's license used to create the LA Wallet credential
+     * @type {Date}
+     * @memberof LaWalletProviderOutput
+     */
+    expirationDate: Date;
+    /**
+     * The 4-digit audit number of the driver's license used to create the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    auditNumber: string;
+    /**
+     * The license status from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    licenseStatus: string;
+    /**
+     * The license class from the LA Wallet credential
+     *
+     * Possible values:
+     * - "A": Commercial Driver's License, Combination Vehicles
+     * - "B": Commercial Driver's License, Heavy Straight Vehicle
+     * - "C": Commercial Driver's License, Light Straight Vehicle
+     * - "D": Chauffeur's Driver's License
+     * - "E": Driver's License for Personal Vehicle
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    licenseClass: string;
+    /**
+     * The first name from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    firstName: string;
+    /**
+     * The middle name from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    middleName: string;
+    /**
+     * The last name from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth from the LA Wallet credential
+     * @type {Date}
+     * @memberof LaWalletProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The sex from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    sex: string;
+    /**
+     * The address' line 1 from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    addressLine1: string;
+    /**
+     * The address' line 2 from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    addressLine2?: string | null;
+    /**
+     * The address' city from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    addressCity: string;
+    /**
+     * The address' state from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    addressState: string;
+    /**
+     * The address' ZIP from the LA Wallet credential
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    addressZip: string;
+    /**
+     * The county ("parish") code from the LA Wallet credential.
+     *
+     * This is a number from 1 to 64, representing one of Louisiana's 64 parishes.
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    county: string;
+    /**
+     * The coarse age returned by LA Wallet for this credential
+     *
+     * Possible values:
+     * - "Under 18"
+     * - "Under 21"
+     * - "Over 21"
+     * @type {string}
+     * @memberof LaWalletProviderOutput
+     */
+    coarseAge: string;
+}
+/**
+ * Check if a given object implements the LaWalletProviderOutput interface.
+ */
+export declare function instanceOfLaWalletProviderOutput(value: object): value is LaWalletProviderOutput;
+export declare function LaWalletProviderOutputFromJSON(json: any): LaWalletProviderOutput;
+export declare function LaWalletProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LaWalletProviderOutput;
+export declare function LaWalletProviderOutputToJSON(json: any): LaWalletProviderOutput;
+export declare function LaWalletProviderOutputToJSONTyped(value?: LaWalletProviderOutput | null, ignoreDiscriminator?: boolean): any;