@trinsic/api 2.0.0-alpha3 → 2.0.0

package/src/models/ListProviderContractsResponse.ts

@@ -0,0 +1,68 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ProviderContract } from './ProviderContract';
+import {
+    ProviderContractFromJSON,
+    ProviderContractFromJSONTyped,
+    ProviderContractToJSON,
+} from './ProviderContract';
+
+/**
+ * 
+ * @export
+ * @interface ListProviderContractsResponse
+ */
+export interface ListProviderContractsResponse {
+    /**
+     * Contracts for all Providers available to your App, filtered by your App's current test mode setting.
+     * @type {Array<ProviderContract>}
+     * @memberof ListProviderContractsResponse
+     */
+    providerContracts: Array<ProviderContract>;
+}
+
+/**
+ * Check if a given object implements the ListProviderContractsResponse interface.
+ */
+export function instanceOfListProviderContractsResponse(value: object): value is ListProviderContractsResponse {
+    if (!('providerContracts' in value) || value['providerContracts'] === undefined) return false;
+    return true;
+}
+
+export function ListProviderContractsResponseFromJSON(json: any): ListProviderContractsResponse {
+    return ListProviderContractsResponseFromJSONTyped(json, false);
+}
+
+export function ListProviderContractsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListProviderContractsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'providerContracts': ((json['providerContracts'] as Array<any>).map(ProviderContractFromJSON)),
+    };
+}
+
+export function ListProviderContractsResponseToJSON(value?: ListProviderContractsResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'providerContracts': ((value['providerContracts'] as Array<any>).map(ProviderContractToJSON)),
+    };
+}
+

package/src/models/MobileIdInput.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 { Language } from './Language';
+import {
+    LanguageFromJSON,
+    LanguageFromJSONTyped,
+    LanguageToJSON,
+} from './Language';
+
+/**
+ * 
+ * @export
+ * @interface MobileIdInput
+ */
+export interface MobileIdInput {
+    /**
+     * The user's phone number in E.164 format
+     * @type {string}
+     * @memberof MobileIdInput
+     */
+    mobileIdPhoneNumber?: string | null;
+    /**
+     * The user's National ID number
+     * @type {string}
+     * @memberof MobileIdInput
+     */
+    mobileIdNationalIdentityNumber?: string | null;
+    /**
+     * The user's language -- LIT, EST, ENG, or RUS
+     * @type {Language}
+     * @memberof MobileIdInput
+     */
+    mobileIdLanguage?: Language | null;
+}
+
+
+
+/**
+ * Check if a given object implements the MobileIdInput interface.
+ */
+export function instanceOfMobileIdInput(value: object): value is MobileIdInput {
+    return true;
+}
+
+export function MobileIdInputFromJSON(json: any): MobileIdInput {
+    return MobileIdInputFromJSONTyped(json, false);
+}
+
+export function MobileIdInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): MobileIdInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'mobileIdPhoneNumber': json['mobileIdPhoneNumber'] == null ? undefined : json['mobileIdPhoneNumber'],
+        'mobileIdNationalIdentityNumber': json['mobileIdNationalIdentityNumber'] == null ? undefined : json['mobileIdNationalIdentityNumber'],
+        'mobileIdLanguage': json['mobileIdLanguage'] == null ? undefined : LanguageFromJSON(json['mobileIdLanguage']),
+    };
+}
+
+export function MobileIdInputToJSON(value?: MobileIdInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'mobileIdPhoneNumber': value['mobileIdPhoneNumber'],
+        'mobileIdNationalIdentityNumber': value['mobileIdNationalIdentityNumber'],
+        'mobileIdLanguage': LanguageToJSON(value['mobileIdLanguage']),
+    };
+}
+

package/src/models/ProviderContract.ts

@@ -0,0 +1,235 @@
+/* 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 { SubProviderMetadata } from './SubProviderMetadata';
+import {
+    SubProviderMetadataFromJSON,
+    SubProviderMetadataFromJSONTyped,
+    SubProviderMetadataToJSON,
+} from './SubProviderMetadata';
+import type { ResultCollectionMethod } from './ResultCollectionMethod';
+import {
+    ResultCollectionMethodFromJSON,
+    ResultCollectionMethodFromJSONTyped,
+    ResultCollectionMethodToJSON,
+} from './ResultCollectionMethod';
+import type { IntegrationLaunchMethod } from './IntegrationLaunchMethod';
+import {
+    IntegrationLaunchMethodFromJSON,
+    IntegrationLaunchMethodFromJSONTyped,
+    IntegrationLaunchMethodToJSON,
+} from './IntegrationLaunchMethod';
+
+/**
+ * 
+ * @export
+ * @interface ProviderContract
+ */
+export interface ProviderContract {
+    /**
+     * The ID of the Provider for this contract.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    id: string;
+    /**
+     * The Provider's Name as it appears in Trinsic's Dashboard and Widget
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    name: 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
+     */
+    description: string;
+    /**
+     * A URL pointing to the Provider's logo on Trinsic's CDN.
+     *             
+     * May be a PNG, JPG, or SVG image.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    logoUrl: string;
+    /**
+     * Whether the Provider is available for use in your App.
+     *             
+     * If `false`, you will need to contact Trinsic to enable this Provider for your App.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    available: boolean;
+    /**
+     * The geographies within the Regions the Provider is available.
+     * @type {Array<string>}
+     * @memberof ProviderContract
+     */
+    geography: Array<string>;
+    /**
+     * The regions within which the Provider is available.
+     * @type {Array<string>}
+     * @memberof ProviderContract
+     */
+    regions: Array<string>;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *             
+     * The `LaunchMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
+     * @type {IntegrationLaunchMethod}
+     * @memberof ProviderContract
+     */
+    launchMethod: IntegrationLaunchMethod;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *             
+     * The `CollectionMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
+     * @type {ResultCollectionMethod}
+     * @memberof ProviderContract
+     */
+    collectionMethod: ResultCollectionMethod;
+    /**
+     * 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.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    resultsMayBeDelayedAfterRedirect: boolean;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *             
+     * Whether the Provider requires the `RefreshStepContent` capability.
+     *             
+     * For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a
+     * resilient user flow.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    hasRefreshableContent: boolean;
+    /**
+     * Relevant to Hosted Provider Sessions and Advanced Provider Sessions.
+     *             
+     * If `true`, this Provider requires provider-specific input on Session creation.
+     * If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    requiresInput: boolean;
+    /**
+     * Whether there exists a Trinsic-hosted UI for this Provider.
+     *             
+     * This is `true` for any Provider which is not a simple, OIDC-like redirect flow.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    hasTrinsicInterface: boolean;
+    /**
+     * Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API.
+     *             
+     * If `false`, the Provider may still be launched through Advanced Provider Sessions;
+     * however, it will necessarily require a Trinsic-hosted UI to function.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    supportsAdvancedProviderSessions: boolean;
+    /**
+     * 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 ProviderContract
+     */
+    subProviders?: Array<SubProviderMetadata> | null;
+}
+
+
+
+/**
+ * Check if a given object implements the ProviderContract interface.
+ */
+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 (!('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;
+    if (!('geography' in value) || value['geography'] === undefined) return false;
+    if (!('regions' in value) || value['regions'] === undefined) return false;
+    if (!('launchMethod' in value) || value['launchMethod'] === undefined) return false;
+    if (!('collectionMethod' in value) || value['collectionMethod'] === undefined) return false;
+    if (!('resultsMayBeDelayedAfterRedirect' in value) || value['resultsMayBeDelayedAfterRedirect'] === undefined) return false;
+    if (!('hasRefreshableContent' in value) || value['hasRefreshableContent'] === undefined) return false;
+    if (!('requiresInput' in value) || value['requiresInput'] === undefined) return false;
+    if (!('hasTrinsicInterface' in value) || value['hasTrinsicInterface'] === undefined) return false;
+    if (!('supportsAdvancedProviderSessions' in value) || value['supportsAdvancedProviderSessions'] === undefined) return false;
+    return true;
+}
+
+export function ProviderContractFromJSON(json: any): ProviderContract {
+    return ProviderContractFromJSONTyped(json, false);
+}
+
+export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderContract {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+        'available': json['available'],
+        'geography': json['geography'],
+        'regions': json['regions'],
+        'launchMethod': IntegrationLaunchMethodFromJSON(json['launchMethod']),
+        'collectionMethod': ResultCollectionMethodFromJSON(json['collectionMethod']),
+        'resultsMayBeDelayedAfterRedirect': json['resultsMayBeDelayedAfterRedirect'],
+        'hasRefreshableContent': json['hasRefreshableContent'],
+        'requiresInput': json['requiresInput'],
+        'hasTrinsicInterface': json['hasTrinsicInterface'],
+        'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
+        'subProviders': json['subProviders'] == null ? undefined : ((json['subProviders'] as Array<any>).map(SubProviderMetadataFromJSON)),
+    };
+}
+
+export function ProviderContractToJSON(value?: ProviderContract | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'logoUrl': value['logoUrl'],
+        'available': value['available'],
+        'geography': value['geography'],
+        'regions': value['regions'],
+        'launchMethod': IntegrationLaunchMethodToJSON(value['launchMethod']),
+        'collectionMethod': ResultCollectionMethodToJSON(value['collectionMethod']),
+        'resultsMayBeDelayedAfterRedirect': value['resultsMayBeDelayedAfterRedirect'],
+        'hasRefreshableContent': value['hasRefreshableContent'],
+        'requiresInput': value['requiresInput'],
+        'hasTrinsicInterface': value['hasTrinsicInterface'],
+        'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
+        'subProviders': value['subProviders'] == null ? undefined : ((value['subProviders'] as Array<any>).map(SubProviderMetadataToJSON)),
+    };
+}
+

package/src/models/ProviderInfo.ts

@@ -37,12 +37,6 @@ export interface ProviderInfo {
      * @memberof ProviderInfo
      */
     logoUrl: string;
-    /**
-     * List of child provider id's where the provider allows deep-launching of a specific provider.
-     * @type {Array<string>}
-     * @memberof ProviderInfo
-     */
-    childProviderIds?: Array<string> | null;
 }
 
 /**
@@ -68,7 +62,6 @@ export function ProviderInfoFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'id': json['id'],
         'name': json['name'],
         'logoUrl': json['logoUrl'],
-        'childProviderIds': json['childProviderIds'] == null ? undefined : json['childProviderIds'],
     };
 }
 
@@ -81,7 +74,6 @@ export function ProviderInfoToJSON(value?: ProviderInfo | null): any {
         'id': value['id'],
         'name': value['name'],
         'logoUrl': value['logoUrl'],
-        'childProviderIds': value['childProviderIds'],
     };
 }
 

package/src/models/ProviderInformation.ts

@@ -24,19 +24,19 @@ export interface ProviderInformation {
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerId: string;
+    readonly providerId: string;
     /**
      * 
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerDisplayName: string;
+    readonly providerDisplayName: string;
     /**
      * 
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerLogo: string;
+    readonly providerLogo: string;
 }
 
 /**
@@ -65,15 +65,12 @@ export function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator:
     };
 }
 
-export function ProviderInformationToJSON(value?: ProviderInformation | null): any {
+export function ProviderInformationToJSON(value?: Omit<ProviderInformation, 'providerId'|'providerDisplayName'|'providerLogo'> | null): any {
     if (value == null) {
         return value;
     }
     return {
         
-        'providerId': value['providerId'],
-        'providerDisplayName': value['providerDisplayName'],
-        'providerLogo': value['providerLogo'],
     };
 }