@trinsic/api 2.1.1-alpha1 → 2.2.0-alpha1

package/src/models/CreateMdlExchangeRequest.ts

@@ -0,0 +1,159 @@
+/* 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 { MdlExchangeMechanism } from './MdlExchangeMechanism';
+import {
+    MdlExchangeMechanismFromJSON,
+    MdlExchangeMechanismFromJSONTyped,
+    MdlExchangeMechanismToJSON,
+    MdlExchangeMechanismToJSONTyped,
+} from './MdlExchangeMechanism';
+
+/**
+ * Request to create an mDL Exchange.
+ * @export
+ * @interface CreateMdlExchangeRequest
+ */
+export interface CreateMdlExchangeRequest {
+    /**
+     * The ID of the VerificationProfile to use for this mDL exchange.
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    verificationProfileId: string;
+    /**
+     * The ID of the provider to use for this mDL exchange.
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    provider: string;
+    /**
+     * The mechanism by which the mDL exchange will occur (web, native SDK, etc.)
+     * @type {MdlExchangeMechanism}
+     * @memberof CreateMdlExchangeRequest
+     */
+    exchangeMechanism: MdlExchangeMechanism;
+    /**
+     * The document type to request from the wallet.
+     *             
+     * Typically, this is one of the following values:
+     *             
+     * - `org.iso.18013.5.1.mDL` (Mobile Driver's License)
+     * - `com.google.wallet.idcard.1` (Google Wallet ID Pass)
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    documentType: string;
+    /**
+     * The namespaces and fields to request from the mDL.
+     *             
+     * This is a nested map / dictionary. The outer dictionary's keys are namespaces (e.g. "org.iso.18013.5.1").
+     * The inner dictionary's keys are field names within each namespace, with boolean values indicating
+     * whether the specified field will be retained post-verification.
+     * @type {{ [key: string]: { [key: string]: boolean; }; }}
+     * @memberof CreateMdlExchangeRequest
+     */
+    nameSpaces: { [key: string]: { [key: string]: boolean; }; };
+    /**
+     * If using the `DigitalCredentialsApi` exchange mechanism, this is the hostname on which
+     * the Digital Credentials API will be called.
+     *             
+     * For example, if the user is on the page `https://foo.example.com/verify-mdl`, the proper value to use
+     * is `foo.example.com`.
+     *             
+     * Present for ease of testing only. May be removed as this API is stabilized.
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    digitalCredentialsApiHost?: string | null;
+    /**
+     * If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the package name
+     * of the Android App which will execute the mDL exchange.
+     *             
+     * This should be set to the package name of your app.
+     *             
+     * Present for ease of testing only. May be removed as this API is stabilized.
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    androidNativeAppPackageName?: string | null;
+    /**
+     * If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the SHA-256
+     * fingerprint of the signing certificate used to sign the Android App which will execute the mDL exchange.
+     *             
+     * Present for ease of testing only. May be removed as this API is stabilized.
+     * @type {string}
+     * @memberof CreateMdlExchangeRequest
+     */
+    androidNativeAppSigningCertificateFingerprint?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateMdlExchangeRequest interface.
+ */
+export function instanceOfCreateMdlExchangeRequest(value: object): value is CreateMdlExchangeRequest {
+    if (!('verificationProfileId' in value) || value['verificationProfileId'] === undefined) return false;
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    if (!('exchangeMechanism' in value) || value['exchangeMechanism'] === undefined) return false;
+    if (!('documentType' in value) || value['documentType'] === undefined) return false;
+    if (!('nameSpaces' in value) || value['nameSpaces'] === undefined) return false;
+    return true;
+}
+
+export function CreateMdlExchangeRequestFromJSON(json: any): CreateMdlExchangeRequest {
+    return CreateMdlExchangeRequestFromJSONTyped(json, false);
+}
+
+export function CreateMdlExchangeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateMdlExchangeRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'verificationProfileId': json['verificationProfileId'],
+        'provider': json['provider'],
+        'exchangeMechanism': MdlExchangeMechanismFromJSON(json['exchangeMechanism']),
+        'documentType': json['documentType'],
+        'nameSpaces': json['nameSpaces'],
+        'digitalCredentialsApiHost': json['digitalCredentialsApiHost'] == null ? undefined : json['digitalCredentialsApiHost'],
+        'androidNativeAppPackageName': json['androidNativeAppPackageName'] == null ? undefined : json['androidNativeAppPackageName'],
+        'androidNativeAppSigningCertificateFingerprint': json['androidNativeAppSigningCertificateFingerprint'] == null ? undefined : json['androidNativeAppSigningCertificateFingerprint'],
+    };
+}
+
+export function CreateMdlExchangeRequestToJSON(json: any): CreateMdlExchangeRequest {
+    return CreateMdlExchangeRequestToJSONTyped(json, false);
+}
+
+export function CreateMdlExchangeRequestToJSONTyped(value?: CreateMdlExchangeRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'verificationProfileId': value['verificationProfileId'],
+        'provider': value['provider'],
+        'exchangeMechanism': MdlExchangeMechanismToJSON(value['exchangeMechanism']),
+        'documentType': value['documentType'],
+        'nameSpaces': value['nameSpaces'],
+        'digitalCredentialsApiHost': value['digitalCredentialsApiHost'],
+        'androidNativeAppPackageName': value['androidNativeAppPackageName'],
+        'androidNativeAppSigningCertificateFingerprint': value['androidNativeAppSigningCertificateFingerprint'],
+    };
+}
+

package/src/models/CreateMdlExchangeResponse.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';
+/**
+ * 
+ * @export
+ * @interface CreateMdlExchangeResponse
+ */
+export interface CreateMdlExchangeResponse {
+    /**
+     * The ID of the mDL exchange which was created.
+     * @type {string}
+     * @memberof CreateMdlExchangeResponse
+     */
+    exchangeId: string;
+    /**
+     * The request object for this mDL exchange.
+     *             
+     * Pass this into a Trinsic mDL SDK (Web, iOS, Android) exactly as-is to initiate the mDL exchange.
+     * @type {string}
+     * @memberof CreateMdlExchangeResponse
+     */
+    requestObjectBase64Url: string;
+    /**
+     * The encrypted exchange context for this mDL exchange.
+     *             
+     * This must be passed back to the API during finalization, alongside the response token from the wallet.
+     * @type {string}
+     * @memberof CreateMdlExchangeResponse
+     */
+    exchangeContext: string;
+}
+
+/**
+ * Check if a given object implements the CreateMdlExchangeResponse interface.
+ */
+export function instanceOfCreateMdlExchangeResponse(value: object): value is CreateMdlExchangeResponse {
+    if (!('exchangeId' in value) || value['exchangeId'] === undefined) return false;
+    if (!('requestObjectBase64Url' in value) || value['requestObjectBase64Url'] === undefined) return false;
+    if (!('exchangeContext' in value) || value['exchangeContext'] === undefined) return false;
+    return true;
+}
+
+export function CreateMdlExchangeResponseFromJSON(json: any): CreateMdlExchangeResponse {
+    return CreateMdlExchangeResponseFromJSONTyped(json, false);
+}
+
+export function CreateMdlExchangeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateMdlExchangeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'exchangeId': json['exchangeId'],
+        'requestObjectBase64Url': json['requestObjectBase64Url'],
+        'exchangeContext': json['exchangeContext'],
+    };
+}
+
+export function CreateMdlExchangeResponseToJSON(json: any): CreateMdlExchangeResponse {
+    return CreateMdlExchangeResponseToJSONTyped(json, false);
+}
+
+export function CreateMdlExchangeResponseToJSONTyped(value?: CreateMdlExchangeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'exchangeId': value['exchangeId'],
+        'requestObjectBase64Url': value['requestObjectBase64Url'],
+        'exchangeContext': value['exchangeContext'],
+    };
+}
+

package/src/models/CreateWidgetSessionRequest.ts

@@ -27,11 +27,17 @@ import {
  * @interface CreateWidgetSessionRequest
  */
 export interface CreateWidgetSessionRequest {
+    /**
+     * The ID of the Verification Profile to use for this session.
+     * @type {string}
+     * @memberof CreateWidgetSessionRequest
+     */
+    verificationProfileId: string;
     /**
      * The URL to redirect the user to after the widget session is complete.
      *             
      * *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget
-     * as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect.
+     * as a popup; in that case, session resolution is handled by our SDK, not via redirect.
      * @type {string}
      * @memberof CreateWidgetSessionRequest
      */
@@ -57,6 +63,7 @@ export interface CreateWidgetSessionRequest {
  * Check if a given object implements the CreateWidgetSessionRequest interface.
  */
 export function instanceOfCreateWidgetSessionRequest(value: object): value is CreateWidgetSessionRequest {
+    if (!('verificationProfileId' in value) || value['verificationProfileId'] === undefined) return false;
     return true;
 }
 
@@ -70,6 +77,7 @@ export function CreateWidgetSessionRequestFromJSONTyped(json: any, ignoreDiscrim
     }
     return {
         
+        'verificationProfileId': json['verificationProfileId'],
         'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
         'providers': json['providers'] == null ? undefined : json['providers'],
         'recommendationInfo': json['recommendationInfo'] == null ? undefined : RecommendationInfoFromJSON(json['recommendationInfo']),
@@ -87,6 +95,7 @@ export function CreateWidgetSessionRequestToJSONTyped(value?: CreateWidgetSessio
 
     return {
         
+        'verificationProfileId': value['verificationProfileId'],
         'redirectUrl': value['redirectUrl'],
         'providers': value['providers'],
         'recommendationInfo': RecommendationInfoToJSON(value['recommendationInfo']),

package/src/models/ExternalMdlFieldData.ts

@@ -0,0 +1,85 @@
+/* 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 { MdlFieldDataType } from './MdlFieldDataType';
+import {
+    MdlFieldDataTypeFromJSON,
+    MdlFieldDataTypeFromJSONTyped,
+    MdlFieldDataTypeToJSON,
+    MdlFieldDataTypeToJSONTyped,
+} from './MdlFieldDataType';
+
+/**
+ * 
+ * @export
+ * @interface ExternalMdlFieldData
+ */
+export interface ExternalMdlFieldData {
+    /**
+     * The type of data contained in `value`.
+     * @type {MdlFieldDataType}
+     * @memberof ExternalMdlFieldData
+     */
+    type: MdlFieldDataType;
+    /**
+     * The string-encoded value of the field.
+     * @type {string}
+     * @memberof ExternalMdlFieldData
+     */
+    value: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ExternalMdlFieldData interface.
+ */
+export function instanceOfExternalMdlFieldData(value: object): value is ExternalMdlFieldData {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function ExternalMdlFieldDataFromJSON(json: any): ExternalMdlFieldData {
+    return ExternalMdlFieldDataFromJSONTyped(json, false);
+}
+
+export function ExternalMdlFieldDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExternalMdlFieldData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': MdlFieldDataTypeFromJSON(json['type']),
+        'value': json['value'],
+    };
+}
+
+export function ExternalMdlFieldDataToJSON(json: any): ExternalMdlFieldData {
+    return ExternalMdlFieldDataToJSONTyped(json, false);
+}
+
+export function ExternalMdlFieldDataToJSONTyped(value?: ExternalMdlFieldData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': MdlFieldDataTypeToJSON(value['type']),
+        'value': value['value'],
+    };
+}
+

package/src/models/FinalizeMdlExchangeRequest.ts

@@ -0,0 +1,93 @@
+/* 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 FinalizeMdlExchangeRequest
+ */
+export interface FinalizeMdlExchangeRequest {
+    /**
+     * The ID of the VerificationProfile which was used to create the mDL exchange.
+     * @type {string}
+     * @memberof FinalizeMdlExchangeRequest
+     */
+    verificationProfileId: string;
+    /**
+     * The ID of the mDL exchange to finalize.
+     * @type {string}
+     * @memberof FinalizeMdlExchangeRequest
+     */
+    exchangeId: string;
+    /**
+     * The encrypted exchange context which was returned when the mDL exchange was created.
+     * @type {string}
+     * @memberof FinalizeMdlExchangeRequest
+     */
+    exchangeContext: string;
+    /**
+     * The response token returned by Trinsic's SDK after a successful mDL exchange.
+     * @type {string}
+     * @memberof FinalizeMdlExchangeRequest
+     */
+    responseToken: string;
+}
+
+/**
+ * Check if a given object implements the FinalizeMdlExchangeRequest interface.
+ */
+export function instanceOfFinalizeMdlExchangeRequest(value: object): value is FinalizeMdlExchangeRequest {
+    if (!('verificationProfileId' in value) || value['verificationProfileId'] === undefined) return false;
+    if (!('exchangeId' in value) || value['exchangeId'] === undefined) return false;
+    if (!('exchangeContext' in value) || value['exchangeContext'] === undefined) return false;
+    if (!('responseToken' in value) || value['responseToken'] === undefined) return false;
+    return true;
+}
+
+export function FinalizeMdlExchangeRequestFromJSON(json: any): FinalizeMdlExchangeRequest {
+    return FinalizeMdlExchangeRequestFromJSONTyped(json, false);
+}
+
+export function FinalizeMdlExchangeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FinalizeMdlExchangeRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'verificationProfileId': json['verificationProfileId'],
+        'exchangeId': json['exchangeId'],
+        'exchangeContext': json['exchangeContext'],
+        'responseToken': json['responseToken'],
+    };
+}
+
+export function FinalizeMdlExchangeRequestToJSON(json: any): FinalizeMdlExchangeRequest {
+    return FinalizeMdlExchangeRequestToJSONTyped(json, false);
+}
+
+export function FinalizeMdlExchangeRequestToJSONTyped(value?: FinalizeMdlExchangeRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'verificationProfileId': value['verificationProfileId'],
+        'exchangeId': value['exchangeId'],
+        'exchangeContext': value['exchangeContext'],
+        'responseToken': value['responseToken'],
+    };
+}
+

package/src/models/FinalizeMdlExchangeResponse.ts

@@ -0,0 +1,115 @@
+/* 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 { MdlIdentityData } from './MdlIdentityData';
+import {
+    MdlIdentityDataFromJSON,
+    MdlIdentityDataFromJSONTyped,
+    MdlIdentityDataToJSON,
+    MdlIdentityDataToJSONTyped,
+} from './MdlIdentityData';
+import type { IdentityData } from './IdentityData';
+import {
+    IdentityDataFromJSON,
+    IdentityDataFromJSONTyped,
+    IdentityDataToJSON,
+    IdentityDataToJSONTyped,
+} from './IdentityData';
+import type { Session } from './Session';
+import {
+    SessionFromJSON,
+    SessionFromJSONTyped,
+    SessionToJSON,
+    SessionToJSONTyped,
+} from './Session';
+
+/**
+ * 
+ * @export
+ * @interface FinalizeMdlExchangeResponse
+ */
+export interface FinalizeMdlExchangeResponse {
+    /**
+     * The Exchange ID of the mDL exchange which was just finalized.
+     * @type {string}
+     * @memberof FinalizeMdlExchangeResponse
+     */
+    exchangeId: string;
+    /**
+     * The AcceptanceSession which was created as a result of finalizing this mDL exchange.
+     * @type {Session}
+     * @memberof FinalizeMdlExchangeResponse
+     */
+    createdSession: Session;
+    /**
+     * The identity data from the mDL exchange, in a semi-normalized format.
+     *             
+     * Supports all possible fields and namespaces, but does not map them to Trinsic's common data model.
+     * @type {MdlIdentityData}
+     * @memberof FinalizeMdlExchangeResponse
+     */
+    mdlData?: MdlIdentityData | null;
+    /**
+     * The identity data from the mDL exchange, normalized into Trinsic's common data model.
+     * @type {IdentityData}
+     * @memberof FinalizeMdlExchangeResponse
+     */
+    normalizedIdentityData?: IdentityData | null;
+}
+
+/**
+ * Check if a given object implements the FinalizeMdlExchangeResponse interface.
+ */
+export function instanceOfFinalizeMdlExchangeResponse(value: object): value is FinalizeMdlExchangeResponse {
+    if (!('exchangeId' in value) || value['exchangeId'] === undefined) return false;
+    if (!('createdSession' in value) || value['createdSession'] === undefined) return false;
+    return true;
+}
+
+export function FinalizeMdlExchangeResponseFromJSON(json: any): FinalizeMdlExchangeResponse {
+    return FinalizeMdlExchangeResponseFromJSONTyped(json, false);
+}
+
+export function FinalizeMdlExchangeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FinalizeMdlExchangeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'exchangeId': json['exchangeId'],
+        'createdSession': SessionFromJSON(json['createdSession']),
+        'mdlData': json['mdlData'] == null ? undefined : MdlIdentityDataFromJSON(json['mdlData']),
+        'normalizedIdentityData': json['normalizedIdentityData'] == null ? undefined : IdentityDataFromJSON(json['normalizedIdentityData']),
+    };
+}
+
+export function FinalizeMdlExchangeResponseToJSON(json: any): FinalizeMdlExchangeResponse {
+    return FinalizeMdlExchangeResponseToJSONTyped(json, false);
+}
+
+export function FinalizeMdlExchangeResponseToJSONTyped(value?: FinalizeMdlExchangeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'exchangeId': value['exchangeId'],
+        'createdSession': SessionToJSON(value['createdSession']),
+        'mdlData': MdlIdentityDataToJSON(value['mdlData']),
+        'normalizedIdentityData': IdentityDataToJSON(value['normalizedIdentityData']),
+    };
+}
+

package/src/models/GetAttachmentRequest.ts

@@ -25,6 +25,12 @@ export interface GetAttachmentRequest {
      * @memberof GetAttachmentRequest
      */
     attachmentAccessKey: string;
+    /**
+     * The ID of the Acceptance Session for which the Attachment is being requested.
+     * @type {string}
+     * @memberof GetAttachmentRequest
+     */
+    sessionId: string;
 }
 
 /**
@@ -32,6 +38,7 @@ export interface GetAttachmentRequest {
  */
 export function instanceOfGetAttachmentRequest(value: object): value is GetAttachmentRequest {
     if (!('attachmentAccessKey' in value) || value['attachmentAccessKey'] === undefined) return false;
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
     return true;
 }
 
@@ -46,6 +53,7 @@ export function GetAttachmentRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'attachmentAccessKey': json['attachmentAccessKey'],
+        'sessionId': json['sessionId'],
     };
 }
 
@@ -61,6 +69,7 @@ export function GetAttachmentRequestToJSONTyped(value?: GetAttachmentRequest | n
     return {
         
         'attachmentAccessKey': value['attachmentAccessKey'],
+        'sessionId': value['sessionId'],
     };
 }