@trinsic/api 2.0.2 → 2.1.0-alpha1

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { FieldAvailability } from './FieldAvailability';
+/**
+ * Information about a field that a Provider will return in verification results.
+ * @export
+ * @interface ContractField
+ */
+export interface ContractField {
+    /**
+     * The name of the field as it appears in verification results.
+     * @type {string}
+     * @memberof ContractField
+     */
+    name: string;
+    /**
+     * Indicates when this field will be present in verification results.
+     * @type {FieldAvailability}
+     * @memberof ContractField
+     */
+    outputted: FieldAvailability;
+}
+/**
+ * Check if a given object implements the ContractField interface.
+ */
+export declare function instanceOfContractField(value: object): value is ContractField;
+export declare function ContractFieldFromJSON(json: any): ContractField;
+export declare function ContractFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractField;
+export declare function ContractFieldToJSON(json: any): ContractField;
+export declare function ContractFieldToJSONTyped(value?: ContractField | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ContractField.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.
+ */
+import { FieldAvailabilityFromJSON, FieldAvailabilityToJSON, } from './FieldAvailability';
+/**
+ * Check if a given object implements the ContractField interface.
+ */
+export function instanceOfContractField(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('outputted' in value) || value['outputted'] === undefined)
+        return false;
+    return true;
+}
+export function ContractFieldFromJSON(json) {
+    return ContractFieldFromJSONTyped(json, false);
+}
+export function ContractFieldFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'outputted': FieldAvailabilityFromJSON(json['outputted']),
+    };
+}
+export function ContractFieldToJSON(json) {
+    return ContractFieldToJSONTyped(json, false);
+}
+export function ContractFieldToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'outputted': FieldAvailabilityToJSON(value['outputted']),
+    };
+}

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

@@ -23,12 +23,6 @@ export interface CreateAdvancedProviderSessionRequest {
      * @memberof CreateAdvancedProviderSessionRequest
      */
     provider: string;
-    /**
-     * Provider-specific input for those providers which require it.
-     * @type {ProviderInput}
-     * @memberof CreateAdvancedProviderSessionRequest
-     */
-    providerInput?: ProviderInput | null;
     /**
      * The Redirect URL to which the user should be sent after the session is complete.
      *
@@ -73,6 +67,12 @@ export interface CreateAdvancedProviderSessionRequest {
      * @memberof CreateAdvancedProviderSessionRequest
      */
     fallbackToHostedUI?: boolean | null;
+    /**
+     * Provider-specific input for those providers which require it.
+     * @type {ProviderInput}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    providerInput?: ProviderInput | null;
 }
 /**
  * Check if a given object implements the CreateAdvancedProviderSessionRequest interface.

package/dist/esm/models/CreateAdvancedProviderSessionRequest.js

@@ -32,10 +32,10 @@ export function CreateAdvancedProviderSessionRequestFromJSONTyped(json, ignoreDi
     }
     return {
         'provider': json['provider'],
-        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
         'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
         'capabilities': (json['capabilities'].map(IntegrationCapabilityFromJSON)),
         'fallbackToHostedUI': json['fallbackToHostedUI'] == null ? undefined : json['fallbackToHostedUI'],
+        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
     };
 }
 export function CreateAdvancedProviderSessionRequestToJSON(json) {
@@ -47,9 +47,9 @@ export function CreateAdvancedProviderSessionRequestToJSONTyped(value, ignoreDis
     }
     return {
         'provider': value['provider'],
-        'providerInput': ProviderInputToJSON(value['providerInput']),
         'redirectUrl': value['redirectUrl'],
         'capabilities': (value['capabilities'].map(IntegrationCapabilityToJSON)),
         'fallbackToHostedUI': value['fallbackToHostedUI'],
+        'providerInput': ProviderInputToJSON(value['providerInput']),
     };
 }

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

@@ -30,8 +30,14 @@ export interface CreateHostedProviderSessionRequest {
     redirectUrl: string;
     /**
      * Provider-specific input for those providers which require it.
+     *
+     *
+     * <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation,
+     * and will instead always redirect the user to a hosted interface to collect input. If you need
+     * to collect input from the user yourself, please use the Create Advanced Session endpoint instead.
      * @type {ProviderInput}
      * @memberof CreateHostedProviderSessionRequest
+     * @deprecated
      */
     providerInput?: ProviderInput | null;
 }

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

@@ -18,6 +18,7 @@ export declare const DocumentType: {
     readonly DriversLicense: "DriversLicense";
     readonly NationalId: "NationalId";
     readonly IdCard: "IdCard";
+    readonly Other: "Other";
 };
 export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
 export declare function instanceOfDocumentType(value: any): boolean;

package/dist/esm/models/DocumentType.js

@@ -19,7 +19,8 @@ export const DocumentType = {
     Passport: 'Passport',
     DriversLicense: 'DriversLicense',
     NationalId: 'NationalId',
-    IdCard: 'IdCard'
+    IdCard: 'IdCard',
+    Other: 'Other'
 };
 export function instanceOfDocumentType(value) {
     for (const key in DocumentType) {

package/dist/esm/models/FieldAvailability.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.
+ */
+/**
+ * Indicates when a field will be available in verification results.
+ * @export
+ */
+export declare const FieldAvailability: {
+    readonly Never: "Never";
+    readonly Sometimes: "Sometimes";
+    readonly Always: "Always";
+};
+export type FieldAvailability = typeof FieldAvailability[keyof typeof FieldAvailability];
+export declare function instanceOfFieldAvailability(value: any): boolean;
+export declare function FieldAvailabilityFromJSON(json: any): FieldAvailability;
+export declare function FieldAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldAvailability;
+export declare function FieldAvailabilityToJSON(value?: FieldAvailability | null): any;
+export declare function FieldAvailabilityToJSONTyped(value: any, ignoreDiscriminator: boolean): FieldAvailability;

package/dist/esm/models/FieldAvailability.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ * Indicates when a field will be available in verification results.
+ * @export
+ */
+export const FieldAvailability = {
+    Never: 'Never',
+    Sometimes: 'Sometimes',
+    Always: 'Always'
+};
+export function instanceOfFieldAvailability(value) {
+    for (const key in FieldAvailability) {
+        if (Object.prototype.hasOwnProperty.call(FieldAvailability, key)) {
+            if (FieldAvailability[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function FieldAvailabilityFromJSON(json) {
+    return FieldAvailabilityFromJSONTyped(json, false);
+}
+export function FieldAvailabilityFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FieldAvailabilityToJSON(value) {
+    return value;
+}
+export function FieldAvailabilityToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -16,31 +16,31 @@
  */
 export interface HttpValidationProblemDetails {
     /**
-     *
+     * A URI reference that identifies the problem type.
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
     type?: string | null;
     /**
-     *
+     * A short, human-readable summary of the error.
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
     title?: string | null;
     /**
-     *
+     * The HTTP status code returned for the request.
      * @type {number}
      * @memberof HttpValidationProblemDetails
      */
     status?: number | null;
     /**
-     *
+     * A human-readable explanation specific of the problem.
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
     detail?: string | null;
     /**
-     *
+     * A URI reference that identifies the specific occurrence of the problem.
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */

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

@@ -20,6 +20,7 @@ export declare const IntegrationCapability: {
     readonly RefreshStepContent: "RefreshStepContent";
     readonly CaptureRedirect: "CaptureRedirect";
     readonly PollResult: "PollResult";
+    readonly PollAfterRedirect: "PollAfterRedirect";
 };
 export type IntegrationCapability = typeof IntegrationCapability[keyof typeof IntegrationCapability];
 export declare function instanceOfIntegrationCapability(value: any): boolean;

package/dist/esm/models/IntegrationCapability.js

@@ -21,7 +21,8 @@ export const IntegrationCapability = {
     ShowContent: 'ShowContent',
     RefreshStepContent: 'RefreshStepContent',
     CaptureRedirect: 'CaptureRedirect',
-    PollResult: 'PollResult'
+    PollResult: 'PollResult',
+    PollAfterRedirect: 'PollAfterRedirect'
 };
 export function instanceOfIntegrationCapability(value) {
     for (const key in IntegrationCapability) {

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

@@ -17,31 +17,31 @@
 export interface ProblemDetails {
     [key: string]: any | any;
     /**
-     *
+     * A URI reference that identifies the problem type.
      * @type {string}
      * @memberof ProblemDetails
      */
     type?: string | null;
     /**
-     *
+     * A short, human-readable summary of the error.
      * @type {string}
      * @memberof ProblemDetails
      */
     title?: string | null;
     /**
-     *
+     * The HTTP status code returned for the request.
      * @type {number}
      * @memberof ProblemDetails
      */
     status?: number | null;
     /**
-     *
+     * A human-readable explanation specific of the problem.
      * @type {string}
      * @memberof ProblemDetails
      */
     detail?: string | null;
     /**
-     *
+     * A URI reference that identifies the specific occurrence of the problem.
      * @type {string}
      * @memberof ProblemDetails
      */

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ContractField } from './ContractField';
 import type { ProviderHealth } from './ProviderHealth';
 import type { SubProviderMetadata } from './SubProviderMetadata';
 import type { ResultCollectionMethod } from './ResultCollectionMethod';
@@ -31,12 +32,21 @@ export interface ProviderContract {
      * @memberof ProviderContract
      */
     name: string;
+    /**
+     * The Provider's subtext recommended to be shown next to the name.
+     *
+     * This is flavor text, not a full, human-readable description of the provider.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    subtext: string;
     /**
      * The Provider's description as it appears in Trinsic's Widget.
      *
      * This is flavor text, not a full, human-readable description of the provider.
      * @type {string}
      * @memberof ProviderContract
+     * @deprecated
      */
     description: string;
     /**
@@ -87,7 +97,8 @@ export interface ProviderContract {
      * If `true`, then the results for this Provider may not be available immediately after the user is redirected back
      * to your application. In this case, the `GetSessionResults` API must be called until results are available.
      *
-     * This is an uncommon scenario, and typically only applies to Providers which use a biometric check or traditional document scan.
+     * This is an uncommon scenario, and only applies to Providers which cannot guarantee
+     * the availability of results immediately after the user is redirected back to your application.
      * @type {boolean}
      * @memberof ProviderContract
      */
@@ -129,6 +140,12 @@ export interface ProviderContract {
      * @memberof ProviderContract
      */
     supportsAdvancedProviderSessions: boolean;
+    /**
+     * Information about the fields that this Provider will return in verification results.
+     * @type {Array<ContractField>}
+     * @memberof ProviderContract
+     */
+    availableFields?: Array<ContractField> | null;
     /**
      * Metadata about the sub-providers which are available for this Provider.
      *

package/dist/esm/models/ProviderContract.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ContractFieldFromJSON, ContractFieldToJSON, } from './ContractField';
 import { ProviderHealthFromJSON, ProviderHealthToJSON, } from './ProviderHealth';
 import { SubProviderMetadataFromJSON, SubProviderMetadataToJSON, } from './SubProviderMetadata';
 import { ResultCollectionMethodFromJSON, ResultCollectionMethodToJSON, } from './ResultCollectionMethod';
@@ -23,6 +24,8 @@ export function instanceOfProviderContract(value) {
         return false;
     if (!('name' in value) || value['name'] === undefined)
         return false;
+    if (!('subtext' in value) || value['subtext'] === undefined)
+        return false;
     if (!('description' in value) || value['description'] === undefined)
         return false;
     if (!('logoUrl' in value) || value['logoUrl'] === undefined)
@@ -61,6 +64,7 @@ export function ProviderContractFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'subtext': json['subtext'],
         'description': json['description'],
         'logoUrl': json['logoUrl'],
         'available': json['available'],
@@ -73,6 +77,7 @@ export function ProviderContractFromJSONTyped(json, ignoreDiscriminator) {
         'requiresInput': json['requiresInput'],
         'hasTrinsicInterface': json['hasTrinsicInterface'],
         'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
+        'availableFields': json['availableFields'] == null ? undefined : (json['availableFields'].map(ContractFieldFromJSON)),
         'subProviders': json['subProviders'] == null ? undefined : (json['subProviders'].map(SubProviderMetadataFromJSON)),
         'health': ProviderHealthFromJSON(json['health']),
     };
@@ -87,6 +92,7 @@ export function ProviderContractToJSONTyped(value, ignoreDiscriminator = false)
     return {
         'id': value['id'],
         'name': value['name'],
+        'subtext': value['subtext'],
         'description': value['description'],
         'logoUrl': value['logoUrl'],
         'available': value['available'],
@@ -99,6 +105,7 @@ export function ProviderContractToJSONTyped(value, ignoreDiscriminator = false)
         'requiresInput': value['requiresInput'],
         'hasTrinsicInterface': value['hasTrinsicInterface'],
         'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
+        'availableFields': value['availableFields'] == null ? undefined : (value['availableFields'].map(ContractFieldToJSON)),
         'subProviders': value['subProviders'] == null ? undefined : (value['subProviders'].map(SubProviderMetadataToJSON)),
         'health': ProviderHealthToJSON(value['health']),
     };

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SubProviderMetadata } from './SubProviderMetadata';
 /**
  * A provider that can be specified when creating a `Session`
  * @export
@@ -33,6 +34,37 @@ export interface ProviderInfo {
      * @memberof ProviderInfo
      */
     logoUrl: string;
+    /**
+     * The Provider's subtext recommended to be shown next to the name.
+     *
+     * This is flavor text, not a full, human-readable description of the provider.
+     * @type {string}
+     * @memberof ProviderInfo
+     */
+    subtext: string;
+    /**
+     * The Provider's description recommended to be shown next to the name.
+     *
+     * This is flavor text, not a full, human-readable description of the provider.
+     * @type {string}
+     * @memberof ProviderInfo
+     * @deprecated
+     */
+    description: string;
+    /**
+     * The current health status of the provider
+     * @type {string}
+     * @memberof ProviderInfo
+     */
+    health: string;
+    /**
+     * Metadata about the sub-providers which are available for this Provider.
+     *
+     * For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
+     * @type {Array<SubProviderMetadata>}
+     * @memberof ProviderInfo
+     */
+    subProviders?: Array<SubProviderMetadata> | null;
 }
 /**
  * Check if a given object implements the ProviderInfo interface.

package/dist/esm/models/ProviderInfo.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { SubProviderMetadataFromJSON, SubProviderMetadataToJSON, } from './SubProviderMetadata';
 /**
  * Check if a given object implements the ProviderInfo interface.
  */
@@ -21,6 +22,12 @@ export function instanceOfProviderInfo(value) {
         return false;
     if (!('logoUrl' in value) || value['logoUrl'] === undefined)
         return false;
+    if (!('subtext' in value) || value['subtext'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('health' in value) || value['health'] === undefined)
+        return false;
     return true;
 }
 export function ProviderInfoFromJSON(json) {
@@ -34,6 +41,10 @@ export function ProviderInfoFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'logoUrl': json['logoUrl'],
+        'subtext': json['subtext'],
+        'description': json['description'],
+        'health': json['health'],
+        'subProviders': json['subProviders'] == null ? undefined : (json['subProviders'].map(SubProviderMetadataFromJSON)),
     };
 }
 export function ProviderInfoToJSON(json) {
@@ -47,5 +58,9 @@ export function ProviderInfoToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'name': value['name'],
         'logoUrl': value['logoUrl'],
+        'subtext': value['subtext'],
+        'description': value['description'],
+        'health': value['health'],
+        'subProviders': value['subProviders'] == null ? undefined : (value['subProviders'].map(SubProviderMetadataToJSON)),
     };
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SubProviderMetadata } from './SubProviderMetadata';
 /**
  *
  * @export
@@ -16,23 +17,66 @@
  */
 export interface ProviderInformation {
     /**
-     *
+     * The ID of the provider
      * @type {string}
      * @memberof ProviderInformation
      */
-    readonly providerId: string;
+    id: string;
     /**
-     *
+     * The friendly, human-readable name of the provider
      * @type {string}
      * @memberof ProviderInformation
      */
-    readonly providerDisplayName: string;
+    name: string;
     /**
+     * A URL pointing to the provider's logo
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    logoUrl: string;
+    /**
+     * The Provider's subtext recommended to be shown next to the name.
      *
+     * This is flavor text, not a full, human-readable description of the provider.
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    subtext: string;
+    /**
+     * The ID of the provider
+     * @type {string}
+     * @memberof ProviderInformation
+     * @deprecated
+     */
+    providerId: string;
+    /**
+     * The friendly, human-readable name of the provider
      * @type {string}
      * @memberof ProviderInformation
+     * @deprecated
+     */
+    providerDisplayName: string;
+    /**
+     * A URL pointing to the provider's logo
+     * @type {string}
+     * @memberof ProviderInformation
+     * @deprecated
+     */
+    providerLogo: string;
+    /**
+     * The current health status of the provider
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    health: string;
+    /**
+     * Metadata about the sub-providers which are available for this Provider.
+     *
+     * For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
+     * @type {Array<SubProviderMetadata>}
+     * @memberof ProviderInformation
      */
-    readonly providerLogo: string;
+    subProviders?: Array<SubProviderMetadata> | null;
 }
 /**
  * Check if a given object implements the ProviderInformation interface.
@@ -41,4 +85,4 @@ export declare function instanceOfProviderInformation(value: object): value is P
 export declare function ProviderInformationFromJSON(json: any): ProviderInformation;
 export declare function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInformation;
 export declare function ProviderInformationToJSON(json: any): ProviderInformation;
-export declare function ProviderInformationToJSONTyped(value?: Omit<ProviderInformation, 'providerId' | 'providerDisplayName' | 'providerLogo'> | null, ignoreDiscriminator?: boolean): any;
+export declare function ProviderInformationToJSONTyped(value?: ProviderInformation | null, ignoreDiscriminator?: boolean): any;