@trinsic/api 2.0.0-alpha2 → 2.0.0

package/src/models/CreateAdvancedProviderSessionRequest.ts

@@ -43,51 +43,51 @@ export interface CreateAdvancedProviderSessionRequest {
      * @type {ProviderInput}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    providerInput?: ProviderInput;
+    providerInput?: ProviderInput | null;
     /**
-     * The Redirect URL to which the user should be sent after the session is complete.
-     *             
+     * The Redirect URL to which the user should be sent after the session is complete.
+     *             
      * This field is required for providers which employ a redirect-based flow.
      * @type {string}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    redirectUrl?: string;
+    redirectUrl?: string | null;
     /**
-     * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
-     *             
-     * Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.
-     * The exception being refresh content to support updating the content of the launch method.
-     *             
-     * For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.
-     * To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.
-     *             
-     * If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.
-     * If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.
-     *             
+     * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
+     *             
+     * Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.
+     * The exception being refresh content to support updating the content of the launch method.
+     *             
+     * For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.
+     * To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.
+     *             
+     * If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.
+     * If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.
+     *             
      * Read more on how to integrate at <a href="https://docs.trinsic.id/docs/advanced-provider-sessions">the guide on Advanced Provider Sessions</a>
      * @type {Array<IntegrationCapability>}
      * @memberof CreateAdvancedProviderSessionRequest
      */
     capabilities: Array<IntegrationCapability>;
     /**
-     * Whether the session should fall back to a Trinsic-hosted UI in certain instances.
-     *             
-     * Specifically, fallback will occur if any of the following are true:
-     * - You attempted to launch a provider which requires a capability you did not express support for
-     *     - In this case, Trinsic's hosted UI will perform the necessary capability
-     * - You attempted to launch a provider which requires input, and the input was either not provided or incomplete
-     *     - In this case, Trinsic's hosted UI will collect the necessary input from the user
-     *             
-     * If fallback occurs, the session's NextStep will always be LaunchBrowser,
-     * and the CollectionMethod will always be CaptureRedirect.
-     *             
-     * If this field is set to `true`, you must also:
-     * 1. Set the `RedirectUrl` field to a non-empty value
+     * Whether the session should fall back to a Trinsic-hosted UI in certain instances.
+     *             
+     * Specifically, fallback will occur if any of the following are true:
+     * - You attempted to launch a provider which requires a capability you did not express support for
+     *     - In this case, Trinsic's hosted UI will perform the necessary capability
+     * - You attempted to launch a provider which requires input, and the input was either not provided or incomplete
+     *     - In this case, Trinsic's hosted UI will collect the necessary input from the user
+     *             
+     * If fallback occurs, the session's NextStep will always be LaunchBrowser,
+     * and the CollectionMethod will always be CaptureRedirect.
+     *             
+     * If this field is set to `true`, you must also:
+     * 1. Set the `RedirectUrl` field to a non-empty value
      * 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
      * @type {boolean}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    fallbackToHostedUI?: boolean;
+    fallbackToHostedUI?: boolean | null;
 }
 
 /**

package/src/models/CreateHostedProviderSessionRequest.ts

@@ -43,7 +43,7 @@ export interface CreateHostedProviderSessionRequest {
      * @type {ProviderInput}
      * @memberof CreateHostedProviderSessionRequest
      */
-    providerInput?: ProviderInput;
+    providerInput?: ProviderInput | null;
 }
 
 /**

package/src/models/CreateHostedProviderSessionResponse.ts

@@ -26,17 +26,29 @@ export interface CreateHostedProviderSessionResponse {
      */
     sessionId: string;
     /**
-     * The URL that should be used to launch the Hosted Provider Session on your user's device.
-     *             
-     * There are two recommended ways to do so:
-     * - Redirect their browser to the `LaunchUrl` as a top-level navigation
-     * - Open a popup window and navigate it to the `LaunchUrl`
-     *             
+     * The URL that should be used to launch the Hosted Provider Session on your user's device.
+     *             
+     * There are two recommended ways to do so:
+     * - Redirect their browser to the `LaunchUrl` as a top-level navigation
+     * - Open a popup window and navigate it to the `LaunchUrl`
+     *             
      * 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 CreateHostedProviderSessionResponse
      */
-    launchUrl?: string;
+    launchUrl: string;
+    /**
+     * The `resultsAccessKey` for the Acceptance Session.
+     *             
+     * This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.
+     *             
+     * Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.
+     *             
+     * Trinsic cannot access a Session's Data Vault without this key.
+     * @type {string}
+     * @memberof CreateHostedProviderSessionResponse
+     */
+    resultsAccessKey: string;
 }
 
 /**
@@ -44,6 +56,8 @@ export interface CreateHostedProviderSessionResponse {
  */
 export function instanceOfCreateHostedProviderSessionResponse(value: object): value is CreateHostedProviderSessionResponse {
     if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined) return false;
     return true;
 }
 
@@ -58,7 +72,8 @@ export function CreateHostedProviderSessionResponseFromJSONTyped(json: any, igno
     return {
         
         'sessionId': json['sessionId'],
-        'launchUrl': json['launchUrl'] == null ? undefined : json['launchUrl'],
+        'launchUrl': json['launchUrl'],
+        'resultsAccessKey': json['resultsAccessKey'],
     };
 }
 
@@ -70,6 +85,7 @@ export function CreateHostedProviderSessionResponseToJSON(value?: CreateHostedPr
         
         'sessionId': value['sessionId'],
         'launchUrl': value['launchUrl'],
+        'resultsAccessKey': value['resultsAccessKey'],
     };
 }
 

package/src/models/CreateWidgetSessionRequest.ts

@@ -13,12 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
-import type { KnownIdentityData } from './KnownIdentityData';
+import type { RecommendationInfo } from './RecommendationInfo';
 import {
-    KnownIdentityDataFromJSON,
-    KnownIdentityDataFromJSONTyped,
-    KnownIdentityDataToJSON,
-} from './KnownIdentityData';
+    RecommendationInfoFromJSON,
+    RecommendationInfoFromJSONTyped,
+    RecommendationInfoToJSON,
+} from './RecommendationInfo';
 
 /**
  * 
@@ -27,28 +27,29 @@ import {
  */
 export interface CreateWidgetSessionRequest {
     /**
-     * The URL to redirect the user to after the widget session is complete.
-     *             
-     * *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget
+     * The URL to redirect the user to after the widget session is complete.
+     *             
+     * *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget
      * as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect.
      * @type {string}
      * @memberof CreateWidgetSessionRequest
      */
-    redirectUrl?: string;
+    redirectUrl?: string | null;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      * @type {Array<string>}
      * @memberof CreateWidgetSessionRequest
      */
-    providers?: Array<string>;
+    providers?: Array<string> | null;
     /**
-     * Known identity data of an individual being verified.
-     *             
-     * Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
-     * @type {KnownIdentityData}
+     * Data that you already know about the user being verified.
+     * 
+     * 
+     * This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first.
+     * @type {RecommendationInfo}
      * @memberof CreateWidgetSessionRequest
      */
-    knownIdentityData?: KnownIdentityData;
+    recommendationInfo?: RecommendationInfo | null;
 }
 
 /**
@@ -70,7 +71,7 @@ export function CreateWidgetSessionRequestFromJSONTyped(json: any, ignoreDiscrim
         
         'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
         'providers': json['providers'] == null ? undefined : json['providers'],
-        'knownIdentityData': json['knownIdentityData'] == null ? undefined : KnownIdentityDataFromJSON(json['knownIdentityData']),
+        'recommendationInfo': json['recommendationInfo'] == null ? undefined : RecommendationInfoFromJSON(json['recommendationInfo']),
     };
 }
 
@@ -82,7 +83,7 @@ export function CreateWidgetSessionRequestToJSON(value?: CreateWidgetSessionRequ
         
         'redirectUrl': value['redirectUrl'],
         'providers': value['providers'],
-        'knownIdentityData': KnownIdentityDataToJSON(value['knownIdentityData']),
+        'recommendationInfo': RecommendationInfoToJSON(value['recommendationInfo']),
     };
 }
 

package/src/models/CreateWidgetSessionResponse.ts

@@ -26,15 +26,27 @@ export interface CreateWidgetSessionResponse {
      */
     sessionId: string;
     /**
-     * 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.
-     *             
+     * 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.
+     *             
      * 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 CreateWidgetSessionResponse
      */
-    launchUrl?: string;
+    launchUrl: string;
+    /**
+     * The `resultsAccessKey` for the Acceptance Session.
+     *             
+     * This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.
+     *             
+     * Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.
+     *             
+     * Trinsic cannot access a Session's Data Vault without this key.
+     * @type {string}
+     * @memberof CreateWidgetSessionResponse
+     */
+    resultsAccessKey: string;
 }
 
 /**
@@ -42,6 +54,8 @@ export interface CreateWidgetSessionResponse {
  */
 export function instanceOfCreateWidgetSessionResponse(value: object): value is CreateWidgetSessionResponse {
     if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined) return false;
     return true;
 }
 
@@ -56,7 +70,8 @@ export function CreateWidgetSessionResponseFromJSONTyped(json: any, ignoreDiscri
     return {
         
         'sessionId': json['sessionId'],
-        'launchUrl': json['launchUrl'] == null ? undefined : json['launchUrl'],
+        'launchUrl': json['launchUrl'],
+        'resultsAccessKey': json['resultsAccessKey'],
     };
 }
 
@@ -68,6 +83,7 @@ export function CreateWidgetSessionResponseToJSON(value?: CreateWidgetSessionRes
         
         'sessionId': value['sessionId'],
         'launchUrl': value['launchUrl'],
+        'resultsAccessKey': value['resultsAccessKey'],
     };
 }
 

package/src/models/DocumentData.ts

@@ -31,37 +31,37 @@ export interface DocumentData {
      * @type {DocumentType}
      * @memberof DocumentData
      */
-    type?: DocumentType;
+    type?: DocumentType | null;
     /**
      * 
      * @type {string}
      * @memberof DocumentData
      */
-    number?: string;
+    number?: string | null;
     /**
      * 
      * @type {Date}
      * @memberof DocumentData
      */
-    issueDate?: Date;
+    issueDate?: Date | null;
     /**
      * 
      * @type {Date}
      * @memberof DocumentData
      */
-    expirationDate?: Date;
+    expirationDate?: Date | null;
     /**
      * 
      * @type {string}
      * @memberof DocumentData
      */
-    issuingCountry?: string;
+    issuingCountry?: string | null;
     /**
      * 
      * @type {string}
      * @memberof DocumentData
      */
-    issuingAuthority?: string;
+    issuingAuthority?: string | null;
 }
 
 
@@ -100,8 +100,8 @@ export function DocumentDataToJSON(value?: DocumentData | null): any {
         
         'type': DocumentTypeToJSON(value['type']),
         'number': value['number'],
-        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate']).toISOString().substring(0,10)),
-        'expirationDate': value['expirationDate'] == null ? undefined : ((value['expirationDate']).toISOString().substring(0,10)),
+        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate'] as any).toISOString().substring(0,10)),
+        'expirationDate': value['expirationDate'] == null ? undefined : ((value['expirationDate'] as any).toISOString().substring(0,10)),
         'issuingCountry': value['issuingCountry'],
         'issuingAuthority': value['issuingAuthority'],
     };

package/src/models/DocumentScanAttachments.ts

@@ -24,7 +24,7 @@ export interface DocumentScanAttachments {
      * @type {string}
      * @memberof DocumentScanAttachments
      */
-    report?: string;
+    report?: string | null;
 }
 
 /**

package/src/models/GetSessionResultResponse.ts

@@ -43,7 +43,7 @@ export interface GetSessionResultResponse {
      * @type {IdentityData}
      * @memberof GetSessionResultResponse
      */
-    identityData?: IdentityData;
+    identityData?: IdentityData | null;
 }
 
 /**

package/src/models/HttpValidationProblemDetails.ts

@@ -24,31 +24,31 @@ export interface HttpValidationProblemDetails {
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    type?: string;
+    type?: string | null;
     /**
      * 
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    title?: string;
+    title?: string | null;
     /**
      * 
      * @type {number}
      * @memberof HttpValidationProblemDetails
      */
-    status?: number;
+    status?: number | null;
     /**
      * 
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    detail?: string;
+    detail?: string | null;
     /**
      * 
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    instance?: string;
+    instance?: string | null;
     /**
      * 
      * @type {{ [key: string]: Array<string>; }}

package/src/models/IdentityData.ts

@@ -43,25 +43,31 @@ export interface IdentityData {
      * @type {string}
      * @memberof IdentityData
      */
-    originatingProviderId?: string;
+    originatingProviderId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IdentityData
+     */
+    originatingSubProviderId?: string | null;
     /**
      * 
      * @type {PersonData}
      * @memberof IdentityData
      */
-    person?: PersonData;
+    person?: PersonData | null;
     /**
      * 
      * @type {DocumentData}
      * @memberof IdentityData
      */
-    document?: DocumentData;
+    document?: DocumentData | null;
     /**
      * 
      * @type {AttachmentAccessKeys}
      * @memberof IdentityData
      */
-    attachmentAccessKeys?: AttachmentAccessKeys;
+    attachmentAccessKeys?: AttachmentAccessKeys | null;
 }
 
 /**
@@ -82,6 +88,7 @@ export function IdentityDataFromJSONTyped(json: any, ignoreDiscriminator: boolea
     return {
         
         'originatingProviderId': json['originatingProviderId'] == null ? undefined : json['originatingProviderId'],
+        'originatingSubProviderId': json['originatingSubProviderId'] == null ? undefined : json['originatingSubProviderId'],
         'person': json['person'] == null ? undefined : PersonDataFromJSON(json['person']),
         'document': json['document'] == null ? undefined : DocumentDataFromJSON(json['document']),
         'attachmentAccessKeys': json['attachmentAccessKeys'] == null ? undefined : AttachmentAccessKeysFromJSON(json['attachmentAccessKeys']),
@@ -95,6 +102,7 @@ export function IdentityDataToJSON(value?: IdentityData | null): any {
     return {
         
         'originatingProviderId': value['originatingProviderId'],
+        'originatingSubProviderId': value['originatingSubProviderId'],
         'person': PersonDataToJSON(value['person']),
         'document': DocumentDataToJSON(value['document']),
         'attachmentAccessKeys': AttachmentAccessKeysToJSON(value['attachmentAccessKeys']),

package/src/models/IdinInput.ts

@@ -0,0 +1,62 @@
+/* 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 IdinInput
+ */
+export interface IdinInput {
+    /**
+     * The ID of the specific bank to invoke with IDIN.
+     *             
+     * If not specified, the user will be prompted to select a bank.
+     * @type {string}
+     * @memberof IdinInput
+     */
+    subProviderId?: string | null;
+}
+
+/**
+ * Check if a given object implements the IdinInput interface.
+ */
+export function instanceOfIdinInput(value: object): value is IdinInput {
+    return true;
+}
+
+export function IdinInputFromJSON(json: any): IdinInput {
+    return IdinInputFromJSONTyped(json, false);
+}
+
+export function IdinInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdinInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+    };
+}
+
+export function IdinInputToJSON(value?: IdinInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'subProviderId': value['subProviderId'],
+    };
+}
+

package/src/models/IndonesiaNikInput.ts

@@ -0,0 +1,79 @@
+/* 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 IndonesiaNikInput
+ */
+export interface IndonesiaNikInput {
+    /**
+     * The user's full name
+     * @type {string}
+     * @memberof IndonesiaNikInput
+     */
+    fullName: string;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof IndonesiaNikInput
+     */
+    dateOfBirth: Date;
+    /**
+     * The user's Indonesia NIK ID number
+     * @type {string}
+     * @memberof IndonesiaNikInput
+     */
+    nikIdNumber: string;
+}
+
+/**
+ * Check if a given object implements the IndonesiaNikInput interface.
+ */
+export function instanceOfIndonesiaNikInput(value: object): value is IndonesiaNikInput {
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('nikIdNumber' in value) || value['nikIdNumber'] === undefined) return false;
+    return true;
+}
+
+export function IndonesiaNikInputFromJSON(json: any): IndonesiaNikInput {
+    return IndonesiaNikInputFromJSONTyped(json, false);
+}
+
+export function IndonesiaNikInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndonesiaNikInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'nikIdNumber': json['nikIdNumber'],
+    };
+}
+
+export function IndonesiaNikInputToJSON(value?: IndonesiaNikInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'fullName': value['fullName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'nikIdNumber': value['nikIdNumber'],
+    };
+}
+

package/src/models/IntegrationLaunchMethod.ts

@@ -19,7 +19,7 @@
  */
 export const IntegrationLaunchMethod = {
     LaunchBrowser: 'LaunchBrowser',
-    PollResult: 'PollResult',
+    None: 'None',
     DeeplinkToMobile: 'DeeplinkToMobile',
     ShowContent: 'ShowContent'
 } as const;

package/src/models/IntegrationStep.ts

@@ -49,7 +49,7 @@ export interface IntegrationStep {
      * @type {StepRefreshInfo}
      * @memberof IntegrationStep
      */
-    refresh: StepRefreshInfo;
+    refresh: StepRefreshInfo | null;
 }