@trinsic/api 1.1.1 → 1.2.0

package/dist/esm/models/ProviderInformation.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ProviderInformation interface.
+ */
+export function instanceOfProviderInformation(value) {
+    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) {
+    return ProviderInformationFromJSONTyped(json, false);
+}
+export function ProviderInformationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'providerId': json['providerId'],
+        'providerDisplayName': json['providerDisplayName'],
+        'providerLogo': json['providerLogo'],
+    };
+}
+export function ProviderInformationToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'providerId': value['providerId'],
+        'providerDisplayName': value['providerDisplayName'],
+        'providerLogo': value['providerLogo'],
+    };
+}

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

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfRecommendRequest(value: object): value is RecommendRequest;
+export declare function RecommendRequestFromJSON(json: any): RecommendRequest;
+export declare function RecommendRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendRequest;
+export declare function RecommendRequestToJSON(value?: RecommendRequest | null): any;

package/dist/esm/models/RecommendRequest.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the RecommendRequest interface.
+ */
+export function instanceOfRecommendRequest(value) {
+    if (!('phoneNumber' in value) || value['phoneNumber'] === undefined)
+        return false;
+    return true;
+}
+export function RecommendRequestFromJSON(json) {
+    return RecommendRequestFromJSONTyped(json, false);
+}
+export function RecommendRequestFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'phoneNumber': value['phoneNumber'],
+        'countries': value['countries'],
+        'states': value['states'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 type { ProviderInformation } 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 declare function instanceOfRecommendResponse(value: object): value is RecommendResponse;
+export declare function RecommendResponseFromJSON(json: any): RecommendResponse;
+export declare function RecommendResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendResponse;
+export declare function RecommendResponseToJSON(value?: RecommendResponse | null): any;

package/dist/esm/models/RecommendResponse.js

@@ -0,0 +1,49 @@
+/* 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 { ProviderInformationFromJSON, ProviderInformationToJSON, } from './ProviderInformation';
+/**
+ * Check if a given object implements the RecommendResponse interface.
+ */
+export function instanceOfRecommendResponse(value) {
+    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) {
+    return RecommendResponseFromJSONTyped(json, false);
+}
+export function RecommendResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'recognized': (json['recognized'].map(ProviderInformationFromJSON)),
+        'relevant': (json['relevant'].map(ProviderInformationFromJSON)),
+        'remainder': (json['remainder'].map(ProviderInformationFromJSON)),
+    };
+}
+export function RecommendResponseToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'recognized': (value['recognized'].map(ProviderInformationToJSON)),
+        'relevant': (value['relevant'].map(ProviderInformationToJSON)),
+        'remainder': (value['remainder'].map(ProviderInformationToJSON)),
+    };
+}

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

@@ -19,6 +19,7 @@ export declare const VerificationFailCode: {
     readonly VerificationFailInvalidImage: "VerificationFailInvalidImage";
     readonly VerificationFailInauthentic: "VerificationFailInauthentic";
     readonly VerificationFailUnsupportedDocument: "VerificationFailUnsupportedDocument";
+    readonly VerificationFailUserAbandoned: "VerificationFailUserAbandoned";
 };
 export type VerificationFailCode = typeof VerificationFailCode[keyof typeof VerificationFailCode];
 export declare function instanceOfVerificationFailCode(value: any): boolean;

package/dist/esm/models/VerificationFailCode.js

@@ -20,7 +20,8 @@ export const VerificationFailCode = {
     VerificationFailInternal: 'VerificationFailInternal',
     VerificationFailInvalidImage: 'VerificationFailInvalidImage',
     VerificationFailInauthentic: 'VerificationFailInauthentic',
-    VerificationFailUnsupportedDocument: 'VerificationFailUnsupportedDocument'
+    VerificationFailUnsupportedDocument: 'VerificationFailUnsupportedDocument',
+    VerificationFailUserAbandoned: 'VerificationFailUserAbandoned'
 };
 export function instanceOfVerificationFailCode(value) {
     for (const key in VerificationFailCode) {

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

@@ -14,11 +14,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';

package/dist/esm/models/index.js

@@ -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';

package/dist/models/CreateSessionRequest.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { KnownIdentityData } from './KnownIdentityData';
 import type { DisclosedFieldsRequest } from './DisclosedFieldsRequest';
 /**
  *
@@ -27,6 +28,27 @@ export interface CreateSessionRequest {
      * @memberof CreateSessionRequest
      */
     launchProviderDirectly?: boolean;
+    /**
+     * Whether to enable Trinsic's "Remember Me" feature, which allows users to save their credentials for future use.
+     *
+     * This option is only relevant when `LaunchProviderDirectly` is unspecified or set to `false`.
+     * If `LaunchProviderDirectly` is `true`, this field must be unspecified or set to `false`.
+     *
+     * If this field is set to `true`, then:
+     *   - The user will be prompted to authenticate with their phone number at the start of the flow
+     *   - If the user has previously saved a verification for reuse with Trinsic, they will be offered the ability to reuse it
+     *   - After the user has verified their identity (and if the identity provider in question supports it), they will be prompted to save their credentials for future use
+     *
+     * If this field is set to `false`, then:
+     *   - The user will not be prompted to authenticate with their phone number at the start of the flow.
+     *     - Instead, the user will be immediately shown the list of available providers
+     *   - The user will not be offered the ability to reuse a previously-saved Trinsic credential
+     *   - After the user has verified their identity, they will not be prompted to save their credentials for future use
+     *     - Instead, they will immediately return to your product
+     * @type {boolean}
+     * @memberof CreateSessionRequest
+     */
+    enableRememberMe?: boolean;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      *
@@ -36,6 +58,14 @@ export interface CreateSessionRequest {
      * @memberof CreateSessionRequest
      */
     providers?: Array<string>;
+    /**
+     * Known identity data of an individual being verified.
+     *
+     * Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
+     * @type {KnownIdentityData}
+     * @memberof CreateSessionRequest
+     */
+    knownIdentityData?: KnownIdentityData;
     /**
      * Specific identity attributes to request. If not provided, all available attributes will be requested.
      * @type {DisclosedFieldsRequest}

package/dist/models/CreateSessionRequest.js

@@ -17,6 +17,7 @@ exports.instanceOfCreateSessionRequest = instanceOfCreateSessionRequest;
 exports.CreateSessionRequestFromJSON = CreateSessionRequestFromJSON;
 exports.CreateSessionRequestFromJSONTyped = CreateSessionRequestFromJSONTyped;
 exports.CreateSessionRequestToJSON = CreateSessionRequestToJSON;
+const KnownIdentityData_1 = require("./KnownIdentityData");
 const DisclosedFieldsRequest_1 = require("./DisclosedFieldsRequest");
 /**
  * Check if a given object implements the CreateSessionRequest interface.
@@ -33,7 +34,9 @@ function CreateSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'launchProviderDirectly': json['launchProviderDirectly'] == null ? undefined : json['launchProviderDirectly'],
+        'enableRememberMe': json['enableRememberMe'] == null ? undefined : json['enableRememberMe'],
         'providers': json['providers'] == null ? undefined : json['providers'],
+        'knownIdentityData': json['knownIdentityData'] == null ? undefined : (0, KnownIdentityData_1.KnownIdentityDataFromJSON)(json['knownIdentityData']),
         'disclosedFields': json['disclosedFields'] == null ? undefined : (0, DisclosedFieldsRequest_1.DisclosedFieldsRequestFromJSON)(json['disclosedFields']),
     };
 }
@@ -43,7 +46,9 @@ function CreateSessionRequestToJSON(value) {
     }
     return {
         'launchProviderDirectly': value['launchProviderDirectly'],
+        'enableRememberMe': value['enableRememberMe'],
         'providers': value['providers'],
+        'knownIdentityData': (0, KnownIdentityData_1.KnownIdentityDataToJSON)(value['knownIdentityData']),
         'disclosedFields': (0, DisclosedFieldsRequest_1.DisclosedFieldsRequestToJSON)(value['disclosedFields']),
     };
 }

package/dist/models/KnownAddress.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfKnownAddress(value: object): value is KnownAddress;
+export declare function KnownAddressFromJSON(json: any): KnownAddress;
+export declare function KnownAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownAddress;
+export declare function KnownAddressToJSON(value?: KnownAddress | null): any;

package/dist/models/KnownAddress.js

@@ -0,0 +1,56 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfKnownAddress = instanceOfKnownAddress;
+exports.KnownAddressFromJSON = KnownAddressFromJSON;
+exports.KnownAddressFromJSONTyped = KnownAddressFromJSONTyped;
+exports.KnownAddressToJSON = KnownAddressToJSON;
+/**
+ * Check if a given object implements the KnownAddress interface.
+ */
+function instanceOfKnownAddress(value) {
+    return true;
+}
+function KnownAddressFromJSON(json) {
+    return KnownAddressFromJSONTyped(json, false);
+}
+function KnownAddressFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function KnownAddressToJSON(value) {
+    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/dist/models/KnownIdentityData.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 type { KnownPersonData } 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 declare function instanceOfKnownIdentityData(value: object): value is KnownIdentityData;
+export declare function KnownIdentityDataFromJSON(json: any): KnownIdentityData;
+export declare function KnownIdentityDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownIdentityData;
+export declare function KnownIdentityDataToJSON(value?: KnownIdentityData | null): any;

package/dist/models/KnownIdentityData.js

@@ -0,0 +1,45 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfKnownIdentityData = instanceOfKnownIdentityData;
+exports.KnownIdentityDataFromJSON = KnownIdentityDataFromJSON;
+exports.KnownIdentityDataFromJSONTyped = KnownIdentityDataFromJSONTyped;
+exports.KnownIdentityDataToJSON = KnownIdentityDataToJSON;
+const KnownPersonData_1 = require("./KnownPersonData");
+/**
+ * Check if a given object implements the KnownIdentityData interface.
+ */
+function instanceOfKnownIdentityData(value) {
+    return true;
+}
+function KnownIdentityDataFromJSON(json) {
+    return KnownIdentityDataFromJSONTyped(json, false);
+}
+function KnownIdentityDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'person': json['person'] == null ? undefined : (0, KnownPersonData_1.KnownPersonDataFromJSON)(json['person']),
+    };
+}
+function KnownIdentityDataToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'person': (0, KnownPersonData_1.KnownPersonDataToJSON)(value['person']),
+    };
+}

package/dist/models/KnownPersonData.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 type { KnownAddress } 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 declare function instanceOfKnownPersonData(value: object): value is KnownPersonData;
+export declare function KnownPersonDataFromJSON(json: any): KnownPersonData;
+export declare function KnownPersonDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): KnownPersonData;
+export declare function KnownPersonDataToJSON(value?: KnownPersonData | null): any;