@trinsic/api 2.3.0-alpha2 → 3.0.0

package/src/models/CzechiaMojeIdProviderOutput.ts

@@ -0,0 +1,95 @@
+/* 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-mojeid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface CzechiaMojeIdProviderOutput
+ */
+export interface CzechiaMojeIdProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The OpenID 2.0 Identifier ("openid2_id") of the verified individual's MojeID account.
+     *             
+     * This is an HTTPS URL which uniquely identifies the user within the MojeID system.
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    openId2Identifier: string;
+}
+
+/**
+ * Check if a given object implements the CzechiaMojeIdProviderOutput interface.
+ */
+export function instanceOfCzechiaMojeIdProviderOutput(value: object): value is CzechiaMojeIdProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('openId2Identifier' in value) || value['openId2Identifier'] === undefined) return false;
+    return true;
+}
+
+export function CzechiaMojeIdProviderOutputFromJSON(json: any): CzechiaMojeIdProviderOutput {
+    return CzechiaMojeIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function CzechiaMojeIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CzechiaMojeIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'openId2Identifier': json['openId2Identifier'],
+    };
+}
+
+export function CzechiaMojeIdProviderOutputToJSON(json: any): CzechiaMojeIdProviderOutput {
+    return CzechiaMojeIdProviderOutputToJSONTyped(json, false);
+}
+
+export function CzechiaMojeIdProviderOutputToJSONTyped(value?: CzechiaMojeIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'openId2Identifier': value['openId2Identifier'],
+    };
+}
+

package/src/models/DocumentData.ts

@@ -28,37 +28,45 @@ import {
  */
 export interface DocumentData {
     /**
-     * 
+     * The type of the document.
      * @type {DocumentType}
      * @memberof DocumentData
      */
     type?: DocumentType | null;
     /**
-     * 
+     * The primary identifying number of the document.
      * @type {string}
      * @memberof DocumentData
      */
     number?: string | null;
     /**
-     * 
+     * The date the document was issued.
      * @type {Date}
      * @memberof DocumentData
      */
     issueDate?: Date | null;
     /**
-     * 
+     * The date the document expires.
      * @type {Date}
      * @memberof DocumentData
      */
     expirationDate?: Date | null;
     /**
-     * 
+     * The ISO 3166-1 alpha-2 country code of the country that issued the document.
      * @type {string}
      * @memberof DocumentData
      */
     issuingCountry?: string | null;
     /**
-     * 
+     * The ISO 3166-2 subdivision code of the issuing authority which issued the document.
+     *             
+     * This is always in the form {CountryCode}-{SubdivisionCode}, where CountryCode is 2 letters and SubdivisionCode is 1-3 alphanumeric characters.
+     * @type {string}
+     * @memberof DocumentData
+     */
+    issuingSubdivision?: string | null;
+    /**
+     * The name of the authority which issued the document.
      * @type {string}
      * @memberof DocumentData
      */
@@ -89,6 +97,7 @@ export function DocumentDataFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'issueDate': json['issueDate'] == null ? undefined : (new Date(json['issueDate'])),
         'expirationDate': json['expirationDate'] == null ? undefined : (new Date(json['expirationDate'])),
         'issuingCountry': json['issuingCountry'] == null ? undefined : json['issuingCountry'],
+        'issuingSubdivision': json['issuingSubdivision'] == null ? undefined : json['issuingSubdivision'],
         'issuingAuthority': json['issuingAuthority'] == null ? undefined : json['issuingAuthority'],
     };
 }
@@ -109,6 +118,7 @@ export function DocumentDataToJSONTyped(value?: DocumentData | null, ignoreDiscr
         '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)),
         'issuingCountry': value['issuingCountry'],
+        'issuingSubdivision': value['issuingSubdivision'],
         'issuingAuthority': value['issuingAuthority'],
     };
 }

package/src/models/EstoniaIdCardProviderOutput.ts

@@ -0,0 +1,107 @@
+/* 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-ee-web-eid-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface EstoniaIdCardProviderOutput
+ */
+export interface EstoniaIdCardProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The 11-digit Estonian personal identification code ("isikukood") of the verified individual.
+     *             
+     * This is in the format GYYMMDDSSSC, where:
+     * - G combines the century and sex of birth
+     * - YYMMDD is the date of birth within the given century
+     * - SSS is a serial number distinguishing people born on the same date
+     * - C is a checksum digit
+     *             
+     * If G is odd, the individual is male.
+     * If G is even, the individual is female.
+     *             
+     * If G is 1 or 2, the individual was born in the 19th century (1800-1899).
+     * If G is 3 or 4, the individual was born in the 20th century (1900-1999).
+     * If G is 5 or 6, the individual was born in the 21st century (2000-2099).
+     * If G is 7 or 8, the individual was born in the 22nd century (2100-2199).
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    personalIdentificationCode: string;
+}
+
+/**
+ * Check if a given object implements the EstoniaIdCardProviderOutput interface.
+ */
+export function instanceOfEstoniaIdCardProviderOutput(value: object): value is EstoniaIdCardProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('personalIdentificationCode' in value) || value['personalIdentificationCode'] === undefined) return false;
+    return true;
+}
+
+export function EstoniaIdCardProviderOutputFromJSON(json: any): EstoniaIdCardProviderOutput {
+    return EstoniaIdCardProviderOutputFromJSONTyped(json, false);
+}
+
+export function EstoniaIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstoniaIdCardProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'personalIdentificationCode': json['personalIdentificationCode'],
+    };
+}
+
+export function EstoniaIdCardProviderOutputToJSON(json: any): EstoniaIdCardProviderOutput {
+    return EstoniaIdCardProviderOutputToJSONTyped(json, false);
+}
+
+export function EstoniaIdCardProviderOutputToJSONTyped(value?: EstoniaIdCardProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'personalIdentificationCode': value['personalIdentificationCode'],
+    };
+}
+

package/src/models/FaydaProviderOutput.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * 
+ * Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model.
  * @export
  * @interface FaydaProviderOutput
  */

package/src/models/FinlandIdCardProviderOutput.ts

@@ -0,0 +1,106 @@
+/* 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-fi-id-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface FinlandIdCardProviderOutput
+ */
+export interface FinlandIdCardProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof FinlandIdCardProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof FinlandIdCardProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof FinlandIdCardProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * 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 FinlandIdCardProviderOutput
+     */
+    personalIdentificationCode: string;
+}
+
+/**
+ * Check if a given object implements the FinlandIdCardProviderOutput interface.
+ */
+export function instanceOfFinlandIdCardProviderOutput(value: object): value is FinlandIdCardProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('personalIdentificationCode' in value) || value['personalIdentificationCode'] === undefined) return false;
+    return true;
+}
+
+export function FinlandIdCardProviderOutputFromJSON(json: any): FinlandIdCardProviderOutput {
+    return FinlandIdCardProviderOutputFromJSONTyped(json, false);
+}
+
+export function FinlandIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FinlandIdCardProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'personalIdentificationCode': json['personalIdentificationCode'],
+    };
+}
+
+export function FinlandIdCardProviderOutputToJSON(json: any): FinlandIdCardProviderOutput {
+    return FinlandIdCardProviderOutputToJSONTyped(json, false);
+}
+
+export function FinlandIdCardProviderOutputToJSONTyped(value?: FinlandIdCardProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'personalIdentificationCode': value['personalIdentificationCode'],
+    };
+}
+

package/src/models/FrejaProviderOutput.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 FrejaProviderOutput
+ */
+export interface FrejaProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof FrejaProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof FrejaProviderOutput
+     */
+    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 FrejaProviderOutput
+     */
+    personalNumber: string;
+    /**
+     * The 2-digit ISO country code of the country which issued the personal number.
+     * @type {string}
+     * @memberof FrejaProviderOutput
+     */
+    personalNumberCountry: string;
+}
+
+/**
+ * Check if a given object implements the FrejaProviderOutput interface.
+ */
+export function instanceOfFrejaProviderOutput(value: object): value is FrejaProviderOutput {
+    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 FrejaProviderOutputFromJSON(json: any): FrejaProviderOutput {
+    return FrejaProviderOutputFromJSONTyped(json, false);
+}
+
+export function FrejaProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FrejaProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'personalNumber': json['personalNumber'],
+        'personalNumberCountry': json['personalNumberCountry'],
+    };
+}
+
+export function FrejaProviderOutputToJSON(json: any): FrejaProviderOutput {
+    return FrejaProviderOutputToJSONTyped(json, false);
+}
+
+export function FrejaProviderOutputToJSONTyped(value?: FrejaProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'personalNumber': value['personalNumber'],
+        'personalNumberCountry': value['personalNumberCountry'],
+    };
+}
+

package/src/models/FrenchNumeriqueGivenName.ts

@@ -0,0 +1,82 @@
+/* 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';
+/**
+ * Given name information including the full given name and its structured components.
+ * @export
+ * @interface FrenchNumeriqueGivenName
+ */
+export interface FrenchNumeriqueGivenName {
+    /**
+     * Full given name(s) as recorded on the user's French identity document.
+     * If the user has multiple given names, they are separated by a single space.
+     * @type {string}
+     * @memberof FrenchNumeriqueGivenName
+     */
+    fullGivenName?: string | null;
+    /**
+     * First/primary given name (premier prénom).
+     * @type {string}
+     * @memberof FrenchNumeriqueGivenName
+     */
+    firstName?: string | null;
+    /**
+     * Middle name(s) (prénoms secondaires), separated by spaces if multiple.
+     * @type {string}
+     * @memberof FrenchNumeriqueGivenName
+     */
+    middleName?: string | null;
+}
+
+/**
+ * Check if a given object implements the FrenchNumeriqueGivenName interface.
+ */
+export function instanceOfFrenchNumeriqueGivenName(value: object): value is FrenchNumeriqueGivenName {
+    return true;
+}
+
+export function FrenchNumeriqueGivenNameFromJSON(json: any): FrenchNumeriqueGivenName {
+    return FrenchNumeriqueGivenNameFromJSONTyped(json, false);
+}
+
+export function FrenchNumeriqueGivenNameFromJSONTyped(json: any, ignoreDiscriminator: boolean): FrenchNumeriqueGivenName {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullGivenName': json['fullGivenName'] == null ? undefined : json['fullGivenName'],
+        'firstName': json['firstName'] == null ? undefined : json['firstName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+    };
+}
+
+export function FrenchNumeriqueGivenNameToJSON(json: any): FrenchNumeriqueGivenName {
+    return FrenchNumeriqueGivenNameToJSONTyped(json, false);
+}
+
+export function FrenchNumeriqueGivenNameToJSONTyped(value?: FrenchNumeriqueGivenName | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'fullGivenName': value['fullGivenName'],
+        'firstName': value['firstName'],
+        'middleName': value['middleName'],
+    };
+}
+

package/src/models/FrenchNumeriqueNationality.ts

@@ -0,0 +1,73 @@
+/* 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';
+/**
+ * Nationality information with ISO 3166 alpha-3 code and French label.
+ * @export
+ * @interface FrenchNumeriqueNationality
+ */
+export interface FrenchNumeriqueNationality {
+    /**
+     * ISO 3166 alpha-3 country code.
+     * @type {string}
+     * @memberof FrenchNumeriqueNationality
+     */
+    code?: string | null;
+    /**
+     * Nationality label in French.
+     * @type {string}
+     * @memberof FrenchNumeriqueNationality
+     */
+    label?: string | null;
+}
+
+/**
+ * Check if a given object implements the FrenchNumeriqueNationality interface.
+ */
+export function instanceOfFrenchNumeriqueNationality(value: object): value is FrenchNumeriqueNationality {
+    return true;
+}
+
+export function FrenchNumeriqueNationalityFromJSON(json: any): FrenchNumeriqueNationality {
+    return FrenchNumeriqueNationalityFromJSONTyped(json, false);
+}
+
+export function FrenchNumeriqueNationalityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FrenchNumeriqueNationality {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+        'label': json['label'] == null ? undefined : json['label'],
+    };
+}
+
+export function FrenchNumeriqueNationalityToJSON(json: any): FrenchNumeriqueNationality {
+    return FrenchNumeriqueNationalityToJSONTyped(json, false);
+}
+
+export function FrenchNumeriqueNationalityToJSONTyped(value?: FrenchNumeriqueNationality | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'label': value['label'],
+    };
+}
+