@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/src/models/ProviderSupportedLanguage.ts

@@ -0,0 +1,74 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface ProviderSupportedLanguage
+ */
+export interface ProviderSupportedLanguage {
+    /**
+     * BCP 47 language code.
+     * @type {string}
+     * @memberof ProviderSupportedLanguage
+     */
+    code: string;
+    /**
+     * Human-readable display label for the language.
+     * @type {string}
+     * @memberof ProviderSupportedLanguage
+     */
+    label?: string | null;
+}
+
+/**
+ * Check if a given object implements the ProviderSupportedLanguage interface.
+ */
+export function instanceOfProviderSupportedLanguage(value: object): value is ProviderSupportedLanguage {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    return true;
+}
+
+export function ProviderSupportedLanguageFromJSON(json: any): ProviderSupportedLanguage {
+    return ProviderSupportedLanguageFromJSONTyped(json, false);
+}
+
+export function ProviderSupportedLanguageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderSupportedLanguage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'label': json['label'] == null ? undefined : json['label'],
+    };
+}
+
+export function ProviderSupportedLanguageToJSON(json: any): ProviderSupportedLanguage {
+    return ProviderSupportedLanguageToJSONTyped(json, false);
+}
+
+export function ProviderSupportedLanguageToJSONTyped(value?: ProviderSupportedLanguage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'label': value['label'],
+    };
+}
+

package/src/models/SerbiaIdCardProviderOutput.ts

@@ -99,7 +99,7 @@ export function SerbiaIdCardProviderOutputToJSONTyped(value?: SerbiaIdCardProvid
         
         'firstName': value['firstName'],
         'lastName': value['lastName'],
-        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'dateOfBirth': value['dateOfBirth'].toISOString().substring(0,10),
         'uniqueMasterCitizenNumber': value['uniqueMasterCitizenNumber'],
     };
 }

package/src/models/SignzyIndiaAadhaarFetchProviderOutput.ts

@@ -0,0 +1,183 @@
+/* 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 { AadhaarLocalizedClaims } from './AadhaarLocalizedClaims';
+import {
+    AadhaarLocalizedClaimsFromJSON,
+    AadhaarLocalizedClaimsFromJSONTyped,
+    AadhaarLocalizedClaimsToJSON,
+    AadhaarLocalizedClaimsToJSONTyped,
+} from './AadhaarLocalizedClaims';
+import type { AadhaarClaims } from './AadhaarClaims';
+import {
+    AadhaarClaimsFromJSON,
+    AadhaarClaimsFromJSONTyped,
+    AadhaarClaimsToJSON,
+    AadhaarClaimsToJSONTyped,
+} from './AadhaarClaims';
+
+/**
+ * Exposed properties for the `india-digilocker-aadhaar-fetch` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface SignzyIndiaAadhaarFetchProviderOutput
+ */
+export interface SignzyIndiaAadhaarFetchProviderOutput {
+    /**
+     * The document type from which the identity data was retrieved.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    documentType?: string | null;
+    /**
+     * The timestamp when the signed document was generated and verified.
+     * @type {Date}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    timestamp?: Date | null;
+    /**
+     * The validity expiration timestamp for the verification document.
+     * @type {Date}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    timeToLive?: Date | null;
+    /**
+     * The Aadhaar number (UID) value for the individual.
+     *             
+     * This is only the last four digits of the Aadhaar number.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    aadhaarNumberLastFour?: string | null;
+    /**
+     * The claims extracted from the Aadhaar document.
+     * @type {AadhaarClaims}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    claims?: AadhaarClaims | null;
+    /**
+     * The localized claims extracted from the Aadhaar document.
+     * @type {AadhaarLocalizedClaims}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    localizedClaims?: AadhaarLocalizedClaims | null;
+    /**
+     * Whether our own validation of the Aadhaar document signature and certificate chain succeeded.
+     *             
+     * When the signed document (e.g. Digilocker XML) is available, we validate it using the standard CCA/SafeScrypt chain.
+     * When the document is not returned, the signature cannot be validated and this is false. Some providers (e.g. Signzy) also
+     * supply a separate DSC validation indicator in the webhook payload; that is independent of this flag, which reflects only our validation.
+     * @type {boolean}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    documentSignatureValidated: boolean;
+    /**
+     * DigiLocker's 36-character stable account identifier.
+     *             
+     * This identifier is deemed safe to use to reference the individual.
+     * *Note, the format is not guaranteed to be a UUID.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    digilockerId?: string | null;
+    /**
+     * The identifier for the issuer of the DigiLocker document.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    issuerId?: string | null;
+    /**
+     * Issuer name for the DigiLocker document.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    issuer?: string | null;
+    /**
+     * The individual's mobile phone number from DigiLocker's account details.
+     * @type {string}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    mobilePhone?: string | null;
+    /**
+     * DigiLocker consent scopes that the individual actually consented to for this session.
+     * Included in provider output so customers can verify what was granted: the customer does not control
+     * these—the individual chooses scopes in the DigiLocker consent UI, and there is no way to pre-select
+     * or enforce them. This is a common source of error (e.g. the individual skips a scope), so surfacing the
+     * granted scopes lets customers confirm the session had the expected consent.
+     * @type {Array<string>}
+     * @memberof SignzyIndiaAadhaarFetchProviderOutput
+     */
+    scope: Array<string>;
+}
+
+/**
+ * Check if a given object implements the SignzyIndiaAadhaarFetchProviderOutput interface.
+ */
+export function instanceOfSignzyIndiaAadhaarFetchProviderOutput(value: object): value is SignzyIndiaAadhaarFetchProviderOutput {
+    if (!('documentSignatureValidated' in value) || value['documentSignatureValidated'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    return true;
+}
+
+export function SignzyIndiaAadhaarFetchProviderOutputFromJSON(json: any): SignzyIndiaAadhaarFetchProviderOutput {
+    return SignzyIndiaAadhaarFetchProviderOutputFromJSONTyped(json, false);
+}
+
+export function SignzyIndiaAadhaarFetchProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignzyIndiaAadhaarFetchProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'documentType': json['documentType'] == null ? undefined : json['documentType'],
+        'timestamp': json['timestamp'] == null ? undefined : (new Date(json['timestamp'])),
+        'timeToLive': json['timeToLive'] == null ? undefined : (new Date(json['timeToLive'])),
+        'aadhaarNumberLastFour': json['aadhaarNumberLastFour'] == null ? undefined : json['aadhaarNumberLastFour'],
+        'claims': json['claims'] == null ? undefined : AadhaarClaimsFromJSON(json['claims']),
+        'localizedClaims': json['localizedClaims'] == null ? undefined : AadhaarLocalizedClaimsFromJSON(json['localizedClaims']),
+        'documentSignatureValidated': json['documentSignatureValidated'],
+        'digilockerId': json['digilockerId'] == null ? undefined : json['digilockerId'],
+        'issuerId': json['issuerId'] == null ? undefined : json['issuerId'],
+        'issuer': json['issuer'] == null ? undefined : json['issuer'],
+        'mobilePhone': json['mobilePhone'] == null ? undefined : json['mobilePhone'],
+        'scope': json['scope'],
+    };
+}
+
+export function SignzyIndiaAadhaarFetchProviderOutputToJSON(json: any): SignzyIndiaAadhaarFetchProviderOutput {
+    return SignzyIndiaAadhaarFetchProviderOutputToJSONTyped(json, false);
+}
+
+export function SignzyIndiaAadhaarFetchProviderOutputToJSONTyped(value?: SignzyIndiaAadhaarFetchProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'documentType': value['documentType'],
+        'timestamp': value['timestamp'] == null ? value['timestamp'] : value['timestamp'].toISOString(),
+        'timeToLive': value['timeToLive'] == null ? value['timeToLive'] : value['timeToLive'].toISOString(),
+        'aadhaarNumberLastFour': value['aadhaarNumberLastFour'],
+        'claims': AadhaarClaimsToJSON(value['claims']),
+        'localizedClaims': AadhaarLocalizedClaimsToJSON(value['localizedClaims']),
+        'documentSignatureValidated': value['documentSignatureValidated'],
+        'digilockerId': value['digilockerId'],
+        'issuerId': value['issuerId'],
+        'issuer': value['issuer'],
+        'mobilePhone': value['mobilePhone'],
+        'scope': value['scope'],
+    };
+}
+

package/src/models/SingpassLoginProviderOutput.ts

@@ -0,0 +1,132 @@
+/* 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 `singpass-login` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface SingpassLoginProviderOutput
+ */
+export interface SingpassLoginProviderOutput {
+    /**
+     * The Singpass subject identifier.
+     *             
+     * This is a public identifier which is globally unique across the Singpass system.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    sub?: string | null;
+    /**
+     * The Singpass account type for this user.
+     *             
+     * Possible values:
+     * - foreign (Singpass Foreign Account (SFA) holders)
+     * - standard (Singapore Citizens, Permanent Residents, or FIN holders)
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    accountType?: string | null;
+    /**
+     * The Unique Identifier Number (UINFIN) for the user.
+     *             
+     * The number can be either the National Registration Identity Card or Foreign Identification Number (NRIC/FIN).
+     * Follows the format @xxxxxxx#:
+     * - @ is the status of the holder.
+     *     - Singapore citizens and permanent residents born before 1 January 2000 are assigned the letter "S".
+     *     - Singapore citizens and permanent residents born on or after 1 January 2000 are assigned the letter "T".
+     *     - Foreigners issued with long-term passes before 1 January 2000 are assigned the letter "F".
+     *     - Foreigners issued with long-term passes from 1 January 2000 to 31 December 2021 are assigned the letter "G".
+     *     - Foreigners issued with long-term passes on or after 1 January 2022 are assigned the letter "M".
+     * - xxxxxxx is seven digit serial number.
+     * - # is the checksum letter.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    identityNumber?: string | null;
+    /**
+     * The individual's identity country of issuance.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    countryOfIssuance?: string | null;
+    /**
+     * The individual's principal name.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    name?: string | null;
+    /**
+     * The individual's email address.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The individual's mobile number.
+     *             
+     * For Singpass Foreign Account (SFA) users, this will always be null.
+     * @type {string}
+     * @memberof SingpassLoginProviderOutput
+     */
+    mobileNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the SingpassLoginProviderOutput interface.
+ */
+export function instanceOfSingpassLoginProviderOutput(value: object): value is SingpassLoginProviderOutput {
+    return true;
+}
+
+export function SingpassLoginProviderOutputFromJSON(json: any): SingpassLoginProviderOutput {
+    return SingpassLoginProviderOutputFromJSONTyped(json, false);
+}
+
+export function SingpassLoginProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SingpassLoginProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sub': json['sub'] == null ? undefined : json['sub'],
+        'accountType': json['accountType'] == null ? undefined : json['accountType'],
+        'identityNumber': json['identityNumber'] == null ? undefined : json['identityNumber'],
+        'countryOfIssuance': json['countryOfIssuance'] == null ? undefined : json['countryOfIssuance'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
+    };
+}
+
+export function SingpassLoginProviderOutputToJSON(json: any): SingpassLoginProviderOutput {
+    return SingpassLoginProviderOutputToJSONTyped(json, false);
+}
+
+export function SingpassLoginProviderOutputToJSONTyped(value?: SingpassLoginProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sub': value['sub'],
+        'accountType': value['accountType'],
+        'identityNumber': value['identityNumber'],
+        'countryOfIssuance': value['countryOfIssuance'],
+        'name': value['name'],
+        'email': value['email'],
+        'mobileNumber': value['mobileNumber'],
+    };
+}
+

package/src/models/SingpassMyInfoDescription.ts

@@ -0,0 +1,73 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface SingpassMyInfoDescription
+ */
+export interface SingpassMyInfoDescription {
+    /**
+     * The code for the following description.
+     * @type {string}
+     * @memberof SingpassMyInfoDescription
+     */
+    code?: string | null;
+    /**
+     * The full description of the field.
+     * @type {string}
+     * @memberof SingpassMyInfoDescription
+     */
+    description?: string | null;
+}
+
+/**
+ * Check if a given object implements the SingpassMyInfoDescription interface.
+ */
+export function instanceOfSingpassMyInfoDescription(value: object): value is SingpassMyInfoDescription {
+    return true;
+}
+
+export function SingpassMyInfoDescriptionFromJSON(json: any): SingpassMyInfoDescription {
+    return SingpassMyInfoDescriptionFromJSONTyped(json, false);
+}
+
+export function SingpassMyInfoDescriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SingpassMyInfoDescription {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'] == null ? undefined : json['code'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function SingpassMyInfoDescriptionToJSON(json: any): SingpassMyInfoDescription {
+    return SingpassMyInfoDescriptionToJSONTyped(json, false);
+}
+
+export function SingpassMyInfoDescriptionToJSONTyped(value?: SingpassMyInfoDescription | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'description': value['description'],
+    };
+}
+

package/src/models/SingpassMyInfoProviderOutput.ts

@@ -0,0 +1,81 @@
+/* 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 { SingpassPersonalCatalog } from './SingpassPersonalCatalog';
+import {
+    SingpassPersonalCatalogFromJSON,
+    SingpassPersonalCatalogFromJSONTyped,
+    SingpassPersonalCatalogToJSON,
+    SingpassPersonalCatalogToJSONTyped,
+} from './SingpassPersonalCatalog';
+
+/**
+ * Exposed properties for the `singpass-myinfo` Provider which do not directly map to the normalized IdentityData model.
+ * @export
+ * @interface SingpassMyInfoProviderOutput
+ */
+export interface SingpassMyInfoProviderOutput {
+    /**
+     * The Singpass subject identifier.
+     * @type {string}
+     * @memberof SingpassMyInfoProviderOutput
+     */
+    sub?: string | null;
+    /**
+     * The MyInfo personal catalog.
+     * @type {SingpassPersonalCatalog}
+     * @memberof SingpassMyInfoProviderOutput
+     */
+    personInfo?: SingpassPersonalCatalog | null;
+}
+
+/**
+ * Check if a given object implements the SingpassMyInfoProviderOutput interface.
+ */
+export function instanceOfSingpassMyInfoProviderOutput(value: object): value is SingpassMyInfoProviderOutput {
+    return true;
+}
+
+export function SingpassMyInfoProviderOutputFromJSON(json: any): SingpassMyInfoProviderOutput {
+    return SingpassMyInfoProviderOutputFromJSONTyped(json, false);
+}
+
+export function SingpassMyInfoProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SingpassMyInfoProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sub': json['sub'] == null ? undefined : json['sub'],
+        'personInfo': json['personInfo'] == null ? undefined : SingpassPersonalCatalogFromJSON(json['personInfo']),
+    };
+}
+
+export function SingpassMyInfoProviderOutputToJSON(json: any): SingpassMyInfoProviderOutput {
+    return SingpassMyInfoProviderOutputToJSONTyped(json, false);
+}
+
+export function SingpassMyInfoProviderOutputToJSONTyped(value?: SingpassMyInfoProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sub': value['sub'],
+        'personInfo': SingpassPersonalCatalogToJSON(value['personInfo']),
+    };
+}
+