@trinsic/api 3.0.1 → 3.1.0-preview1

package/src/models/DigilockerAadhaarProviderOutput.ts

@@ -0,0 +1,135 @@
+/* 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 { AadhaarLocalizedClaims } from './AadhaarLocalizedClaims';
+import {
+    AadhaarLocalizedClaimsFromJSON,
+    AadhaarLocalizedClaimsFromJSONTyped,
+    AadhaarLocalizedClaimsToJSON,
+    AadhaarLocalizedClaimsToJSONTyped,
+} from './AadhaarLocalizedClaims';
+import type { AadhaarClaims } from './AadhaarClaims';
+import {
+    AadhaarClaimsFromJSON,
+    AadhaarClaimsFromJSONTyped,
+    AadhaarClaimsToJSON,
+    AadhaarClaimsToJSONTyped,
+} from './AadhaarClaims';
+
+/**
+ * Exposed properties for the `india-digilocker-aadhaar` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface DigilockerAadhaarProviderOutput
+ */
+export interface DigilockerAadhaarProviderOutput {
+    /**
+     * The document type from which the identity data was retrieved.
+     * @type {string}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    documentType?: string | null;
+    /**
+     * The timestamp when the signed document was generated and verified.
+     * @type {Date}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    timestamp?: Date | null;
+    /**
+     * The validity expiration timestamp for the verification document.
+     * @type {Date}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    timeToLive?: Date | null;
+    /**
+     * The Aadhaar number (UID) value for the individual.
+     *             
+     * This is only the last four digits of the Aadhaar number.
+     * @type {string}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    aadhaarNumberLastFour?: string | null;
+    /**
+     * The claims extracted from the Aadhaar document.
+     * @type {AadhaarClaims}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    claims?: AadhaarClaims | null;
+    /**
+     * The localized claims extracted from the Aadhaar document.
+     * @type {AadhaarLocalizedClaims}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    localizedClaims?: AadhaarLocalizedClaims | null;
+    /**
+     * Whether our own validation of the Aadhaar document signature and certificate chain succeeded.
+     *             
+     * When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain.
+     * When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also
+     * supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation.
+     * @type {boolean}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    documentSignatureValidated: boolean;
+}
+
+/**
+ * Check if a given object implements the DigilockerAadhaarProviderOutput interface.
+ */
+export function instanceOfDigilockerAadhaarProviderOutput(value: object): value is DigilockerAadhaarProviderOutput {
+    if (!('documentSignatureValidated' in value) || value['documentSignatureValidated'] === undefined) return false;
+    return true;
+}
+
+export function DigilockerAadhaarProviderOutputFromJSON(json: any): DigilockerAadhaarProviderOutput {
+    return DigilockerAadhaarProviderOutputFromJSONTyped(json, false);
+}
+
+export function DigilockerAadhaarProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): DigilockerAadhaarProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentType': json['documentType'] == null ? undefined : json['documentType'],
+        'timestamp': json['timestamp'] == null ? undefined : (new Date(json['timestamp'])),
+        'timeToLive': json['timeToLive'] == null ? undefined : (new Date(json['timeToLive'])),
+        'aadhaarNumberLastFour': json['aadhaarNumberLastFour'] == null ? undefined : json['aadhaarNumberLastFour'],
+        'claims': json['claims'] == null ? undefined : AadhaarClaimsFromJSON(json['claims']),
+        'localizedClaims': json['localizedClaims'] == null ? undefined : AadhaarLocalizedClaimsFromJSON(json['localizedClaims']),
+        'documentSignatureValidated': json['documentSignatureValidated'],
+    };
+}
+
+export function DigilockerAadhaarProviderOutputToJSON(json: any): DigilockerAadhaarProviderOutput {
+    return DigilockerAadhaarProviderOutputToJSONTyped(json, false);
+}
+
+export function DigilockerAadhaarProviderOutputToJSONTyped(value?: DigilockerAadhaarProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'documentType': value['documentType'],
+        'timestamp': value['timestamp'] == null ? value['timestamp'] : value['timestamp'].toISOString(),
+        'timeToLive': value['timeToLive'] == null ? value['timeToLive'] : value['timeToLive'].toISOString(),
+        'aadhaarNumberLastFour': value['aadhaarNumberLastFour'],
+        'claims': AadhaarClaimsToJSON(value['claims']),
+        'localizedClaims': AadhaarLocalizedClaimsToJSON(value['localizedClaims']),
+        'documentSignatureValidated': value['documentSignatureValidated'],
+    };
+}
+

package/src/models/DocumentData.ts

@@ -115,8 +115,8 @@ export function DocumentDataToJSONTyped(value?: DocumentData | null, ignoreDiscr
         
         'type': DocumentTypeToJSON(value['type']),
         'number': value['number'],
-        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate'] as any).toISOString().substring(0,10)),
-        'expirationDate': value['expirationDate'] == null ? undefined : ((value['expirationDate'] as any).toISOString().substring(0,10)),
+        'issueDate': value['issueDate'] == null ? value['issueDate'] : value['issueDate'].toISOString().substring(0,10),
+        'expirationDate': value['expirationDate'] == null ? value['expirationDate'] : value['expirationDate'].toISOString().substring(0,10),
         'issuingCountry': value['issuingCountry'],
         'issuingSubdivision': value['issuingSubdivision'],
         'issuingAuthority': value['issuingAuthority'],

package/src/models/ElSalvadorDuiLookupInput.ts

@@ -0,0 +1,80 @@
+/* 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 ElSalvadorDuiLookupInput
+ */
+export interface ElSalvadorDuiLookupInput {
+    /**
+     * The DUI (Documento Único de Identidad) number for the holder.
+     *             
+     * Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit).
+     * The input will automatically be sanitized of dots, hyphens, spaces, or other non-alphanumeric characters
+     * before lookup.
+     *             
+     * The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the
+     * algorithm is available in the public domain for those who seek it.
+     * @type {string}
+     * @memberof ElSalvadorDuiLookupInput
+     */
+    documentNumber?: string | null;
+    /**
+     * The DUI holder's date of birth. Required to match the correct person in official records.
+     * @type {Date}
+     * @memberof ElSalvadorDuiLookupInput
+     */
+    dateOfBirth?: Date | null;
+}
+
+/**
+ * Check if a given object implements the ElSalvadorDuiLookupInput interface.
+ */
+export function instanceOfElSalvadorDuiLookupInput(value: object): value is ElSalvadorDuiLookupInput {
+    return true;
+}
+
+export function ElSalvadorDuiLookupInputFromJSON(json: any): ElSalvadorDuiLookupInput {
+    return ElSalvadorDuiLookupInputFromJSONTyped(json, false);
+}
+
+export function ElSalvadorDuiLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ElSalvadorDuiLookupInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+    };
+}
+
+export function ElSalvadorDuiLookupInputToJSON(json: any): ElSalvadorDuiLookupInput {
+    return ElSalvadorDuiLookupInputToJSONTyped(json, false);
+}
+
+export function ElSalvadorDuiLookupInputToJSONTyped(value?: ElSalvadorDuiLookupInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'documentNumber': value['documentNumber'],
+        'dateOfBirth': value['dateOfBirth'] == null ? value['dateOfBirth'] : value['dateOfBirth'].toISOString().substring(0,10),
+    };
+}
+

package/src/models/ElSalvadorDuiProviderOutput.ts

@@ -0,0 +1,91 @@
+/* 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 `el-salvador-dui-lookup` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface ElSalvadorDuiProviderOutput
+ */
+export interface ElSalvadorDuiProviderOutput {
+    /**
+     * Full name as it appears on the DUI (Documento Único de Identidad), as returned by Verifik from
+     * official records administered by the Registro Nacional de las Personas Naturales (RNPN).
+     * @type {string}
+     * @memberof ElSalvadorDuiProviderOutput
+     */
+    fullName: string;
+    /**
+     * The DUI (Documento Único de Identidad) document number as returned by Verifik for the matched record.
+     *             
+     * Nine numeric digits after sanitization. Commonly printed as ########-# (hyphen before the final digit).
+     * The output will be stripped of the hyphen and will preserve leading zeros.
+     *             
+     * The ninth digit is a check digit. This is not publicly documented by the Salvadoran government, but the
+     * algorithm is available in the public domain for those who seek it.
+     * @type {string}
+     * @memberof ElSalvadorDuiProviderOutput
+     */
+    documentNumber: string;
+    /**
+     * The date of birth that was supplied for the lookup and confirmed as matching the DUI record.
+     * @type {Date}
+     * @memberof ElSalvadorDuiProviderOutput
+     */
+    dateOfBirth: Date;
+}
+
+/**
+ * Check if a given object implements the ElSalvadorDuiProviderOutput interface.
+ */
+export function instanceOfElSalvadorDuiProviderOutput(value: object): value is ElSalvadorDuiProviderOutput {
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('documentNumber' in value) || value['documentNumber'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    return true;
+}
+
+export function ElSalvadorDuiProviderOutputFromJSON(json: any): ElSalvadorDuiProviderOutput {
+    return ElSalvadorDuiProviderOutputFromJSONTyped(json, false);
+}
+
+export function ElSalvadorDuiProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ElSalvadorDuiProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'],
+        'documentNumber': json['documentNumber'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+    };
+}
+
+export function ElSalvadorDuiProviderOutputToJSON(json: any): ElSalvadorDuiProviderOutput {
+    return ElSalvadorDuiProviderOutputToJSONTyped(json, false);
+}
+
+export function ElSalvadorDuiProviderOutputToJSONTyped(value?: ElSalvadorDuiProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'fullName': value['fullName'],
+        'documentNumber': value['documentNumber'],
+        'dateOfBirth': value['dateOfBirth'].toISOString().substring(0,10),
+    };
+}
+

package/src/models/EstoniaIdCardProviderOutput.ts

@@ -100,7 +100,7 @@ export function EstoniaIdCardProviderOutputToJSONTyped(value?: EstoniaIdCardProv
         
         'firstName': value['firstName'],
         'lastName': value['lastName'],
-        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'dateOfBirth': value['dateOfBirth'].toISOString().substring(0,10),
         'personalIdentificationCode': value['personalIdentificationCode'],
     };
 }

package/src/models/FaydaProviderAddress.ts

@@ -0,0 +1,87 @@
+/* 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 FaydaProviderAddress
+ */
+export interface FaydaProviderAddress {
+    /**
+     * The region, which is the primary administrative division of the address.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderAddress
+     */
+    region?: string | null;
+    /**
+     * The zone, which is the administrative area within the region.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderAddress
+     */
+    zone?: string | null;
+    /**
+     * The woreda, which is the local district within the zone.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderAddress
+     */
+    woreda?: string | null;
+}
+
+/**
+ * Check if a given object implements the FaydaProviderAddress interface.
+ */
+export function instanceOfFaydaProviderAddress(value: object): value is FaydaProviderAddress {
+    return true;
+}
+
+export function FaydaProviderAddressFromJSON(json: any): FaydaProviderAddress {
+    return FaydaProviderAddressFromJSONTyped(json, false);
+}
+
+export function FaydaProviderAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): FaydaProviderAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'region': json['region'] == null ? undefined : json['region'],
+        'zone': json['zone'] == null ? undefined : json['zone'],
+        'woreda': json['woreda'] == null ? undefined : json['woreda'],
+    };
+}
+
+export function FaydaProviderAddressToJSON(json: any): FaydaProviderAddress {
+    return FaydaProviderAddressToJSONTyped(json, false);
+}
+
+export function FaydaProviderAddressToJSONTyped(value?: FaydaProviderAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'region': value['region'],
+        'zone': value['zone'],
+        'woreda': value['woreda'],
+    };
+}
+

package/src/models/FaydaProviderOutput.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { FaydaProviderAddress } from './FaydaProviderAddress';
+import {
+    FaydaProviderAddressFromJSON,
+    FaydaProviderAddressFromJSONTyped,
+    FaydaProviderAddressToJSON,
+    FaydaProviderAddressToJSONTyped,
+} from './FaydaProviderAddress';
+
 /**
  * Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model.
  * @export
@@ -20,14 +28,88 @@ import { mapValues } from '../runtime';
  */
 export interface FaydaProviderOutput {
     /**
-     * A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered.
+     * A unique eKYC identifying token used to match the original eKYC token received from the provider when the individual was initially registered.
      *             
-     * Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when
-     * the user was initially registered to do a comparison of the subs to verify that it is the same person.
+     * Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique individual token received from Fayda when
+     * the individual was initially registered to do a comparison of the subs to verify that it is the same person.
      * @type {string}
      * @memberof FaydaProviderOutput
      */
     sub?: string | null;
+    /**
+     * The full name of the verified individual.
+     *             
+     * This may be an English or Arabic name if the individual only has it one language, otherwise this will be null and the other names will be populated.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    name?: string | null;
+    /**
+     * The full English name of the verified individual.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    englishName?: string | null;
+    /**
+     * The full Arabic name of the verified individual.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    arabicName?: string | null;
+    /**
+     * The date of birth of the verified individual.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {Date}
+     * @memberof FaydaProviderOutput
+     */
+    birthdate?: Date | null;
+    /**
+     * The sex of the verified individual.
+     *             
+     * Possible values:
+     * - Unknown
+     * - NotApplicable
+     * - Male
+     * - Female
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The nationality of the verified individual as an ISO 3166-1 alpha-2 country code.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    nationality?: string | null;
+    /**
+     * The phone number of the verified individual.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    phoneNumber?: string | null;
+    /**
+     * The email address of the verified individual.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The address of the verified individual.
+     *             
+     * This attribute is only available if registered directly.
+     * @type {FaydaProviderAddress}
+     * @memberof FaydaProviderOutput
+     */
+    address?: FaydaProviderAddress | null;
 }
 
 /**
@@ -48,6 +130,15 @@ export function FaydaProviderOutputFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'sub': json['sub'] == null ? undefined : json['sub'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'englishName': json['englishName'] == null ? undefined : json['englishName'],
+        'arabicName': json['arabicName'] == null ? undefined : json['arabicName'],
+        'birthdate': json['birthdate'] == null ? undefined : (new Date(json['birthdate'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'address': json['address'] == null ? undefined : FaydaProviderAddressFromJSON(json['address']),
     };
 }
 
@@ -63,6 +154,15 @@ export function FaydaProviderOutputToJSONTyped(value?: FaydaProviderOutput | nul
     return {
         
         'sub': value['sub'],
+        'name': value['name'],
+        'englishName': value['englishName'],
+        'arabicName': value['arabicName'],
+        'birthdate': value['birthdate'] == null ? value['birthdate'] : value['birthdate'].toISOString().substring(0,10),
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'phoneNumber': value['phoneNumber'],
+        'email': value['email'],
+        'address': FaydaProviderAddressToJSON(value['address']),
     };
 }
 

package/src/models/FinlandIdCardProviderOutput.ts

@@ -99,7 +99,7 @@ export function FinlandIdCardProviderOutputToJSONTyped(value?: FinlandIdCardProv
         
         'firstName': value['firstName'],
         'lastName': value['lastName'],
-        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'dateOfBirth': value['dateOfBirth'].toISOString().substring(0,10),
         'personalIdentificationCode': value['personalIdentificationCode'],
     };
 }