@trinsic/api 2.2.0 → 2.3.0-alpha1

package/src/models/ProviderContract.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContractIdentifierField } from './ContractIdentifierField';
+import {
+    ContractIdentifierFieldFromJSON,
+    ContractIdentifierFieldFromJSONTyped,
+    ContractIdentifierFieldToJSON,
+    ContractIdentifierFieldToJSONTyped,
+} from './ContractIdentifierField';
 import type { ContractField } from './ContractField';
 import {
     ContractFieldFromJSON,
@@ -191,6 +198,12 @@ export interface ProviderContract {
      * @memberof ProviderContract
      */
     availableFields?: Array<ContractField> | null;
+    /**
+     * Information about the identifiers this Provider returns in verification results.
+     * @type {Array<ContractIdentifierField>}
+     * @memberof ProviderContract
+     */
+    availableIdentifiers?: Array<ContractIdentifierField> | null;
     /**
      * Metadata about the sub-providers which are available for this Provider.
      *             
@@ -260,6 +273,7 @@ export function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: bo
         'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
         'supportsDirectProviderSessions': json['supportsDirectProviderSessions'],
         'availableFields': json['availableFields'] == null ? undefined : ((json['availableFields'] as Array<any>).map(ContractFieldFromJSON)),
+        'availableIdentifiers': json['availableIdentifiers'] == null ? undefined : ((json['availableIdentifiers'] as Array<any>).map(ContractIdentifierFieldFromJSON)),
         'subProviders': json['subProviders'] == null ? undefined : ((json['subProviders'] as Array<any>).map(SubProviderMetadataFromJSON)),
         'health': ProviderHealthFromJSON(json['health']),
     };
@@ -293,6 +307,7 @@ export function ProviderContractToJSONTyped(value?: ProviderContract | null, ign
         'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
         'supportsDirectProviderSessions': value['supportsDirectProviderSessions'],
         'availableFields': value['availableFields'] == null ? undefined : ((value['availableFields'] as Array<any>).map(ContractFieldToJSON)),
+        'availableIdentifiers': value['availableIdentifiers'] == null ? undefined : ((value['availableIdentifiers'] as Array<any>).map(ContractIdentifierFieldToJSON)),
         'subProviders': value['subProviders'] == null ? undefined : ((value['subProviders'] as Array<any>).map(SubProviderMetadataToJSON)),
         'health': ProviderHealthToJSON(value['health']),
     };

package/src/models/ProviderOutput.ts

@@ -0,0 +1,103 @@
+/* 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 { 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;
+}
+
+/**
+ * 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']),
+    };
+}
+
+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']),
+    };
+}
+

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/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,110 @@
+/* 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;
+    /**
+     * Fiscal tax number for the subject.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    fiscalNumber?: string | null;
+    /**
+     * Unique user identifier contained within the SPID identity.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    spidCode?: string | null;
+    /**
+     * VAT number for the subject.
+     * @type {string}
+     * @memberof SpidProviderOutput
+     */
+    ivaCode?: string | null;
+    /**
+     * 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;
+}
+
+/**
+ * Check if a given object implements the SpidProviderOutput interface.
+ */
+export function instanceOfSpidProviderOutput(value: object): value is SpidProviderOutput {
+    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']),
+        'fiscalNumber': json['fiscalNumber'] == null ? undefined : json['fiscalNumber'],
+        'spidCode': json['spidCode'] == null ? undefined : json['spidCode'],
+        'ivaCode': json['ivaCode'] == null ? undefined : json['ivaCode'],
+        'spidCredentialExpirationDate': json['spidCredentialExpirationDate'] == null ? undefined : (new Date(json['spidCredentialExpirationDate'])),
+    };
+}
+
+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']),
+        'fiscalNumber': value['fiscalNumber'],
+        'spidCode': value['spidCode'],
+        'ivaCode': value['ivaCode'],
+        'spidCredentialExpirationDate': value['spidCredentialExpirationDate'] == null ? undefined : ((value['spidCredentialExpirationDate'] as any).toISOString().substring(0,10)),
+    };
+}
+

package/src/models/VerificationProfileResponse.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';
+/**
+ * 
+ * @export
+ * @interface VerificationProfileResponse
+ */
+export interface VerificationProfileResponse {
+    /**
+     * The ID of the verification profile
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    id: string;
+    /**
+     * An alias of the verification profile shown to developers and administrators.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    alias: string;
+    /**
+     * The brand name of the verification profile shown to end-users.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    brandName: string;
+    /**
+     * The URL of the verification profile's logo.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    logoUrl: string;
+    /**
+     * The primary color of the verification profile.
+     * @type {string}
+     * @memberof VerificationProfileResponse
+     */
+    primaryColor: string;
+    /**
+     * The providers that are currently enabled for the verification profile.
+     * @type {Array<string>}
+     * @memberof VerificationProfileResponse
+     */
+    enabledProviders: Array<string>;
+}
+
+/**
+ * Check if a given object implements the VerificationProfileResponse interface.
+ */
+export function instanceOfVerificationProfileResponse(value: object): value is VerificationProfileResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('alias' in value) || value['alias'] === undefined) return false;
+    if (!('brandName' in value) || value['brandName'] === undefined) return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined) return false;
+    if (!('primaryColor' in value) || value['primaryColor'] === undefined) return false;
+    if (!('enabledProviders' in value) || value['enabledProviders'] === undefined) return false;
+    return true;
+}
+
+export function VerificationProfileResponseFromJSON(json: any): VerificationProfileResponse {
+    return VerificationProfileResponseFromJSONTyped(json, false);
+}
+
+export function VerificationProfileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VerificationProfileResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'alias': json['alias'],
+        'brandName': json['brandName'],
+        'logoUrl': json['logoUrl'],
+        'primaryColor': json['primaryColor'],
+        'enabledProviders': json['enabledProviders'],
+    };
+}
+
+export function VerificationProfileResponseToJSON(json: any): VerificationProfileResponse {
+    return VerificationProfileResponseToJSONTyped(json, false);
+}
+
+export function VerificationProfileResponseToJSONTyped(value?: VerificationProfileResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'alias': value['alias'],
+        'brandName': value['brandName'],
+        'logoUrl': value['logoUrl'],
+        'primaryColor': value['primaryColor'],
+        'enabledProviders': value['enabledProviders'],
+    };
+}
+

package/src/models/index.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AadhaarInput';
+export * from './AddRedirectUriResponse';
 export * from './Address';
 export * from './AppleWalletInput';
 export * from './AttachmentAccessKeys';
@@ -9,18 +10,22 @@ export * from './BrazilCpfCheckInput';
 export * from './BrazilDigitalCnhInput';
 export * from './CancelSessionResponse';
 export * from './ContractField';
+export * from './ContractIdentifierField';
 export * from './CreateDirectProviderSessionRequest';
 export * from './CreateDirectProviderSessionResponse';
 export * from './CreateHostedProviderSessionRequest';
 export * from './CreateHostedProviderSessionResponse';
 export * from './CreateMdlExchangeRequest';
 export * from './CreateMdlExchangeResponse';
+export * from './CreateVerificationProfileResponse';
 export * from './CreateWidgetSessionRequest';
 export * from './CreateWidgetSessionResponse';
 export * from './DocumentData';
 export * from './DocumentScanAttachments';
 export * from './DocumentType';
+export * from './EnvironmentRedirectUrisAddRequest';
 export * from './ExternalMdlFieldData';
+export * from './FaydaProviderOutput';
 export * from './FieldAvailability';
 export * from './FinalizeMdlExchangeRequest';
 export * from './FinalizeMdlExchangeResponse';
@@ -31,6 +36,7 @@ export * from './GetSessionResultRequest';
 export * from './GetSessionResultResponse';
 export * from './GoogleWalletInput';
 export * from './HttpValidationProblemDetails';
+export * from './Identifier';
 export * from './IdentityData';
 export * from './IdinInput';
 export * from './IndonesiaDukcapilMatchInput';
@@ -40,9 +46,11 @@ export * from './IntegrationLaunchMethod';
 export * from './IntegrationStep';
 export * from './KenyaNidInput';
 export * from './Language';
+export * from './ListEnvironmentRedirectUrisResponse';
 export * from './ListProviderContractsResponse';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
+export * from './ListVerificationProfilesResponse';
 export * from './Match';
 export * from './MatchData';
 export * from './MdlCertificateData';
@@ -50,6 +58,7 @@ export * from './MdlExchangeMechanism';
 export * from './MdlFieldDataType';
 export * from './MdlIdentityData';
 export * from './MexicoCurpInput';
+export * from './MexicoCurpProviderOutput';
 export * from './MobileIdInput';
 export * from './NigeriaNinInput';
 export * from './OrderDirection';
@@ -63,9 +72,11 @@ export * from './ProviderHealth';
 export * from './ProviderInfo';
 export * from './ProviderInformation';
 export * from './ProviderInput';
+export * from './ProviderOutput';
 export * from './RecommendRequest';
 export * from './RecommendResponse';
 export * from './RecommendationInfo';
+export * from './RedirectUriResponse';
 export * from './RefreshStepContentRequest';
 export * from './RefreshStepContentResponse';
 export * from './ResultCollection';
@@ -76,10 +87,13 @@ export * from './SessionOrdering';
 export * from './Sex';
 export * from './SmartIdInput';
 export * from './SouthAfricaNidInput';
+export * from './SpidBillingInformation';
 export * from './SpidInput';
+export * from './SpidProviderOutput';
 export * from './StepRefreshInfo';
 export * from './SubProviderMetadata';
 export * from './SubmitNativeChallengeResponseRequest';
 export * from './SubmitNativeChallengeResponseResponse';
 export * from './TrinsicTestDatabaseLookupInput';
 export * from './TrinsicTestSubProvidersInput';
+export * from './VerificationProfileResponse';