@trinsic/api 1.1.1 → 1.2.0

package/src/models/KnownAddress.ts

@@ -0,0 +1,108 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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';
+/**
+ * Address information for an individual
+ * @export
+ * @interface KnownAddress
+ */
+export interface KnownAddress {
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    line1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    line2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    line3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    city?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    state?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    postalCode?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KnownAddress
+     */
+    country?: string;
+}
+
+/**
+ * Check if a given object implements the KnownAddress interface.
+ */
+export function instanceOfKnownAddress(value: object): value is KnownAddress {
+    return true;
+}
+
+export function KnownAddressFromJSON(json: any): KnownAddress {
+    return KnownAddressFromJSONTyped(json, false);
+}
+
+export function KnownAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'line1': json['line1'] == null ? undefined : json['line1'],
+        'line2': json['line2'] == null ? undefined : json['line2'],
+        'line3': json['line3'] == null ? undefined : json['line3'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+        'country': json['country'] == null ? undefined : json['country'],
+    };
+}
+
+export function KnownAddressToJSON(value?: KnownAddress | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'line1': value['line1'],
+        'line2': value['line2'],
+        'line3': value['line3'],
+        'city': value['city'],
+        'state': value['state'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+    };
+}
+

package/src/models/KnownIdentityData.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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 { KnownPersonData } from './KnownPersonData';
+import {
+    KnownPersonDataFromJSON,
+    KnownPersonDataFromJSONTyped,
+    KnownPersonDataToJSON,
+} from './KnownPersonData';
+
+/**
+ * Known identity data of an individual being verified.
+ *             
+ * Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
+ * @export
+ * @interface KnownIdentityData
+ */
+export interface KnownIdentityData {
+    /**
+     * Known identity data specific to the person being verified
+     * @type {KnownPersonData}
+     * @memberof KnownIdentityData
+     */
+    person?: KnownPersonData;
+}
+
+/**
+ * Check if a given object implements the KnownIdentityData interface.
+ */
+export function instanceOfKnownIdentityData(value: object): value is KnownIdentityData {
+    return true;
+}
+
+export function KnownIdentityDataFromJSON(json: any): KnownIdentityData {
+    return KnownIdentityDataFromJSONTyped(json, false);
+}
+
+export function KnownIdentityDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownIdentityData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'person': json['person'] == null ? undefined : KnownPersonDataFromJSON(json['person']),
+    };
+}
+
+export function KnownIdentityDataToJSON(value?: KnownIdentityData | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'person': KnownPersonDataToJSON(value['person']),
+    };
+}
+

package/src/models/KnownPersonData.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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 { KnownAddress } from './KnownAddress';
+import {
+    KnownAddressFromJSON,
+    KnownAddressFromJSONTyped,
+    KnownAddressToJSON,
+} from './KnownAddress';
+
+/**
+ * 
+ * @export
+ * @interface KnownPersonData
+ */
+export interface KnownPersonData {
+    /**
+     * Given (first) name of the individual
+     * @type {string}
+     * @memberof KnownPersonData
+     */
+    givenName?: string;
+    /**
+     * Family (last) name of the individual
+     * @type {string}
+     * @memberof KnownPersonData
+     */
+    familyName?: string;
+    /**
+     * Middle name of the individual
+     * @type {string}
+     * @memberof KnownPersonData
+     */
+    middleName?: string;
+    /**
+     * The phone number (with preceding + character and country code) of the individual being verified
+     * @type {string}
+     * @memberof KnownPersonData
+     */
+    phoneNumber?: string;
+    /**
+     * The address of the individual being verified
+     * @type {KnownAddress}
+     * @memberof KnownPersonData
+     */
+    address?: KnownAddress;
+    /**
+     * Date of birth of the individual, in the format "YYYY-MM-DD"
+     * @type {string}
+     * @memberof KnownPersonData
+     */
+    dateOfBirth?: string;
+}
+
+/**
+ * Check if a given object implements the KnownPersonData interface.
+ */
+export function instanceOfKnownPersonData(value: object): value is KnownPersonData {
+    return true;
+}
+
+export function KnownPersonDataFromJSON(json: any): KnownPersonData {
+    return KnownPersonDataFromJSONTyped(json, false);
+}
+
+export function KnownPersonDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownPersonData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'address': json['address'] == null ? undefined : KnownAddressFromJSON(json['address']),
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : json['dateOfBirth'],
+    };
+}
+
+export function KnownPersonDataToJSON(value?: KnownPersonData | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'middleName': value['middleName'],
+        'phoneNumber': value['phoneNumber'],
+        'address': KnownAddressToJSON(value['address']),
+        'dateOfBirth': value['dateOfBirth'],
+    };
+}
+

package/src/models/ProviderInformation.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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 ProviderInformation
+ */
+export interface ProviderInformation {
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    providerId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    providerDisplayName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    providerLogo: string;
+}
+
+/**
+ * Check if a given object implements the ProviderInformation interface.
+ */
+export function instanceOfProviderInformation(value: object): value is ProviderInformation {
+    if (!('providerId' in value) || value['providerId'] === undefined) return false;
+    if (!('providerDisplayName' in value) || value['providerDisplayName'] === undefined) return false;
+    if (!('providerLogo' in value) || value['providerLogo'] === undefined) return false;
+    return true;
+}
+
+export function ProviderInformationFromJSON(json: any): ProviderInformation {
+    return ProviderInformationFromJSONTyped(json, false);
+}
+
+export function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInformation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'providerId': json['providerId'],
+        'providerDisplayName': json['providerDisplayName'],
+        'providerLogo': json['providerLogo'],
+    };
+}
+
+export function ProviderInformationToJSON(value?: ProviderInformation | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'providerId': value['providerId'],
+        'providerDisplayName': value['providerDisplayName'],
+        'providerLogo': value['providerLogo'],
+    };
+}
+

package/src/models/RecommendRequest.ts

@@ -0,0 +1,77 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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 RecommendRequest
+ */
+export interface RecommendRequest {
+    /**
+     * The phone number of the user you whish to generate a recommendation for. Will be used to lookup the user's identity in the network
+     * @type {string}
+     * @memberof RecommendRequest
+     */
+    phoneNumber: string;
+    /**
+     * A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user's country of residence, nationality, etc.
+     * @type {Array<string>}
+     * @memberof RecommendRequest
+     */
+    countries?: Array<string>;
+    /**
+     * If one of the countries is US, you can specify a list of US states to further refine the recommendation (e.g., CA, UT, NY)
+     * @type {Array<string>}
+     * @memberof RecommendRequest
+     */
+    states?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the RecommendRequest interface.
+ */
+export function instanceOfRecommendRequest(value: object): value is RecommendRequest {
+    if (!('phoneNumber' in value) || value['phoneNumber'] === undefined) return false;
+    return true;
+}
+
+export function RecommendRequestFromJSON(json: any): RecommendRequest {
+    return RecommendRequestFromJSONTyped(json, false);
+}
+
+export function RecommendRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'phoneNumber': json['phoneNumber'],
+        'countries': json['countries'] == null ? undefined : json['countries'],
+        'states': json['states'] == null ? undefined : json['states'],
+    };
+}
+
+export function RecommendRequestToJSON(value?: RecommendRequest | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'phoneNumber': value['phoneNumber'],
+        'countries': value['countries'],
+        'states': value['states'],
+    };
+}
+

package/src/models/RecommendResponse.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect 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 { ProviderInformation } from './ProviderInformation';
+import {
+    ProviderInformationFromJSON,
+    ProviderInformationFromJSONTyped,
+    ProviderInformationToJSON,
+} from './ProviderInformation';
+
+/**
+ * 
+ * @export
+ * @interface RecommendResponse
+ */
+export interface RecommendResponse {
+    /**
+     * The list of providers that were recognized in Trinsic's network. These are providers that already verified this user
+     * @type {Array<ProviderInformation>}
+     * @memberof RecommendResponse
+     */
+    recognized: Array<ProviderInformation>;
+    /**
+     * The list of providers that although not recognized, are relevant to the user's identity. The user may have been verified by these providers
+     * @type {Array<ProviderInformation>}
+     * @memberof RecommendResponse
+     */
+    relevant: Array<ProviderInformation>;
+    /**
+     * The list of providers that are not recognized and are not relevant to the user's identity
+     * @type {Array<ProviderInformation>}
+     * @memberof RecommendResponse
+     */
+    remainder: Array<ProviderInformation>;
+}
+
+/**
+ * Check if a given object implements the RecommendResponse interface.
+ */
+export function instanceOfRecommendResponse(value: object): value is RecommendResponse {
+    if (!('recognized' in value) || value['recognized'] === undefined) return false;
+    if (!('relevant' in value) || value['relevant'] === undefined) return false;
+    if (!('remainder' in value) || value['remainder'] === undefined) return false;
+    return true;
+}
+
+export function RecommendResponseFromJSON(json: any): RecommendResponse {
+    return RecommendResponseFromJSONTyped(json, false);
+}
+
+export function RecommendResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'recognized': ((json['recognized'] as Array<any>).map(ProviderInformationFromJSON)),
+        'relevant': ((json['relevant'] as Array<any>).map(ProviderInformationFromJSON)),
+        'remainder': ((json['remainder'] as Array<any>).map(ProviderInformationFromJSON)),
+    };
+}
+
+export function RecommendResponseToJSON(value?: RecommendResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'recognized': ((value['recognized'] as Array<any>).map(ProviderInformationToJSON)),
+        'relevant': ((value['relevant'] as Array<any>).map(ProviderInformationToJSON)),
+        'remainder': ((value['remainder'] as Array<any>).map(ProviderInformationToJSON)),
+    };
+}
+

package/src/models/VerificationFailCode.ts

@@ -22,7 +22,8 @@ export const VerificationFailCode = {
     VerificationFailInternal: 'VerificationFailInternal',
     VerificationFailInvalidImage: 'VerificationFailInvalidImage',
     VerificationFailInauthentic: 'VerificationFailInauthentic',
-    VerificationFailUnsupportedDocument: 'VerificationFailUnsupportedDocument'
+    VerificationFailUnsupportedDocument: 'VerificationFailUnsupportedDocument',
+    VerificationFailUserAbandoned: 'VerificationFailUserAbandoned'
 } as const;
 export type VerificationFailCode = typeof VerificationFailCode[keyof typeof VerificationFailCode];
 

package/src/models/index.ts

@@ -16,11 +16,17 @@ export * from './GetSessionResultRequest';
 export * from './GetSessionResultResponse';
 export * from './IdentityData';
 export * from './IdentityLookupResponse';
+export * from './KnownAddress';
+export * from './KnownIdentityData';
+export * from './KnownPersonData';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
 export * from './OrderDirection';
 export * from './PersonData';
 export * from './ProviderInfo';
+export * from './ProviderInformation';
+export * from './RecommendRequest';
+export * from './RecommendResponse';
 export * from './Session';
 export * from './SessionFailCode';
 export * from './SessionOrdering';