@trinsic/api 2.0.0-alpha2 → 2.0.0

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

@@ -0,0 +1,67 @@
+/**
+ * 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
+ * @interface NigeriaNinInput
+ */
+export interface NigeriaNinInput {
+    /**
+     * The user's first name as it appears in their National ID
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    firstName: string;
+    /**
+     * The user's middle name as it appears in their National ID (optional)
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    middleName?: string | null;
+    /**
+     * The user's last name as it appears in their National ID (optional)
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    lastName: string;
+    /**
+     * The user's phone number (optional)
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    phoneNumber?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof NigeriaNinInput
+     */
+    dateOfBirth: Date;
+    /**
+     * The user's gender as it appears in their National ID (e.g., male, female)
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    gender?: string | null;
+    /**
+     * The user's South African National ID number
+     * @type {string}
+     * @memberof NigeriaNinInput
+     */
+    nationalIdNumber: string;
+}
+/**
+ * Check if a given object implements the NigeriaNinInput interface.
+ */
+export declare function instanceOfNigeriaNinInput(value: object): value is NigeriaNinInput;
+export declare function NigeriaNinInputFromJSON(json: any): NigeriaNinInput;
+export declare function NigeriaNinInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): NigeriaNinInput;
+export declare function NigeriaNinInputToJSON(value?: NigeriaNinInput | null): any;

package/dist/esm/models/NigeriaNinInput.js

@@ -0,0 +1,58 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the NigeriaNinInput interface.
+ */
+export function instanceOfNigeriaNinInput(value) {
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined)
+        return false;
+    if (!('nationalIdNumber' in value) || value['nationalIdNumber'] === undefined)
+        return false;
+    return true;
+}
+export function NigeriaNinInputFromJSON(json) {
+    return NigeriaNinInputFromJSONTyped(json, false);
+}
+export function NigeriaNinInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['firstName'],
+        'middleName': json['middleName'] == null ? undefined : json['middleName'],
+        'lastName': json['lastName'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationalIdNumber': json['nationalIdNumber'],
+    };
+}
+export function NigeriaNinInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'firstName': value['firstName'],
+        'middleName': value['middleName'],
+        'lastName': value['lastName'],
+        'phoneNumber': value['phoneNumber'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'gender': value['gender'],
+        'nationalIdNumber': value['nationalIdNumber'],
+    };
+}

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

@@ -22,61 +22,61 @@ export interface PersonData {
      * @type {string}
      * @memberof PersonData
      */
-    givenName?: string;
+    givenName?: string | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    familyName?: string;
+    familyName?: string | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    middleName?: string;
+    middleName?: string | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    fullName?: string;
+    fullName?: string | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    suffix?: string;
+    suffix?: string | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    nationality?: string;
+    nationality?: string | null;
     /**
      *
      * @type {Sex}
      * @memberof PersonData
      */
-    sex?: Sex;
+    sex?: Sex | null;
     /**
      *
      * @type {string}
      * @memberof PersonData
      */
-    phoneNumber?: string;
+    phoneNumber?: string | null;
     /**
      *
      * @type {Address}
      * @memberof PersonData
      */
-    address?: Address;
+    address?: Address | null;
     /**
      *
      * @type {Date}
      * @memberof PersonData
      */
-    dateOfBirth?: Date;
+    dateOfBirth?: Date | null;
 }
 /**
  * Check if a given object implements the PersonData interface.

package/dist/esm/models/PersonData.js

@@ -53,6 +53,6 @@ export function PersonDataToJSON(value) {
         'sex': SexToJSON(value['sex']),
         'phoneNumber': value['phoneNumber'],
         'address': AddressToJSON(value['address']),
-        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
     };
 }

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

@@ -20,31 +20,31 @@ export interface PhilippineMatchInput {
      * @type {string}
      * @memberof PhilippineMatchInput
      */
-    givenName?: string;
+    givenName?: string | null;
     /**
      * The user's middle name
      * @type {string}
      * @memberof PhilippineMatchInput
      */
-    middleName?: string;
+    middleName?: string | null;
     /**
      * The user's family / last name
      * @type {string}
      * @memberof PhilippineMatchInput
      */
-    familyName?: string;
+    familyName?: string | null;
     /**
      * The user's name suffix
      * @type {string}
      * @memberof PhilippineMatchInput
      */
-    suffix?: string;
+    suffix?: string | null;
     /**
      * The user's date of birth, in `YYYY-MM-DD` format
      * @type {Date}
      * @memberof PhilippineMatchInput
      */
-    dateOfBirth?: Date;
+    dateOfBirth?: Date | null;
 }
 /**
  * Check if a given object implements the PhilippineMatchInput interface.

package/dist/esm/models/PhilippineMatchInput.js

@@ -41,6 +41,6 @@ export function PhilippineMatchInputToJSON(value) {
         'middleName': value['middleName'],
         'familyName': value['familyName'],
         'suffix': value['suffix'],
-        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
     };
 }

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

@@ -20,13 +20,13 @@ export interface PhilippineQRInput {
      * @type {string}
      * @memberof PhilippineQRInput
      */
-    qrCodeText?: string;
+    qrCodeText?: string | null;
     /**
      * The raw bytes of the image containing the user's QR code.
      * @type {string}
      * @memberof PhilippineQRInput
      */
-    qrCodeImage?: string;
+    qrCodeImage?: string | null;
 }
 /**
  * Check if a given object implements the PhilippineQRInput interface.

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

@@ -21,31 +21,31 @@ export interface ProblemDetails {
      * @type {string}
      * @memberof ProblemDetails
      */
-    type?: string;
+    type?: string | null;
     /**
      *
      * @type {string}
      * @memberof ProblemDetails
      */
-    title?: string;
+    title?: string | null;
     /**
      *
      * @type {number}
      * @memberof ProblemDetails
      */
-    status?: number;
+    status?: number | null;
     /**
      *
      * @type {string}
      * @memberof ProblemDetails
      */
-    detail?: string;
+    detail?: string | null;
     /**
      *
      * @type {string}
      * @memberof ProblemDetails
      */
-    instance?: string;
+    instance?: string | null;
 }
 /**
  * Check if a given object implements the ProblemDetails interface.

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

@@ -21,7 +21,7 @@ export interface ProviderAttachments {
      * @type {DocumentScanAttachments}
      * @memberof ProviderAttachments
      */
-    documentScan?: DocumentScanAttachments;
+    documentScan?: DocumentScanAttachments | null;
 }
 /**
  * Check if a given object implements the ProviderAttachments interface.

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

@@ -0,0 +1,146 @@
+/**
+ * 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 { SubProviderMetadata } from './SubProviderMetadata';
+import type { ResultCollectionMethod } from './ResultCollectionMethod';
+import type { IntegrationLaunchMethod } 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 declare function instanceOfProviderContract(value: object): value is ProviderContract;
+export declare function ProviderContractFromJSON(json: any): ProviderContract;
+export declare function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderContract;
+export declare function ProviderContractToJSON(value?: ProviderContract | null): any;

package/dist/esm/models/ProviderContract.js

@@ -0,0 +1,97 @@
+/* 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 { SubProviderMetadataFromJSON, SubProviderMetadataToJSON, } from './SubProviderMetadata';
+import { ResultCollectionMethodFromJSON, ResultCollectionMethodToJSON, } from './ResultCollectionMethod';
+import { IntegrationLaunchMethodFromJSON, IntegrationLaunchMethodToJSON, } from './IntegrationLaunchMethod';
+/**
+ * Check if a given object implements the ProviderContract interface.
+ */
+export function instanceOfProviderContract(value) {
+    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) {
+    return ProviderContractFromJSONTyped(json, false);
+}
+export function ProviderContractFromJSONTyped(json, ignoreDiscriminator) {
+    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'].map(SubProviderMetadataFromJSON)),
+    };
+}
+export function ProviderContractToJSON(value) {
+    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'].map(SubProviderMetadataToJSON)),
+    };
+}

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

@@ -33,12 +33,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>;
 }
 /**
  * Check if a given object implements the ProviderInfo interface.

package/dist/esm/models/ProviderInfo.js

@@ -34,7 +34,6 @@ export function ProviderInfoFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'logoUrl': json['logoUrl'],
-        'childProviderIds': json['childProviderIds'] == null ? undefined : json['childProviderIds'],
     };
 }
 export function ProviderInfoToJSON(value) {
@@ -45,6 +44,5 @@ export function ProviderInfoToJSON(value) {
         'id': value['id'],
         'name': value['name'],
         'logoUrl': value['logoUrl'],
-        'childProviderIds': value['childProviderIds'],
     };
 }

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

@@ -20,19 +20,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;
 }
 /**
  * Check if a given object implements the ProviderInformation interface.
@@ -40,4 +40,4 @@ export interface ProviderInformation {
 export declare function instanceOfProviderInformation(value: object): value is ProviderInformation;
 export declare function ProviderInformationFromJSON(json: any): ProviderInformation;
 export declare function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInformation;
-export declare function ProviderInformationToJSON(value?: ProviderInformation | null): any;
+export declare function ProviderInformationToJSON(value?: Omit<ProviderInformation, 'providerId' | 'providerDisplayName' | 'providerLogo'> | null): any;

package/dist/esm/models/ProviderInformation.js

@@ -40,9 +40,5 @@ export function ProviderInformationToJSON(value) {
     if (value == null) {
         return value;
     }
-    return {
-        'providerId': value['providerId'],
-        'providerDisplayName': value['providerDisplayName'],
-        'providerLogo': value['providerLogo'],
-    };
+    return {};
 }