@trinsic/api 2.2.0 → 2.3.0-alpha2

package/src/models/ProviderOutput.ts

@@ -0,0 +1,133 @@
+/* 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 { FaydaProviderOutput } from './FaydaProviderOutput';
+import {
+    FaydaProviderOutputFromJSON,
+    FaydaProviderOutputFromJSONTyped,
+    FaydaProviderOutputToJSON,
+    FaydaProviderOutputToJSONTyped,
+} from './FaydaProviderOutput';
+import type { MexicoCurpProviderOutput } from './MexicoCurpProviderOutput';
+import {
+    MexicoCurpProviderOutputFromJSON,
+    MexicoCurpProviderOutputFromJSONTyped,
+    MexicoCurpProviderOutputToJSON,
+    MexicoCurpProviderOutputToJSONTyped,
+} from './MexicoCurpProviderOutput';
+import type { PhilippinesPhysicalNidProviderOutput } from './PhilippinesPhysicalNidProviderOutput';
+import {
+    PhilippinesPhysicalNidProviderOutputFromJSON,
+    PhilippinesPhysicalNidProviderOutputFromJSONTyped,
+    PhilippinesPhysicalNidProviderOutputToJSON,
+    PhilippinesPhysicalNidProviderOutputToJSONTyped,
+} from './PhilippinesPhysicalNidProviderOutput';
+import type { PhilippinesDigitalNidProviderOutput } from './PhilippinesDigitalNidProviderOutput';
+import {
+    PhilippinesDigitalNidProviderOutputFromJSON,
+    PhilippinesDigitalNidProviderOutputFromJSONTyped,
+    PhilippinesDigitalNidProviderOutputToJSON,
+    PhilippinesDigitalNidProviderOutputToJSONTyped,
+} from './PhilippinesDigitalNidProviderOutput';
+import type { SpidProviderOutput } from './SpidProviderOutput';
+import {
+    SpidProviderOutputFromJSON,
+    SpidProviderOutputFromJSONTyped,
+    SpidProviderOutputToJSON,
+    SpidProviderOutputToJSONTyped,
+} from './SpidProviderOutput';
+
+/**
+ * 
+ * @export
+ * @interface ProviderOutput
+ */
+export interface ProviderOutput {
+    /**
+     * 
+     * @type {SpidProviderOutput}
+     * @memberof ProviderOutput
+     */
+    italySpid?: SpidProviderOutput | null;
+    /**
+     * 
+     * @type {MexicoCurpProviderOutput}
+     * @memberof ProviderOutput
+     */
+    mexicoCurpLookup?: MexicoCurpProviderOutput | null;
+    /**
+     * 
+     * @type {FaydaProviderOutput}
+     * @memberof ProviderOutput
+     */
+    ethiopiaFayda?: FaydaProviderOutput | null;
+    /**
+     * 
+     * @type {PhilippinesPhysicalNidProviderOutput}
+     * @memberof ProviderOutput
+     */
+    philippinesPhysicalNationalIdQr?: PhilippinesPhysicalNidProviderOutput | null;
+    /**
+     * 
+     * @type {PhilippinesDigitalNidProviderOutput}
+     * @memberof ProviderOutput
+     */
+    philippinesDigitalNationalIdQr?: PhilippinesDigitalNidProviderOutput | null;
+}
+
+/**
+ * Check if a given object implements the ProviderOutput interface.
+ */
+export function instanceOfProviderOutput(value: object): value is ProviderOutput {
+    return true;
+}
+
+export function ProviderOutputFromJSON(json: any): ProviderOutput {
+    return ProviderOutputFromJSONTyped(json, false);
+}
+
+export function ProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'italySpid': json['italy-spid'] == null ? undefined : SpidProviderOutputFromJSON(json['italy-spid']),
+        'mexicoCurpLookup': json['mexico-curp-lookup'] == null ? undefined : MexicoCurpProviderOutputFromJSON(json['mexico-curp-lookup']),
+        'ethiopiaFayda': json['ethiopia-fayda'] == null ? undefined : FaydaProviderOutputFromJSON(json['ethiopia-fayda']),
+        'philippinesPhysicalNationalIdQr': json['philippines-physical-national-id-qr'] == null ? undefined : PhilippinesPhysicalNidProviderOutputFromJSON(json['philippines-physical-national-id-qr']),
+        'philippinesDigitalNationalIdQr': json['philippines-digital-national-id-qr'] == null ? undefined : PhilippinesDigitalNidProviderOutputFromJSON(json['philippines-digital-national-id-qr']),
+    };
+}
+
+export function ProviderOutputToJSON(json: any): ProviderOutput {
+    return ProviderOutputToJSONTyped(json, false);
+}
+
+export function ProviderOutputToJSONTyped(value?: ProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'italy-spid': SpidProviderOutputToJSON(value['italySpid']),
+        'mexico-curp-lookup': MexicoCurpProviderOutputToJSON(value['mexicoCurpLookup']),
+        'ethiopia-fayda': FaydaProviderOutputToJSON(value['ethiopiaFayda']),
+        'philippines-physical-national-id-qr': PhilippinesPhysicalNidProviderOutputToJSON(value['philippinesPhysicalNationalIdQr']),
+        'philippines-digital-national-id-qr': PhilippinesDigitalNidProviderOutputToJSON(value['philippinesDigitalNationalIdQr']),
+    };
+}
+

package/src/models/RedirectUriResponse.ts

@@ -0,0 +1,75 @@
+/* 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 RedirectUriResponse
+ */
+export interface RedirectUriResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedirectUriResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedirectUriResponse
+     */
+    uri: string;
+}
+
+/**
+ * Check if a given object implements the RedirectUriResponse interface.
+ */
+export function instanceOfRedirectUriResponse(value: object): value is RedirectUriResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('uri' in value) || value['uri'] === undefined) return false;
+    return true;
+}
+
+export function RedirectUriResponseFromJSON(json: any): RedirectUriResponse {
+    return RedirectUriResponseFromJSONTyped(json, false);
+}
+
+export function RedirectUriResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RedirectUriResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'uri': json['uri'],
+    };
+}
+
+export function RedirectUriResponseToJSON(json: any): RedirectUriResponse {
+    return RedirectUriResponseToJSONTyped(json, false);
+}
+
+export function RedirectUriResponseToJSONTyped(value?: RedirectUriResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'uri': value['uri'],
+    };
+}
+

package/src/models/SexV1.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const SexV1 = {
+    Unknown: 'Unknown',
+    NotApplicable: 'NotApplicable',
+    Male: 'Male',
+    Female: 'Female'
+} as const;
+export type SexV1 = typeof SexV1[keyof typeof SexV1];
+
+
+export function instanceOfSexV1(value: any): boolean {
+    for (const key in SexV1) {
+        if (Object.prototype.hasOwnProperty.call(SexV1, key)) {
+            if (SexV1[key as keyof typeof SexV1] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SexV1FromJSON(json: any): SexV1 {
+    return SexV1FromJSONTyped(json, false);
+}
+
+export function SexV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): SexV1 {
+    return json as SexV1;
+}
+
+export function SexV1ToJSON(value?: SexV1 | null): any {
+    return value as any;
+}
+
+export function SexV1ToJSONTyped(value: any, ignoreDiscriminator: boolean): SexV1 {
+    return value as SexV1;
+}
+

package/src/models/SouthAfricaNidInput.ts

@@ -38,7 +38,7 @@ export interface SouthAfricaNidInput {
      */
     gender: string;
     /**
-     * The user's South African National ID number
+     * The user's National ID number
      * @type {string}
      * @memberof SouthAfricaNidInput
      */

package/src/models/SouthAfricaNidLookup2Input.ts

@@ -0,0 +1,65 @@
+/* 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 SouthAfricaNidLookup2Input
+ */
+export interface SouthAfricaNidLookup2Input {
+    /**
+     * The user's National ID number
+     * @type {string}
+     * @memberof SouthAfricaNidLookup2Input
+     */
+    idNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the SouthAfricaNidLookup2Input interface.
+ */
+export function instanceOfSouthAfricaNidLookup2Input(value: object): value is SouthAfricaNidLookup2Input {
+    return true;
+}
+
+export function SouthAfricaNidLookup2InputFromJSON(json: any): SouthAfricaNidLookup2Input {
+    return SouthAfricaNidLookup2InputFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidLookup2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidLookup2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+    };
+}
+
+export function SouthAfricaNidLookup2InputToJSON(json: any): SouthAfricaNidLookup2Input {
+    return SouthAfricaNidLookup2InputToJSONTyped(json, false);
+}
+
+export function SouthAfricaNidLookup2InputToJSONTyped(value?: SouthAfricaNidLookup2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+    };
+}
+

package/src/models/SpidBillingInformation.ts

@@ -0,0 +1,88 @@
+/* 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';
+/**
+ * Billing information for a SPID Verification.
+ * @export
+ * @interface SpidBillingInformation
+ */
+export interface SpidBillingInformation {
+    /**
+     * Whether this SPID verification has resulted in a billable event.
+     * @type {boolean}
+     * @memberof SpidBillingInformation
+     */
+    isBillable: boolean;
+    /**
+     * The billable verification type for this SPID verification.
+     *             
+     * Possible values: "Authentication" | "Registration"
+     * @type {string}
+     * @memberof SpidBillingInformation
+     */
+    verificationType: string;
+    /**
+     * The billable verification level for this SPID verification.
+     *             
+     * Possible values: 1 | 2 | 3
+     * @type {number}
+     * @memberof SpidBillingInformation
+     */
+    verificationLevel: number;
+}
+
+/**
+ * Check if a given object implements the SpidBillingInformation interface.
+ */
+export function instanceOfSpidBillingInformation(value: object): value is SpidBillingInformation {
+    if (!('isBillable' in value) || value['isBillable'] === undefined) return false;
+    if (!('verificationType' in value) || value['verificationType'] === undefined) return false;
+    if (!('verificationLevel' in value) || value['verificationLevel'] === undefined) return false;
+    return true;
+}
+
+export function SpidBillingInformationFromJSON(json: any): SpidBillingInformation {
+    return SpidBillingInformationFromJSONTyped(json, false);
+}
+
+export function SpidBillingInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): SpidBillingInformation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'isBillable': json['isBillable'],
+        'verificationType': json['verificationType'],
+        'verificationLevel': json['verificationLevel'],
+    };
+}
+
+export function SpidBillingInformationToJSON(json: any): SpidBillingInformation {
+    return SpidBillingInformationToJSONTyped(json, false);
+}
+
+export function SpidBillingInformationToJSONTyped(value?: SpidBillingInformation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'isBillable': value['isBillable'],
+        'verificationType': value['verificationType'],
+        'verificationLevel': value['verificationLevel'],
+    };
+}
+

package/src/models/SpidInput.ts

@@ -27,6 +27,17 @@ export interface SpidInput {
      * @memberof SpidInput
      */
     subProviderId?: string | null;
+    /**
+     * Only applicable if period-based billing is enabled for your Verification Profile. Contact Trinsic to enable this.
+     *             
+     * A secret UTF-8 string between 32 and 64 characters in length, used to enable privacy-preserving tracking of unique user verifications during a billing period.
+     *             
+     * WARNING: This value must NOT change during the course of a billing period for a given Verification Profile, or double-billing may occur.
+     * If multiple Verification Profiles are configured to use the same Trinsic-managed SPID Service Provider, the same Billing Tracking Secret must be provided across all such Verification Profiles.
+     * @type {string}
+     * @memberof SpidInput
+     */
+    billingTrackingSecret?: string | null;
 }
 
 /**
@@ -47,6 +58,7 @@ export function SpidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean):
     return {
         
         'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+        'billingTrackingSecret': json['billingTrackingSecret'] == null ? undefined : json['billingTrackingSecret'],
     };
 }
 
@@ -62,6 +74,7 @@ export function SpidInputToJSONTyped(value?: SpidInput | null, ignoreDiscriminat
     return {
         
         'subProviderId': value['subProviderId'],
+        'billingTrackingSecret': value['billingTrackingSecret'],
     };
 }
 

package/src/models/SpidProviderOutput.ts

@@ -0,0 +1,192 @@
+/* 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 { SpidBillingInformation } from './SpidBillingInformation';
+import {
+    SpidBillingInformationFromJSON,
+    SpidBillingInformationFromJSONTyped,
+    SpidBillingInformationToJSON,
+    SpidBillingInformationToJSONTyped,
+} from './SpidBillingInformation';
+
+/**
+ * 
+ * @export
+ * @interface SpidProviderOutput
+ */
+export interface SpidProviderOutput {
+    /**
+     * Information about the billable status of this SPID Verification.
+     *             
+     * Present only if your account has period-based billing enabled for SPID. Contact Trinsic to enable this.
+     * @type {SpidBillingInformation}
+     * @memberof SpidProviderOutput
+     */
+    billingInformation?: SpidBillingInformation | null;
+    /**
+     * The SPID Entity ID of the Identity Provider which issued the SPID identity.
+     *             
+     * This is an HTTPS URI which uniquely identifies the IdP within the SPID federation.
+     *             
+     * A normalized / simplified representation of this value is present in the `originatingSubProviderId` field in Trinsic's normalized data model.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    identityProviderEntityId: string;
+    /**
+     * The identifier of the user's SPID credential.
+     *             
+     * This uniquely identifies the credential within the SPID federation.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    spidCode: string;
+    /**
+     * Expiration date of the user's SPID credential.
+     *             
+     * This is not the same as the expiration date of the underlying identity document (such as a passport) which was
+     * used to create the SPID identity.
+     * @type {Date}
+     * @memberof SpidProviderOutput
+     */
+    spidCredentialExpirationDate?: Date | null;
+    /**
+     * The user's place of birth.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    placeOfBirth?: string | null;
+    /**
+     * The user's county of birth.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    countyOfBirth?: string | null;
+    /**
+     * The raw, space-separated string value for the "IdCard" field from the SPID identity.
+     *             
+     * Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    rawIdCard?: string | null;
+    /**
+     * The email address of the user.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    email?: string | null;
+    /**
+     * The digital address of the user.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    digitalAddress?: string | null;
+    /**
+     * Fiscal tax number for the subject.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    fiscalNumber?: string | null;
+    /**
+     * VAT number for the subject.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    ivaCode?: string | null;
+    /**
+     * The name of the company which the user is associated with.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    companyName?: string | null;
+    /**
+     * The fiscal tax number of the company which the user is associated with.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    companyFiscalNumber?: string | null;
+    /**
+     * The registered office address of the company which the user is associated with.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    registeredOffice?: string | null;
+}
+
+/**
+ * Check if a given object implements the SpidProviderOutput interface.
+ */
+export function instanceOfSpidProviderOutput(value: object): value is SpidProviderOutput {
+    if (!('identityProviderEntityId' in value) || value['identityProviderEntityId'] === undefined) return false;
+    if (!('spidCode' in value) || value['spidCode'] === undefined) return false;
+    return true;
+}
+
+export function SpidProviderOutputFromJSON(json: any): SpidProviderOutput {
+    return SpidProviderOutputFromJSONTyped(json, false);
+}
+
+export function SpidProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SpidProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'billingInformation': json['billingInformation'] == null ? undefined : SpidBillingInformationFromJSON(json['billingInformation']),
+        'identityProviderEntityId': json['identityProviderEntityId'],
+        'spidCode': json['spidCode'],
+        'spidCredentialExpirationDate': json['spidCredentialExpirationDate'] == null ? undefined : (new Date(json['spidCredentialExpirationDate'])),
+        'placeOfBirth': json['placeOfBirth'] == null ? undefined : json['placeOfBirth'],
+        'countyOfBirth': json['countyOfBirth'] == null ? undefined : json['countyOfBirth'],
+        'rawIdCard': json['rawIdCard'] == null ? undefined : json['rawIdCard'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'digitalAddress': json['digitalAddress'] == null ? undefined : json['digitalAddress'],
+        'fiscalNumber': json['fiscalNumber'] == null ? undefined : json['fiscalNumber'],
+        'ivaCode': json['ivaCode'] == null ? undefined : json['ivaCode'],
+        'companyName': json['companyName'] == null ? undefined : json['companyName'],
+        'companyFiscalNumber': json['companyFiscalNumber'] == null ? undefined : json['companyFiscalNumber'],
+        'registeredOffice': json['registeredOffice'] == null ? undefined : json['registeredOffice'],
+    };
+}
+
+export function SpidProviderOutputToJSON(json: any): SpidProviderOutput {
+    return SpidProviderOutputToJSONTyped(json, false);
+}
+
+export function SpidProviderOutputToJSONTyped(value?: SpidProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'billingInformation': SpidBillingInformationToJSON(value['billingInformation']),
+        'identityProviderEntityId': value['identityProviderEntityId'],
+        'spidCode': value['spidCode'],
+        'spidCredentialExpirationDate': value['spidCredentialExpirationDate'] == null ? undefined : ((value['spidCredentialExpirationDate'] as any).toISOString().substring(0,10)),
+        'placeOfBirth': value['placeOfBirth'],
+        'countyOfBirth': value['countyOfBirth'],
+        'rawIdCard': value['rawIdCard'],
+        'email': value['email'],
+        'digitalAddress': value['digitalAddress'],
+        'fiscalNumber': value['fiscalNumber'],
+        'ivaCode': value['ivaCode'],
+        'companyName': value['companyName'],
+        'companyFiscalNumber': value['companyFiscalNumber'],
+        'registeredOffice': value['registeredOffice'],
+    };
+}
+