@trinsic/api 2.3.0-alpha2 → 3.0.1

package/src/models/LatviaEparakstsMobileProviderOutput.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * Exposed properties for the `a-lv-eparaksts-mobile-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface LatviaEparakstsMobileProviderOutput
+ */
+export interface LatviaEparakstsMobileProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof LatviaEparakstsMobileProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof LatviaEparakstsMobileProviderOutput
+     */
+    lastName: string;
+    /**
+     * The 11-digit Latvian personal code ("personas kods") of the verified individual.
+     *             
+     * This has two possible formats, depending on whether the personal code was issued after July 1, 2017.
+     *             
+     * For personal codes issued before July 1, 2017, the format is DDMMYY-CZZZQ, where:
+     * - DDMMYY is the date of birth, followed by an optional hyphen
+     * - C represents the century of birth ('0' for 1800-1899, '1' for 1900-1999, '2' for 2000-2099)
+     * - ZZZ is a serial number
+     * - Q is a checksum digit
+     *             
+     * For personal codes issued on or after July 1, 2017, the format is 32ZZZZZZZZQ, where:
+     * - 32 is a fixed prefix
+     * - ZZZZZZZQ are 8 random digits
+     * - Q is a checksum digit
+     *             
+     * NOTE: Individuals born before July 1, 2017 can elect to be issued a new personal code which does not contain their birthdate.
+     * Therefore, no concrete assumptions may be made about an individual's date of birth based solely on the format of their personal code.
+     * @type {string}
+     * @memberof LatviaEparakstsMobileProviderOutput
+     */
+    personalCode: string;
+}
+
+/**
+ * Check if a given object implements the LatviaEparakstsMobileProviderOutput interface.
+ */
+export function instanceOfLatviaEparakstsMobileProviderOutput(value: object): value is LatviaEparakstsMobileProviderOutput {
+    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;
+}
+
+export function LatviaEparakstsMobileProviderOutputFromJSON(json: any): LatviaEparakstsMobileProviderOutput {
+    return LatviaEparakstsMobileProviderOutputFromJSONTyped(json, false);
+}
+
+export function LatviaEparakstsMobileProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LatviaEparakstsMobileProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'personalCode': json['personalCode'],
+    };
+}
+
+export function LatviaEparakstsMobileProviderOutputToJSON(json: any): LatviaEparakstsMobileProviderOutput {
+    return LatviaEparakstsMobileProviderOutputToJSONTyped(json, false);
+}
+
+export function LatviaEparakstsMobileProviderOutputToJSONTyped(value?: LatviaEparakstsMobileProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'personalCode': value['personalCode'],
+    };
+}
+

package/src/models/LatviaEparakstsProviderOutput.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * Exposed properties for the `a-lv-eparaksts-id-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface LatviaEparakstsProviderOutput
+ */
+export interface LatviaEparakstsProviderOutput {
+    /**
+     * The first name of the verified individual
+     * @type {string}
+     * @memberof LatviaEparakstsProviderOutput
+     */
+    firstName: string;
+    /**
+     * The last name of the verified individual
+     * @type {string}
+     * @memberof LatviaEparakstsProviderOutput
+     */
+    lastName: string;
+    /**
+     * The 11-digit Latvian personal code ("personas kods") of the verified individual.
+     *             
+     * This has two possible formats, depending on whether the personal code was issued after July 1, 2017.
+     *             
+     * For personal codes issued before July 1, 2017, the format is DDMMYY-CZZZQ, where:
+     * - DDMMYY is the date of birth, followed by an optional hyphen
+     * - C represents the century of birth ('0' for 1800-1899, '1' for 1900-1999, '2' for 2000-2099)
+     * - ZZZ is a serial number
+     * - Q is a checksum digit
+     *             
+     * For personal codes issued on or after July 1, 2017, the format is 32ZZZZZZZZQ, where:
+     * - 32 is a fixed prefix
+     * - ZZZZZZZQ are 8 random digits
+     * - Q is a checksum digit
+     *             
+     * NOTE: Individuals born before July 1, 2017 can elect to be issued a new personal code which does not contain their birthdate.
+     * Therefore, no concrete assumptions may be made about an individual's date of birth based solely on the format of their personal code.
+     * @type {string}
+     * @memberof LatviaEparakstsProviderOutput
+     */
+    personalCode: string;
+}
+
+/**
+ * Check if a given object implements the LatviaEparakstsProviderOutput interface.
+ */
+export function instanceOfLatviaEparakstsProviderOutput(value: object): value is LatviaEparakstsProviderOutput {
+    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;
+}
+
+export function LatviaEparakstsProviderOutputFromJSON(json: any): LatviaEparakstsProviderOutput {
+    return LatviaEparakstsProviderOutputFromJSONTyped(json, false);
+}
+
+export function LatviaEparakstsProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LatviaEparakstsProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'personalCode': json['personalCode'],
+    };
+}
+
+export function LatviaEparakstsProviderOutputToJSON(json: any): LatviaEparakstsProviderOutput {
+    return LatviaEparakstsProviderOutputToJSONTyped(json, false);
+}
+
+export function LatviaEparakstsProviderOutputToJSONTyped(value?: LatviaEparakstsProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'personalCode': value['personalCode'],
+    };
+}
+

package/src/models/ListProvidersResponse.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { ProviderInfo } from './ProviderInfo';
+import type { Provider } from './Provider';
 import {
-    ProviderInfoFromJSON,
-    ProviderInfoFromJSONTyped,
-    ProviderInfoToJSON,
-    ProviderInfoToJSONTyped,
-} from './ProviderInfo';
+    ProviderFromJSON,
+    ProviderFromJSONTyped,
+    ProviderToJSON,
+    ProviderToJSONTyped,
+} from './Provider';
 
 /**
  * 
@@ -28,11 +28,11 @@ import {
  */
 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>;
 }
 
 /**
@@ -53,7 +53,7 @@ export function ListProvidersResponseFromJSONTyped(json: any, ignoreDiscriminato
     }
     return {
         
-        'providers': ((json['providers'] as Array<any>).map(ProviderInfoFromJSON)),
+        'providers': ((json['providers'] as Array<any>).map(ProviderFromJSON)),
     };
 }
 
@@ -68,7 +68,7 @@ export function ListProvidersResponseToJSONTyped(value?: ListProvidersResponse |
 
     return {
         
-        'providers': ((value['providers'] as Array<any>).map(ProviderInfoToJSON)),
+        'providers': ((value['providers'] as Array<any>).map(ProviderToJSON)),
     };
 }
 

package/src/models/{ListEnvironmentRedirectUrisResponse.ts → ListRedirectUrisResponse.ts}

@@ -24,37 +24,37 @@ import {
 /**
  * Response from listing redirect URIs within an environment.
  * @export
- * @interface ListEnvironmentRedirectUrisResponse
+ * @interface ListRedirectUrisResponse
  */
-export interface ListEnvironmentRedirectUrisResponse {
+export interface ListRedirectUrisResponse {
     /**
      * List of redirect uris within the environment.
      * @type {Array<RedirectUriResponse>}
-     * @memberof ListEnvironmentRedirectUrisResponse
+     * @memberof ListRedirectUrisResponse
      */
     uris: Array<RedirectUriResponse>;
     /**
      * Whether there are additional pages of uris to retrieve
      * @type {boolean}
-     * @memberof ListEnvironmentRedirectUrisResponse
+     * @memberof ListRedirectUrisResponse
      */
     more: boolean;
 }
 
 /**
- * Check if a given object implements the ListEnvironmentRedirectUrisResponse interface.
+ * Check if a given object implements the ListRedirectUrisResponse interface.
  */
-export function instanceOfListEnvironmentRedirectUrisResponse(value: object): value is ListEnvironmentRedirectUrisResponse {
+export function instanceOfListRedirectUrisResponse(value: object): value is ListRedirectUrisResponse {
     if (!('uris' in value) || value['uris'] === undefined) return false;
     if (!('more' in value) || value['more'] === undefined) return false;
     return true;
 }
 
-export function ListEnvironmentRedirectUrisResponseFromJSON(json: any): ListEnvironmentRedirectUrisResponse {
-    return ListEnvironmentRedirectUrisResponseFromJSONTyped(json, false);
+export function ListRedirectUrisResponseFromJSON(json: any): ListRedirectUrisResponse {
+    return ListRedirectUrisResponseFromJSONTyped(json, false);
 }
 
-export function ListEnvironmentRedirectUrisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListEnvironmentRedirectUrisResponse {
+export function ListRedirectUrisResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListRedirectUrisResponse {
     if (json == null) {
         return json;
     }
@@ -65,11 +65,11 @@ export function ListEnvironmentRedirectUrisResponseFromJSONTyped(json: any, igno
     };
 }
 
-export function ListEnvironmentRedirectUrisResponseToJSON(json: any): ListEnvironmentRedirectUrisResponse {
-    return ListEnvironmentRedirectUrisResponseToJSONTyped(json, false);
+export function ListRedirectUrisResponseToJSON(json: any): ListRedirectUrisResponse {
+    return ListRedirectUrisResponseToJSONTyped(json, false);
 }
 
-export function ListEnvironmentRedirectUrisResponseToJSONTyped(value?: ListEnvironmentRedirectUrisResponse | null, ignoreDiscriminator: boolean = false): any {
+export function ListRedirectUrisResponseToJSONTyped(value?: ListRedirectUrisResponse | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/src/models/LithuaniaIdCardProviderOutput.ts

@@ -0,0 +1,111 @@
+/* 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';
+/**
+ * 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 function instanceOfLithuaniaIdCardProviderOutput(value: object): value is LithuaniaIdCardProviderOutput {
+    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;
+}
+
+export function LithuaniaIdCardProviderOutputFromJSON(json: any): LithuaniaIdCardProviderOutput {
+    return LithuaniaIdCardProviderOutputFromJSONTyped(json, false);
+}
+
+export function LithuaniaIdCardProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LithuaniaIdCardProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'],
+        'lastName': json['lastName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'personalCode': json['personalCode'],
+    };
+}
+
+export function LithuaniaIdCardProviderOutputToJSON(json: any): LithuaniaIdCardProviderOutput {
+    return LithuaniaIdCardProviderOutputToJSONTyped(json, false);
+}
+
+export function LithuaniaIdCardProviderOutputToJSONTyped(value?: LithuaniaIdCardProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'lastName': value['lastName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'personalCode': value['personalCode'],
+    };
+}
+

package/src/models/LloydsSmartIdProviderOutput.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 `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 function instanceOfLloydsSmartIdProviderOutput(value: object): value is LloydsSmartIdProviderOutput {
+    return true;
+}
+
+export function LloydsSmartIdProviderOutputFromJSON(json: any): LloydsSmartIdProviderOutput {
+    return LloydsSmartIdProviderOutputFromJSONTyped(json, false);
+}
+
+export function LloydsSmartIdProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): LloydsSmartIdProviderOutput {
+    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 LloydsSmartIdProviderOutputToJSON(json: any): LloydsSmartIdProviderOutput {
+    return LloydsSmartIdProviderOutputToJSONTyped(json, false);
+}
+
+export function LloydsSmartIdProviderOutputToJSONTyped(value?: LloydsSmartIdProviderOutput | 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/Match.ts

@@ -20,13 +20,21 @@ import { mapValues } from '../runtime';
  */
 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
      */