@trinsic/api 2.3.0-alpha2 → 3.0.1

package/dist/esm/models/NigeriaNinLookup2Input.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 NigeriaNinLookup2Input
+ */
+export interface NigeriaNinLookup2Input {
+    /**
+     * The user's National ID number (NIN)
+     * @type {string}
+     * @memberof NigeriaNinLookup2Input
+     */
+    idNumber?: string | null;
+}
+/**
+ * Check if a given object implements the NigeriaNinLookup2Input interface.
+ */
+export declare function instanceOfNigeriaNinLookup2Input(value: object): value is NigeriaNinLookup2Input;
+export declare function NigeriaNinLookup2InputFromJSON(json: any): NigeriaNinLookup2Input;
+export declare function NigeriaNinLookup2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinLookup2Input;
+export declare function NigeriaNinLookup2InputToJSON(json: any): NigeriaNinLookup2Input;
+export declare function NigeriaNinLookup2InputToJSONTyped(value?: NigeriaNinLookup2Input | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/NigeriaNinLookup2Input.js

@@ -0,0 +1,41 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the NigeriaNinLookup2Input interface.
+ */
+export function instanceOfNigeriaNinLookup2Input(value) {
+    return true;
+}
+export function NigeriaNinLookup2InputFromJSON(json) {
+    return NigeriaNinLookup2InputFromJSONTyped(json, false);
+}
+export function NigeriaNinLookup2InputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+    };
+}
+export function NigeriaNinLookup2InputToJSON(json) {
+    return NigeriaNinLookup2InputToJSONTyped(json, false);
+}
+export function NigeriaNinLookup2InputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'idNumber': value['idNumber'],
+    };
+}

package/dist/esm/models/NigeriaNinMatch2Input.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 { NigeriaNinMatch2InputSex } from './NigeriaNinMatch2InputSex';
+/**
+ *
+ * @export
+ * @interface NigeriaNinMatch2Input
+ */
+export interface NigeriaNinMatch2Input {
+    /**
+     * The user's Nigerian National ID number (NIN)
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    idNumber?: string | null;
+    /**
+     * The user's first name as it appears in their National ID
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    givenName?: string | null;
+    /**
+     * The user's last name as it appears in their National ID
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    familyName?: string | null;
+    /**
+     * The user's middle name as it appears in their National ID (optional)
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    middleName?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof NigeriaNinMatch2Input
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The user's sex as it appears in their National ID
+     * @type {NigeriaNinMatch2InputSex}
+     * @memberof NigeriaNinMatch2Input
+     */
+    sex?: NigeriaNinMatch2InputSex | null;
+    /**
+     * The user's phone number as it appears in their National ID (optional).
+     * Must be in E.164 international format: "+234XXXXXXXXX"
+     * @type {string}
+     * @memberof NigeriaNinMatch2Input
+     */
+    phoneNumber?: string | null;
+}
+/**
+ * Check if a given object implements the NigeriaNinMatch2Input interface.
+ */
+export declare function instanceOfNigeriaNinMatch2Input(value: object): value is NigeriaNinMatch2Input;
+export declare function NigeriaNinMatch2InputFromJSON(json: any): NigeriaNinMatch2Input;
+export declare function NigeriaNinMatch2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinMatch2Input;
+export declare function NigeriaNinMatch2InputToJSON(json: any): NigeriaNinMatch2Input;
+export declare function NigeriaNinMatch2InputToJSONTyped(value?: NigeriaNinMatch2Input | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/NigeriaNinMatch2Input.js

@@ -0,0 +1,54 @@
+/* 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 { NigeriaNinMatch2InputSexFromJSON, NigeriaNinMatch2InputSexToJSON, } from './NigeriaNinMatch2InputSex';
+/**
+ * Check if a given object implements the NigeriaNinMatch2Input interface.
+ */
+export function instanceOfNigeriaNinMatch2Input(value) {
+    return true;
+}
+export function NigeriaNinMatch2InputFromJSON(json) {
+    return NigeriaNinMatch2InputFromJSONTyped(json, false);
+}
+export function NigeriaNinMatch2InputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'sex': json['sex'] == null ? undefined : NigeriaNinMatch2InputSexFromJSON(json['sex']),
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+    };
+}
+export function NigeriaNinMatch2InputToJSON(json) {
+    return NigeriaNinMatch2InputToJSONTyped(json, false);
+}
+export function NigeriaNinMatch2InputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'idNumber': value['idNumber'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'middleName': value['middleName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'sex': NigeriaNinMatch2InputSexToJSON(value['sex']),
+        'phoneNumber': value['phoneNumber'],
+    };
+}

package/dist/esm/models/NigeriaNinMatch2InputSex.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+export declare const NigeriaNinMatch2InputSex: {
+    readonly Male: "Male";
+    readonly Female: "Female";
+};
+export type NigeriaNinMatch2InputSex = typeof NigeriaNinMatch2InputSex[keyof typeof NigeriaNinMatch2InputSex];
+export declare function instanceOfNigeriaNinMatch2InputSex(value: any): boolean;
+export declare function NigeriaNinMatch2InputSexFromJSON(json: any): NigeriaNinMatch2InputSex;
+export declare function NigeriaNinMatch2InputSexFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinMatch2InputSex;
+export declare function NigeriaNinMatch2InputSexToJSON(value?: NigeriaNinMatch2InputSex | null): any;
+export declare function NigeriaNinMatch2InputSexToJSONTyped(value: any, ignoreDiscriminator: boolean): NigeriaNinMatch2InputSex;

package/dist/esm/models/NigeriaNinMatch2InputSex.js

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

package/dist/esm/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/esm/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/esm/models/PeruDniAddress.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PeruDniAddress interface.
+ */
+export 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;
+}
+export function PeruDniAddressFromJSON(json) {
+    return PeruDniAddressFromJSONTyped(json, false);
+}
+export function PeruDniAddressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'region': json['region'],
+        'province': json['province'],
+        'district': json['district'],
+    };
+}
+export function PeruDniAddressToJSON(json) {
+    return PeruDniAddressToJSONTyped(json, false);
+}
+export function PeruDniAddressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'region': value['region'],
+        'province': value['province'],
+        'district': value['district'],
+    };
+}

package/dist/esm/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/esm/models/PeruDniLookupInput.js

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