@trinsic/api 3.0.1 → 3.1.0-preview1

package/src/models/ColombiaCcLookupInput.ts

@@ -0,0 +1,79 @@
+/* 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 ColombiaCcLookupInput
+ */
+export interface ColombiaCcLookupInput {
+    /**
+     * The CC (Cédula de Ciudadanía, Citizenship Document) document number.
+     *             
+     * Format:
+     * - Cédulas after 2004 use the NUIP (Número Único de Identificación Personal), which is 10 digits.
+     *   Older documents may have fewer than 10 digits and are still valid.
+     * - In Colombia the number is often written with dots as thousands separators (e.g. 1.234.567.890). If dots,
+     *   hyphens, spaces, or other non-alphanumeric characters are included, they will be sanitized before lookup.
+     * @type {string}
+     * @memberof ColombiaCcLookupInput
+     */
+    documentNumber?: string | null;
+    /**
+     * Document issue date, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof ColombiaCcLookupInput
+     */
+    issueDate?: Date | null;
+}
+
+/**
+ * Check if a given object implements the ColombiaCcLookupInput interface.
+ */
+export function instanceOfColombiaCcLookupInput(value: object): value is ColombiaCcLookupInput {
+    return true;
+}
+
+export function ColombiaCcLookupInputFromJSON(json: any): ColombiaCcLookupInput {
+    return ColombiaCcLookupInputFromJSONTyped(json, false);
+}
+
+export function ColombiaCcLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColombiaCcLookupInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+        'issueDate': json['issueDate'] == null ? undefined : (new Date(json['issueDate'])),
+    };
+}
+
+export function ColombiaCcLookupInputToJSON(json: any): ColombiaCcLookupInput {
+    return ColombiaCcLookupInputToJSONTyped(json, false);
+}
+
+export function ColombiaCcLookupInputToJSONTyped(value?: ColombiaCcLookupInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'documentNumber': value['documentNumber'],
+        'issueDate': value['issueDate'] == null ? value['issueDate'] : value['issueDate'].toISOString().substring(0,10),
+    };
+}
+

package/src/models/ColombiaCcProviderOutput.ts

@@ -0,0 +1,177 @@
+/* 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 { ColombiaExpeditionPlace } from './ColombiaExpeditionPlace';
+import {
+    ColombiaExpeditionPlaceFromJSON,
+    ColombiaExpeditionPlaceFromJSONTyped,
+    ColombiaExpeditionPlaceToJSON,
+    ColombiaExpeditionPlaceToJSONTyped,
+} from './ColombiaExpeditionPlace';
+
+/**
+ * Exposed properties for the `colombia-cc-lookup` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface ColombiaCcProviderOutput
+ */
+export interface ColombiaCcProviderOutput {
+    /**
+     * Full name as it appears on the CC.
+     * @type {string}
+     * @memberof ColombiaCcProviderOutput
+     */
+    fullName: string;
+    /**
+     * Given name(s) of the holder as they appear on the CC.
+     * @type {string}
+     * @memberof ColombiaCcProviderOutput
+     */
+    givenName: string;
+    /**
+     * Family name(s) of the holder as they appear on the CC. Space-separated when
+     * both paternal and maternal family names are present.
+     * @type {string}
+     * @memberof ColombiaCcProviderOutput
+     */
+    familyName: string;
+    /**
+     * Date of birth as recorded in the civil registry (Registraduría Nacional).
+     * @type {Date}
+     * @memberof ColombiaCcProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * Sex of the holder as recorded in the civil registry (Registraduría Nacional).
+     *             
+     * Possible values:
+     * - Male
+     * - Female
+     * - Unknown (when the sex is not recorded or cannot be confidently determined)
+     * @type {string}
+     * @memberof ColombiaCcProviderOutput
+     */
+    sex: string;
+    /**
+     * Whether the person is reported as alive in Colombia's official civil registry (Registraduría Nacional).
+     *             
+     * Used to detect identity fraud when the holder is deceased.
+     * @type {boolean}
+     * @memberof ColombiaCcProviderOutput
+     */
+    isAlive: boolean;
+    /**
+     * The Cédula de Ciudadanía (CC) document number.
+     *             
+     * This is the unique identifier assigned by the Registraduría Nacional when the person is first
+     * issued a CC. It does not change when the person renews or receives a new physical card; it
+     * remains the same for the individual for life.
+     *             
+     * Cédulas issued after 2004 use the NUIP (Número Único de Identificación Personal), which is
+     * 10 digits. Older documents may have fewer than 10 digits and are still valid.
+     * @type {string}
+     * @memberof ColombiaCcProviderOutput
+     */
+    documentNumber: string;
+    /**
+     * Date the CC was issued (fecha de expedición).
+     *             
+     * Format:
+     * - yyyy-MM-dd
+     * @type {Date}
+     * @memberof ColombiaCcProviderOutput
+     */
+    expeditionDate: Date;
+    /**
+     * Place where the CC was issued (lugar de expedición): municipality and department as recorded
+     * by the Registraduría Nacional.
+     * @type {ColombiaExpeditionPlace}
+     * @memberof ColombiaCcProviderOutput
+     */
+    expeditionPlace: ColombiaExpeditionPlace;
+    /**
+     * All names as they appear on the CC, as an array of strings.
+     *             
+     * Format:
+     * - Order follows the civil registry: typically family name(s) first, then given name(s).
+     * @type {Array<string>}
+     * @memberof ColombiaCcProviderOutput
+     */
+    arrayName: Array<string>;
+}
+
+/**
+ * Check if a given object implements the ColombiaCcProviderOutput interface.
+ */
+export function instanceOfColombiaCcProviderOutput(value: object): value is ColombiaCcProviderOutput {
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('givenName' in value) || value['givenName'] === undefined) return false;
+    if (!('familyName' in value) || value['familyName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('sex' in value) || value['sex'] === undefined) return false;
+    if (!('isAlive' in value) || value['isAlive'] === undefined) return false;
+    if (!('documentNumber' in value) || value['documentNumber'] === undefined) return false;
+    if (!('expeditionDate' in value) || value['expeditionDate'] === undefined) return false;
+    if (!('expeditionPlace' in value) || value['expeditionPlace'] === undefined) return false;
+    if (!('arrayName' in value) || value['arrayName'] === undefined) return false;
+    return true;
+}
+
+export function ColombiaCcProviderOutputFromJSON(json: any): ColombiaCcProviderOutput {
+    return ColombiaCcProviderOutputFromJSONTyped(json, false);
+}
+
+export function ColombiaCcProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColombiaCcProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'],
+        'givenName': json['givenName'],
+        'familyName': json['familyName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'sex': json['sex'],
+        'isAlive': json['isAlive'],
+        'documentNumber': json['documentNumber'],
+        'expeditionDate': (new Date(json['expeditionDate'])),
+        'expeditionPlace': ColombiaExpeditionPlaceFromJSON(json['expeditionPlace']),
+        'arrayName': json['arrayName'],
+    };
+}
+
+export function ColombiaCcProviderOutputToJSON(json: any): ColombiaCcProviderOutput {
+    return ColombiaCcProviderOutputToJSONTyped(json, false);
+}
+
+export function ColombiaCcProviderOutputToJSONTyped(value?: ColombiaCcProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'fullName': value['fullName'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'dateOfBirth': value['dateOfBirth'].toISOString().substring(0,10),
+        'sex': value['sex'],
+        'isAlive': value['isAlive'],
+        'documentNumber': value['documentNumber'],
+        'expeditionDate': value['expeditionDate'].toISOString().substring(0,10),
+        'expeditionPlace': ColombiaExpeditionPlaceToJSON(value['expeditionPlace']),
+        'arrayName': value['arrayName'],
+    };
+}
+

package/src/models/ColombiaExpeditionPlace.ts

@@ -0,0 +1,81 @@
+/* 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';
+/**
+ * Place of expedition (issue) for the Colombia Cédula de Ciudadanía (CC) as recorded by the Registraduría
+ * Nacional del Estado Civil (National Civil Registry).
+ *             
+ * Colombia uses a two-level administrative hierarchy for place of issue: municipality (municipio) within
+ * department (departamento).
+ * @export
+ * @interface ColombiaExpeditionPlace
+ */
+export interface ColombiaExpeditionPlace {
+    /**
+     * Municipality (municipio) where the CC was issued.
+     *             
+     * This is the second-level administrative division in Colombia.
+     * @type {string}
+     * @memberof ColombiaExpeditionPlace
+     */
+    municipality?: string | null;
+    /**
+     * Department (departamento) where the CC was issued.
+     *             
+     * This is the first-level administrative division in Colombia.
+     * @type {string}
+     * @memberof ColombiaExpeditionPlace
+     */
+    department?: string | null;
+}
+
+/**
+ * Check if a given object implements the ColombiaExpeditionPlace interface.
+ */
+export function instanceOfColombiaExpeditionPlace(value: object): value is ColombiaExpeditionPlace {
+    return true;
+}
+
+export function ColombiaExpeditionPlaceFromJSON(json: any): ColombiaExpeditionPlace {
+    return ColombiaExpeditionPlaceFromJSONTyped(json, false);
+}
+
+export function ColombiaExpeditionPlaceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColombiaExpeditionPlace {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'municipality': json['municipality'] == null ? undefined : json['municipality'],
+        'department': json['department'] == null ? undefined : json['department'],
+    };
+}
+
+export function ColombiaExpeditionPlaceToJSON(json: any): ColombiaExpeditionPlace {
+    return ColombiaExpeditionPlaceToJSONTyped(json, false);
+}
+
+export function ColombiaExpeditionPlaceToJSONTyped(value?: ColombiaExpeditionPlace | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'municipality': value['municipality'],
+        'department': value['department'],
+    };
+}
+

package/src/models/ConnectIdAddress.ts

@@ -0,0 +1,99 @@
+/* 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 ConnectIdAddress
+ */
+export interface ConnectIdAddress {
+    /**
+     * The address' line or street.
+     * @type {string}
+     * @memberof ConnectIdAddress
+     */
+    streetAddress?: string | null;
+    /**
+     * The address' locality or city.
+     * @type {string}
+     * @memberof ConnectIdAddress
+     */
+    locality?: string | null;
+    /**
+     * The address' region, state, or territory.
+     * @type {string}
+     * @memberof ConnectIdAddress
+     */
+    region?: string | null;
+    /**
+     * The address' country.
+     *             
+     * This value is not normalized and may be an alpha-3 code or full country name.
+     * @type {string}
+     * @memberof ConnectIdAddress
+     */
+    country?: string | null;
+    /**
+     * The address' postal code.
+     * @type {string}
+     * @memberof ConnectIdAddress
+     */
+    postalCode?: string | null;
+}
+
+/**
+ * Check if a given object implements the ConnectIdAddress interface.
+ */
+export function instanceOfConnectIdAddress(value: object): value is ConnectIdAddress {
+    return true;
+}
+
+export function ConnectIdAddressFromJSON(json: any): ConnectIdAddress {
+    return ConnectIdAddressFromJSONTyped(json, false);
+}
+
+export function ConnectIdAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectIdAddress {
+    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'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+    };
+}
+
+export function ConnectIdAddressToJSON(json: any): ConnectIdAddress {
+    return ConnectIdAddressToJSONTyped(json, false);
+}
+
+export function ConnectIdAddressToJSONTyped(value?: ConnectIdAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'streetAddress': value['streetAddress'],
+        'locality': value['locality'],
+        'region': value['region'],
+        'country': value['country'],
+        'postalCode': value['postalCode'],
+    };
+}
+

package/src/models/ConnectIdAgeVerification.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';
+/**
+ * 
+ * @export
+ * @interface ConnectIdAgeVerification
+ */
+export interface ConnectIdAgeVerification {
+    /**
+     * If the individual is over 18 years old.
+     * @type {boolean}
+     * @memberof ConnectIdAgeVerification
+     */
+    over18?: boolean | null;
+    /**
+     * The authority that verified the claim.
+     * @type {string}
+     * @memberof ConnectIdAgeVerification
+     */
+    trustFramework?: string | null;
+}
+
+/**
+ * Check if a given object implements the ConnectIdAgeVerification interface.
+ */
+export function instanceOfConnectIdAgeVerification(value: object): value is ConnectIdAgeVerification {
+    return true;
+}
+
+export function ConnectIdAgeVerificationFromJSON(json: any): ConnectIdAgeVerification {
+    return ConnectIdAgeVerificationFromJSONTyped(json, false);
+}
+
+export function ConnectIdAgeVerificationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectIdAgeVerification {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'over18': json['over18'] == null ? undefined : json['over18'],
+        'trustFramework': json['trustFramework'] == null ? undefined : json['trustFramework'],
+    };
+}
+
+export function ConnectIdAgeVerificationToJSON(json: any): ConnectIdAgeVerification {
+    return ConnectIdAgeVerificationToJSONTyped(json, false);
+}
+
+export function ConnectIdAgeVerificationToJSONTyped(value?: ConnectIdAgeVerification | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'over18': value['over18'],
+        'trustFramework': value['trustFramework'],
+    };
+}
+

package/src/models/ConnectIdProviderOutput.ts

@@ -0,0 +1,154 @@
+/* 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 { ConnectIdAgeVerification } from './ConnectIdAgeVerification';
+import {
+    ConnectIdAgeVerificationFromJSON,
+    ConnectIdAgeVerificationFromJSONTyped,
+    ConnectIdAgeVerificationToJSON,
+    ConnectIdAgeVerificationToJSONTyped,
+} from './ConnectIdAgeVerification';
+import type { ConnectIdAddress } from './ConnectIdAddress';
+import {
+    ConnectIdAddressFromJSON,
+    ConnectIdAddressFromJSONTyped,
+    ConnectIdAddressToJSON,
+    ConnectIdAddressToJSONTyped,
+} from './ConnectIdAddress';
+
+/**
+ * Exposed properties for the `australia-connect-id` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface ConnectIdProviderOutput
+ */
+export interface ConnectIdProviderOutput {
+    /**
+     * The date of birth of an individual in YYYY-MM-DD format.
+     * @type {Date}
+     * @memberof ConnectIdProviderOutput
+     */
+    birthdate?: Date | null;
+    /**
+     * The given name of an individual.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The middle name of an individual.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    middleName?: string | null;
+    /**
+     * The family/last name of an individual.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * The phone number of an individual.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    phoneNumber?: string | null;
+    /**
+     * The email of an individual.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The OpenID Connect (OIDC) subject identifier (sub).
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    sub?: string | null;
+    /**
+     * The age verification claim and whether the individual meets the age requirement.
+     * @type {ConnectIdAgeVerification}
+     * @memberof ConnectIdProviderOutput
+     */
+    ageVerification?: ConnectIdAgeVerification | null;
+    /**
+     * The verification session's transaction number.
+     *             
+     * This is a unique identifier assigned to a single ConnectID transaction flow. It can be used for audit purposes or to flag fraudulent activity.
+     * @type {string}
+     * @memberof ConnectIdProviderOutput
+     */
+    transaction?: string | null;
+    /**
+     * The address.
+     * @type {ConnectIdAddress}
+     * @memberof ConnectIdProviderOutput
+     */
+    address?: ConnectIdAddress | null;
+}
+
+/**
+ * Check if a given object implements the ConnectIdProviderOutput interface.
+ */
+export function instanceOfConnectIdProviderOutput(value: object): value is ConnectIdProviderOutput {
+    return true;
+}
+
+export function ConnectIdProviderOutputFromJSON(json: any): ConnectIdProviderOutput {
+    return ConnectIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function ConnectIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'birthdate': json['birthdate'] == null ? undefined : (new Date(json['birthdate'])),
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'sub': json['sub'] == null ? undefined : json['sub'],
+        'ageVerification': json['ageVerification'] == null ? undefined : ConnectIdAgeVerificationFromJSON(json['ageVerification']),
+        'transaction': json['transaction'] == null ? undefined : json['transaction'],
+        'address': json['address'] == null ? undefined : ConnectIdAddressFromJSON(json['address']),
+    };
+}
+
+export function ConnectIdProviderOutputToJSON(json: any): ConnectIdProviderOutput {
+    return ConnectIdProviderOutputToJSONTyped(json, false);
+}
+
+export function ConnectIdProviderOutputToJSONTyped(value?: ConnectIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'birthdate': value['birthdate'] == null ? value['birthdate'] : value['birthdate'].toISOString().substring(0,10),
+        'givenName': value['givenName'],
+        'middleName': value['middleName'],
+        'familyName': value['familyName'],
+        'phoneNumber': value['phoneNumber'],
+        'email': value['email'],
+        'sub': value['sub'],
+        'ageVerification': ConnectIdAgeVerificationToJSON(value['ageVerification']),
+        'transaction': value['transaction'],
+        'address': ConnectIdAddressToJSON(value['address']),
+    };
+}
+