@trinsic/api 2.3.0-alpha2 → 3.0.1

package/dist/models/NigeriaNinMatch2InputSex.js

@@ -0,0 +1,51 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NigeriaNinMatch2InputSex = void 0;
+exports.instanceOfNigeriaNinMatch2InputSex = instanceOfNigeriaNinMatch2InputSex;
+exports.NigeriaNinMatch2InputSexFromJSON = NigeriaNinMatch2InputSexFromJSON;
+exports.NigeriaNinMatch2InputSexFromJSONTyped = NigeriaNinMatch2InputSexFromJSONTyped;
+exports.NigeriaNinMatch2InputSexToJSON = NigeriaNinMatch2InputSexToJSON;
+exports.NigeriaNinMatch2InputSexToJSONTyped = NigeriaNinMatch2InputSexToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.NigeriaNinMatch2InputSex = {
+    Male: 'Male',
+    Female: 'Female'
+};
+function instanceOfNigeriaNinMatch2InputSex(value) {
+    for (const key in exports.NigeriaNinMatch2InputSex) {
+        if (Object.prototype.hasOwnProperty.call(exports.NigeriaNinMatch2InputSex, key)) {
+            if (exports.NigeriaNinMatch2InputSex[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function NigeriaNinMatch2InputSexFromJSON(json) {
+    return NigeriaNinMatch2InputSexFromJSONTyped(json, false);
+}
+function NigeriaNinMatch2InputSexFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function NigeriaNinMatch2InputSexToJSON(value) {
+    return value;
+}
+function NigeriaNinMatch2InputSexToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/PersonData.d.ts

@@ -12,37 +12,39 @@
 import type { Address } from './Address';
 import type { Sex } from './Sex';
 /**
- *
+ * Identity information for the individual being verified
  * @export
  * @interface PersonData
  */
 export interface PersonData {
     /**
-     *
+     * Given (first) name of the individual
      * @type {string}
      * @memberof PersonData
      */
     givenName?: string | null;
     /**
-     *
+     * Family (last) name of the individual
      * @type {string}
      * @memberof PersonData
      */
     familyName?: string | null;
     /**
-     *
+     * Middle name of the individual
      * @type {string}
      * @memberof PersonData
      */
     middleName?: string | null;
     /**
+     * The individual's full name as a single string.
      *
+     * Useful for names which do not fit into a "first middle last" structure.
      * @type {string}
      * @memberof PersonData
      */
     fullName?: string | null;
     /**
-     *
+     * Suffix of the individual's name
      * @type {string}
      * @memberof PersonData
      */
@@ -66,7 +68,7 @@ export interface PersonData {
      */
     phoneNumber?: string | null;
     /**
-     *
+     * Address information for an individual
      * @type {Address}
      * @memberof PersonData
      */

package/dist/models/PeruDniAddress.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * Not a typical address. Does not include street or city. Instead, includes region, province and district.
+ * @export
+ * @interface PeruDniAddress
+ */
+export interface PeruDniAddress {
+    /**
+     * Region in Peru (also known as department). This is the first level subdivision in the country.
+     *
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    region: string;
+    /**
+     * Province within the region. This is the second level subdivision in the country.
+     *
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    province: string;
+    /**
+     * District within the province. This is the third level subdivision in the country.
+     *
+     * Format:
+     * - All uppercase.
+     * @type {string}
+     * @memberof PeruDniAddress
+     */
+    district: string;
+}
+/**
+ * Check if a given object implements the PeruDniAddress interface.
+ */
+export declare function instanceOfPeruDniAddress(value: object): value is PeruDniAddress;
+export declare function PeruDniAddressFromJSON(json: any): PeruDniAddress;
+export declare function PeruDniAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): PeruDniAddress;
+export declare function PeruDniAddressToJSON(json: any): PeruDniAddress;
+export declare function PeruDniAddressToJSONTyped(value?: PeruDniAddress | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PeruDniAddress.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPeruDniAddress = instanceOfPeruDniAddress;
+exports.PeruDniAddressFromJSON = PeruDniAddressFromJSON;
+exports.PeruDniAddressFromJSONTyped = PeruDniAddressFromJSONTyped;
+exports.PeruDniAddressToJSON = PeruDniAddressToJSON;
+exports.PeruDniAddressToJSONTyped = PeruDniAddressToJSONTyped;
+/**
+ * Check if a given object implements the PeruDniAddress interface.
+ */
+function instanceOfPeruDniAddress(value) {
+    if (!('region' in value) || value['region'] === undefined)
+        return false;
+    if (!('province' in value) || value['province'] === undefined)
+        return false;
+    if (!('district' in value) || value['district'] === undefined)
+        return false;
+    return true;
+}
+function PeruDniAddressFromJSON(json) {
+    return PeruDniAddressFromJSONTyped(json, false);
+}
+function PeruDniAddressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'region': json['region'],
+        'province': json['province'],
+        'district': json['district'],
+    };
+}
+function PeruDniAddressToJSON(json) {
+    return PeruDniAddressToJSONTyped(json, false);
+}
+function PeruDniAddressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'region': value['region'],
+        'province': value['province'],
+        'district': value['district'],
+    };
+}

package/dist/models/PeruDniLookupInput.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PeruDniLookupInput
+ */
+export interface PeruDniLookupInput {
+    /**
+     * The user's DNI number (8 digits).
+     *
+     * Format:
+     * - Must not include verification digit. On the DNI card, a ninth digit appears after the first eight, with value
+     *   0-9 or A-K. This is not included in the DNI number when verifying against Peru's database.
+     * - Peru DNI is sometimes represented with dots. Though uncommon, if dots are included, they will be sanitized.
+     * @type {string}
+     * @memberof PeruDniLookupInput
+     */
+    documentNumber?: string | null;
+}
+/**
+ * Check if a given object implements the PeruDniLookupInput interface.
+ */
+export declare function instanceOfPeruDniLookupInput(value: object): value is PeruDniLookupInput;
+export declare function PeruDniLookupInputFromJSON(json: any): PeruDniLookupInput;
+export declare function PeruDniLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PeruDniLookupInput;
+export declare function PeruDniLookupInputToJSON(json: any): PeruDniLookupInput;
+export declare function PeruDniLookupInputToJSONTyped(value?: PeruDniLookupInput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PeruDniLookupInput.js

@@ -0,0 +1,48 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPeruDniLookupInput = instanceOfPeruDniLookupInput;
+exports.PeruDniLookupInputFromJSON = PeruDniLookupInputFromJSON;
+exports.PeruDniLookupInputFromJSONTyped = PeruDniLookupInputFromJSONTyped;
+exports.PeruDniLookupInputToJSON = PeruDniLookupInputToJSON;
+exports.PeruDniLookupInputToJSONTyped = PeruDniLookupInputToJSONTyped;
+/**
+ * Check if a given object implements the PeruDniLookupInput interface.
+ */
+function instanceOfPeruDniLookupInput(value) {
+    return true;
+}
+function PeruDniLookupInputFromJSON(json) {
+    return PeruDniLookupInputFromJSONTyped(json, false);
+}
+function PeruDniLookupInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'documentNumber': json['documentNumber'] == null ? undefined : json['documentNumber'],
+    };
+}
+function PeruDniLookupInputToJSON(json) {
+    return PeruDniLookupInputToJSONTyped(json, false);
+}
+function PeruDniLookupInputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'documentNumber': value['documentNumber'],
+    };
+}

package/dist/models/PeruDniProviderOutput.d.ts

@@ -0,0 +1,213 @@
+/**
+ * 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 type { PeruDniAddress } from './PeruDniAddress';
+/**
+ * Exposed properties for the `peru-dni-lookup` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface PeruDniProviderOutput
+ */
+export interface PeruDniProviderOutput {
+    /**
+     * Information about the general area in which the DNI holder resides.
+     *
+     * This field is not always available.
+     * @type {PeruDniAddress}
+     * @memberof PeruDniProviderOutput
+     */
+    address?: PeruDniAddress | null;
+    /**
+     * All names that appear on DNI, as an array of strings.
+     *
+     * Format:
+     * - All uppercase
+     * - Ordered by paternal family name, then maternal family name, then given names.
+     * @type {Array<string>}
+     * @memberof PeruDniProviderOutput
+     */
+    arrayName: Array<string>;
+    /**
+     * Marital status as it appears on the DNI.
+     *
+     * This field is not always available.
+     *
+     * Valid values:
+     * - "Single"
+     * - "Married"
+     * - "Divorced"
+     * - "Widowed"
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    civilStatus?: string | null;
+    /**
+     * Date of birth as it appears on the DNI.
+     *
+     * This field is not always available.
+     * @type {Date}
+     * @memberof PeruDniProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The user's National Identity Document number (Documento Nacional de Identidad or DNI).
+     *
+     * Format:
+     * - 8 digits
+     * - Does NOT include verification digit. On the DNI card, a ninth digit appears next to the first eight. It is
+     *   0-9 or A-K. This is NOT included in the DNI number when returned from Peru's database.
+     * - Does NOT include dots or hyphens
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    documentNumber: string;
+    /**
+     * Should always be "DNI".
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    documentType: string;
+    /**
+     * Date that the DNI was issued.
+     *
+     * This field is not always available.
+     *
+     * Format:
+     * - yyyy-MM-dd
+     * @type {Date}
+     * @memberof PeruDniProviderOutput
+     */
+    expeditionDate?: Date | null;
+    /**
+     * Date that the DNI will expire. DNI expires every 8 years, unless the citizen is >= 60 years old, in which case
+     * it never expires.
+     *
+     * This field is not always available.
+     *
+     * Format:
+     * - yyyy-MM-dd
+     * @type {Date}
+     * @memberof PeruDniProviderOutput
+     */
+    expirationDate?: Date | null;
+    /**
+     * Given names as they appear on DNI.
+     *
+     * Format:
+     * - All uppercase
+     * - Space-separated
+     * - Will include all given names
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    firstName: string;
+    /**
+     * All names as they appear on DNI.
+     *
+     * Format:
+     * - All uppercase
+     * - Space-separated
+     * - Will include all names, given and family
+     * - Ordered by given names first, then paternal family name, then maternal family name
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    fullName: string;
+    /**
+     * Family names as they appear on DNI.
+     *
+     * Format:
+     * - All uppercase
+     * - Will include all family names
+     * - Ordered by paternal family name first, then maternal family name
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    lastName: string;
+    /**
+     * Maternal last name as it appears on DNI.
+     *
+     * Format:
+     * - All uppercase
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    maternalLastName: string;
+    /**
+     * Paternal last name as it appears on DNI.
+     *
+     * Format:
+     * - All uppercase
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    paternalLastName: string;
+    /**
+     * Sex as it appears on DNI.
+     *
+     * This field is not always available.
+     *
+     * Values:
+     * - "Male"
+     * - "Female"
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    sex?: string | null;
+    /**
+     * In Peru, geographical locations have an official geographical code called UBIGEO, from the spanish "UBIcación
+     * GEOgráfica" (Geographic Location). This is an administrative geocode, is different from a postal code (which
+     * Peru also has) and is used to specifically delineate the administrative region, province and district hierarchy.
+     *
+     * There are two coding systems for UBIGEO: one from INEI (National Institute of Statistics and Informatics) and
+     * another from RENIEC (National Registry of Identification and Civil Status). The two coding systems are similar
+     * but are not 100% the same (some numbers will map to different geographic locations). This field follows the
+     * coding system from RENIEC.
+     *
+     * This field is not always available.
+     *
+     * Format:
+     * - Always 6 digits
+     * - First two digits represent region
+     * - Middle two are province
+     * - Last two are district
+     *
+     * Given the example 081304, that would correspond to:
+     * - 08 - Cusco Region
+     * - 0813 - Urubamba Province
+     * - 081304 - Machupicchu District
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    ubigeoReniec?: string | null;
+    /**
+     * The final (ninth) digit of the DNI, which serves as a checksum over the first eight digits.
+     *
+     * This field is not always available.
+     *
+     * Format:
+     * - Single character
+     * - Either 0-9 or A-K
+     *
+     * Read more here:
+     *   https://elcomercio.pe/mag/respuestas/cual-es-el-digito-verificador-de-mi-dni-documento-nacional-de-identidad-reniec-peru-nnda-nnlt-noticia/
+     * @type {string}
+     * @memberof PeruDniProviderOutput
+     */
+    verificationDigit?: string | null;
+}
+/**
+ * Check if a given object implements the PeruDniProviderOutput interface.
+ */
+export declare function instanceOfPeruDniProviderOutput(value: object): value is PeruDniProviderOutput;
+export declare function PeruDniProviderOutputFromJSON(json: any): PeruDniProviderOutput;
+export declare function PeruDniProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PeruDniProviderOutput;
+export declare function PeruDniProviderOutputToJSON(json: any): PeruDniProviderOutput;
+export declare function PeruDniProviderOutputToJSONTyped(value?: PeruDniProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PeruDniProviderOutput.js

@@ -0,0 +1,95 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPeruDniProviderOutput = instanceOfPeruDniProviderOutput;
+exports.PeruDniProviderOutputFromJSON = PeruDniProviderOutputFromJSON;
+exports.PeruDniProviderOutputFromJSONTyped = PeruDniProviderOutputFromJSONTyped;
+exports.PeruDniProviderOutputToJSON = PeruDniProviderOutputToJSON;
+exports.PeruDniProviderOutputToJSONTyped = PeruDniProviderOutputToJSONTyped;
+const PeruDniAddress_1 = require("./PeruDniAddress");
+/**
+ * Check if a given object implements the PeruDniProviderOutput interface.
+ */
+function instanceOfPeruDniProviderOutput(value) {
+    if (!('arrayName' in value) || value['arrayName'] === undefined)
+        return false;
+    if (!('documentNumber' in value) || value['documentNumber'] === undefined)
+        return false;
+    if (!('documentType' in value) || value['documentType'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('fullName' in value) || value['fullName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('maternalLastName' in value) || value['maternalLastName'] === undefined)
+        return false;
+    if (!('paternalLastName' in value) || value['paternalLastName'] === undefined)
+        return false;
+    return true;
+}
+function PeruDniProviderOutputFromJSON(json) {
+    return PeruDniProviderOutputFromJSONTyped(json, false);
+}
+function PeruDniProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'address': json['address'] == null ? undefined : (0, PeruDniAddress_1.PeruDniAddressFromJSON)(json['address']),
+        'arrayName': json['arrayName'],
+        'civilStatus': json['civilStatus'] == null ? undefined : json['civilStatus'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'documentNumber': json['documentNumber'],
+        'documentType': json['documentType'],
+        'expeditionDate': json['expeditionDate'] == null ? undefined : (new Date(json['expeditionDate'])),
+        'expirationDate': json['expirationDate'] == null ? undefined : (new Date(json['expirationDate'])),
+        'firstName': json['firstName'],
+        'fullName': json['fullName'],
+        'lastName': json['lastName'],
+        'maternalLastName': json['maternalLastName'],
+        'paternalLastName': json['paternalLastName'],
+        'sex': json['sex'] == null ? undefined : json['sex'],
+        'ubigeoReniec': json['ubigeoReniec'] == null ? undefined : json['ubigeoReniec'],
+        'verificationDigit': json['verificationDigit'] == null ? undefined : json['verificationDigit'],
+    };
+}
+function PeruDniProviderOutputToJSON(json) {
+    return PeruDniProviderOutputToJSONTyped(json, false);
+}
+function PeruDniProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'address': (0, PeruDniAddress_1.PeruDniAddressToJSON)(value['address']),
+        'arrayName': value['arrayName'],
+        'civilStatus': value['civilStatus'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'documentNumber': value['documentNumber'],
+        'documentType': value['documentType'],
+        'expeditionDate': value['expeditionDate'] == null ? undefined : (value['expeditionDate'].toISOString().substring(0, 10)),
+        'expirationDate': value['expirationDate'] == null ? undefined : (value['expirationDate'].toISOString().substring(0, 10)),
+        'firstName': value['firstName'],
+        'fullName': value['fullName'],
+        'lastName': value['lastName'],
+        'maternalLastName': value['maternalLastName'],
+        'paternalLastName': value['paternalLastName'],
+        'sex': value['sex'],
+        'ubigeoReniec': value['ubigeoReniec'],
+        'verificationDigit': value['verificationDigit'],
+    };
+}

package/dist/models/PhilippinesDigitalNidProviderOutput.d.ts

@@ -10,13 +10,14 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Exposed properties for the `philippines-digital-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
  * @export
  * @interface PhilippinesDigitalNidProviderOutput
  */
 export interface PhilippinesDigitalNidProviderOutput {
     /**
-     * The PhilSys card number.
+     * The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN.
+     * The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between.
      * @type {string}
      * @memberof PhilippinesDigitalNidProviderOutput
      */

package/dist/models/PhilippinesPhysicalNidProviderOutput.d.ts

@@ -10,13 +10,14 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Exposed properties for the `philippines-physical-national-id-qr` Provider which do not directly map to the normalized IdentityData model.
  * @export
  * @interface PhilippinesPhysicalNidProviderOutput
  */
 export interface PhilippinesPhysicalNidProviderOutput {
     /**
-     * The PhilSys card number.
+     * The PhilSys Card Number (PCN). Every citizen or resident alien registered in PhilSys has a PhilSys Number (PSN). This number is tokenized into a card number to protect the PSN.
+     * The PhilSys Card Number is 12 characters long, and often is written in octets with dashes in between.
      * @type {string}
      * @memberof PhilippinesPhysicalNidProviderOutput
      */