@trinsic/api 1.2.0 → 2.0.0-alpha3

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/SouthAfricaNidInput.ts

@@ -0,0 +1,88 @@
+/* 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 SouthAfricaNidInput
+ */
+export interface SouthAfricaNidInput {
+    /**
+     * The user's full name as it appears in their National ID
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    fullName: string;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof SouthAfricaNidInput
+     */
+    dateOfBirth: Date;
+    /**
+     * The user's gender as it appears in their National ID (e.g., male, female)
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    gender: string;
+    /**
+     * The user's South African National ID number
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    nationalIdNumber: string;
+}
+
+/**
+ * Check if a given object implements the SouthAfricaNidInput interface.
+ */
+export function instanceOfSouthAfricaNidInput(value: object): value is SouthAfricaNidInput {
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('gender' in value) || value['gender'] === undefined) return false;
+    if (!('nationalIdNumber' in value) || value['nationalIdNumber'] === undefined) return false;
+    return true;
+}
+
+export function SouthAfricaNidInputFromJSON(json: any): SouthAfricaNidInput {
+    return SouthAfricaNidInputFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'gender': json['gender'],
+        'nationalIdNumber': json['nationalIdNumber'],
+    };
+}
+
+export function SouthAfricaNidInputToJSON(value?: SouthAfricaNidInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'fullName': value['fullName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'gender': value['gender'],
+        'nationalIdNumber': value['nationalIdNumber'],
+    };
+}
+

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,36 +1,58 @@
 /* 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 './IndonesiaNikInput';
+export * from './IntegrationCapability';
+export * from './IntegrationLaunchMethod';
+export * from './IntegrationStep';
+export * from './KenyaNidInput';
 export * from './KnownAddress';
 export * from './KnownIdentityData';
 export * from './KnownPersonData';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
+export * from './MexicoCurpInput';
+export * from './NigeriaNinInput';
 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 './SouthAfricaNidInput';
+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,82 +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 { KnownIdentityData } from './KnownIdentityData';
-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>;
-    /**
-     * 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}
-     * @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;

package/dist/esm/models/CreateSessionRequest.js

@@ -1,48 +0,0 @@
-/* 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 { KnownIdentityDataFromJSON, KnownIdentityDataToJSON, } from './KnownIdentityData';
-import { DisclosedFieldsRequestFromJSON, DisclosedFieldsRequestToJSON, } from './DisclosedFieldsRequest';
-/**
- * Check if a given object implements the CreateSessionRequest interface.
- */
-export function instanceOfCreateSessionRequest(value) {
-    return true;
-}
-export function CreateSessionRequestFromJSON(json) {
-    return CreateSessionRequestFromJSONTyped(json, false);
-}
-export function CreateSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    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']),
-    };
-}
-export function CreateSessionRequestToJSON(value) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'launchProviderDirectly': value['launchProviderDirectly'],
-        'enableRememberMe': value['enableRememberMe'],
-        'providers': value['providers'],
-        'knownIdentityData': KnownIdentityDataToJSON(value['knownIdentityData']),
-        'disclosedFields': DisclosedFieldsRequestToJSON(value['disclosedFields']),
-    };
-}

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

@@ -1,43 +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 { Session } from './Session';
-/**
- *
- * @export
- * @interface CreateSessionResponse
- */
-export interface CreateSessionResponse {
-    /**
-     * The created Acceptance Session
-     * @type {Session}
-     * @memberof CreateSessionResponse
-     */
-    session: Session;
-    /**
-     * The URL that should be used to invoke the Acceptance Session on your user's device.
-     *
-     * You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.
-     * If the Session was created with `LaunchProviderDirectly` set to `true`, you can't use the iFrame mode.
-     *
-     * This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
-     * @type {string}
-     * @memberof CreateSessionResponse
-     */
-    launchUrl?: string;
-}
-/**
- * Check if a given object implements the CreateSessionResponse interface.
- */
-export declare function instanceOfCreateSessionResponse(value: object): value is CreateSessionResponse;
-export declare function CreateSessionResponseFromJSON(json: any): CreateSessionResponse;
-export declare function CreateSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateSessionResponse;
-export declare function CreateSessionResponseToJSON(value?: CreateSessionResponse | null): any;

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

@@ -1,97 +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.
- */
-/**
- *
- * @export
- * @interface DisclosedFields
- */
-export interface DisclosedFields {
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    idNumber: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    givenName: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    familyName: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    address: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    dateOfBirth: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    country: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    issueDate: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    expirationDate: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    documentFront: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    documentBack: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    documentPortrait: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DisclosedFields
-     */
-    selfie: boolean;
-}
-/**
- * Check if a given object implements the DisclosedFields interface.
- */
-export declare function instanceOfDisclosedFields(value: object): value is DisclosedFields;
-export declare function DisclosedFieldsFromJSON(json: any): DisclosedFields;
-export declare function DisclosedFieldsFromJSONTyped(json: any, ignoreDiscriminator: boolean): DisclosedFields;
-export declare function DisclosedFieldsToJSON(value?: DisclosedFields | null): any;