@trinsic/api 3.0.1 → 3.1.0-preview1

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

@@ -0,0 +1,108 @@
+/**
+ * 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.
+ */
+/**
+ * Exposed properties for the `uk-evisa-lookup` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface UnitedKingdomEvisaProviderOutput
+ */
+export interface UnitedKingdomEvisaProviderOutput {
+    /**
+     * The first name of the individual as recorded on the eVisa.
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    firstName?: string | null;
+    /**
+     * The last name of the individual as recorded on the eVisa.
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    lastName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * @type {Date}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The 9-character share code used for the verification.
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    shareCode?: string | null;
+    /**
+     * The eVisa reference number issued by UK Visas and Immigration (UKVI).
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    referenceNumber?: string | null;
+    /**
+     * The expiration date of the eVisa. Only present for immigration_status verifications.
+     * @type {Date}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    expirationDate?: Date | null;
+    /**
+     * The start date from which the eVisa is valid. Only returned for immigration_status and right_to_rent verifications — not returned for right_to_work.
+     * @type {Date}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    validFrom?: Date | null;
+    /**
+     * The nationality of the individual as recorded on the eVisa. Only present for immigration_status verifications.
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    nationality?: string | null;
+    /**
+     * The immigration status of the individual. Only present for immigration_status verifications.
+     * This is a personalized record for each individual, and there is no single definitive list.
+     * Some common values:
+     * - Settled
+     * - Pre-settled
+     * - Student
+     * - Graduate
+     * - Youth Mobility
+     * - Global Talent
+     * - Skilled Worker
+     * - Limited leave
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    immigrationStatus?: string | null;
+    /**
+     * Overall verification outcome: "pass", "fail", or "inconclusive".
+     * "inconclusive" is returned for indefinite immigration statuses not yet on the provider's
+     * official list — identity details are still returned, but date validations cannot be performed.
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    outcome?: string | null;
+    /**
+     * Type of verification.
+     * List of possible values:
+     * - immigration_status
+     * - right_to_work
+     * - right_to_rent
+     * @type {string}
+     * @memberof UnitedKingdomEvisaProviderOutput
+     */
+    evidenceType?: string | null;
+}
+/**
+ * Check if a given object implements the UnitedKingdomEvisaProviderOutput interface.
+ */
+export declare function instanceOfUnitedKingdomEvisaProviderOutput(value: object): value is UnitedKingdomEvisaProviderOutput;
+export declare function UnitedKingdomEvisaProviderOutputFromJSON(json: any): UnitedKingdomEvisaProviderOutput;
+export declare function UnitedKingdomEvisaProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnitedKingdomEvisaProviderOutput;
+export declare function UnitedKingdomEvisaProviderOutputToJSON(json: any): UnitedKingdomEvisaProviderOutput;
+export declare function UnitedKingdomEvisaProviderOutputToJSONTyped(value?: UnitedKingdomEvisaProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UnitedKingdomEvisaProviderOutput.js

@@ -0,0 +1,61 @@
+/* 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 UnitedKingdomEvisaProviderOutput interface.
+ */
+export function instanceOfUnitedKingdomEvisaProviderOutput(value) {
+    return true;
+}
+export function UnitedKingdomEvisaProviderOutputFromJSON(json) {
+    return UnitedKingdomEvisaProviderOutputFromJSONTyped(json, false);
+}
+export function UnitedKingdomEvisaProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['firstName'] == null ? undefined : json['firstName'],
+        'lastName': json['lastName'] == null ? undefined : json['lastName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'shareCode': json['shareCode'] == null ? undefined : json['shareCode'],
+        'referenceNumber': json['referenceNumber'] == null ? undefined : json['referenceNumber'],
+        'expirationDate': json['expirationDate'] == null ? undefined : (new Date(json['expirationDate'])),
+        'validFrom': json['validFrom'] == null ? undefined : (new Date(json['validFrom'])),
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'immigrationStatus': json['immigrationStatus'] == null ? undefined : json['immigrationStatus'],
+        'outcome': json['outcome'] == null ? undefined : json['outcome'],
+        'evidenceType': json['evidenceType'] == null ? undefined : json['evidenceType'],
+    };
+}
+export function UnitedKingdomEvisaProviderOutputToJSON(json) {
+    return UnitedKingdomEvisaProviderOutputToJSONTyped(json, false);
+}
+export function UnitedKingdomEvisaProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? value['dateOfBirth'] : value['dateOfBirth'].toISOString().substring(0, 10),
+        'shareCode': value['shareCode'],
+        'referenceNumber': value['referenceNumber'],
+        'expirationDate': value['expirationDate'] == null ? value['expirationDate'] : value['expirationDate'].toISOString().substring(0, 10),
+        'validFrom': value['validFrom'] == null ? value['validFrom'] : value['validFrom'].toISOString().substring(0, 10),
+        'nationality': value['nationality'],
+        'immigrationStatus': value['immigrationStatus'],
+        'outcome': value['outcome'],
+        'evidenceType': value['evidenceType'],
+    };
+}

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

@@ -0,0 +1,35 @@
+/**
+ * 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 { Raw18013RequestInput } from './Raw18013RequestInput';
+/**
+ *
+ * @export
+ * @interface UsaCaliforniaDmvInput
+ */
+export interface UsaCaliforniaDmvInput {
+    /**
+     * The raw 18013-7 exchange request to use for this verification.
+     *
+     * If set, this overrides any default configuration on your Verification Profile.
+     * @type {Raw18013RequestInput}
+     * @memberof UsaCaliforniaDmvInput
+     */
+    previewRaw18013Request?: Raw18013RequestInput | null;
+}
+/**
+ * Check if a given object implements the UsaCaliforniaDmvInput interface.
+ */
+export declare function instanceOfUsaCaliforniaDmvInput(value: object): value is UsaCaliforniaDmvInput;
+export declare function UsaCaliforniaDmvInputFromJSON(json: any): UsaCaliforniaDmvInput;
+export declare function UsaCaliforniaDmvInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): UsaCaliforniaDmvInput;
+export declare function UsaCaliforniaDmvInputToJSON(json: any): UsaCaliforniaDmvInput;
+export declare function UsaCaliforniaDmvInputToJSONTyped(value?: UsaCaliforniaDmvInput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UsaCaliforniaDmvInput.js

@@ -0,0 +1,42 @@
+/* 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 { Raw18013RequestInputFromJSON, Raw18013RequestInputToJSON, } from './Raw18013RequestInput';
+/**
+ * Check if a given object implements the UsaCaliforniaDmvInput interface.
+ */
+export function instanceOfUsaCaliforniaDmvInput(value) {
+    return true;
+}
+export function UsaCaliforniaDmvInputFromJSON(json) {
+    return UsaCaliforniaDmvInputFromJSONTyped(json, false);
+}
+export function UsaCaliforniaDmvInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'previewRaw18013Request': json['preview_raw18013Request'] == null ? undefined : Raw18013RequestInputFromJSON(json['preview_raw18013Request']),
+    };
+}
+export function UsaCaliforniaDmvInputToJSON(json) {
+    return UsaCaliforniaDmvInputToJSONTyped(json, false);
+}
+export function UsaCaliforniaDmvInputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'preview_raw18013Request': Raw18013RequestInputToJSON(value['previewRaw18013Request']),
+    };
+}

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

@@ -33,6 +33,12 @@ export interface VerificationProfileResponse {
      * @memberof VerificationProfileResponse
      */
     brandName: string;
+    /**
+     * A customer-defined external ID for this verification profile, unique within your organization.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    externalId?: string | null;
     /**
      * The URL of the verification profile's logo.
      * @type {string}
@@ -51,6 +57,12 @@ export interface VerificationProfileResponse {
      * @memberof VerificationProfileResponse
      */
     enabledProviders: Array<string>;
+    /**
+     * The session expiration for verification sessions created with this profile.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    sessionExpiration: string;
     /**
      * Whether this profile is for production usage. Only applicable for Live environment profiles.
      * @type {boolean}

package/dist/esm/models/VerificationProfileResponse.js

@@ -27,6 +27,8 @@ export function instanceOfVerificationProfileResponse(value) {
         return false;
     if (!('enabledProviders' in value) || value['enabledProviders'] === undefined)
         return false;
+    if (!('sessionExpiration' in value) || value['sessionExpiration'] === undefined)
+        return false;
     if (!('isProductionUsage' in value) || value['isProductionUsage'] === undefined)
         return false;
     return true;
@@ -42,9 +44,11 @@ export function VerificationProfileResponseFromJSONTyped(json, ignoreDiscriminat
         'id': json['id'],
         'alias': json['alias'],
         'brandName': json['brandName'],
+        'externalId': json['externalId'] == null ? undefined : json['externalId'],
         'logoUrl': json['logoUrl'],
         'primaryColor': json['primaryColor'],
         'enabledProviders': json['enabledProviders'],
+        'sessionExpiration': json['sessionExpiration'],
         'isProductionUsage': json['isProductionUsage'],
     };
 }
@@ -59,9 +63,11 @@ export function VerificationProfileResponseToJSONTyped(value, ignoreDiscriminato
         'id': value['id'],
         'alias': value['alias'],
         'brandName': value['brandName'],
+        'externalId': value['externalId'],
         'logoUrl': value['logoUrl'],
         'primaryColor': value['primaryColor'],
         'enabledProviders': value['enabledProviders'],
+        'sessionExpiration': value['sessionExpiration'],
         'isProductionUsage': value['isProductionUsage'],
     };
 }

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

@@ -0,0 +1,112 @@
+/**
+ * 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 { YotiStructuredPostalAddress } from './YotiStructuredPostalAddress';
+import type { YotiDocumentDetails } from './YotiDocumentDetails';
+/**
+ * Exposed properties for the `yoti-deeplink` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface YotiDeeplinkProviderOutput
+ */
+export interface YotiDeeplinkProviderOutput {
+    /**
+     * A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party.
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    rememberMeId?: string | null;
+    /**
+     * The email address of the individual
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The given name of the individual. This can correspond to first and middle names in English.
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * Full name of the individual which is composed of the given and family name.
+     * Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {Date}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.
+     *
+     * Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * In some countries
+     * Possible values:
+     * - "MALE"
+     * - "FEMALE"
+     * - "TRANSGENDER"
+     * - "OTHER"
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The nationality of the individual as a ISO alpha-3 code
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    nationality?: string | null;
+    /**
+     * The mobile phone number of the individual. This number was verified with a one time password (OTP) during the individual's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the individual's identity.
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    mobileNumber?: string | null;
+    /**
+     * A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified".
+     * Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {YotiStructuredPostalAddress}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    structuredPostalAddress?: YotiStructuredPostalAddress | null;
+    /**
+     * The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified". The format of this will be different for each country.
+     * Refer to `StructuredPostalAddress` for a detailed version of the address.
+     * @type {string}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    postalAddress?: string | null;
+    /**
+     * The details of the underlying document used to help create the Yoti credential
+     * @type {YotiDocumentDetails}
+     * @memberof YotiDeeplinkProviderOutput
+     */
+    documentDetails?: YotiDocumentDetails | null;
+}
+/**
+ * Check if a given object implements the YotiDeeplinkProviderOutput interface.
+ */
+export declare function instanceOfYotiDeeplinkProviderOutput(value: object): value is YotiDeeplinkProviderOutput;
+export declare function YotiDeeplinkProviderOutputFromJSON(json: any): YotiDeeplinkProviderOutput;
+export declare function YotiDeeplinkProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): YotiDeeplinkProviderOutput;
+export declare function YotiDeeplinkProviderOutputToJSON(json: any): YotiDeeplinkProviderOutput;
+export declare function YotiDeeplinkProviderOutputToJSONTyped(value?: YotiDeeplinkProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/YotiDeeplinkProviderOutput.js

@@ -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 { YotiStructuredPostalAddressFromJSON, YotiStructuredPostalAddressToJSON, } from './YotiStructuredPostalAddress';
+import { YotiDocumentDetailsFromJSON, YotiDocumentDetailsToJSON, } from './YotiDocumentDetails';
+/**
+ * Check if a given object implements the YotiDeeplinkProviderOutput interface.
+ */
+export function instanceOfYotiDeeplinkProviderOutput(value) {
+    return true;
+}
+export function YotiDeeplinkProviderOutputFromJSON(json) {
+    return YotiDeeplinkProviderOutputFromJSONTyped(json, false);
+}
+export function YotiDeeplinkProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'rememberMeId': json['rememberMeId'] == null ? undefined : json['rememberMeId'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
+        'structuredPostalAddress': json['structuredPostalAddress'] == null ? undefined : YotiStructuredPostalAddressFromJSON(json['structuredPostalAddress']),
+        'postalAddress': json['postalAddress'] == null ? undefined : json['postalAddress'],
+        'documentDetails': json['documentDetails'] == null ? undefined : YotiDocumentDetailsFromJSON(json['documentDetails']),
+    };
+}
+export function YotiDeeplinkProviderOutputToJSON(json) {
+    return YotiDeeplinkProviderOutputToJSONTyped(json, false);
+}
+export function YotiDeeplinkProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'rememberMeId': value['rememberMeId'],
+        'email': value['email'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'fullName': value['fullName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? value['dateOfBirth'] : value['dateOfBirth'].toISOString().substring(0, 10),
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'mobileNumber': value['mobileNumber'],
+        'structuredPostalAddress': YotiStructuredPostalAddressToJSON(value['structuredPostalAddress']),
+        'postalAddress': value['postalAddress'],
+        'documentDetails': YotiDocumentDetailsToJSON(value['documentDetails']),
+    };
+}

package/dist/esm/models/YotiDocumentDetails.js

@@ -43,7 +43,7 @@ export function YotiDocumentDetailsToJSONTyped(value, ignoreDiscriminator = fals
         'type': value['type'],
         'issuingCountry': value['issuingCountry'],
         'documentNumber': value['documentNumber'],
-        'expirationDate': value['expirationDate'] == null ? undefined : (value['expirationDate'].toISOString().substring(0, 10)),
+        'expirationDate': value['expirationDate'] == null ? value['expirationDate'] : value['expirationDate'].toISOString().substring(0, 10),
         'issuingAuthority': value['issuingAuthority'],
     };
 }

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

@@ -18,7 +18,7 @@ import type { YotiDocumentDetails } from './YotiDocumentDetails';
  */
 export interface YotiProviderOutput {
     /**
-     * The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service.
+     * A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party.
      * @type {string}
      * @memberof YotiProviderOutput
      */
@@ -76,7 +76,7 @@ export interface YotiProviderOutput {
      */
     nationality?: string | null;
     /**
-     * The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity.
+     * The mobile phone number of the individual. This number was verified with a one time password (OTP) during the individual's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the individual's identity.
      * @type {string}
      * @memberof YotiProviderOutput
      */

package/dist/esm/models/YotiProviderOutput.js

@@ -54,7 +54,7 @@ export function YotiProviderOutputToJSONTyped(value, ignoreDiscriminator = false
         'givenName': value['givenName'],
         'familyName': value['familyName'],
         'fullName': value['fullName'],
-        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
+        'dateOfBirth': value['dateOfBirth'] == null ? value['dateOfBirth'] : value['dateOfBirth'].toISOString().substring(0, 10),
         'gender': value['gender'],
         'nationality': value['nationality'],
         'mobileNumber': value['mobileNumber'],