@trinsic/api 2.0.2 → 2.1.0-alpha1

package/src/models/BrazilDigitalCnhInput.ts

@@ -27,12 +27,6 @@ export interface BrazilDigitalCnhInput {
     cpfNumber: string;
     /**
      * The raw bytes of the digital CNH file collected from the user.
-     *             
-     * TODO: Lucas or JP help me describe these below vvvvvvvv
-     * This can be:
-     * - An image containing a physical or digital QR code
-     * - A PDF file exported from the CNH app
-     * - Some scary third thing?
      * @type {string}
      * @memberof BrazilDigitalCnhInput
      */

package/src/models/ContractField.ts

@@ -0,0 +1,85 @@
+/* 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 { FieldAvailability } from './FieldAvailability';
+import {
+    FieldAvailabilityFromJSON,
+    FieldAvailabilityFromJSONTyped,
+    FieldAvailabilityToJSON,
+    FieldAvailabilityToJSONTyped,
+} 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 function instanceOfContractField(value: object): value is ContractField {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('outputted' in value) || value['outputted'] === undefined) return false;
+    return true;
+}
+
+export function ContractFieldFromJSON(json: any): ContractField {
+    return ContractFieldFromJSONTyped(json, false);
+}
+
+export function ContractFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractField {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'outputted': FieldAvailabilityFromJSON(json['outputted']),
+    };
+}
+
+export function ContractFieldToJSON(json: any): ContractField {
+    return ContractFieldToJSONTyped(json, false);
+}
+
+export function ContractFieldToJSONTyped(value?: ContractField | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'outputted': FieldAvailabilityToJSON(value['outputted']),
+    };
+}
+

package/src/models/CreateAdvancedProviderSessionRequest.ts

@@ -40,12 +40,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.
      *             
@@ -90,6 +84,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;
 }
 
 /**
@@ -112,10 +112,10 @@ export function CreateAdvancedProviderSessionRequestFromJSONTyped(json: any, ign
     return {
         
         'provider': json['provider'],
-        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
         'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
         'capabilities': ((json['capabilities'] as Array<any>).map(IntegrationCapabilityFromJSON)),
         'fallbackToHostedUI': json['fallbackToHostedUI'] == null ? undefined : json['fallbackToHostedUI'],
+        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
     };
 }
 
@@ -131,10 +131,10 @@ export function CreateAdvancedProviderSessionRequestToJSONTyped(value?: CreateAd
     return {
         
         'provider': value['provider'],
-        'providerInput': ProviderInputToJSON(value['providerInput']),
         'redirectUrl': value['redirectUrl'],
         'capabilities': ((value['capabilities'] as Array<any>).map(IntegrationCapabilityToJSON)),
         'fallbackToHostedUI': value['fallbackToHostedUI'],
+        'providerInput': ProviderInputToJSON(value['providerInput']),
     };
 }
 

package/src/models/CreateHostedProviderSessionRequest.ts

@@ -41,8 +41,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/src/models/DocumentType.ts

@@ -21,7 +21,8 @@ export const DocumentType = {
     Passport: 'Passport',
     DriversLicense: 'DriversLicense',
     NationalId: 'NationalId',
-    IdCard: 'IdCard'
+    IdCard: 'IdCard',
+    Other: 'Other'
 } as const;
 export type DocumentType = typeof DocumentType[keyof typeof DocumentType];
 

package/src/models/FieldAvailability.ts

@@ -0,0 +1,54 @@
+/* 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'
+} as const;
+export type FieldAvailability = typeof FieldAvailability[keyof typeof FieldAvailability];
+
+
+export function instanceOfFieldAvailability(value: any): boolean {
+    for (const key in FieldAvailability) {
+        if (Object.prototype.hasOwnProperty.call(FieldAvailability, key)) {
+            if (FieldAvailability[key as keyof typeof FieldAvailability] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function FieldAvailabilityFromJSON(json: any): FieldAvailability {
+    return FieldAvailabilityFromJSONTyped(json, false);
+}
+
+export function FieldAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldAvailability {
+    return json as FieldAvailability;
+}
+
+export function FieldAvailabilityToJSON(value?: FieldAvailability | null): any {
+    return value as any;
+}
+
+export function FieldAvailabilityToJSONTyped(value: any, ignoreDiscriminator: boolean): FieldAvailability {
+    return value as FieldAvailability;
+}
+

package/src/models/HttpValidationProblemDetails.ts

@@ -20,31 +20,31 @@ import { mapValues } from '../runtime';
  */
 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/src/models/IntegrationCapability.ts

@@ -23,7 +23,8 @@ export const IntegrationCapability = {
     ShowContent: 'ShowContent',
     RefreshStepContent: 'RefreshStepContent',
     CaptureRedirect: 'CaptureRedirect',
-    PollResult: 'PollResult'
+    PollResult: 'PollResult',
+    PollAfterRedirect: 'PollAfterRedirect'
 } as const;
 export type IntegrationCapability = typeof IntegrationCapability[keyof typeof IntegrationCapability];
 

package/src/models/ProblemDetails.ts

@@ -21,31 +21,31 @@ import { mapValues } from '../runtime';
 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/src/models/ProviderContract.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContractField } from './ContractField';
+import {
+    ContractFieldFromJSON,
+    ContractFieldFromJSONTyped,
+    ContractFieldToJSON,
+    ContractFieldToJSONTyped,
+} from './ContractField';
 import type { ProviderHealth } from './ProviderHealth';
 import {
     ProviderHealthFromJSON,
@@ -60,12 +67,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;
     /**
@@ -116,7 +132,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
      */
@@ -158,6 +175,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.
      *             
@@ -182,6 +205,7 @@ export interface ProviderContract {
 export function instanceOfProviderContract(value: object): value is ProviderContract {
     if (!('id' in value) || value['id'] === undefined) 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) return false;
     if (!('available' in value) || value['available'] === undefined) return false;
@@ -210,6 +234,7 @@ export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'id': json['id'],
         'name': json['name'],
+        'subtext': json['subtext'],
         'description': json['description'],
         'logoUrl': json['logoUrl'],
         'available': json['available'],
@@ -222,6 +247,7 @@ export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: bo
         'requiresInput': json['requiresInput'],
         'hasTrinsicInterface': json['hasTrinsicInterface'],
         'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
+        'availableFields': json['availableFields'] == null ? undefined : ((json['availableFields'] as Array<any>).map(ContractFieldFromJSON)),
         'subProviders': json['subProviders'] == null ? undefined : ((json['subProviders'] as Array<any>).map(SubProviderMetadataFromJSON)),
         'health': ProviderHealthFromJSON(json['health']),
     };
@@ -240,6 +266,7 @@ export function ProviderContractToJSONTyped(value?: ProviderContract | null, ign
         
         'id': value['id'],
         'name': value['name'],
+        'subtext': value['subtext'],
         'description': value['description'],
         'logoUrl': value['logoUrl'],
         'available': value['available'],
@@ -252,6 +279,7 @@ export function ProviderContractToJSONTyped(value?: ProviderContract | null, ign
         'requiresInput': value['requiresInput'],
         'hasTrinsicInterface': value['hasTrinsicInterface'],
         'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
+        'availableFields': value['availableFields'] == null ? undefined : ((value['availableFields'] as Array<any>).map(ContractFieldToJSON)),
         'subProviders': value['subProviders'] == null ? undefined : ((value['subProviders'] as Array<any>).map(SubProviderMetadataToJSON)),
         'health': ProviderHealthToJSON(value['health']),
     };

package/src/models/ProviderInfo.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { SubProviderMetadata } from './SubProviderMetadata';
+import {
+    SubProviderMetadataFromJSON,
+    SubProviderMetadataFromJSONTyped,
+    SubProviderMetadataToJSON,
+    SubProviderMetadataToJSONTyped,
+} from './SubProviderMetadata';
+
 /**
  * A provider that can be specified when creating a `Session`
  * @export
@@ -37,6 +45,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;
 }
 
 /**
@@ -46,6 +85,9 @@ export function instanceOfProviderInfo(value: object): value is ProviderInfo {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) 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;
 }
 
@@ -62,6 +104,10 @@ export function ProviderInfoFromJSONTyped(json: any, ignoreDiscriminator: boolea
         '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'] as Array<any>).map(SubProviderMetadataFromJSON)),
     };
 }
 
@@ -79,6 +125,10 @@ export function ProviderInfoToJSONTyped(value?: ProviderInfo | null, ignoreDiscr
         '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'] as Array<any>).map(SubProviderMetadataToJSON)),
     };
 }
 

package/src/models/ProviderInformation.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { SubProviderMetadata } from './SubProviderMetadata';
+import {
+    SubProviderMetadataFromJSON,
+    SubProviderMetadataFromJSONTyped,
+    SubProviderMetadataToJSON,
+    SubProviderMetadataToJSONTyped,
+} from './SubProviderMetadata';
+
 /**
  * 
  * @export
@@ -20,32 +28,80 @@ import { mapValues } from '../runtime';
  */
 export interface ProviderInformation {
     /**
-     * 
+     * The ID of the provider
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    id: string;
+    /**
+     * The friendly, human-readable name of the provider
+     * @type {string}
+     * @memberof ProviderInformation
+     */
+    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
      */
-    readonly providerId: string;
+    providerDisplayName: string;
     /**
-     * 
+     * A URL pointing to the provider's logo
      * @type {string}
      * @memberof ProviderInformation
+     * @deprecated
      */
-    readonly providerDisplayName: string;
+    providerLogo: string;
     /**
-     * 
+     * The current health status of the provider
      * @type {string}
      * @memberof ProviderInformation
      */
-    readonly providerLogo: string;
+    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
+     */
+    subProviders?: Array<SubProviderMetadata> | null;
 }
 
 /**
  * Check if a given object implements the ProviderInformation interface.
  */
 export function instanceOfProviderInformation(value: object): value is ProviderInformation {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined) return false;
+    if (!('subtext' in value) || value['subtext'] === undefined) return false;
     if (!('providerId' in value) || value['providerId'] === undefined) return false;
     if (!('providerDisplayName' in value) || value['providerDisplayName'] === undefined) return false;
     if (!('providerLogo' in value) || value['providerLogo'] === undefined) return false;
+    if (!('health' in value) || value['health'] === undefined) return false;
     return true;
 }
 
@@ -59,9 +115,15 @@ export function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator:
     }
     return {
         
+        'id': json['id'],
+        'name': json['name'],
+        'logoUrl': json['logoUrl'],
+        'subtext': json['subtext'],
         'providerId': json['providerId'],
         'providerDisplayName': json['providerDisplayName'],
         'providerLogo': json['providerLogo'],
+        'health': json['health'],
+        'subProviders': json['subProviders'] == null ? undefined : ((json['subProviders'] as Array<any>).map(SubProviderMetadataFromJSON)),
     };
 }
 
@@ -69,13 +131,22 @@ export function ProviderInformationToJSON(json: any): ProviderInformation {
     return ProviderInformationToJSONTyped(json, false);
 }
 
-export function ProviderInformationToJSONTyped(value?: Omit<ProviderInformation, 'providerId'|'providerDisplayName'|'providerLogo'> | null, ignoreDiscriminator: boolean = false): any {
+export function ProviderInformationToJSONTyped(value?: ProviderInformation | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
+        'id': value['id'],
+        'name': value['name'],
+        'logoUrl': value['logoUrl'],
+        'subtext': value['subtext'],
+        'providerId': value['providerId'],
+        'providerDisplayName': value['providerDisplayName'],
+        'providerLogo': value['providerLogo'],
+        'health': value['health'],
+        'subProviders': value['subProviders'] == null ? undefined : ((value['subProviders'] as Array<any>).map(SubProviderMetadataToJSON)),
     };
 }