@trinsic/api 1.1.1 → 1.2.0

package/dist/models/KnownPersonData.js

@@ -0,0 +1,55 @@
+"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.instanceOfKnownPersonData = instanceOfKnownPersonData;
+exports.KnownPersonDataFromJSON = KnownPersonDataFromJSON;
+exports.KnownPersonDataFromJSONTyped = KnownPersonDataFromJSONTyped;
+exports.KnownPersonDataToJSON = KnownPersonDataToJSON;
+const KnownAddress_1 = require("./KnownAddress");
+/**
+ * Check if a given object implements the KnownPersonData interface.
+ */
+function instanceOfKnownPersonData(value) {
+    return true;
+}
+function KnownPersonDataFromJSON(json) {
+    return KnownPersonDataFromJSONTyped(json, false);
+}
+function KnownPersonDataFromJSONTyped(json, ignoreDiscriminator) {
+    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 : (0, KnownAddress_1.KnownAddressFromJSON)(json['address']),
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : json['dateOfBirth'],
+    };
+}
+function KnownPersonDataToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'middleName': value['middleName'],
+        'phoneNumber': value['phoneNumber'],
+        'address': (0, KnownAddress_1.KnownAddressToJSON)(value['address']),
+        'dateOfBirth': value['dateOfBirth'],
+    };
+}

package/dist/models/ProviderInformation.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 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 declare function instanceOfProviderInformation(value: object): value is ProviderInformation;
+export declare function ProviderInformationFromJSON(json: any): ProviderInformation;
+export declare function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInformation;
+export declare function ProviderInformationToJSON(value?: ProviderInformation | null): any;

package/dist/models/ProviderInformation.js

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

package/dist/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/models/RecommendRequest.js

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

package/dist/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/models/RecommendResponse.js

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

package/dist/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/models/VerificationFailCode.js

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

package/dist/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/models/index.js

@@ -32,11 +32,17 @@ __exportStar(require("./GetSessionResultRequest"), exports);
 __exportStar(require("./GetSessionResultResponse"), exports);
 __exportStar(require("./IdentityData"), exports);
 __exportStar(require("./IdentityLookupResponse"), exports);
+__exportStar(require("./KnownAddress"), exports);
+__exportStar(require("./KnownIdentityData"), exports);
+__exportStar(require("./KnownPersonData"), exports);
 __exportStar(require("./ListProvidersResponse"), exports);
 __exportStar(require("./ListSessionsResponse"), exports);
 __exportStar(require("./OrderDirection"), exports);
 __exportStar(require("./PersonData"), exports);
 __exportStar(require("./ProviderInfo"), exports);
+__exportStar(require("./ProviderInformation"), exports);
+__exportStar(require("./RecommendRequest"), exports);
+__exportStar(require("./RecommendResponse"), exports);
 __exportStar(require("./Session"), exports);
 __exportStar(require("./SessionFailCode"), exports);
 __exportStar(require("./SessionOrdering"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trinsic/api",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Trinsic API TypeScript library.",
   "author": "Trinsic",
   "repository": {

package/src/apis/NetworkApi.ts

@@ -18,6 +18,8 @@ import type {
   FailureMessage,
   IdentityLookupResponse,
   ListProvidersResponse,
+  RecommendRequest,
+  RecommendResponse,
   ValidationResult,
 } from '../models/index';
 import {
@@ -27,6 +29,10 @@ import {
     IdentityLookupResponseToJSON,
     ListProvidersResponseFromJSON,
     ListProvidersResponseToJSON,
+    RecommendRequestFromJSON,
+    RecommendRequestToJSON,
+    RecommendResponseFromJSON,
+    RecommendResponseToJSON,
     ValidationResultFromJSON,
     ValidationResultToJSON,
 } from '../models/index';
@@ -35,6 +41,10 @@ export interface IdentityLookupRequest {
     phoneNumber: string;
 }
 
+export interface RecommendProvidersRequest {
+    recommendRequest?: RecommendRequest;
+}
+
 /**
  * NetworkApi - interface
  * 
@@ -73,6 +83,22 @@ export interface NetworkApiInterface {
      */
     listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
 
+    /**
+     * Generate provider recommendations based on the given signals (phone number, countries, states)
+     * @summary Recommend Providers
+     * @param {RecommendRequest} [recommendRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NetworkApiInterface
+     */
+    recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>>;
+
+    /**
+     * Generate provider recommendations based on the given signals (phone number, countries, states)
+     * Recommend Providers
+     */
+    recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse>;
+
 }
 
 /**
@@ -159,4 +185,43 @@ export class NetworkApi extends runtime.BaseAPI implements NetworkApiInterface {
         return await response.value();
     }
 
+    /**
+     * Generate provider recommendations based on the given signals (phone number, countries, states)
+     * Recommend Providers
+     */
+    async recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/network/recommend`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: RecommendRequestToJSON(requestParameters['recommendRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RecommendResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Generate provider recommendations based on the given signals (phone number, countries, states)
+     * Recommend Providers
+     */
+    async recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse> {
+        const response = await this.recommendProvidersRaw({ recommendRequest: recommendRequest }, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/CreateSessionRequest.ts

@@ -13,6 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
+import type { KnownIdentityData } from './KnownIdentityData';
+import {
+    KnownIdentityDataFromJSON,
+    KnownIdentityDataFromJSONTyped,
+    KnownIdentityDataToJSON,
+} from './KnownIdentityData';
 import type { DisclosedFieldsRequest } from './DisclosedFieldsRequest';
 import {
     DisclosedFieldsRequestFromJSON,
@@ -37,6 +43,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.
      *             
@@ -46,6 +73,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}
@@ -72,7 +107,9 @@ export function CreateSessionRequestFromJSONTyped(json: any, 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 : KnownIdentityDataFromJSON(json['knownIdentityData']),
         'disclosedFields': json['disclosedFields'] == null ? undefined : DisclosedFieldsRequestFromJSON(json['disclosedFields']),
     };
 }
@@ -84,7 +121,9 @@ export function CreateSessionRequestToJSON(value?: CreateSessionRequest | null):
     return {
         
         'launchProviderDirectly': value['launchProviderDirectly'],
+        'enableRememberMe': value['enableRememberMe'],
         'providers': value['providers'],
+        'knownIdentityData': KnownIdentityDataToJSON(value['knownIdentityData']),
         'disclosedFields': DisclosedFieldsRequestToJSON(value['disclosedFields']),
     };
 }