@trinsic/api 2.3.0-alpha2 → 3.0.0

package/src/models/MobileIdProviderOutput.ts

@@ -0,0 +1,167 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Exposed properties for the `mobile-id` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface MobileIdProviderOutput
+ */
+export interface MobileIdProviderOutput {
+    /**
+     * The given name of the individual, extracted from the Mobile ID authentication
+     * certificate's Subject Distinguished Name "G" (givenName) attribute.
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name (surname) of the individual, extracted from the Mobile ID
+     * authentication certificate's Subject Distinguished Name "SN" (surname) attribute.
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The individual's date of birth, derived from the personal code.
+     * @type {Date}
+     * @memberof MobileIdProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The individual's sex, derived from the first digit of the personal code.
+     *             
+     * Possible values:
+     * - Male
+     * - Female
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    sex?: string | null;
+    /**
+     * The ISO 3166-1 alpha-2 country code extracted from the Mobile ID authentication
+     * certificate's Subject Distinguished Name "C" (country) attribute.
+     *             
+     * This represents the country of the certificate issuer, not the person's nationality
+     * or citizenship. For Mobile ID, this will be "EE" (Estonia) or "LT" (Lithuania).
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    country?: string | null;
+    /**
+     * The identity document type, extracted from the first 3 characters of the
+     * SERIALNUMBER field (before the country code).
+     *             
+     * Possible values:
+     * - PNO: Personal Number (national civic registration number)
+     * - PAS: Passport
+     * - IDC: National identity card
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    identityType?: string | null;
+    /**
+     * The personal code (Estonian: isikukood, Lithuanian: asmens kodas) of the individual,
+     * extracted from the SERIALNUMBER field of the Mobile ID authentication certificate.
+     * This is the portion after the identity type and country prefix
+     * (e.g., "48501010014" from "PNOEE-48501010014").
+     *             
+     * Both Estonian and Lithuanian personal codes are 11 digits in the format GYYMMDDSSSC where:
+     * - G = century/gender (3-4 = 1900s, 5-6 = 2000s; odd = male, even = female)
+     * - YYMMDD = date of birth
+     * - SSS = sequence number
+     * - C = checksum digit
+     *             
+     * See:
+     * - https://en.wikipedia.org/wiki/National_identification_number#Estonia
+     * - https://en.wikipedia.org/wiki/National_identification_number#Lithuania
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    personalCode?: string | null;
+    /**
+     * The SERIALNUMBER attribute from the Mobile ID authentication certificate's Subject
+     * Distinguished Name. Format: "{identity-type}{country-code}-{identifier}"
+     *             
+     * Components:
+     * - identity-type (3 chars): PNO (Personal Number), PAS (Passport), IDC (ID Card)
+     * - country-code (2 chars): ISO 3166-1 alpha-2 (EE, LT)
+     * - identifier: The personal code
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    serialNumber?: string | null;
+    /**
+     * The full Subject Distinguished Name (Subject DN) from the Mobile ID
+     * authentication certificate. Contains comma-separated RDN (Relative Distinguished Name)
+     * components including C (Country), CN (Common Name), SN (Surname), G (Given Name),
+     * and SERIALNUMBER (Personal identifier).
+     * @type {string}
+     * @memberof MobileIdProviderOutput
+     */
+    certificateSubject?: string | null;
+}
+
+/**
+ * Check if a given object implements the MobileIdProviderOutput interface.
+ */
+export function instanceOfMobileIdProviderOutput(value: object): value is MobileIdProviderOutput {
+    return true;
+}
+
+export function MobileIdProviderOutputFromJSON(json: any): MobileIdProviderOutput {
+    return MobileIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function MobileIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): MobileIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'sex': json['sex'] == null ? undefined : json['sex'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'identityType': json['identityType'] == null ? undefined : json['identityType'],
+        'personalCode': json['personalCode'] == null ? undefined : json['personalCode'],
+        'serialNumber': json['serialNumber'] == null ? undefined : json['serialNumber'],
+        'certificateSubject': json['certificateSubject'] == null ? undefined : json['certificateSubject'],
+    };
+}
+
+export function MobileIdProviderOutputToJSON(json: any): MobileIdProviderOutput {
+    return MobileIdProviderOutputToJSONTyped(json, false);
+}
+
+export function MobileIdProviderOutputToJSONTyped(value?: MobileIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'sex': value['sex'],
+        'country': value['country'],
+        'identityType': value['identityType'],
+        'personalCode': value['personalCode'],
+        'serialNumber': value['serialNumber'],
+        'certificateSubject': value['certificateSubject'],
+    };
+}
+

package/src/models/NigeriaNinBiometric2Input.ts

@@ -0,0 +1,84 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NigeriaNinBiometric2Input
+ */
+export interface NigeriaNinBiometric2Input {
+    /**
+     * The user's Nigerian National ID number (NIN)
+     * @type {string}
+     * @memberof NigeriaNinBiometric2Input
+     */
+    idNumber?: string | null;
+    /**
+     * An array of exactly 8 images required for biometric liveness verification.
+     * The first 7 images should be liveness frames captured during the liveness detection process,
+     * and the last image (8th) should be a selfie of the user. All images must be in JPEG format
+     * and each image must be less than 15MB in size.
+     * @type {Array<string>}
+     * @memberof NigeriaNinBiometric2Input
+     */
+    livenessImages?: Array<string> | null;
+    /**
+     * Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
+     * @type {string}
+     * @memberof NigeriaNinBiometric2Input
+     */
+    testSelfie?: string | null;
+}
+
+/**
+ * Check if a given object implements the NigeriaNinBiometric2Input interface.
+ */
+export function instanceOfNigeriaNinBiometric2Input(value: object): value is NigeriaNinBiometric2Input {
+    return true;
+}
+
+export function NigeriaNinBiometric2InputFromJSON(json: any): NigeriaNinBiometric2Input {
+    return NigeriaNinBiometric2InputFromJSONTyped(json, false);
+}
+
+export function NigeriaNinBiometric2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinBiometric2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+        'livenessImages': json['livenessImages'] == null ? undefined : json['livenessImages'],
+        'testSelfie': json['testSelfie'] == null ? undefined : json['testSelfie'],
+    };
+}
+
+export function NigeriaNinBiometric2InputToJSON(json: any): NigeriaNinBiometric2Input {
+    return NigeriaNinBiometric2InputToJSONTyped(json, false);
+}
+
+export function NigeriaNinBiometric2InputToJSONTyped(value?: NigeriaNinBiometric2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+        'livenessImages': value['livenessImages'],
+        'testSelfie': value['testSelfie'],
+    };
+}
+

package/src/models/NigeriaNinLookup2Input.ts

@@ -0,0 +1,65 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NigeriaNinLookup2Input
+ */
+export interface NigeriaNinLookup2Input {
+    /**
+     * The user's National ID number (NIN)
+     * @type {string}
+     * @memberof NigeriaNinLookup2Input
+     */
+    idNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the NigeriaNinLookup2Input interface.
+ */
+export function instanceOfNigeriaNinLookup2Input(value: object): value is NigeriaNinLookup2Input {
+    return true;
+}
+
+export function NigeriaNinLookup2InputFromJSON(json: any): NigeriaNinLookup2Input {
+    return NigeriaNinLookup2InputFromJSONTyped(json, false);
+}
+
+export function NigeriaNinLookup2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinLookup2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+    };
+}
+
+export function NigeriaNinLookup2InputToJSON(json: any): NigeriaNinLookup2Input {
+    return NigeriaNinLookup2InputToJSONTyped(json, false);
+}
+
+export function NigeriaNinLookup2InputToJSONTyped(value?: NigeriaNinLookup2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+    };
+}
+

package/src/models/NigeriaNinMatch2Input.ts

@@ -0,0 +1,124 @@
+/* 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 { mapValues } from '../runtime';
+import type { NigeriaNinMatch2InputSex } from './NigeriaNinMatch2InputSex';
+import {
+    NigeriaNinMatch2InputSexFromJSON,
+    NigeriaNinMatch2InputSexFromJSONTyped,
+    NigeriaNinMatch2InputSexToJSON,
+    NigeriaNinMatch2InputSexToJSONTyped,
+} from './NigeriaNinMatch2InputSex';
+
+/**
+ * 
+ * @export
+ * @interface NigeriaNinMatch2Input
+ */
+export interface NigeriaNinMatch2Input {
+    /**
+     * The user's Nigerian National ID number (NIN)
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    idNumber?: string | null;
+    /**
+     * The user's first name as it appears in their National ID
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    givenName?: string | null;
+    /**
+     * The user's last name as it appears in their National ID
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    familyName?: string | null;
+    /**
+     * The user's middle name as it appears in their National ID (optional)
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    middleName?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof NigeriaNinMatch2Input
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The user's sex as it appears in their National ID
+     * @type {NigeriaNinMatch2InputSex}
+     * @memberof NigeriaNinMatch2Input
+     */
+    sex?: NigeriaNinMatch2InputSex | null;
+    /**
+     * The user's phone number as it appears in their National ID (optional).
+     * Must be in E.164 international format: "+234XXXXXXXXX"
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    phoneNumber?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the NigeriaNinMatch2Input interface.
+ */
+export function instanceOfNigeriaNinMatch2Input(value: object): value is NigeriaNinMatch2Input {
+    return true;
+}
+
+export function NigeriaNinMatch2InputFromJSON(json: any): NigeriaNinMatch2Input {
+    return NigeriaNinMatch2InputFromJSONTyped(json, false);
+}
+
+export function NigeriaNinMatch2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinMatch2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        '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 : NigeriaNinMatch2InputSexFromJSON(json['sex']),
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+    };
+}
+
+export function NigeriaNinMatch2InputToJSON(json: any): NigeriaNinMatch2Input {
+    return NigeriaNinMatch2InputToJSONTyped(json, false);
+}
+
+export function NigeriaNinMatch2InputToJSONTyped(value?: NigeriaNinMatch2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'middleName': value['middleName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'sex': NigeriaNinMatch2InputSexToJSON(value['sex']),
+        'phoneNumber': value['phoneNumber'],
+    };
+}
+

package/src/models/NigeriaNinMatch2InputSex.ts

@@ -0,0 +1,53 @@
+/* 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 NigeriaNinMatch2InputSex = {
+    Male: 'Male',
+    Female: 'Female'
+} as const;
+export type NigeriaNinMatch2InputSex = typeof NigeriaNinMatch2InputSex[keyof typeof NigeriaNinMatch2InputSex];
+
+
+export function instanceOfNigeriaNinMatch2InputSex(value: any): boolean {
+    for (const key in NigeriaNinMatch2InputSex) {
+        if (Object.prototype.hasOwnProperty.call(NigeriaNinMatch2InputSex, key)) {
+            if (NigeriaNinMatch2InputSex[key as keyof typeof NigeriaNinMatch2InputSex] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function NigeriaNinMatch2InputSexFromJSON(json: any): NigeriaNinMatch2InputSex {
+    return NigeriaNinMatch2InputSexFromJSONTyped(json, false);
+}
+
+export function NigeriaNinMatch2InputSexFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinMatch2InputSex {
+    return json as NigeriaNinMatch2InputSex;
+}
+
+export function NigeriaNinMatch2InputSexToJSON(value?: NigeriaNinMatch2InputSex | null): any {
+    return value as any;
+}
+
+export function NigeriaNinMatch2InputSexToJSONTyped(value: any, ignoreDiscriminator: boolean): NigeriaNinMatch2InputSex {
+    return value as NigeriaNinMatch2InputSex;
+}
+

package/src/models/PersonData.ts

@@ -29,37 +29,39 @@ import {
 } from './Sex';
 
 /**
- * 
+ * Identity information for the individual being verified
  * @export
  * @interface PersonData
  */
 export interface PersonData {
     /**
-     * 
+     * Given (first) name of the individual
      * @type {string}
      * @memberof PersonData
      */
     givenName?: string | null;
     /**
-     * 
+     * Family (last) name of the individual
      * @type {string}
      * @memberof PersonData
      */
     familyName?: string | null;
     /**
-     * 
+     * Middle name of the individual
      * @type {string}
      * @memberof PersonData
      */
     middleName?: string | null;
     /**
-     * 
+     * The individual's full name as a single string.
+     *             
+     * Useful for names which do not fit into a "first middle last" structure.
      * @type {string}
      * @memberof PersonData
      */
     fullName?: string | null;
     /**
-     * 
+     * Suffix of the individual's name
      * @type {string}
      * @memberof PersonData
      */
@@ -83,7 +85,7 @@ export interface PersonData {
      */
     phoneNumber?: string | null;
     /**
-     * 
+     * Address information for an individual
      * @type {Address}
      * @memberof PersonData
      */

package/src/models/PeruDniAddress.ts

@@ -0,0 +1,93 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Not a typical address. Does not include street or city. Instead, includes region, province and district.
+ * @export
+ * @interface PeruDniAddress
+ */
+export interface PeruDniAddress {
+    /**
+     * Region in Peru (also known as department). This is the first level subdivision in the country.
+     *             
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    region: string;
+    /**
+     * Province within the region. This is the second level subdivision in the country.
+     *             
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    province: string;
+    /**
+     * District within the province. This is the third level subdivision in the country.
+     *             
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    district: string;
+}
+
+/**
+ * Check if a given object implements the PeruDniAddress interface.
+ */
+export function instanceOfPeruDniAddress(value: object): value is PeruDniAddress {
+    if (!('region' in value) || value['region'] === undefined) return false;
+    if (!('province' in value) || value['province'] === undefined) return false;
+    if (!('district' in value) || value['district'] === undefined) return false;
+    return true;
+}
+
+export function PeruDniAddressFromJSON(json: any): PeruDniAddress {
+    return PeruDniAddressFromJSONTyped(json, false);
+}
+
+export function PeruDniAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): PeruDniAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'region': json['region'],
+        'province': json['province'],
+        'district': json['district'],
+    };
+}
+
+export function PeruDniAddressToJSON(json: any): PeruDniAddress {
+    return PeruDniAddressToJSONTyped(json, false);
+}
+
+export function PeruDniAddressToJSONTyped(value?: PeruDniAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'region': value['region'],
+        'province': value['province'],
+        'district': value['district'],
+    };
+}
+