@trinsic/api 2.3.0-alpha2 → 3.0.0

package/src/models/Address.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * 
+ * Address information for an individual
  * @export
  * @interface Address
  */
@@ -44,7 +44,10 @@ export interface Address {
      */
     city?: string | null;
     /**
-     * 
+     * The subdivision code of the address.
+     *             
+     * Subdivision refers to a state, province, or other similar division of a country.
+     * Examples include "CA" for California, "QC" for Québec, "MD" for Madrid, or "NSW" for New South Wales.
      * @type {string}
      * @memberof Address
      */
@@ -62,7 +65,7 @@ export interface Address {
      */
     country?: string | null;
     /**
-     * 
+     * The full address as a single string
      * @type {string}
      * @memberof Address
      */

package/src/models/AppleWalletProviderOutput.ts

@@ -0,0 +1,74 @@
+/* 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 { MdlOutput } from './MdlOutput';
+import {
+    MdlOutputFromJSON,
+    MdlOutputFromJSONTyped,
+    MdlOutputToJSON,
+    MdlOutputToJSONTyped,
+} from './MdlOutput';
+
+/**
+ * Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface AppleWalletProviderOutput
+ */
+export interface AppleWalletProviderOutput {
+    /**
+     * The raw output of the mDL exchange performed through Apple Wallet.
+     * @type {MdlOutput}
+     * @memberof AppleWalletProviderOutput
+     */
+    rawMdlOutput: MdlOutput;
+}
+
+/**
+ * Check if a given object implements the AppleWalletProviderOutput interface.
+ */
+export function instanceOfAppleWalletProviderOutput(value: object): value is AppleWalletProviderOutput {
+    if (!('rawMdlOutput' in value) || value['rawMdlOutput'] === undefined) return false;
+    return true;
+}
+
+export function AppleWalletProviderOutputFromJSON(json: any): AppleWalletProviderOutput {
+    return AppleWalletProviderOutputFromJSONTyped(json, false);
+}
+
+export function AppleWalletProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppleWalletProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rawMdlOutput': MdlOutputFromJSON(json['rawMdlOutput']),
+    };
+}
+
+export function AppleWalletProviderOutputToJSON(json: any): AppleWalletProviderOutput {
+    return AppleWalletProviderOutputToJSONTyped(json, false);
+}
+
+export function AppleWalletProviderOutputToJSONTyped(value?: AppleWalletProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'rawMdlOutput': MdlOutputToJSON(value['rawMdlOutput']),
+    };
+}
+

package/src/models/AttachmentInfo.ts

@@ -0,0 +1,105 @@
+/* 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 AttachmentInfo
+ */
+export interface AttachmentInfo {
+    /**
+     * The unique identifier of the Attachment.
+     *             
+     * Pass this to the `GetAttachment` endpoint, along with the Session ID and the `resultsAccessKey` for said Session.
+     * @type {string}
+     * @memberof AttachmentInfo
+     */
+    id: string;
+    /**
+     * The type of the Attachment.
+     *             
+     * Possible values:
+     * - "selfie"
+     * - "document_front"
+     * - "document_back"
+     * - "document_portrait"
+     * - "document_signature"
+     * - "document_scan_report"
+     *             
+     * Additional attachment types may be defined for specific Providers.
+     * @type {string}
+     * @memberof AttachmentInfo
+     */
+    type: string;
+    /**
+     * The MIME type of the attachment's contents; eg, "image/jpeg" or "application/pdf".
+     * @type {string}
+     * @memberof AttachmentInfo
+     */
+    contentType: string;
+    /**
+     * The size in bytes of the attachment.
+     * @type {number}
+     * @memberof AttachmentInfo
+     */
+    sizeBytes: number;
+}
+
+/**
+ * Check if a given object implements the AttachmentInfo interface.
+ */
+export function instanceOfAttachmentInfo(value: object): value is AttachmentInfo {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('contentType' in value) || value['contentType'] === undefined) return false;
+    if (!('sizeBytes' in value) || value['sizeBytes'] === undefined) return false;
+    return true;
+}
+
+export function AttachmentInfoFromJSON(json: any): AttachmentInfo {
+    return AttachmentInfoFromJSONTyped(json, false);
+}
+
+export function AttachmentInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttachmentInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        'contentType': json['contentType'],
+        'sizeBytes': json['sizeBytes'],
+    };
+}
+
+export function AttachmentInfoToJSON(json: any): AttachmentInfo {
+    return AttachmentInfoToJSONTyped(json, false);
+}
+
+export function AttachmentInfoToJSONTyped(value?: AttachmentInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'contentType': value['contentType'],
+        'sizeBytes': value['sizeBytes'],
+    };
+}
+

package/src/models/AttributeAvailability.ts

@@ -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.
+ */
+
+
+/**
+ * Indicates when an attribute will be available in verification results.
+ * @export
+ */
+export const AttributeAvailability = {
+    Never: 'Never',
+    Sometimes: 'Sometimes',
+    Always: 'Always'
+} as const;
+export type AttributeAvailability = typeof AttributeAvailability[keyof typeof AttributeAvailability];
+
+
+export function instanceOfAttributeAvailability(value: any): boolean {
+    for (const key in AttributeAvailability) {
+        if (Object.prototype.hasOwnProperty.call(AttributeAvailability, key)) {
+            if (AttributeAvailability[key as keyof typeof AttributeAvailability] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AttributeAvailabilityFromJSON(json: any): AttributeAvailability {
+    return AttributeAvailabilityFromJSONTyped(json, false);
+}
+
+export function AttributeAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttributeAvailability {
+    return json as AttributeAvailability;
+}
+
+export function AttributeAvailabilityToJSON(value?: AttributeAvailability | null): any {
+    return value as any;
+}
+
+export function AttributeAvailabilityToJSONTyped(value: any, ignoreDiscriminator: boolean): AttributeAvailability {
+    return value as AttributeAvailability;
+}
+

package/src/models/AustriaHandySignaturProviderOutput.ts

@@ -0,0 +1,75 @@
+/* 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-at-handy-signatur-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface AustriaHandySignaturProviderOutput
+ */
+export interface AustriaHandySignaturProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof AustriaHandySignaturProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof AustriaHandySignaturProviderOutput
+     */
+    lastName: string;
+}
+
+/**
+ * Check if a given object implements the AustriaHandySignaturProviderOutput interface.
+ */
+export function instanceOfAustriaHandySignaturProviderOutput(value: object): value is AustriaHandySignaturProviderOutput {
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    return true;
+}
+
+export function AustriaHandySignaturProviderOutputFromJSON(json: any): AustriaHandySignaturProviderOutput {
+    return AustriaHandySignaturProviderOutputFromJSONTyped(json, false);
+}
+
+export function AustriaHandySignaturProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AustriaHandySignaturProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+    };
+}
+
+export function AustriaHandySignaturProviderOutputToJSON(json: any): AustriaHandySignaturProviderOutput {
+    return AustriaHandySignaturProviderOutputToJSONTyped(json, false);
+}
+
+export function AustriaHandySignaturProviderOutputToJSONTyped(value?: AustriaHandySignaturProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+    };
+}
+

package/src/models/BelgiumIdCardProviderOutput.ts

@@ -0,0 +1,100 @@
+/* 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-be-id-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface BelgiumIdCardProviderOutput
+ */
+export interface BelgiumIdCardProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof BelgiumIdCardProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof BelgiumIdCardProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof BelgiumIdCardProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The Belgian National Register Number ("Rijksregisternummer") of the verified individual.
+     *             
+     * This is an 11-digit number in the format YYMMDDXXXCC, where:
+     * - YYMMDD represents the individual's date of birth (year, month, day).
+     * - XXX is a sequential birth number, odd for males and even for females.
+     * - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97)
+     *             
+     * For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation.
+     * @type {string}
+     * @memberof BelgiumIdCardProviderOutput
+     */
+    nationalRegisterNumber: string;
+}
+
+/**
+ * Check if a given object implements the BelgiumIdCardProviderOutput interface.
+ */
+export function instanceOfBelgiumIdCardProviderOutput(value: object): value is BelgiumIdCardProviderOutput {
+    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 (!('nationalRegisterNumber' in value) || value['nationalRegisterNumber'] === undefined) return false;
+    return true;
+}
+
+export function BelgiumIdCardProviderOutputFromJSON(json: any): BelgiumIdCardProviderOutput {
+    return BelgiumIdCardProviderOutputFromJSONTyped(json, false);
+}
+
+export function BelgiumIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): BelgiumIdCardProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'nationalRegisterNumber': json['nationalRegisterNumber'],
+    };
+}
+
+export function BelgiumIdCardProviderOutputToJSON(json: any): BelgiumIdCardProviderOutput {
+    return BelgiumIdCardProviderOutputToJSONTyped(json, false);
+}
+
+export function BelgiumIdCardProviderOutputToJSONTyped(value?: BelgiumIdCardProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'nationalRegisterNumber': value['nationalRegisterNumber'],
+    };
+}
+

package/src/models/ContractAttachment.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';
+import type { AttributeAvailability } from './AttributeAvailability';
+import {
+    AttributeAvailabilityFromJSON,
+    AttributeAvailabilityFromJSONTyped,
+    AttributeAvailabilityToJSON,
+    AttributeAvailabilityToJSONTyped,
+} from './AttributeAvailability';
+
+/**
+ * Information about an attachment that a Provider may return in verification results.
+ * @export
+ * @interface ContractAttachment
+ */
+export interface ContractAttachment {
+    /**
+     * The type of the attachment as it appears in verification results.
+     *             
+     * Possible values:
+     * - "selfie"
+     * - "document_front"
+     * - "document_back"
+     * - "document_portrait"
+     * - "document_signature"
+     * - "document_scan_report"
+     *             
+     * Additional attachment types may be defined for specific Providers.
+     * @type {string}
+     * @memberof ContractAttachment
+     */
+    type: string;
+    /**
+     * Indicates when this attachment will be present in verification results.
+     * @type {AttributeAvailability}
+     * @memberof ContractAttachment
+     */
+    outputted: AttributeAvailability;
+}
+
+
+
+/**
+ * Check if a given object implements the ContractAttachment interface.
+ */
+export function instanceOfContractAttachment(value: object): value is ContractAttachment {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('outputted' in value) || value['outputted'] === undefined) return false;
+    return true;
+}
+
+export function ContractAttachmentFromJSON(json: any): ContractAttachment {
+    return ContractAttachmentFromJSONTyped(json, false);
+}
+
+export function ContractAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAttachment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'outputted': AttributeAvailabilityFromJSON(json['outputted']),
+    };
+}
+
+export function ContractAttachmentToJSON(json: any): ContractAttachment {
+    return ContractAttachmentToJSONTyped(json, false);
+}
+
+export function ContractAttachmentToJSONTyped(value?: ContractAttachment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'outputted': AttributeAvailabilityToJSON(value['outputted']),
+    };
+}
+

package/src/models/ContractAttribute.ts

@@ -0,0 +1,85 @@
+/* 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 { AttributeAvailability } from './AttributeAvailability';
+import {
+    AttributeAvailabilityFromJSON,
+    AttributeAvailabilityFromJSONTyped,
+    AttributeAvailabilityToJSON,
+    AttributeAvailabilityToJSONTyped,
+} from './AttributeAvailability';
+
+/**
+ * Information about an attribute that a Provider may return in verification results.
+ * @export
+ * @interface ContractAttribute
+ */
+export interface ContractAttribute {
+    /**
+     * The scope of the attribute as it appears in verification results.
+     * @type {string}
+     * @memberof ContractAttribute
+     */
+    scope: string;
+    /**
+     * Indicates when this attribute will be present in verification results.
+     * @type {AttributeAvailability}
+     * @memberof ContractAttribute
+     */
+    outputted: AttributeAvailability;
+}
+
+
+
+/**
+ * Check if a given object implements the ContractAttribute interface.
+ */
+export function instanceOfContractAttribute(value: object): value is ContractAttribute {
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('outputted' in value) || value['outputted'] === undefined) return false;
+    return true;
+}
+
+export function ContractAttributeFromJSON(json: any): ContractAttribute {
+    return ContractAttributeFromJSONTyped(json, false);
+}
+
+export function ContractAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractAttribute {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scope': json['scope'],
+        'outputted': AttributeAvailabilityFromJSON(json['outputted']),
+    };
+}
+
+export function ContractAttributeToJSON(json: any): ContractAttribute {
+    return ContractAttributeToJSONTyped(json, false);
+}
+
+export function ContractAttributeToJSONTyped(value?: ContractAttribute | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scope': value['scope'],
+        'outputted': AttributeAvailabilityToJSON(value['outputted']),
+    };
+}
+

package/src/models/CoteDIvoireNidLookup2Input.ts

@@ -0,0 +1,65 @@
+/* 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 CoteDIvoireNidLookup2Input
+ */
+export interface CoteDIvoireNidLookup2Input {
+    /**
+     * The user's National ID number (NNI) or document number
+     * @type {string}
+     * @memberof CoteDIvoireNidLookup2Input
+     */
+    idNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the CoteDIvoireNidLookup2Input interface.
+ */
+export function instanceOfCoteDIvoireNidLookup2Input(value: object): value is CoteDIvoireNidLookup2Input {
+    return true;
+}
+
+export function CoteDIvoireNidLookup2InputFromJSON(json: any): CoteDIvoireNidLookup2Input {
+    return CoteDIvoireNidLookup2InputFromJSONTyped(json, false);
+}
+
+export function CoteDIvoireNidLookup2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CoteDIvoireNidLookup2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+    };
+}
+
+export function CoteDIvoireNidLookup2InputToJSON(json: any): CoteDIvoireNidLookup2Input {
+    return CoteDIvoireNidLookup2InputToJSONTyped(json, false);
+}
+
+export function CoteDIvoireNidLookup2InputToJSONTyped(value?: CoteDIvoireNidLookup2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+    };
+}
+