@trinsic/api 2.3.0-alpha2 → 3.0.1

package/dist/models/LatviaEparakstsProviderOutput.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfLatviaEparakstsProviderOutput = instanceOfLatviaEparakstsProviderOutput;
+exports.LatviaEparakstsProviderOutputFromJSON = LatviaEparakstsProviderOutputFromJSON;
+exports.LatviaEparakstsProviderOutputFromJSONTyped = LatviaEparakstsProviderOutputFromJSONTyped;
+exports.LatviaEparakstsProviderOutputToJSON = LatviaEparakstsProviderOutputToJSON;
+exports.LatviaEparakstsProviderOutputToJSONTyped = LatviaEparakstsProviderOutputToJSONTyped;
+/**
+ * Check if a given object implements the LatviaEparakstsProviderOutput interface.
+ */
+function instanceOfLatviaEparakstsProviderOutput(value) {
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('personalCode' in value) || value['personalCode'] === undefined)
+        return false;
+    return true;
+}
+function LatviaEparakstsProviderOutputFromJSON(json) {
+    return LatviaEparakstsProviderOutputFromJSONTyped(json, false);
+}
+function LatviaEparakstsProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'personalCode': json['personalCode'],
+    };
+}
+function LatviaEparakstsProviderOutputToJSON(json) {
+    return LatviaEparakstsProviderOutputToJSONTyped(json, false);
+}
+function LatviaEparakstsProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'personalCode': value['personalCode'],
+    };
+}

package/dist/models/ListProvidersResponse.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { ProviderInfo } from './ProviderInfo';
+import type { Provider } from './Provider';
 /**
  *
  * @export
@@ -17,11 +17,11 @@ import type { ProviderInfo } from './ProviderInfo';
  */
 export interface ListProvidersResponse {
     /**
-     * The list of identity providers available to your account
-     * @type {Array<ProviderInfo>}
+     * The list of providers available to this organization
+     * @type {Array<Provider>}
      * @memberof ListProvidersResponse
      */
-    providers: Array<ProviderInfo>;
+    providers: Array<Provider>;
 }
 /**
  * Check if a given object implements the ListProvidersResponse interface.

package/dist/models/ListProvidersResponse.js

@@ -18,7 +18,7 @@ exports.ListProvidersResponseFromJSON = ListProvidersResponseFromJSON;
 exports.ListProvidersResponseFromJSONTyped = ListProvidersResponseFromJSONTyped;
 exports.ListProvidersResponseToJSON = ListProvidersResponseToJSON;
 exports.ListProvidersResponseToJSONTyped = ListProvidersResponseToJSONTyped;
-const ProviderInfo_1 = require("./ProviderInfo");
+const Provider_1 = require("./Provider");
 /**
  * Check if a given object implements the ListProvidersResponse interface.
  */
@@ -35,7 +35,7 @@ function ListProvidersResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'providers': (json['providers'].map(ProviderInfo_1.ProviderInfoFromJSON)),
+        'providers': (json['providers'].map(Provider_1.ProviderFromJSON)),
     };
 }
 function ListProvidersResponseToJSON(json) {
@@ -46,6 +46,6 @@ function ListProvidersResponseToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
-        'providers': (value['providers'].map(ProviderInfo_1.ProviderInfoToJSON)),
+        'providers': (value['providers'].map(Provider_1.ProviderToJSON)),
     };
 }

package/dist/models/ListRedirectUrisResponse.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 { RedirectUriResponse } from './RedirectUriResponse';
+/**
+ * Response from listing redirect URIs within an environment.
+ * @export
+ * @interface ListRedirectUrisResponse
+ */
+export interface ListRedirectUrisResponse {
+    /**
+     * List of redirect uris within the environment.
+     * @type {Array<RedirectUriResponse>}
+     * @memberof ListRedirectUrisResponse
+     */
+    uris: Array<RedirectUriResponse>;
+    /**
+     * Whether there are additional pages of uris to retrieve
+     * @type {boolean}
+     * @memberof ListRedirectUrisResponse
+     */
+    more: boolean;
+}
+/**
+ * Check if a given object implements the ListRedirectUrisResponse interface.
+ */
+export declare function instanceOfListRedirectUrisResponse(value: object): value is ListRedirectUrisResponse;
+export declare function ListRedirectUrisResponseFromJSON(json: any): ListRedirectUrisResponse;
+export declare function ListRedirectUrisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListRedirectUrisResponse;
+export declare function ListRedirectUrisResponseToJSON(json: any): ListRedirectUrisResponse;
+export declare function ListRedirectUrisResponseToJSONTyped(value?: ListRedirectUrisResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListRedirectUrisResponse.js

@@ -0,0 +1,55 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfListRedirectUrisResponse = instanceOfListRedirectUrisResponse;
+exports.ListRedirectUrisResponseFromJSON = ListRedirectUrisResponseFromJSON;
+exports.ListRedirectUrisResponseFromJSONTyped = ListRedirectUrisResponseFromJSONTyped;
+exports.ListRedirectUrisResponseToJSON = ListRedirectUrisResponseToJSON;
+exports.ListRedirectUrisResponseToJSONTyped = ListRedirectUrisResponseToJSONTyped;
+const RedirectUriResponse_1 = require("./RedirectUriResponse");
+/**
+ * Check if a given object implements the ListRedirectUrisResponse interface.
+ */
+function instanceOfListRedirectUrisResponse(value) {
+    if (!('uris' in value) || value['uris'] === undefined)
+        return false;
+    if (!('more' in value) || value['more'] === undefined)
+        return false;
+    return true;
+}
+function ListRedirectUrisResponseFromJSON(json) {
+    return ListRedirectUrisResponseFromJSONTyped(json, false);
+}
+function ListRedirectUrisResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'uris': (json['uris'].map(RedirectUriResponse_1.RedirectUriResponseFromJSON)),
+        'more': json['more'],
+    };
+}
+function ListRedirectUrisResponseToJSON(json) {
+    return ListRedirectUrisResponseToJSONTyped(json, false);
+}
+function ListRedirectUrisResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'uris': (value['uris'].map(RedirectUriResponse_1.RedirectUriResponseToJSON)),
+        'more': value['more'],
+    };
+}

package/dist/models/LithuaniaIdCardProviderOutput.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+/**
+ * Exposed properties for the `a-lt-id-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface LithuaniaIdCardProviderOutput
+ */
+export interface LithuaniaIdCardProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof LithuaniaIdCardProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof LithuaniaIdCardProviderOutput
+     */
+    lastName: string;
+    /**
+     * The date of birth of the verified individual
+     * @type {Date}
+     * @memberof LithuaniaIdCardProviderOutput
+     */
+    dateOfBirth: Date;
+    /**
+     * The 11-digit Lithuanian Personal Code (asmens kodas) of the verified individual.
+     *
+     * If the first digit is "9" (rare), the rest of the identifier is random and has no structure.
+     *
+     * Otherwise, this is in the format GYYMMDDSSSC, where:
+     *
+     * - G is both gender and century of birth
+     * - YYMMDD is the date of birth
+     * - SSS is a sequential serial number
+     * - C is a checksum digit
+     *
+     * If G is odd, the gender is male.
+     * If G is even, the gender is female.
+     *
+     * If G is 1 or 2, the individual was born in the 19th century (1800-1899).
+     * If G is 3 or 4, the individual was born in the 20th century (1900-1999).
+     * If G is 5 or 6, the individual was born in the 21st century (2000-2099).
+     *
+     * Rarely, the date of birth may be encoded as 000000 if it is not known.
+     * @type {string}
+     * @memberof LithuaniaIdCardProviderOutput
+     */
+    personalCode: string;
+}
+/**
+ * Check if a given object implements the LithuaniaIdCardProviderOutput interface.
+ */
+export declare function instanceOfLithuaniaIdCardProviderOutput(value: object): value is LithuaniaIdCardProviderOutput;
+export declare function LithuaniaIdCardProviderOutputFromJSON(json: any): LithuaniaIdCardProviderOutput;
+export declare function LithuaniaIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LithuaniaIdCardProviderOutput;
+export declare function LithuaniaIdCardProviderOutputToJSON(json: any): LithuaniaIdCardProviderOutput;
+export declare function LithuaniaIdCardProviderOutputToJSONTyped(value?: LithuaniaIdCardProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LithuaniaIdCardProviderOutput.js

@@ -0,0 +1,62 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfLithuaniaIdCardProviderOutput = instanceOfLithuaniaIdCardProviderOutput;
+exports.LithuaniaIdCardProviderOutputFromJSON = LithuaniaIdCardProviderOutputFromJSON;
+exports.LithuaniaIdCardProviderOutputFromJSONTyped = LithuaniaIdCardProviderOutputFromJSONTyped;
+exports.LithuaniaIdCardProviderOutputToJSON = LithuaniaIdCardProviderOutputToJSON;
+exports.LithuaniaIdCardProviderOutputToJSONTyped = LithuaniaIdCardProviderOutputToJSONTyped;
+/**
+ * Check if a given object implements the LithuaniaIdCardProviderOutput interface.
+ */
+function instanceOfLithuaniaIdCardProviderOutput(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 (!('personalCode' in value) || value['personalCode'] === undefined)
+        return false;
+    return true;
+}
+function LithuaniaIdCardProviderOutputFromJSON(json) {
+    return LithuaniaIdCardProviderOutputFromJSONTyped(json, false);
+}
+function LithuaniaIdCardProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'personalCode': json['personalCode'],
+    };
+}
+function LithuaniaIdCardProviderOutputToJSON(json) {
+    return LithuaniaIdCardProviderOutputToJSONTyped(json, false);
+}
+function LithuaniaIdCardProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'personalCode': value['personalCode'],
+    };
+}

package/dist/models/LloydsSmartIdProviderOutput.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 { YotiStructuredPostalAddress } from './YotiStructuredPostalAddress';
+import type { YotiDocumentDetails } from './YotiDocumentDetails';
+/**
+ * Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface LloydsSmartIdProviderOutput
+ */
+export interface LloydsSmartIdProviderOutput {
+    /**
+     * 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 LloydsSmartIdProviderOutput
+     */
+    rememberMeId?: string | null;
+    /**
+     * The email address of the individual
+     * @type {string}
+     * @memberof LloydsSmartIdProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The given name of the individual. This can correspond to first and middle names in English.
+     * @type {string}
+     * @memberof LloydsSmartIdProviderOutput
+     */
+    givenName?: string | null;
+    /**
+     * The family name of the individual
+     * @type {string}
+     * @memberof LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    gender?: string | null;
+    /**
+     * The nationality of the individual as a ISO alpha-3 code
+     * @type {string}
+     * @memberof LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    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 LloydsSmartIdProviderOutput
+     */
+    postalAddress?: string | null;
+    /**
+     * The details of the underlying document used to help create the Yoti credential
+     * @type {YotiDocumentDetails}
+     * @memberof LloydsSmartIdProviderOutput
+     */
+    documentDetails?: YotiDocumentDetails | null;
+}
+/**
+ * Check if a given object implements the LloydsSmartIdProviderOutput interface.
+ */
+export declare function instanceOfLloydsSmartIdProviderOutput(value: object): value is LloydsSmartIdProviderOutput;
+export declare function LloydsSmartIdProviderOutputFromJSON(json: any): LloydsSmartIdProviderOutput;
+export declare function LloydsSmartIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LloydsSmartIdProviderOutput;
+export declare function LloydsSmartIdProviderOutputToJSON(json: any): LloydsSmartIdProviderOutput;
+export declare function LloydsSmartIdProviderOutputToJSONTyped(value?: LloydsSmartIdProviderOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LloydsSmartIdProviderOutput.js

@@ -0,0 +1,72 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfLloydsSmartIdProviderOutput = instanceOfLloydsSmartIdProviderOutput;
+exports.LloydsSmartIdProviderOutputFromJSON = LloydsSmartIdProviderOutputFromJSON;
+exports.LloydsSmartIdProviderOutputFromJSONTyped = LloydsSmartIdProviderOutputFromJSONTyped;
+exports.LloydsSmartIdProviderOutputToJSON = LloydsSmartIdProviderOutputToJSON;
+exports.LloydsSmartIdProviderOutputToJSONTyped = LloydsSmartIdProviderOutputToJSONTyped;
+const YotiStructuredPostalAddress_1 = require("./YotiStructuredPostalAddress");
+const YotiDocumentDetails_1 = require("./YotiDocumentDetails");
+/**
+ * Check if a given object implements the LloydsSmartIdProviderOutput interface.
+ */
+function instanceOfLloydsSmartIdProviderOutput(value) {
+    return true;
+}
+function LloydsSmartIdProviderOutputFromJSON(json) {
+    return LloydsSmartIdProviderOutputFromJSONTyped(json, false);
+}
+function LloydsSmartIdProviderOutputFromJSONTyped(json, ignoreDiscriminator) {
+    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 : (0, YotiStructuredPostalAddress_1.YotiStructuredPostalAddressFromJSON)(json['structuredPostalAddress']),
+        'postalAddress': json['postalAddress'] == null ? undefined : json['postalAddress'],
+        'documentDetails': json['documentDetails'] == null ? undefined : (0, YotiDocumentDetails_1.YotiDocumentDetailsFromJSON)(json['documentDetails']),
+    };
+}
+function LloydsSmartIdProviderOutputToJSON(json) {
+    return LloydsSmartIdProviderOutputToJSONTyped(json, false);
+}
+function LloydsSmartIdProviderOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    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'].toISOString().substring(0, 10)),
+        'gender': value['gender'],
+        'nationality': value['nationality'],
+        'mobileNumber': value['mobileNumber'],
+        'structuredPostalAddress': (0, YotiStructuredPostalAddress_1.YotiStructuredPostalAddressToJSON)(value['structuredPostalAddress']),
+        'postalAddress': value['postalAddress'],
+        'documentDetails': (0, YotiDocumentDetails_1.YotiDocumentDetailsToJSON)(value['documentDetails']),
+    };
+}

package/dist/models/Match.d.ts

@@ -16,13 +16,21 @@
  */
 export interface Match {
     /**
+     * The probability value of the match.
      *
+     * This is a value between 0 and 1, where 1 indicates a perfect match and 0 indicates no match.
+     *
+     * This field is non-null when the underlying Provider's match output is in the form of a probability score.
      * @type {number}
      * @memberof Match
      */
     probabilityValue?: number | null;
     /**
+     * The boolean value of the match.
+     *
+     * This is a value of true or false, where true indicates a match and false indicates no match.
      *
+     * This field is non-null when the underlying Provider's match output is in the form of a boolean value.
      * @type {boolean}
      * @memberof Match
      */

package/dist/models/MatchData.d.ts

@@ -11,67 +11,90 @@
  */
 import type { Match } from './Match';
 /**
+ * Match results for the data being matched against.
  *
+ * This applies to Providers which operate based on matching data / biometrics against a government database,
+ * returning match scores or results as opposed to the data itself.
  * @export
  * @interface MatchData
  */
 export interface MatchData {
     /**
-     *
+     * Whether the provided National ID Number matched the information on file for the individual
      * @type {Match}
      * @memberof MatchData
      */
     nationalIdNumber?: Match | null;
     /**
+     * The match score for the full name of the individual.
      *
+     * Higher values indicate a closer match.
      * @type {Match}
      * @memberof MatchData
      */
     fullName?: Match | null;
     /**
+     * The match score for the given (first) name of the individual.
      *
+     * Higher values indicate a closer match.
      * @type {Match}
      * @memberof MatchData
      */
     givenName?: Match | null;
     /**
+     * The match score for the middle name(s) of the individual.
      *
+     * Higher values indicate a closer match.
      * @type {Match}
      * @memberof MatchData
      */
     middleName?: Match | null;
     /**
+     * The match score for the family (last) name of the individual.
      *
+     * Higher values indicate a closer match.
      * @type {Match}
      * @memberof MatchData
      */
     familyName?: Match | null;
     /**
-     *
+     * Whether the provided sex of the individual matched the information on file for the individual
      * @type {Match}
      * @memberof MatchData
      */
     sex?: Match | null;
     /**
-     *
+     * Whether the provided date of birth matched the information on file for the individual
      * @type {Match}
      * @memberof MatchData
      */
     dateOfBirth?: Match | null;
     /**
+     * Whether the provided phone number matched the information on file for the individual
+     * @type {Match}
+     * @memberof MatchData
+     */
+    phoneNumber?: Match | null;
+    /**
+     * The match score for the face match between the provided selfie image and the biometrics on file for the individual.
      *
+     * Higher values indicate greater match confidence.
      * @type {Match}
      * @memberof MatchData
      */
     faceMatch?: Match | null;
     /**
+     * The confidence score for the liveness check performed against the selfie image of the individual.
      *
+     * Higher values indicate lower suspicion.
      * @type {Match}
      * @memberof MatchData
      */
     liveness?: Match | null;
     /**
+     * The confidence score for the image manipulation check performed against the selfie image of the individual.
      *
+     * Higher values indicate lower suspicion of image manipulation.
      * @type {Match}
      * @memberof MatchData
      */

package/dist/models/MatchData.js

@@ -40,6 +40,7 @@ function MatchDataFromJSONTyped(json, ignoreDiscriminator) {
         'familyName': json['familyName'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['familyName']),
         'sex': json['sex'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['sex']),
         'dateOfBirth': json['dateOfBirth'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['dateOfBirth']),
+        'phoneNumber': json['phoneNumber'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['phoneNumber']),
         'faceMatch': json['faceMatch'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['faceMatch']),
         'liveness': json['liveness'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['liveness']),
         'imageAuthenticity': json['imageAuthenticity'] == null ? undefined : (0, Match_1.MatchFromJSON)(json['imageAuthenticity']),
@@ -60,6 +61,7 @@ function MatchDataToJSONTyped(value, ignoreDiscriminator = false) {
         'familyName': (0, Match_1.MatchToJSON)(value['familyName']),
         'sex': (0, Match_1.MatchToJSON)(value['sex']),
         'dateOfBirth': (0, Match_1.MatchToJSON)(value['dateOfBirth']),
+        'phoneNumber': (0, Match_1.MatchToJSON)(value['phoneNumber']),
         'faceMatch': (0, Match_1.MatchToJSON)(value['faceMatch']),
         'liveness': (0, Match_1.MatchToJSON)(value['liveness']),
         'imageAuthenticity': (0, Match_1.MatchToJSON)(value['imageAuthenticity']),