@trinsic/api 3.0.0 → 3.0.2-preview1

package/src/models/NigeriaNinLookup2ProviderOutput.ts

@@ -0,0 +1,170 @@
+/* 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 `nigeria-nin-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface NigeriaNinLookup2ProviderOutput
+ */
+export interface NigeriaNinLookup2ProviderOutput {
+    /**
+     * The first name (given name) of the ID holder.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    firstName: string;
+    /**
+     * The middle name of the ID holder.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    middleName?: string | null;
+    /**
+     * The surname (family name) of the ID holder.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    surname: string;
+    /**
+     * The sex of the ID holder.
+     *             
+     * Possible values:
+     * - Male
+     * - Female
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    sex?: string | null;
+    /**
+     * The date of birth of the ID holder.
+     * @type {Date}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * Country of birth as an ISO 3166-1 alpha-2 code.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    birthCountry?: string | null;
+    /**
+     * National Identification Number (NIN).
+     *             
+     * This is a unique, permanent identifier assigned by the National Identity Management Commission
+     * upon enrollment.
+     *             
+     * Format: 11 numeric digits (regex: /^[0-9]{11}$/). The digits are validated using the Verhoeff
+     * algorithm, meaning the last digit serves as a check digit.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    nationalIdentityNumber: string;
+    /**
+     * Phone number registered with the National Identity Management Commission.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    phoneNumber?: string | null;
+    /**
+     * Email address registered with the National Identity Management Commission.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    email?: string | null;
+    /**
+     * Full residential address as a single string, normalized to lowercase without delimiters.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    address?: string | null;
+    /**
+     * Local Government Area of residence.
+     *             
+     * Nigeria is divided into 774 Local Government Areas (LGAs), which are the third-tier
+     * administrative divisions below states and the Federal Capital Territory. LGAs are roughly
+     * equivalent to counties or municipalities in other countries.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    localGovernmentArea?: string | null;
+    /**
+     * State of residence.
+     * @type {string}
+     * @memberof NigeriaNinLookup2ProviderOutput
+     */
+    state?: string | null;
+}
+
+/**
+ * Check if a given object implements the NigeriaNinLookup2ProviderOutput interface.
+ */
+export function instanceOfNigeriaNinLookup2ProviderOutput(value: object): value is NigeriaNinLookup2ProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('surname' in value) || value['surname'] === undefined) return false;
+    if (!('nationalIdentityNumber' in value) || value['nationalIdentityNumber'] === undefined) return false;
+    return true;
+}
+
+export function NigeriaNinLookup2ProviderOutputFromJSON(json: any): NigeriaNinLookup2ProviderOutput {
+    return NigeriaNinLookup2ProviderOutputFromJSONTyped(json, false);
+}
+
+export function NigeriaNinLookup2ProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinLookup2ProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'surname': json['surname'],
+        'sex': json['sex'] == null ? undefined : json['sex'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'birthCountry': json['birthCountry'] == null ? undefined : json['birthCountry'],
+        'nationalIdentityNumber': json['nationalIdentityNumber'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'address': json['address'] == null ? undefined : json['address'],
+        'localGovernmentArea': json['localGovernmentArea'] == null ? undefined : json['localGovernmentArea'],
+        'state': json['state'] == null ? undefined : json['state'],
+    };
+}
+
+export function NigeriaNinLookup2ProviderOutputToJSON(json: any): NigeriaNinLookup2ProviderOutput {
+    return NigeriaNinLookup2ProviderOutputToJSONTyped(json, false);
+}
+
+export function NigeriaNinLookup2ProviderOutputToJSONTyped(value?: NigeriaNinLookup2ProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'middleName': value['middleName'],
+        'surname': value['surname'],
+        'sex': value['sex'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'birthCountry': value['birthCountry'],
+        'nationalIdentityNumber': value['nationalIdentityNumber'],
+        'phoneNumber': value['phoneNumber'],
+        'email': value['email'],
+        'address': value['address'],
+        'localGovernmentArea': value['localGovernmentArea'],
+        'state': value['state'],
+    };
+}
+

package/src/models/NorwegianBankIdProviderOutput.ts

@@ -0,0 +1,144 @@
+/* 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 `norway-bankid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface NorwegianBankIdProviderOutput
+ */
+export interface NorwegianBankIdProviderOutput {
+    /**
+     * The full name of the individual.
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * @type {Date}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The personal identifier for Norwegian BankID.
+     *             
+     * This uniquely identifies the user in the Norwegian BankID system and is considered a stable identifier to use.
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    personalIdentifier?: string | null;
+    /**
+     * The 11-digit Norwegian National Identity Number (fødselsnummer) of the verified individual.
+     *             
+     * This is in the format DDMMYYZZZCC, where:
+     * - DDMMYY is the date of birth (In some cases, this is not the date of birth due to no available identity numbers for some dates
+     * - ZZZ is an individual number, indicating gender
+     * - CC is a checksum character
+     *             
+     * If ZZZ is even, the individual is female.
+     * If ZZZ is odd, the individual is male.
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    nationalIdentityNumber?: string | null;
+    /**
+     * The given name of the individual.
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual.
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    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 NorwegianBankIdProviderOutput
+     */
+    levelOfAssurance?: string | null;
+    /**
+     * The authentication method used by the individual.
+     *             
+     * Possible values:
+     * - urn:bankid:bis - BankID with Biometrics
+     * - urn:bankid:bid - Standard BankID with High Assurance
+     * @type {string}
+     * @memberof NorwegianBankIdProviderOutput
+     */
+    authenticationMethod?: string | null;
+}
+
+/**
+ * Check if a given object implements the NorwegianBankIdProviderOutput interface.
+ */
+export function instanceOfNorwegianBankIdProviderOutput(value: object): value is NorwegianBankIdProviderOutput {
+    return true;
+}
+
+export function NorwegianBankIdProviderOutputFromJSON(json: any): NorwegianBankIdProviderOutput {
+    return NorwegianBankIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function NorwegianBankIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NorwegianBankIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'personalIdentifier': json['personalIdentifier'] == null ? undefined : json['personalIdentifier'],
+        'nationalIdentityNumber': json['nationalIdentityNumber'] == null ? undefined : json['nationalIdentityNumber'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'levelOfAssurance': json['levelOfAssurance'] == null ? undefined : json['levelOfAssurance'],
+        'authenticationMethod': json['authenticationMethod'] == null ? undefined : json['authenticationMethod'],
+    };
+}
+
+export function NorwegianBankIdProviderOutputToJSON(json: any): NorwegianBankIdProviderOutput {
+    return NorwegianBankIdProviderOutputToJSONTyped(json, false);
+}
+
+export function NorwegianBankIdProviderOutputToJSONTyped(value?: NorwegianBankIdProviderOutput | 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)),
+        'personalIdentifier': value['personalIdentifier'],
+        'nationalIdentityNumber': value['nationalIdentityNumber'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'levelOfAssurance': value['levelOfAssurance'],
+        'authenticationMethod': value['authenticationMethod'],
+    };
+}
+

package/src/models/OneIdProviderAddress.ts

@@ -0,0 +1,97 @@
+/* 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 OneIdProviderAddress
+ */
+export interface OneIdProviderAddress {
+    /**
+     * The line or street portion of the address.
+     * @type {string}
+     * @memberof OneIdProviderAddress
+     */
+    streetAddress?: string | null;
+    /**
+     * The locality or city portion of the address.
+     * @type {string}
+     * @memberof OneIdProviderAddress
+     */
+    locality?: string | null;
+    /**
+     * The region or subdivision portion of the address.
+     * @type {string}
+     * @memberof OneIdProviderAddress
+     */
+    region?: string | null;
+    /**
+     * The postal code of the address.
+     * @type {string}
+     * @memberof OneIdProviderAddress
+     */
+    postalCode?: string | null;
+    /**
+     * The alpha-2 country code of the address.
+     * @type {string}
+     * @memberof OneIdProviderAddress
+     */
+    countryCode?: string | null;
+}
+
+/**
+ * Check if a given object implements the OneIdProviderAddress interface.
+ */
+export function instanceOfOneIdProviderAddress(value: object): value is OneIdProviderAddress {
+    return true;
+}
+
+export function OneIdProviderAddressFromJSON(json: any): OneIdProviderAddress {
+    return OneIdProviderAddressFromJSONTyped(json, false);
+}
+
+export function OneIdProviderAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): OneIdProviderAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'streetAddress': json['streetAddress'] == null ? undefined : json['streetAddress'],
+        'locality': json['locality'] == null ? undefined : json['locality'],
+        'region': json['region'] == null ? undefined : json['region'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+        'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
+    };
+}
+
+export function OneIdProviderAddressToJSON(json: any): OneIdProviderAddress {
+    return OneIdProviderAddressToJSONTyped(json, false);
+}
+
+export function OneIdProviderAddressToJSONTyped(value?: OneIdProviderAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'streetAddress': value['streetAddress'],
+        'locality': value['locality'],
+        'region': value['region'],
+        'postalCode': value['postalCode'],
+        'countryCode': value['countryCode'],
+    };
+}
+

package/src/models/OneIdProviderOutput.ts

@@ -0,0 +1,113 @@
+/* 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 { OneIdProviderAddress } from './OneIdProviderAddress';
+import {
+    OneIdProviderAddressFromJSON,
+    OneIdProviderAddressFromJSONTyped,
+    OneIdProviderAddressToJSON,
+    OneIdProviderAddressToJSONTyped,
+} from './OneIdProviderAddress';
+
+/**
+ * Exposed properties for the `oneid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface OneIdProviderOutput
+ */
+export interface OneIdProviderOutput {
+    /**
+     * The OpenID Connect (OIDC) subject identifier (sub).
+     * @type {string}
+     * @memberof OneIdProviderOutput
+     */
+    sub?: string | null;
+    /**
+     * The individual's full name.
+     * @type {string}
+     * @memberof OneIdProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The individual's given name.
+     * @type {string}
+     * @memberof OneIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The individual's family name.
+     * @type {string}
+     * @memberof OneIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * @type {Date}
+     * @memberof OneIdProviderOutput
+     */
+    birthdate?: Date | null;
+    /**
+     * The address of the individual.
+     * @type {OneIdProviderAddress}
+     * @memberof OneIdProviderOutput
+     */
+    address?: OneIdProviderAddress | null;
+}
+
+/**
+ * Check if a given object implements the OneIdProviderOutput interface.
+ */
+export function instanceOfOneIdProviderOutput(value: object): value is OneIdProviderOutput {
+    return true;
+}
+
+export function OneIdProviderOutputFromJSON(json: any): OneIdProviderOutput {
+    return OneIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function OneIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): OneIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sub': json['sub'] == null ? undefined : json['sub'],
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'birthdate': json['birthdate'] == null ? undefined : (new Date(json['birthdate'])),
+        'address': json['address'] == null ? undefined : OneIdProviderAddressFromJSON(json['address']),
+    };
+}
+
+export function OneIdProviderOutputToJSON(json: any): OneIdProviderOutput {
+    return OneIdProviderOutputToJSONTyped(json, false);
+}
+
+export function OneIdProviderOutputToJSONTyped(value?: OneIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sub': value['sub'],
+        'fullName': value['fullName'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'birthdate': value['birthdate'] == null ? undefined : ((value['birthdate'] as any).toISOString().substring(0,10)),
+        'address': OneIdProviderAddressToJSON(value['address']),
+    };
+}
+

package/src/models/OutputFrejaAddress.ts

@@ -0,0 +1,89 @@
+/* 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 OutputFrejaAddress
+ */
+export interface OutputFrejaAddress {
+    /**
+     * The line1 portion of the address. Incorporates all address details that are not included by city, postal code, and country.
+     * @type {string}
+     * @memberof OutputFrejaAddress
+     */
+    line1?: string | null;
+    /**
+     * The name of the city associated with the address.
+     * @type {string}
+     * @memberof OutputFrejaAddress
+     */
+    city?: string | null;
+    /**
+     * The postal code associated with the address.
+     * @type {string}
+     * @memberof OutputFrejaAddress
+     */
+    postalCode?: string | null;
+    /**
+     * The ISO 3166-1 alpha-2 country code associated with the address.
+     * @type {string}
+     * @memberof OutputFrejaAddress
+     */
+    country?: string | null;
+}
+
+/**
+ * Check if a given object implements the OutputFrejaAddress interface.
+ */
+export function instanceOfOutputFrejaAddress(value: object): value is OutputFrejaAddress {
+    return true;
+}
+
+export function OutputFrejaAddressFromJSON(json: any): OutputFrejaAddress {
+    return OutputFrejaAddressFromJSONTyped(json, false);
+}
+
+export function OutputFrejaAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): OutputFrejaAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'line1': json['line1'] == null ? undefined : json['line1'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+        'country': json['country'] == null ? undefined : json['country'],
+    };
+}
+
+export function OutputFrejaAddressToJSON(json: any): OutputFrejaAddress {
+    return OutputFrejaAddressToJSONTyped(json, false);
+}
+
+export function OutputFrejaAddressToJSONTyped(value?: OutputFrejaAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'line1': value['line1'],
+        'city': value['city'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+    };
+}
+