@trinsic/api 1.2.0 → 2.0.0-alpha2

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

@@ -1,5 +1,5 @@
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -16,11 +16,11 @@
  */
 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
+     * The phone number of the user you wish to generate a recommendation for. Will be used to look up the user's identity in the network
      * @type {string}
      * @memberof RecommendRequest
      */
-    phoneNumber: string;
+    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>}
@@ -28,11 +28,17 @@ export interface 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)
+     * If one of the countries has subdivisions, for example the US states, you can specify a list of these to further refine the recommendation (e.g., CA, UT, NY)
      * @type {Array<string>}
      * @memberof RecommendRequest
      */
-    states?: Array<string>;
+    subdivisions?: Array<string>;
+    /**
+     * If true, the recommendation will include providers that are disabled for the app
+     * @type {boolean}
+     * @memberof RecommendRequest
+     */
+    includeDisabledProviders?: boolean;
 }
 /**
  * Check if a given object implements the RecommendRequest interface.

package/dist/esm/models/RecommendRequest.js

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -15,8 +15,6 @@
  * 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) {
@@ -27,9 +25,10 @@ export function RecommendRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'phoneNumber': json['phoneNumber'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
         'countries': json['countries'] == null ? undefined : json['countries'],
-        'states': json['states'] == null ? undefined : json['states'],
+        'subdivisions': json['subdivisions'] == null ? undefined : json['subdivisions'],
+        'includeDisabledProviders': json['includeDisabledProviders'] == null ? undefined : json['includeDisabledProviders'],
     };
 }
 export function RecommendRequestToJSON(value) {
@@ -39,6 +38,7 @@ export function RecommendRequestToJSON(value) {
     return {
         'phoneNumber': value['phoneNumber'],
         'countries': value['countries'],
-        'states': value['states'],
+        'subdivisions': value['subdivisions'],
+        'includeDisabledProviders': value['includeDisabledProviders'],
     };
 }

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

@@ -1,5 +1,5 @@
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1

package/dist/esm/models/RecommendResponse.js

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface RefreshStepContentRequest
+ */
+export interface RefreshStepContentRequest {
+    /**
+     * The `ResultsAccessKey` returned when the Session was created
+     * @type {string}
+     * @memberof RefreshStepContentRequest
+     */
+    resultsAccessKey?: string;
+}
+/**
+ * Check if a given object implements the RefreshStepContentRequest interface.
+ */
+export declare function instanceOfRefreshStepContentRequest(value: object): value is RefreshStepContentRequest;
+export declare function RefreshStepContentRequestFromJSON(json: any): RefreshStepContentRequest;
+export declare function RefreshStepContentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefreshStepContentRequest;
+export declare function RefreshStepContentRequestToJSON(value?: RefreshStepContentRequest | null): any;

package/dist/esm/models/RefreshStepContentRequest.js

@@ -0,0 +1,38 @@
+/* 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 RefreshStepContentRequest interface.
+ */
+export function instanceOfRefreshStepContentRequest(value) {
+    return true;
+}
+export function RefreshStepContentRequestFromJSON(json) {
+    return RefreshStepContentRequestFromJSONTyped(json, false);
+}
+export function RefreshStepContentRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+    };
+}
+export function RefreshStepContentRequestToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'resultsAccessKey': value['resultsAccessKey'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { IntegrationStep } from './IntegrationStep';
+/**
+ *
+ * @export
+ * @interface RefreshStepContentResponse
+ */
+export interface RefreshStepContentResponse {
+    /**
+     * The integration's next step with refreshed content
+     * @type {IntegrationStep}
+     * @memberof RefreshStepContentResponse
+     */
+    nextStep: IntegrationStep;
+}
+/**
+ * Check if a given object implements the RefreshStepContentResponse interface.
+ */
+export declare function instanceOfRefreshStepContentResponse(value: object): value is RefreshStepContentResponse;
+export declare function RefreshStepContentResponseFromJSON(json: any): RefreshStepContentResponse;
+export declare function RefreshStepContentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefreshStepContentResponse;
+export declare function RefreshStepContentResponseToJSON(value?: RefreshStepContentResponse | null): any;

package/dist/esm/models/RefreshStepContentResponse.js

@@ -0,0 +1,41 @@
+/* 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 { IntegrationStepFromJSON, IntegrationStepToJSON, } from './IntegrationStep';
+/**
+ * Check if a given object implements the RefreshStepContentResponse interface.
+ */
+export function instanceOfRefreshStepContentResponse(value) {
+    if (!('nextStep' in value) || value['nextStep'] === undefined)
+        return false;
+    return true;
+}
+export function RefreshStepContentResponseFromJSON(json) {
+    return RefreshStepContentResponseFromJSONTyped(json, false);
+}
+export function RefreshStepContentResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'nextStep': IntegrationStepFromJSON(json['nextStep']),
+    };
+}
+export function RefreshStepContentResponseToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'nextStep': IntegrationStepToJSON(value['nextStep']),
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { ResultCollectionMethod } from './ResultCollectionMethod';
+/**
+ *
+ * @export
+ * @interface ResultCollection
+ */
+export interface ResultCollection {
+    /**
+     * The method by which the results of the Acceptance Session should be collected.
+     * @type {ResultCollectionMethod}
+     * @memberof ResultCollection
+     */
+    method: ResultCollectionMethod;
+    /**
+     * If the method is `PollResult`, this is the key that should be used to poll for the results.
+     * @type {string}
+     * @memberof ResultCollection
+     */
+    resultsAccessKey?: string;
+}
+/**
+ * Check if a given object implements the ResultCollection interface.
+ */
+export declare function instanceOfResultCollection(value: object): value is ResultCollection;
+export declare function ResultCollectionFromJSON(json: any): ResultCollection;
+export declare function ResultCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultCollection;
+export declare function ResultCollectionToJSON(value?: ResultCollection | null): any;

package/dist/esm/models/ResultCollection.js

@@ -0,0 +1,43 @@
+/* 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 { ResultCollectionMethodFromJSON, ResultCollectionMethodToJSON, } from './ResultCollectionMethod';
+/**
+ * Check if a given object implements the ResultCollection interface.
+ */
+export function instanceOfResultCollection(value) {
+    if (!('method' in value) || value['method'] === undefined)
+        return false;
+    return true;
+}
+export function ResultCollectionFromJSON(json) {
+    return ResultCollectionFromJSONTyped(json, false);
+}
+export function ResultCollectionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'method': ResultCollectionMethodFromJSON(json['method']),
+        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+    };
+}
+export function ResultCollectionToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'method': ResultCollectionMethodToJSON(value['method']),
+        'resultsAccessKey': value['resultsAccessKey'],
+    };
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const ResultCollectionMethod: {
+    readonly PollResult: "PollResult";
+    readonly CaptureRedirect: "CaptureRedirect";
+};
+export type ResultCollectionMethod = typeof ResultCollectionMethod[keyof typeof ResultCollectionMethod];
+export declare function instanceOfResultCollectionMethod(value: any): boolean;
+export declare function ResultCollectionMethodFromJSON(json: any): ResultCollectionMethod;
+export declare function ResultCollectionMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultCollectionMethod;
+export declare function ResultCollectionMethodToJSON(value?: ResultCollectionMethod | null): any;

package/dist/esm/models/ResultCollectionMethod.js

@@ -0,0 +1,40 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ */
+export const ResultCollectionMethod = {
+    PollResult: 'PollResult',
+    CaptureRedirect: 'CaptureRedirect'
+};
+export function instanceOfResultCollectionMethod(value) {
+    for (const key in ResultCollectionMethod) {
+        if (Object.prototype.hasOwnProperty.call(ResultCollectionMethod, key)) {
+            if (ResultCollectionMethod[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ResultCollectionMethodFromJSON(json) {
+    return ResultCollectionMethodFromJSONTyped(json, false);
+}
+export function ResultCollectionMethodFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ResultCollectionMethodToJSON(value) {
+    return value;
+}

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

@@ -1,5 +1,5 @@
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -9,10 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { SessionState } from './SessionState';
-import type { DisclosedFields } from './DisclosedFields';
-import type { SessionFailCode } from './SessionFailCode';
-import type { Verification } from './Verification';
+import type { SessionErrorCode } from './SessionErrorCode';
 /**
  *
  * @export
@@ -26,29 +23,30 @@ export interface Session {
      */
     id: string;
     /**
-     * The state of the session
-     * @type {SessionState}
-     * @memberof Session
-     */
-    state: SessionState;
-    /**
-     * If the session is in state `IdvFailed`, this field contains the reason for failure.
-     * @type {SessionFailCode}
+     * Whether the Session is in a terminal / final state.
+     *
+     * If this is `true`, inspect the value of `Success` to determine whether the Session was successful.
+     * @type {boolean}
      * @memberof Session
      */
-    failCode?: SessionFailCode;
+    done: boolean;
     /**
-     * The underlying verification for this Session
-     * @type {Verification}
+     * Whether the Session has completed successfully.
+     *
+     * If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information.
+     * If this is `true`, the Session has completed successfully.
+     * @type {boolean}
      * @memberof Session
      */
-    verification: Verification;
+    success: boolean;
     /**
-     * The fields that were requested to be disclosed when the Session was created
-     * @type {DisclosedFields}
+     * The reason for the Session's failure.
+     *
+     * Only present if `Success` is `false`.
+     * @type {SessionErrorCode}
      * @memberof Session
      */
-    disclosedFields: DisclosedFields;
+    errorCode?: SessionErrorCode;
     /**
      * The unix timestamp, in seconds, when this session was created
      * @type {number}

package/dist/esm/models/Session.js

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -11,21 +11,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { SessionStateFromJSON, SessionStateToJSON, } from './SessionState';
-import { DisclosedFieldsFromJSON, DisclosedFieldsToJSON, } from './DisclosedFields';
-import { SessionFailCodeFromJSON, SessionFailCodeToJSON, } from './SessionFailCode';
-import { VerificationFromJSON, VerificationToJSON, } from './Verification';
+import { SessionErrorCodeFromJSON, SessionErrorCodeToJSON, } from './SessionErrorCode';
 /**
  * Check if a given object implements the Session interface.
  */
 export function instanceOfSession(value) {
     if (!('id' in value) || value['id'] === undefined)
         return false;
-    if (!('state' in value) || value['state'] === undefined)
+    if (!('done' in value) || value['done'] === undefined)
         return false;
-    if (!('verification' in value) || value['verification'] === undefined)
-        return false;
-    if (!('disclosedFields' in value) || value['disclosedFields'] === undefined)
+    if (!('success' in value) || value['success'] === undefined)
         return false;
     if (!('created' in value) || value['created'] === undefined)
         return false;
@@ -42,10 +37,9 @@ export function SessionFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'id': json['id'],
-        'state': SessionStateFromJSON(json['state']),
-        'failCode': json['failCode'] == null ? undefined : SessionFailCodeFromJSON(json['failCode']),
-        'verification': VerificationFromJSON(json['verification']),
-        'disclosedFields': DisclosedFieldsFromJSON(json['disclosedFields']),
+        'done': json['done'],
+        'success': json['success'],
+        'errorCode': json['errorCode'] == null ? undefined : SessionErrorCodeFromJSON(json['errorCode']),
         'created': json['created'],
         'updated': json['updated'],
     };
@@ -56,10 +50,9 @@ export function SessionToJSON(value) {
     }
     return {
         'id': value['id'],
-        'state': SessionStateToJSON(value['state']),
-        'failCode': SessionFailCodeToJSON(value['failCode']),
-        'verification': VerificationToJSON(value['verification']),
-        'disclosedFields': DisclosedFieldsToJSON(value['disclosedFields']),
+        'done': value['done'],
+        'success': value['success'],
+        'errorCode': SessionErrorCodeToJSON(value['errorCode']),
         'created': value['created'],
         'updated': value['updated'],
     };

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

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const SessionErrorCode: {
+    readonly Internal: "Internal";
+    readonly Other: "Other";
+    readonly Canceled: "Canceled";
+    readonly UserAbandoned: "UserAbandoned";
+    readonly UserTimedOut: "UserTimedOut";
+    readonly Expired: "Expired";
+    readonly InvalidImage: "InvalidImage";
+    readonly Inauthentic: "Inauthentic";
+    readonly UnsupportedDocument: "UnsupportedDocument";
+    readonly AssuranceLevelNotMet: "AssuranceLevelNotMet";
+};
+export type SessionErrorCode = typeof SessionErrorCode[keyof typeof SessionErrorCode];
+export declare function instanceOfSessionErrorCode(value: any): boolean;
+export declare function SessionErrorCodeFromJSON(json: any): SessionErrorCode;
+export declare function SessionErrorCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionErrorCode;
+export declare function SessionErrorCodeToJSON(value?: SessionErrorCode | null): any;

package/dist/esm/models/SessionErrorCode.js

@@ -0,0 +1,48 @@
+/* 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.
+ */
+/**
+ *
+ * @export
+ */
+export const SessionErrorCode = {
+    Internal: 'Internal',
+    Other: 'Other',
+    Canceled: 'Canceled',
+    UserAbandoned: 'UserAbandoned',
+    UserTimedOut: 'UserTimedOut',
+    Expired: 'Expired',
+    InvalidImage: 'InvalidImage',
+    Inauthentic: 'Inauthentic',
+    UnsupportedDocument: 'UnsupportedDocument',
+    AssuranceLevelNotMet: 'AssuranceLevelNotMet'
+};
+export function instanceOfSessionErrorCode(value) {
+    for (const key in SessionErrorCode) {
+        if (Object.prototype.hasOwnProperty.call(SessionErrorCode, key)) {
+            if (SessionErrorCode[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function SessionErrorCodeFromJSON(json) {
+    return SessionErrorCodeFromJSONTyped(json, false);
+}
+export function SessionErrorCodeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SessionErrorCodeToJSON(value) {
+    return value;
+}

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

@@ -1,5 +1,5 @@
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1

package/dist/esm/models/SessionOrdering.js

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const Sex: {
+    readonly Unknown: "Unknown";
+    readonly NotApplicable: "NotApplicable";
+    readonly Male: "Male";
+    readonly Female: "Female";
+};
+export type Sex = typeof Sex[keyof typeof Sex];
+export declare function instanceOfSex(value: any): boolean;
+export declare function SexFromJSON(json: any): Sex;
+export declare function SexFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sex;
+export declare function SexToJSON(value?: Sex | null): any;