@trinsic/api 3.0.1 → 3.0.2-preview1

package/src/models/DigilockerAadhaarProviderOutput.ts

@@ -0,0 +1,141 @@
+/* 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 from.
+     *             
+     * Possible values:
+     * - ADHAR
+     * - PANCR
+     * @type {string}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    documentType?: string | null;
+    /**
+     * Whether the downloaded Aadhaar document signature and certificate chain validation succeeded.
+     *             
+     * In some cases, the document may not be returned, but the data is. When the document is received, a certificate validation is performed. When it is not, the signature can not be validated.
+     * @type {boolean}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    documentSignatureValidated: boolean;
+    /**
+     * The timestamp when the signed document was generated and verified.
+     *             
+     * This is parsed as a date-time value. Aadhaar may omit timezone information.
+     * @type {Date}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    timestamp?: Date | null;
+    /**
+     * The validity expiration timestamp for the verification document.
+     *             
+     * This is parsed as a date-time value. Aadhaar may omit timezone information.
+     * @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 signed Aadhaar document.
+     * @type {AadhaarClaims}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    claims?: AadhaarClaims | null;
+    /**
+     * The localized claims extracted from the signed Aadhaar document.
+     * @type {AadhaarLocalizedClaims}
+     * @memberof DigilockerAadhaarProviderOutput
+     */
+    localizedClaims?: AadhaarLocalizedClaims | null;
+}
+
+/**
+ * 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'],
+        'documentSignatureValidated': json['documentSignatureValidated'],
+        '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']),
+    };
+}
+
+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'],
+        'documentSignatureValidated': value['documentSignatureValidated'],
+        'timestamp': value['timestamp'] == null ? undefined : ((value['timestamp'] as any).toISOString()),
+        'timeToLive': value['timeToLive'] == null ? undefined : ((value['timeToLive'] as any).toISOString()),
+        'aadhaarNumberLastFour': value['aadhaarNumberLastFour'],
+        'claims': AadhaarClaimsToJSON(value['claims']),
+        'localizedClaims': AadhaarLocalizedClaimsToJSON(value['localizedClaims']),
+    };
+}
+

package/src/models/FaydaProviderOutput.ts

@@ -28,6 +28,26 @@ export interface FaydaProviderOutput {
      * @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;
 }
 
 /**
@@ -48,6 +68,9 @@ 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'],
     };
 }
 
@@ -63,6 +86,9 @@ export function FaydaProviderOutputToJSONTyped(value?: FaydaProviderOutput | nul
     return {
         
         'sub': value['sub'],
+        'name': value['name'],
+        'englishName': value['englishName'],
+        'arabicName': value['arabicName'],
     };
 }
 

package/src/models/FinnishTrustNetworkProviderOutput.ts

@@ -0,0 +1,176 @@
+/* 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 `finnish-trust-network` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface FinnishTrustNetworkProviderOutput
+ */
+export interface FinnishTrustNetworkProviderOutput {
+    /**
+     * The full name of the individual.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * @type {Date}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The 11-digit Finnish Personal Identification Code (Henkilötunnus) of the verified individual.
+     *             
+     * This is in the format DDMMYYCZZZQ, where:
+     * - DDMMYY is the date of birth
+     * - C is a symbol which determines the century of birth
+     * - ZZZ is an individual number, indicating gender
+     * - Q is a checksum character
+     *             
+     * If ZZZ is even, the individual is female.
+     * If ZZZ is odd, the individual is male.
+     *             
+     * If C is '+', the individual was born in the 19th century (1800-1899).
+     * If C is '-', 'U', 'V', 'W', 'X', or 'Y', the individual was born in the 20th century (1900-1999).
+     * If C is 'A', 'B', 'C', 'D', 'E', or 'F', the individual was born in the 21st century (2000-2099).
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    personalIdentificationCode?: string | null;
+    /**
+     * The 9-digit Finnish Unique Identification Number (FINUID, or sähköinen asiointitunnus SATU) of the verified individual.
+     * This number is typically used for online transactions and unlike the Finnish Personal Identification Code, does not reveal personal information such as birthdate.
+     *             
+     * The first 8 digits are randomly generated and the last character is a check control.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    uniqueIdentificationNumber?: string | null;
+    /**
+     * The given name of the individual.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The level of assurance (LOA) for the verification.
+     *             
+     * The LOA refers to the degree of confidence in the claimed identity of a person.
+     * The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels.
+     * To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance
+     *             
+     * Possible values:
+     * - Low: The user has self asserted their identity and multifactor authentication is not required.
+     * - Substantial: The user has performed either a remote or in-person identity verification and multifactor authentication is required.
+     * - High: The user has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    levelOfAssurance?: string | null;
+    /**
+     * The bank used to perform the identification for the verified individual.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    bank?: string | null;
+    /**
+     * The phone number of the verified individual.
+     *             
+     * This is only returned if the user authenticated with MobileID (Mobiilivarmenne).
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    phoneNumber?: string | null;
+    /**
+     * The organization name that the individual is associated with.
+     *             
+     * This is returned for requests that contain the organization scope.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    organizationName?: string | null;
+    /**
+     * The VAT number of the organization that the individual is associated with.
+     *             
+     * This is returned for requests that contain the organization scope.
+     * @type {string}
+     * @memberof FinnishTrustNetworkProviderOutput
+     */
+    vatNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the FinnishTrustNetworkProviderOutput interface.
+ */
+export function instanceOfFinnishTrustNetworkProviderOutput(value: object): value is FinnishTrustNetworkProviderOutput {
+    return true;
+}
+
+export function FinnishTrustNetworkProviderOutputFromJSON(json: any): FinnishTrustNetworkProviderOutput {
+    return FinnishTrustNetworkProviderOutputFromJSONTyped(json, false);
+}
+
+export function FinnishTrustNetworkProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FinnishTrustNetworkProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'personalIdentificationCode': json['personalIdentificationCode'] == null ? undefined : json['personalIdentificationCode'],
+        'uniqueIdentificationNumber': json['uniqueIdentificationNumber'] == null ? undefined : json['uniqueIdentificationNumber'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'levelOfAssurance': json['levelOfAssurance'] == null ? undefined : json['levelOfAssurance'],
+        'bank': json['bank'] == null ? undefined : json['bank'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'organizationName': json['organizationName'] == null ? undefined : json['organizationName'],
+        'vatNumber': json['vatNumber'] == null ? undefined : json['vatNumber'],
+    };
+}
+
+export function FinnishTrustNetworkProviderOutputToJSON(json: any): FinnishTrustNetworkProviderOutput {
+    return FinnishTrustNetworkProviderOutputToJSONTyped(json, false);
+}
+
+export function FinnishTrustNetworkProviderOutputToJSONTyped(value?: FinnishTrustNetworkProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'fullName': value['fullName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'personalIdentificationCode': value['personalIdentificationCode'],
+        'uniqueIdentificationNumber': value['uniqueIdentificationNumber'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'levelOfAssurance': value['levelOfAssurance'],
+        'bank': value['bank'],
+        'phoneNumber': value['phoneNumber'],
+        'organizationName': value['organizationName'],
+        'vatNumber': value['vatNumber'],
+    };
+}
+

package/src/models/FranceIdentiteInput.ts

@@ -0,0 +1,75 @@
+/* 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 { Raw18013RequestInput } from './Raw18013RequestInput';
+import {
+    Raw18013RequestInputFromJSON,
+    Raw18013RequestInputFromJSONTyped,
+    Raw18013RequestInputToJSON,
+    Raw18013RequestInputToJSONTyped,
+} from './Raw18013RequestInput';
+
+/**
+ * 
+ * @export
+ * @interface FranceIdentiteInput
+ */
+export interface FranceIdentiteInput {
+    /**
+     * The raw 18013-7 exchange request to use for this verification.
+     *             
+     * If set, this overrides any default configuration on your Verification Profile.
+     * @type {Raw18013RequestInput}
+     * @memberof FranceIdentiteInput
+     */
+    previewRaw18013Request?: Raw18013RequestInput | null;
+}
+
+/**
+ * Check if a given object implements the FranceIdentiteInput interface.
+ */
+export function instanceOfFranceIdentiteInput(value: object): value is FranceIdentiteInput {
+    return true;
+}
+
+export function FranceIdentiteInputFromJSON(json: any): FranceIdentiteInput {
+    return FranceIdentiteInputFromJSONTyped(json, false);
+}
+
+export function FranceIdentiteInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FranceIdentiteInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'previewRaw18013Request': json['preview_raw18013Request'] == null ? undefined : Raw18013RequestInputFromJSON(json['preview_raw18013Request']),
+    };
+}
+
+export function FranceIdentiteInputToJSON(json: any): FranceIdentiteInput {
+    return FranceIdentiteInputToJSONTyped(json, false);
+}
+
+export function FranceIdentiteInputToJSONTyped(value?: FranceIdentiteInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'preview_raw18013Request': Raw18013RequestInputToJSON(value['previewRaw18013Request']),
+    };
+}
+

package/src/models/FranceIdentiteProviderOutput.ts

@@ -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 { mapValues } from '../runtime';
+import type { MdlOutput } from './MdlOutput';
+import {
+    MdlOutputFromJSON,
+    MdlOutputFromJSONTyped,
+    MdlOutputToJSON,
+    MdlOutputToJSONTyped,
+} from './MdlOutput';
+
+/**
+ * Exposed properties for the `france-identite` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface FranceIdentiteProviderOutput
+ */
+export interface FranceIdentiteProviderOutput {
+    /**
+     * The raw output of the 18013-7 exchange performed through France Identité.
+     * @type {MdlOutput}
+     * @memberof FranceIdentiteProviderOutput
+     */
+    raw18013Output: MdlOutput;
+}
+
+/**
+ * Check if a given object implements the FranceIdentiteProviderOutput interface.
+ */
+export function instanceOfFranceIdentiteProviderOutput(value: object): value is FranceIdentiteProviderOutput {
+    if (!('raw18013Output' in value) || value['raw18013Output'] === undefined) return false;
+    return true;
+}
+
+export function FranceIdentiteProviderOutputFromJSON(json: any): FranceIdentiteProviderOutput {
+    return FranceIdentiteProviderOutputFromJSONTyped(json, false);
+}
+
+export function FranceIdentiteProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FranceIdentiteProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'raw18013Output': MdlOutputFromJSON(json['raw18013Output']),
+    };
+}
+
+export function FranceIdentiteProviderOutputToJSON(json: any): FranceIdentiteProviderOutput {
+    return FranceIdentiteProviderOutputToJSONTyped(json, false);
+}
+
+export function FranceIdentiteProviderOutputToJSONTyped(value?: FranceIdentiteProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'raw18013Output': MdlOutputToJSON(value['raw18013Output']),
+    };
+}
+

package/src/models/FrejaIndirectProviderOutput.ts

@@ -0,0 +1,96 @@
+/* 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 `a-freja-eid-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface FrejaIndirectProviderOutput
+ */
+export interface FrejaIndirectProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof FrejaIndirectProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof FrejaIndirectProviderOutput
+     */
+    lastName: string;
+    /**
+     * The value returned by Freja in the "ssn" field.
+     *             
+     * The actual value of this field depends on the country of origin used to create the Freja credential. It is typically
+     * a Social Security Number, National Identification Number, or equivalent personal identifier.
+     * @type {string}
+     * @memberof FrejaIndirectProviderOutput
+     */
+    personalNumber: string;
+    /**
+     * The 2-digit ISO country code of the country which issued the personal number.
+     * @type {string}
+     * @memberof FrejaIndirectProviderOutput
+     */
+    personalNumberCountry: string;
+}
+
+/**
+ * Check if a given object implements the FrejaIndirectProviderOutput interface.
+ */
+export function instanceOfFrejaIndirectProviderOutput(value: object): value is FrejaIndirectProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('personalNumber' in value) || value['personalNumber'] === undefined) return false;
+    if (!('personalNumberCountry' in value) || value['personalNumberCountry'] === undefined) return false;
+    return true;
+}
+
+export function FrejaIndirectProviderOutputFromJSON(json: any): FrejaIndirectProviderOutput {
+    return FrejaIndirectProviderOutputFromJSONTyped(json, false);
+}
+
+export function FrejaIndirectProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FrejaIndirectProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'personalNumber': json['personalNumber'],
+        'personalNumberCountry': json['personalNumberCountry'],
+    };
+}
+
+export function FrejaIndirectProviderOutputToJSON(json: any): FrejaIndirectProviderOutput {
+    return FrejaIndirectProviderOutputToJSONTyped(json, false);
+}
+
+export function FrejaIndirectProviderOutputToJSONTyped(value?: FrejaIndirectProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'personalNumber': value['personalNumber'],
+        'personalNumberCountry': value['personalNumberCountry'],
+    };
+}
+