@trinsic/api 1.1.2 → 2.0.0-alpha2

package/src/models/RefreshStepContentResponse.ts

@@ -0,0 +1,68 @@
+/* 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 { mapValues } from '../runtime';
+import type { IntegrationStep } from './IntegrationStep';
+import {
+    IntegrationStepFromJSON,
+    IntegrationStepFromJSONTyped,
+    IntegrationStepToJSON,
+} 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 function instanceOfRefreshStepContentResponse(value: object): value is RefreshStepContentResponse {
+    if (!('nextStep' in value) || value['nextStep'] === undefined) return false;
+    return true;
+}
+
+export function RefreshStepContentResponseFromJSON(json: any): RefreshStepContentResponse {
+    return RefreshStepContentResponseFromJSONTyped(json, false);
+}
+
+export function RefreshStepContentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefreshStepContentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nextStep': IntegrationStepFromJSON(json['nextStep']),
+    };
+}
+
+export function RefreshStepContentResponseToJSON(value?: RefreshStepContentResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'nextStep': IntegrationStepToJSON(value['nextStep']),
+    };
+}
+

package/src/models/ResultCollection.ts

@@ -0,0 +1,78 @@
+/* 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 { mapValues } from '../runtime';
+import type { ResultCollectionMethod } from './ResultCollectionMethod';
+import {
+    ResultCollectionMethodFromJSON,
+    ResultCollectionMethodFromJSONTyped,
+    ResultCollectionMethodToJSON,
+} 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 function instanceOfResultCollection(value: object): value is ResultCollection {
+    if (!('method' in value) || value['method'] === undefined) return false;
+    return true;
+}
+
+export function ResultCollectionFromJSON(json: any): ResultCollection {
+    return ResultCollectionFromJSONTyped(json, false);
+}
+
+export function ResultCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultCollection {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'method': ResultCollectionMethodFromJSON(json['method']),
+        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+    };
+}
+
+export function ResultCollectionToJSON(value?: ResultCollection | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'method': ResultCollectionMethodToJSON(value['method']),
+        'resultsAccessKey': value['resultsAccessKey'],
+    };
+}
+

package/src/models/ResultCollectionMethod.ts

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

package/src/models/Session.ts

@@ -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
@@ -13,30 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SessionState } from './SessionState';
+import type { SessionErrorCode } from './SessionErrorCode';
 import {
-    SessionStateFromJSON,
-    SessionStateFromJSONTyped,
-    SessionStateToJSON,
-} from './SessionState';
-import type { DisclosedFields } from './DisclosedFields';
-import {
-    DisclosedFieldsFromJSON,
-    DisclosedFieldsFromJSONTyped,
-    DisclosedFieldsToJSON,
-} from './DisclosedFields';
-import type { SessionFailCode } from './SessionFailCode';
-import {
-    SessionFailCodeFromJSON,
-    SessionFailCodeFromJSONTyped,
-    SessionFailCodeToJSON,
-} from './SessionFailCode';
-import type { Verification } from './Verification';
-import {
-    VerificationFromJSON,
-    VerificationFromJSONTyped,
-    VerificationToJSON,
-} from './Verification';
+    SessionErrorCodeFromJSON,
+    SessionErrorCodeFromJSONTyped,
+    SessionErrorCodeToJSON,
+} from './SessionErrorCode';
 
 /**
  * 
@@ -51,29 +33,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}
@@ -95,9 +78,8 @@ export interface Session {
  */
 export function instanceOfSession(value: object): value is Session {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('state' in value) || value['state'] === undefined) return false;
-    if (!('verification' in value) || value['verification'] === undefined) return false;
-    if (!('disclosedFields' in value) || value['disclosedFields'] === undefined) return false;
+    if (!('done' in value) || value['done'] === undefined) return false;
+    if (!('success' in value) || value['success'] === undefined) return false;
     if (!('created' in value) || value['created'] === undefined) return false;
     if (!('updated' in value) || value['updated'] === undefined) return false;
     return true;
@@ -114,10 +96,9 @@ export function SessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
     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'],
     };
@@ -130,10 +111,9 @@ export function SessionToJSON(value?: Session | null): any {
     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/src/models/SessionErrorCode.ts

@@ -0,0 +1,57 @@
+/* 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'
+} as const;
+export type SessionErrorCode = typeof SessionErrorCode[keyof typeof SessionErrorCode];
+
+
+export function instanceOfSessionErrorCode(value: any): boolean {
+    for (const key in SessionErrorCode) {
+        if (Object.prototype.hasOwnProperty.call(SessionErrorCode, key)) {
+            if (SessionErrorCode[key as keyof typeof SessionErrorCode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SessionErrorCodeFromJSON(json: any): SessionErrorCode {
+    return SessionErrorCodeFromJSONTyped(json, false);
+}
+
+export function SessionErrorCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionErrorCode {
+    return json as SessionErrorCode;
+}
+
+export function SessionErrorCodeToJSON(value?: SessionErrorCode | null): any {
+    return value as any;
+}
+

package/src/models/SessionOrdering.ts

@@ -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/src/models/Sex.ts

@@ -0,0 +1,51 @@
+/* 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 Sex = {
+    Unknown: 'Unknown',
+    NotApplicable: 'NotApplicable',
+    Male: 'Male',
+    Female: 'Female'
+} as const;
+export type Sex = typeof Sex[keyof typeof Sex];
+
+
+export function instanceOfSex(value: any): boolean {
+    for (const key in Sex) {
+        if (Object.prototype.hasOwnProperty.call(Sex, key)) {
+            if (Sex[key as keyof typeof Sex] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SexFromJSON(json: any): Sex {
+    return SexFromJSONTyped(json, false);
+}
+
+export function SexFromJSONTyped(json: any, ignoreDiscriminator: boolean): Sex {
+    return json as Sex;
+}
+
+export function SexToJSON(value?: Sex | null): any {
+    return value as any;
+}
+

package/src/models/StepRefreshInfo.ts

@@ -0,0 +1,81 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface StepRefreshInfo
+ */
+export interface StepRefreshInfo {
+    /**
+     * The UTC date/time at which the step `content` will expire and should no longer be used.
+     *             
+     * Use the `Refresh Step Content` API to obtain a new value for `content`.
+     * @type {Date}
+     * @memberof StepRefreshInfo
+     */
+    expiresAt: Date;
+    /**
+     * The UTC date/time after which Trinsic recommends you refresh the step `content`.
+     * @type {Date}
+     * @memberof StepRefreshInfo
+     */
+    refreshAfter: Date;
+    /**
+     * The total lifetime of the step `content`.
+     * @type {number}
+     * @memberof StepRefreshInfo
+     */
+    timeToLiveSeconds: number;
+}
+
+/**
+ * Check if a given object implements the StepRefreshInfo interface.
+ */
+export function instanceOfStepRefreshInfo(value: object): value is StepRefreshInfo {
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('refreshAfter' in value) || value['refreshAfter'] === undefined) return false;
+    if (!('timeToLiveSeconds' in value) || value['timeToLiveSeconds'] === undefined) return false;
+    return true;
+}
+
+export function StepRefreshInfoFromJSON(json: any): StepRefreshInfo {
+    return StepRefreshInfoFromJSONTyped(json, false);
+}
+
+export function StepRefreshInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): StepRefreshInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'expiresAt': (new Date(json['expiresAt'])),
+        'refreshAfter': (new Date(json['refreshAfter'])),
+        'timeToLiveSeconds': json['timeToLiveSeconds'],
+    };
+}
+
+export function StepRefreshInfoToJSON(value?: StepRefreshInfo | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'expiresAt': ((value['expiresAt']).toISOString()),
+        'refreshAfter': ((value['refreshAfter']).toISOString()),
+        'timeToLiveSeconds': value['timeToLiveSeconds'],
+    };
+}
+

package/src/models/index.ts

@@ -1,30 +1,53 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AadhaarInput';
 export * from './Address';
 export * from './AttachmentAccessKeys';
+export * from './BangladeshNationalIdInput';
+export * from './BrazilCpfCheckInput';
+export * from './BrazilDigitalCnhInput';
 export * from './CancelSessionResponse';
-export * from './CreateSessionRequest';
-export * from './CreateSessionResponse';
-export * from './DisclosedFields';
-export * from './DisclosedFieldsRequest';
+export * from './CreateAdvancedProviderSessionRequest';
+export * from './CreateAdvancedProviderSessionResponse';
+export * from './CreateHostedProviderSessionRequest';
+export * from './CreateHostedProviderSessionResponse';
+export * from './CreateWidgetSessionRequest';
+export * from './CreateWidgetSessionResponse';
 export * from './DocumentData';
-export * from './FailureMessage';
+export * from './DocumentScanAttachments';
+export * from './DocumentType';
 export * from './GetAttachmentRequest';
 export * from './GetAttachmentResponse';
 export * from './GetSessionResponse';
 export * from './GetSessionResultRequest';
 export * from './GetSessionResultResponse';
+export * from './HttpValidationProblemDetails';
 export * from './IdentityData';
-export * from './IdentityLookupResponse';
+export * from './IntegrationCapability';
+export * from './IntegrationLaunchMethod';
+export * from './IntegrationStep';
+export * from './KnownAddress';
+export * from './KnownIdentityData';
+export * from './KnownPersonData';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
 export * from './OrderDirection';
 export * from './PersonData';
+export * from './PhilippineMatchInput';
+export * from './PhilippineQRInput';
+export * from './ProblemDetails';
+export * from './ProviderAttachments';
 export * from './ProviderInfo';
+export * from './ProviderInformation';
+export * from './ProviderInput';
+export * from './RecommendRequest';
+export * from './RecommendResponse';
+export * from './RefreshStepContentRequest';
+export * from './RefreshStepContentResponse';
+export * from './ResultCollection';
+export * from './ResultCollectionMethod';
 export * from './Session';
-export * from './SessionFailCode';
+export * from './SessionErrorCode';
 export * from './SessionOrdering';
-export * from './SessionState';
-export * from './ValidationResult';
-export * from './Verification';
-export * from './VerificationFailCode';
+export * from './Sex';
+export * from './StepRefreshInfo';

package/src/runtime.ts

@@ -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/CreateSessionRequest.d.ts

@@ -1,73 +0,0 @@
-/**
- * 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 { DisclosedFieldsRequest } from './DisclosedFieldsRequest';
-/**
- *
- * @export
- * @interface CreateSessionRequest
- */
-export interface CreateSessionRequest {
-    /**
-     * Whether to immediately launch the identity provider, without invoking the Trinsic Widget UI.
-     *
-     * Users will not be shown the Widget; therefore, reuse of credentials, selection of an identity provider, and saving a verification for future reuse
-     * are not available to the end user in this mode.
-     *
-     * Sessions created with this option enabled must be created with a `RedirectUrl` specified, and cannot be invoked using the frontend SDK at this time.
-     * @type {boolean}
-     * @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.
-     *
-     * If `LaunchMethodDirectly` is `true`, this field must be set, and must have only a single entry.
-     * If `LaunchMethodDirectly` is not specified or is `false`, this field may have any number of entries.
-     * @type {Array<string>}
-     * @memberof CreateSessionRequest
-     */
-    providers?: Array<string>;
-    /**
-     * Specific identity attributes to request. If not provided, all available attributes will be requested.
-     * @type {DisclosedFieldsRequest}
-     * @memberof CreateSessionRequest
-     */
-    disclosedFields?: DisclosedFieldsRequest;
-}
-/**
- * Check if a given object implements the CreateSessionRequest interface.
- */
-export declare function instanceOfCreateSessionRequest(value: object): value is CreateSessionRequest;
-export declare function CreateSessionRequestFromJSON(json: any): CreateSessionRequest;
-export declare function CreateSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSessionRequest;
-export declare function CreateSessionRequestToJSON(value?: CreateSessionRequest | null): any;