@trinsic/api 2.3.0-alpha2 → 3.0.1

package/src/models/SmartIdProviderOutput.ts

@@ -0,0 +1,232 @@
+/* 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 `smart-id` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface SmartIdProviderOutput
+ */
+export interface SmartIdProviderOutput {
+    /**
+     * The given name (first name) of the individual, extracted from the Smart ID
+     * authentication certificate's Subject Distinguished Name "G" (givenName) attribute.
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name (surname) of the individual, extracted from the Smart ID
+     * authentication certificate's Subject Distinguished Name "SN" (surname) attribute.
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The individual's date of birth, derived from the personal code.
+     *             
+     * NOTE: Newer Latvian personal codes starting with "32" do not contain
+     * date of birth information.
+     * @type {Date}
+     * @memberof SmartIdProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The individual's sex, derived from the first digit of the personal code.
+     *             
+     * NOTE: Not available for Latvian personal codes.
+     *             
+     * Possible values:
+     * - Male
+     * - Female
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    sex?: string | null;
+    /**
+     * The ISO 3166-1 alpha-2 country code extracted from the Smart 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 Smart ID, this will be "EE" (Estonia), "LT" (Lithuania), or
+     * "LV" (Latvia).
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    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 SmartIdProviderOutput
+     */
+    identityType?: string | null;
+    /**
+     * The personal code (Estonian: isikukood, Lithuanian: asmens kodas, Latvian: personas kods)
+     * of the individual, extracted from the SERIALNUMBER field of the Smart ID authentication
+     * certificate. This is the portion after the identity type and country prefix
+     * (e.g., "48501010014" from "PNOEE-48501010014").
+     *             
+     * 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
+     *             
+     * Latvian personal codes use the format DDMMYY-NNNNN (6 digits, a dash, and 5 digits).
+     *             
+     * See:
+     * - https://en.wikipedia.org/wiki/National_identification_number#Estonia
+     * - https://en.wikipedia.org/wiki/National_identification_number#Lithuania
+     * - https://en.wikipedia.org/wiki/National_identification_number#Latvia
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    personalCode?: string | null;
+    /**
+     * The SERIALNUMBER attribute from the Smart 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, LV)
+     * - identifier: The personal code
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    serialNumber?: string | null;
+    /**
+     * The full Subject Distinguished Name (Subject DN) from the Smart 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 SmartIdProviderOutput
+     */
+    certificateSubject?: string | null;
+    /**
+     * The certificate level indicating the authentication assurance level.
+     *             
+     * Possible values:
+     * - QUALIFIED: Highest assurance level (eIDAS QES - Qualified Electronic Signature),
+     *   legally equivalent to a handwritten signature. This is the standard production level.
+     * - ADVANCED: Lower assurance level (eIDAS AdES), also called "Smart-ID Basic".
+     *   Only available in test environments for test accounts.
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    certificateLevel?: string | null;
+    /**
+     * A unique identifier for the Smart ID account/document used for this authentication.
+     * Format: PNO{CC}-{personal-code}-{device-id}-{qualification}
+     *             
+     * Components:
+     * - PNO = Personal Number (identity type)
+     * - CC = Country code (EE, LT, LV)
+     * - personal-code = The individual's personal code
+     * - device-id = Random 4-character device identifier
+     * - qualification = NQ (non-qualified) or Q (qualified certificate)
+     *             
+     * This is a stable identifier that can be used to recognize returning users across sessions.
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    documentNumber?: string | null;
+    /**
+     * Indicates which interaction flow was used during the Smart ID authentication process.
+     * This reflects which of the allowedInteractionsOrder options was actually used.
+     *             
+     * Possible values:
+     * - displayTextAndPIN: User saw text and entered PIN
+     * - verificationCodeChoice: User selected from multiple verification codes
+     * - confirmationMessage: User confirmed a message
+     * - confirmationMessageAndVerificationCodeChoice: Combination of both
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    interactionFlowUsed?: string | null;
+    /**
+     * The IP address of the device where the Smart ID app was used for authentication.
+     * Can be IPv4 or IPv6 format.
+     * @type {string}
+     * @memberof SmartIdProviderOutput
+     */
+    deviceIpAddress?: string | null;
+}
+
+/**
+ * Check if a given object implements the SmartIdProviderOutput interface.
+ */
+export function instanceOfSmartIdProviderOutput(value: object): value is SmartIdProviderOutput {
+    return true;
+}
+
+export function SmartIdProviderOutputFromJSON(json: any): SmartIdProviderOutput {
+    return SmartIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function SmartIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmartIdProviderOutput {
+    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'],
+        'certificateLevel': json['certificateLevel'] == null ? undefined : json['certificateLevel'],
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'interactionFlowUsed': json['interactionFlowUsed'] == null ? undefined : json['interactionFlowUsed'],
+        'deviceIpAddress': json['deviceIpAddress'] == null ? undefined : json['deviceIpAddress'],
+    };
+}
+
+export function SmartIdProviderOutputToJSON(json: any): SmartIdProviderOutput {
+    return SmartIdProviderOutputToJSONTyped(json, false);
+}
+
+export function SmartIdProviderOutputToJSONTyped(value?: SmartIdProviderOutput | 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'],
+        'certificateLevel': value['certificateLevel'],
+        'documentNumber': value['documentNumber'],
+        'interactionFlowUsed': value['interactionFlowUsed'],
+        'deviceIpAddress': value['deviceIpAddress'],
+    };
+}
+

package/src/models/SouthAfricaNidBiometric2Input.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 SouthAfricaNidBiometric2Input
+ */
+export interface SouthAfricaNidBiometric2Input {
+    /**
+     * The user's South African National ID number
+     * @type {string}
+     * @memberof SouthAfricaNidBiometric2Input
+     */
+    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 SouthAfricaNidBiometric2Input
+     */
+    livenessImages?: Array<string> | null;
+    /**
+     * Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
+     * @type {string}
+     * @memberof SouthAfricaNidBiometric2Input
+     */
+    testSelfie?: string | null;
+}
+
+/**
+ * Check if a given object implements the SouthAfricaNidBiometric2Input interface.
+ */
+export function instanceOfSouthAfricaNidBiometric2Input(value: object): value is SouthAfricaNidBiometric2Input {
+    return true;
+}
+
+export function SouthAfricaNidBiometric2InputFromJSON(json: any): SouthAfricaNidBiometric2Input {
+    return SouthAfricaNidBiometric2InputFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidBiometric2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidBiometric2Input {
+    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 SouthAfricaNidBiometric2InputToJSON(json: any): SouthAfricaNidBiometric2Input {
+    return SouthAfricaNidBiometric2InputToJSONTyped(json, false);
+}
+
+export function SouthAfricaNidBiometric2InputToJSONTyped(value?: SouthAfricaNidBiometric2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+        'livenessImages': value['livenessImages'],
+        'testSelfie': value['testSelfie'],
+    };
+}
+

package/src/models/SouthAfricaNidMatch2Input.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 { SouthAfricaNidMatch2InputSex } from './SouthAfricaNidMatch2InputSex';
+import {
+    SouthAfricaNidMatch2InputSexFromJSON,
+    SouthAfricaNidMatch2InputSexFromJSONTyped,
+    SouthAfricaNidMatch2InputSexToJSON,
+    SouthAfricaNidMatch2InputSexToJSONTyped,
+} from './SouthAfricaNidMatch2InputSex';
+
+/**
+ * 
+ * @export
+ * @interface SouthAfricaNidMatch2Input
+ */
+export interface SouthAfricaNidMatch2Input {
+    /**
+     * The user's South African National ID number
+     * @type {string}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    idNumber?: string | null;
+    /**
+     * The user's first name as it appears in their National ID
+     * @type {string}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    givenName?: string | null;
+    /**
+     * The user's last name as it appears in their National ID
+     * @type {string}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    familyName?: string | null;
+    /**
+     * The user's middle name as it appears in their National ID (optional)
+     * @type {string}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    middleName?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The user's sex as it appears in their National ID
+     * @type {SouthAfricaNidMatch2InputSex}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    sex?: SouthAfricaNidMatch2InputSex | null;
+    /**
+     * The user's phone number as it appears in their National ID (optional).
+     * Must be in E.164 international format: "+27XXXXXXXXX"
+     * @type {string}
+     * @memberof SouthAfricaNidMatch2Input
+     */
+    phoneNumber?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the SouthAfricaNidMatch2Input interface.
+ */
+export function instanceOfSouthAfricaNidMatch2Input(value: object): value is SouthAfricaNidMatch2Input {
+    return true;
+}
+
+export function SouthAfricaNidMatch2InputFromJSON(json: any): SouthAfricaNidMatch2Input {
+    return SouthAfricaNidMatch2InputFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidMatch2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidMatch2Input {
+    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 : SouthAfricaNidMatch2InputSexFromJSON(json['sex']),
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+    };
+}
+
+export function SouthAfricaNidMatch2InputToJSON(json: any): SouthAfricaNidMatch2Input {
+    return SouthAfricaNidMatch2InputToJSONTyped(json, false);
+}
+
+export function SouthAfricaNidMatch2InputToJSONTyped(value?: SouthAfricaNidMatch2Input | 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': SouthAfricaNidMatch2InputSexToJSON(value['sex']),
+        'phoneNumber': value['phoneNumber'],
+    };
+}
+

package/src/models/SouthAfricaNidMatch2InputSex.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 SouthAfricaNidMatch2InputSex = {
+    Male: 'Male',
+    Female: 'Female'
+} as const;
+export type SouthAfricaNidMatch2InputSex = typeof SouthAfricaNidMatch2InputSex[keyof typeof SouthAfricaNidMatch2InputSex];
+
+
+export function instanceOfSouthAfricaNidMatch2InputSex(value: any): boolean {
+    for (const key in SouthAfricaNidMatch2InputSex) {
+        if (Object.prototype.hasOwnProperty.call(SouthAfricaNidMatch2InputSex, key)) {
+            if (SouthAfricaNidMatch2InputSex[key as keyof typeof SouthAfricaNidMatch2InputSex] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SouthAfricaNidMatch2InputSexFromJSON(json: any): SouthAfricaNidMatch2InputSex {
+    return SouthAfricaNidMatch2InputSexFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidMatch2InputSexFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidMatch2InputSex {
+    return json as SouthAfricaNidMatch2InputSex;
+}
+
+export function SouthAfricaNidMatch2InputSexToJSON(value?: SouthAfricaNidMatch2InputSex | null): any {
+    return value as any;
+}
+
+export function SouthAfricaNidMatch2InputSexToJSONTyped(value: any, ignoreDiscriminator: boolean): SouthAfricaNidMatch2InputSex {
+    return value as SouthAfricaNidMatch2InputSex;
+}
+