@trinsic/api 2.3.0-alpha2 → 3.0.0

package/src/models/PostOfficeEasyIdProviderOutput.ts

@@ -0,0 +1,180 @@
+/* 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 { YotiStructuredPostalAddress } from './YotiStructuredPostalAddress';
+import {
+    YotiStructuredPostalAddressFromJSON,
+    YotiStructuredPostalAddressFromJSONTyped,
+    YotiStructuredPostalAddressToJSON,
+    YotiStructuredPostalAddressToJSONTyped,
+} from './YotiStructuredPostalAddress';
+import type { YotiDocumentDetails } from './YotiDocumentDetails';
+import {
+    YotiDocumentDetailsFromJSON,
+    YotiDocumentDetailsFromJSONTyped,
+    YotiDocumentDetailsToJSON,
+    YotiDocumentDetailsToJSONTyped,
+} from './YotiDocumentDetails';
+
+/**
+ * Exposed properties for the `post-office-easyid` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface PostOfficeEasyIdProviderOutput
+ */
+export interface PostOfficeEasyIdProviderOutput {
+    /**
+     * The unique id for your service of the individual. This is not shared between different services so if the user logs into a different service, the user will have a new id for the other service.
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    rememberMeId?: string | null;
+    /**
+     * The email address of the individual
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The given name of the individual. This can correspond to first and middle names in English.
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    familyName?: string | null;
+    /**
+     * Full name of the individual which is composed of the given and family name.
+     * Unverified full name may be safe to use. For example, Aadhaar card provides full name, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    fullName?: string | null;
+    /**
+     * The date of birth of the individual.
+     * Unverified date of birth may be safe to use. For example, Aadhaar card provides date of birth, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {Date}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The gender of the individual. Depending on the source or country, gender may not be verified. This is a setting that can be configured while setting up scopes.
+     *             
+     * Unverified gender may be safe to use. For example, Aadhaar card provides gender, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * In some countries
+     * Possible values:
+     * - "MALE"
+     * - "FEMALE"
+     * - "TRANSGENDER"
+     * - "OTHER"
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The nationality of the individual as a ISO alpha-3 code
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    nationality?: string | null;
+    /**
+     * The mobile phone number of the individual. This number was verified with a one time password (OTP) during the user's registration with Yoti. In some cases, Yoti may do additional checks against its sources to confirm the user's identity.
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    mobileNumber?: string | null;
+    /**
+     * A structured postal address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified".
+     * Unverified addresses may be safe to use. For example, Aadhaar card provides an address, but due to certain limitations of verifying Aadhaar, Yoti is unable to verify this property so it is listed as "unverified".
+     * @type {YotiStructuredPostalAddress}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    structuredPostalAddress?: YotiStructuredPostalAddress | null;
+    /**
+     * The whole address for the individual that comes from the underlying document or can be manually added. In the case of being manually added, the address is considered "unverified". The format of this will be different for each country.
+     * Refer to `StructuredPostalAddress` for a detailed version of the address.
+     * @type {string}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    postalAddress?: string | null;
+    /**
+     * The details of the underlying document used to help create the Yoti credential
+     * @type {YotiDocumentDetails}
+     * @memberof PostOfficeEasyIdProviderOutput
+     */
+    documentDetails?: YotiDocumentDetails | null;
+}
+
+/**
+ * Check if a given object implements the PostOfficeEasyIdProviderOutput interface.
+ */
+export function instanceOfPostOfficeEasyIdProviderOutput(value: object): value is PostOfficeEasyIdProviderOutput {
+    return true;
+}
+
+export function PostOfficeEasyIdProviderOutputFromJSON(json: any): PostOfficeEasyIdProviderOutput {
+    return PostOfficeEasyIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function PostOfficeEasyIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostOfficeEasyIdProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rememberMeId': json['rememberMeId'] == null ? undefined : json['rememberMeId'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'fullName': json['fullName'] == null ? undefined : json['fullName'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'gender': json['gender'] == null ? undefined : json['gender'],
+        'nationality': json['nationality'] == null ? undefined : json['nationality'],
+        'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
+        'structuredPostalAddress': json['structuredPostalAddress'] == null ? undefined : YotiStructuredPostalAddressFromJSON(json['structuredPostalAddress']),
+        'postalAddress': json['postalAddress'] == null ? undefined : json['postalAddress'],
+        'documentDetails': json['documentDetails'] == null ? undefined : YotiDocumentDetailsFromJSON(json['documentDetails']),
+    };
+}
+
+export function PostOfficeEasyIdProviderOutputToJSON(json: any): PostOfficeEasyIdProviderOutput {
+    return PostOfficeEasyIdProviderOutputToJSONTyped(json, false);
+}
+
+export function PostOfficeEasyIdProviderOutputToJSONTyped(value?: PostOfficeEasyIdProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'rememberMeId': value['rememberMeId'],
+        'email': value['email'],
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'fullName': value['fullName'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'mobileNumber': value['mobileNumber'],
+        'structuredPostalAddress': YotiStructuredPostalAddressToJSON(value['structuredPostalAddress']),
+        'postalAddress': value['postalAddress'],
+        'documentDetails': YotiDocumentDetailsToJSON(value['documentDetails']),
+    };
+}
+

package/src/models/{ProviderContract.ts → Provider.ts}

@@ -13,20 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { ContractIdentifierField } from './ContractIdentifierField';
+import type { ContractAttachment } from './ContractAttachment';
 import {
-    ContractIdentifierFieldFromJSON,
-    ContractIdentifierFieldFromJSONTyped,
-    ContractIdentifierFieldToJSON,
-    ContractIdentifierFieldToJSONTyped,
-} from './ContractIdentifierField';
-import type { ContractField } from './ContractField';
-import {
-    ContractFieldFromJSON,
-    ContractFieldFromJSONTyped,
-    ContractFieldToJSON,
-    ContractFieldToJSONTyped,
-} from './ContractField';
+    ContractAttachmentFromJSON,
+    ContractAttachmentFromJSONTyped,
+    ContractAttachmentToJSON,
+    ContractAttachmentToJSONTyped,
+} from './ContractAttachment';
 import type { ProviderHealth } from './ProviderHealth';
 import {
     ProviderHealthFromJSON,
@@ -48,6 +41,13 @@ import {
     ResultCollectionMethodToJSON,
     ResultCollectionMethodToJSONTyped,
 } from './ResultCollectionMethod';
+import type { ContractAttribute } from './ContractAttribute';
+import {
+    ContractAttributeFromJSON,
+    ContractAttributeFromJSONTyped,
+    ContractAttributeToJSON,
+    ContractAttributeToJSONTyped,
+} from './ContractAttribute';
 import type { IntegrationLaunchMethod } from './IntegrationLaunchMethod';
 import {
     IntegrationLaunchMethodFromJSON,
@@ -59,72 +59,79 @@ import {
 /**
  * 
  * @export
- * @interface ProviderContract
+ * @interface Provider
  */
-export interface ProviderContract {
+export interface Provider {
     /**
-     * The ID of the Provider for this contract.
+     * The unique identifier of the provider
      * @type {string}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     id: string;
     /**
-     * The Provider's Name as it appears in Trinsic's Dashboard and Widget
+     * The display name of the provider
      * @type {string}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     name: string;
+    /**
+     * The URL of the provider's logo
+     * @type {string}
+     * @memberof Provider
+     */
+    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 ProviderContract
+     * @memberof Provider
      */
     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.
+     * A description of the provider's capabilities
      * @type {string}
-     * @memberof ProviderContract
+     * @memberof Provider
      * @deprecated
      */
-    description: string;
+    readonly 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
+     * Geographic regions where this provider operates
+     * @type {Array<string>}
+     * @memberof Provider
+     * @deprecated
      */
-    logoUrl: string;
+    geography: Array<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
+     * Specific regions supported by this provider
+     * @type {Array<string>}
+     * @memberof Provider
      */
-    available: boolean;
+    regions: Array<string>;
     /**
-     * The geographies within the Regions the Provider is available.
+     * The countries where this Provider is available (as alpha-2 ISO codes).
      * @type {Array<string>}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
-    geography: Array<string>;
+    countries: Array<string>;
     /**
-     * The regions within which the Provider is available.
+     * The subdivisions (states, provinces, etc.) where this Provider is available (as alpha-2 ISO codes).
      * @type {Array<string>}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
-    regions: Array<string>;
+    subdivisions: Array<string>;
+    /**
+     * Whether this provider is licensed for use by your organization
+     * @type {boolean}
+     * @memberof Provider
+     */
+    licensed: boolean;
     /**
      * Relevant only to Direct Provider Sessions.
      *             
      * The `LaunchMethod` which must be supported to launch the Provider Session in Direct Provider Sessions.
      * @type {IntegrationLaunchMethod}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     launchMethod: IntegrationLaunchMethod;
     /**
@@ -132,7 +139,7 @@ export interface ProviderContract {
      *             
      * The `CollectionMethod` which must be supported to launch the Provider Session in Direct Provider Sessions.
      * @type {ResultCollectionMethod}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     collectionMethod: ResultCollectionMethod;
     /**
@@ -142,7 +149,7 @@ export interface ProviderContract {
      * 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
+     * @memberof Provider
      */
     resultsMayBeDelayedAfterRedirect: boolean;
     /**
@@ -153,7 +160,7 @@ export interface ProviderContract {
      * 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
+     * @memberof Provider
      */
     hasRefreshableContent: boolean;
     /**
@@ -162,7 +169,7 @@ export interface ProviderContract {
      * 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
+     * @memberof Provider
      */
     requiresInput: boolean;
     /**
@@ -170,7 +177,7 @@ export interface ProviderContract {
      *             
      * This is `true` for any Provider which is not a simple, OIDC-like redirect flow.
      * @type {boolean}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     hasTrinsicInterface: boolean;
     /**
@@ -179,78 +186,76 @@ export interface ProviderContract {
      * If `false`, the Provider may still be launched through Direct Provider Sessions;
      * however, it will necessarily require a Trinsic-hosted UI to function.
      * @type {boolean}
-     * @memberof ProviderContract
-     * @deprecated
-     */
-    supportsAdvancedProviderSessions: boolean;
-    /**
-     * Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.
-     *             
-     * If `false`, the Provider may still be launched through Direct Provider Sessions;
-     * however, it will necessarily require a Trinsic-hosted UI to function.
-     * @type {boolean}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     supportsDirectProviderSessions: boolean;
     /**
-     * Information about the fields that this Provider will return in verification results.
-     * @type {Array<ContractField>}
-     * @memberof ProviderContract
+     * Information about the user attributes that this Provider will return in verification results.
+     * @type {Array<ContractAttribute>}
+     * @memberof Provider
      */
-    availableFields?: Array<ContractField> | null;
+    availableAttributes?: Array<ContractAttribute> | null;
     /**
-     * Information about the identifiers this Provider returns in verification results.
-     * @type {Array<ContractIdentifierField>}
-     * @memberof ProviderContract
+     * Information about the attachments that this Provider will return in verification results.
+     * @type {Array<ContractAttachment>}
+     * @memberof Provider
      */
-    availableIdentifiers?: Array<ContractIdentifierField> | null;
+    availableAttachments?: Array<ContractAttachment> | null;
     /**
-     * Metadata about the sub-providers which are available for this Provider.
+     * Metadata about the sub-providers which are available for this Provider in the current Environment.
      *             
      * For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
      * @type {Array<SubProviderMetadata>}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
     subProviders?: Array<SubProviderMetadata> | null;
     /**
-     * The health for an integration to be able to successfully perform a verification session.
+     * The health for a provider in the live environment
      * @type {ProviderHealth}
-     * @memberof ProviderContract
+     * @memberof Provider
      */
-    health: ProviderHealth;
+    liveHealth: ProviderHealth;
+    /**
+     * The health for a provider in the test environment
+     * @type {ProviderHealth}
+     * @memberof Provider
+     */
+    testHealth: ProviderHealth;
 }
 
 
 
 /**
- * Check if a given object implements the ProviderContract interface.
+ * Check if a given object implements the Provider interface.
  */
-export function instanceOfProviderContract(value: object): value is ProviderContract {
+export function instanceOfProvider(value: object): value is Provider {
     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 (!('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 (!('countries' in value) || value['countries'] === undefined) return false;
+    if (!('subdivisions' in value) || value['subdivisions'] === undefined) return false;
+    if (!('licensed' in value) || value['licensed'] === 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;
     if (!('supportsDirectProviderSessions' in value) || value['supportsDirectProviderSessions'] === undefined) return false;
-    if (!('health' in value) || value['health'] === undefined) return false;
+    if (!('liveHealth' in value) || value['liveHealth'] === undefined) return false;
+    if (!('testHealth' in value) || value['testHealth'] === undefined) return false;
     return true;
 }
 
-export function ProviderContractFromJSON(json: any): ProviderContract {
-    return ProviderContractFromJSONTyped(json, false);
+export function ProviderFromJSON(json: any): Provider {
+    return ProviderFromJSONTyped(json, false);
 }
 
-export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderContract {
+export function ProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Provider {
     if (json == null) {
         return json;
     }
@@ -258,32 +263,34 @@ export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'id': json['id'],
         'name': json['name'],
+        'logoUrl': json['logoUrl'],
         'subtext': json['subtext'],
         'description': json['description'],
-        'logoUrl': json['logoUrl'],
-        'available': json['available'],
         'geography': json['geography'],
         'regions': json['regions'],
+        'countries': json['countries'],
+        'subdivisions': json['subdivisions'],
+        'licensed': json['licensed'],
         'launchMethod': IntegrationLaunchMethodFromJSON(json['launchMethod']),
         'collectionMethod': ResultCollectionMethodFromJSON(json['collectionMethod']),
         'resultsMayBeDelayedAfterRedirect': json['resultsMayBeDelayedAfterRedirect'],
         'hasRefreshableContent': json['hasRefreshableContent'],
         'requiresInput': json['requiresInput'],
         'hasTrinsicInterface': json['hasTrinsicInterface'],
-        'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
         'supportsDirectProviderSessions': json['supportsDirectProviderSessions'],
-        'availableFields': json['availableFields'] == null ? undefined : ((json['availableFields'] as Array<any>).map(ContractFieldFromJSON)),
-        'availableIdentifiers': json['availableIdentifiers'] == null ? undefined : ((json['availableIdentifiers'] as Array<any>).map(ContractIdentifierFieldFromJSON)),
+        'availableAttributes': json['availableAttributes'] == null ? undefined : ((json['availableAttributes'] as Array<any>).map(ContractAttributeFromJSON)),
+        'availableAttachments': json['availableAttachments'] == null ? undefined : ((json['availableAttachments'] as Array<any>).map(ContractAttachmentFromJSON)),
         'subProviders': json['subProviders'] == null ? undefined : ((json['subProviders'] as Array<any>).map(SubProviderMetadataFromJSON)),
-        'health': ProviderHealthFromJSON(json['health']),
+        'liveHealth': ProviderHealthFromJSON(json['liveHealth']),
+        'testHealth': ProviderHealthFromJSON(json['testHealth']),
     };
 }
 
-export function ProviderContractToJSON(json: any): ProviderContract {
-    return ProviderContractToJSONTyped(json, false);
+export function ProviderToJSON(json: any): Provider {
+    return ProviderToJSONTyped(json, false);
 }
 
-export function ProviderContractToJSONTyped(value?: ProviderContract | null, ignoreDiscriminator: boolean = false): any {
+export function ProviderToJSONTyped(value?: Omit<Provider, 'description'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -292,24 +299,25 @@ 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'],
+        'subtext': value['subtext'],
         'geography': value['geography'],
         'regions': value['regions'],
+        'countries': value['countries'],
+        'subdivisions': value['subdivisions'],
+        'licensed': value['licensed'],
         'launchMethod': IntegrationLaunchMethodToJSON(value['launchMethod']),
         'collectionMethod': ResultCollectionMethodToJSON(value['collectionMethod']),
         'resultsMayBeDelayedAfterRedirect': value['resultsMayBeDelayedAfterRedirect'],
         'hasRefreshableContent': value['hasRefreshableContent'],
         'requiresInput': value['requiresInput'],
         'hasTrinsicInterface': value['hasTrinsicInterface'],
-        'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
         'supportsDirectProviderSessions': value['supportsDirectProviderSessions'],
-        'availableFields': value['availableFields'] == null ? undefined : ((value['availableFields'] as Array<any>).map(ContractFieldToJSON)),
-        'availableIdentifiers': value['availableIdentifiers'] == null ? undefined : ((value['availableIdentifiers'] as Array<any>).map(ContractIdentifierFieldToJSON)),
+        'availableAttributes': value['availableAttributes'] == null ? undefined : ((value['availableAttributes'] as Array<any>).map(ContractAttributeToJSON)),
+        'availableAttachments': value['availableAttachments'] == null ? undefined : ((value['availableAttachments'] as Array<any>).map(ContractAttachmentToJSON)),
         'subProviders': value['subProviders'] == null ? undefined : ((value['subProviders'] as Array<any>).map(SubProviderMetadataToJSON)),
-        'health': ProviderHealthToJSON(value['health']),
+        'liveHealth': ProviderHealthToJSON(value['liveHealth']),
+        'testHealth': ProviderHealthToJSON(value['testHealth']),
     };
 }