@trinsic/api 2.3.0-alpha2 → 3.0.1

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'],
+    };
+}
+

package/src/models/CzechiaMojeIdProviderOutput.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';
+/**
+ * Exposed properties for the `a-mojeid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface CzechiaMojeIdProviderOutput
+ */
+export interface CzechiaMojeIdProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The OpenID 2.0 Identifier ("openid2_id") of the verified individual's MojeID account.
+     *             
+     * This is an HTTPS URL which uniquely identifies the user within the MojeID system.
+     * @type {string}
+     * @memberof CzechiaMojeIdProviderOutput
+     */
+    openId2Identifier: string;
+}
+
+/**
+ * Check if a given object implements the CzechiaMojeIdProviderOutput interface.
+ */
+export function instanceOfCzechiaMojeIdProviderOutput(value: object): value is CzechiaMojeIdProviderOutput {
+    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 (!('openId2Identifier' in value) || value['openId2Identifier'] === undefined) return false;
+    return true;
+}
+
+export function CzechiaMojeIdProviderOutputFromJSON(json: any): CzechiaMojeIdProviderOutput {
+    return CzechiaMojeIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function CzechiaMojeIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CzechiaMojeIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'openId2Identifier': json['openId2Identifier'],
+    };
+}
+
+export function CzechiaMojeIdProviderOutputToJSON(json: any): CzechiaMojeIdProviderOutput {
+    return CzechiaMojeIdProviderOutputToJSONTyped(json, false);
+}
+
+export function CzechiaMojeIdProviderOutputToJSONTyped(value?: CzechiaMojeIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'openId2Identifier': value['openId2Identifier'],
+    };
+}
+

package/src/models/DocumentData.ts

@@ -28,37 +28,45 @@ import {
  */
 export interface DocumentData {
     /**
-     * 
+     * The type of the document.
      * @type {DocumentType}
      * @memberof DocumentData
      */
     type?: DocumentType | null;
     /**
-     * 
+     * The primary identifying number of the document.
      * @type {string}
      * @memberof DocumentData
      */
     number?: string | null;
     /**
-     * 
+     * The date the document was issued.
      * @type {Date}
      * @memberof DocumentData
      */
     issueDate?: Date | null;
     /**
-     * 
+     * The date the document expires.
      * @type {Date}
      * @memberof DocumentData
      */
     expirationDate?: Date | null;
     /**
-     * 
+     * The ISO 3166-1 alpha-2 country code of the country that issued the document.
      * @type {string}
      * @memberof DocumentData
      */
     issuingCountry?: string | null;
     /**
-     * 
+     * The ISO 3166-2 subdivision code of the issuing authority which issued the document.
+     *             
+     * This is always in the form {CountryCode}-{SubdivisionCode}, where CountryCode is 2 letters and SubdivisionCode is 1-3 alphanumeric characters.
+     * @type {string}
+     * @memberof DocumentData
+     */
+    issuingSubdivision?: string | null;
+    /**
+     * The name of the authority which issued the document.
      * @type {string}
      * @memberof DocumentData
      */
@@ -89,6 +97,7 @@ export function DocumentDataFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'issueDate': json['issueDate'] == null ? undefined : (new Date(json['issueDate'])),
         'expirationDate': json['expirationDate'] == null ? undefined : (new Date(json['expirationDate'])),
         'issuingCountry': json['issuingCountry'] == null ? undefined : json['issuingCountry'],
+        'issuingSubdivision': json['issuingSubdivision'] == null ? undefined : json['issuingSubdivision'],
         'issuingAuthority': json['issuingAuthority'] == null ? undefined : json['issuingAuthority'],
     };
 }
@@ -109,6 +118,7 @@ export function DocumentDataToJSONTyped(value?: DocumentData | null, ignoreDiscr
         'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate'] as any).toISOString().substring(0,10)),
         'expirationDate': value['expirationDate'] == null ? undefined : ((value['expirationDate'] as any).toISOString().substring(0,10)),
         'issuingCountry': value['issuingCountry'],
+        'issuingSubdivision': value['issuingSubdivision'],
         'issuingAuthority': value['issuingAuthority'],
     };
 }

package/src/models/EstoniaIdCardProviderOutput.ts

@@ -0,0 +1,107 @@
+/* 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-ee-web-eid-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface EstoniaIdCardProviderOutput
+ */
+export interface EstoniaIdCardProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The 11-digit Estonian personal identification code ("isikukood") of the verified individual.
+     *             
+     * This is in the format GYYMMDDSSSC, where:
+     * - G combines the century and sex of birth
+     * - YYMMDD is the date of birth within the given century
+     * - SSS is a serial number distinguishing people born on the same date
+     * - C is a checksum digit
+     *             
+     * If G is odd, the individual is male.
+     * If G is even, the individual is female.
+     *             
+     * If G is 1 or 2, the individual was born in the 19th century (1800-1899).
+     * If G is 3 or 4, the individual was born in the 20th century (1900-1999).
+     * If G is 5 or 6, the individual was born in the 21st century (2000-2099).
+     * If G is 7 or 8, the individual was born in the 22nd century (2100-2199).
+     * @type {string}
+     * @memberof EstoniaIdCardProviderOutput
+     */
+    personalIdentificationCode: string;
+}
+
+/**
+ * Check if a given object implements the EstoniaIdCardProviderOutput interface.
+ */
+export function instanceOfEstoniaIdCardProviderOutput(value: object): value is EstoniaIdCardProviderOutput {
+    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 (!('personalIdentificationCode' in value) || value['personalIdentificationCode'] === undefined) return false;
+    return true;
+}
+
+export function EstoniaIdCardProviderOutputFromJSON(json: any): EstoniaIdCardProviderOutput {
+    return EstoniaIdCardProviderOutputFromJSONTyped(json, false);
+}
+
+export function EstoniaIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): EstoniaIdCardProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'personalIdentificationCode': json['personalIdentificationCode'],
+    };
+}
+
+export function EstoniaIdCardProviderOutputToJSON(json: any): EstoniaIdCardProviderOutput {
+    return EstoniaIdCardProviderOutputToJSONTyped(json, false);
+}
+
+export function EstoniaIdCardProviderOutputToJSONTyped(value?: EstoniaIdCardProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'personalIdentificationCode': value['personalIdentificationCode'],
+    };
+}
+