@trinsic/api 2.3.0-alpha1 → 3.0.0

package/src/models/CreateMdlExchangeRequest.ts

@@ -1,159 +0,0 @@
-/* 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

@@ -1,88 +0,0 @@
-/* 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/DocumentScanAttachments.ts

@@ -1,65 +0,0 @@
-/* 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 DocumentScanAttachments
- */
-export interface DocumentScanAttachments {
-    /**
-     * 
-     * @type {string}
-     * @memberof DocumentScanAttachments
-     */
-    report?: string | null;
-}
-
-/**
- * Check if a given object implements the DocumentScanAttachments interface.
- */
-export function instanceOfDocumentScanAttachments(value: object): value is DocumentScanAttachments {
-    return true;
-}
-
-export function DocumentScanAttachmentsFromJSON(json: any): DocumentScanAttachments {
-    return DocumentScanAttachmentsFromJSONTyped(json, false);
-}
-
-export function DocumentScanAttachmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentScanAttachments {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'report': json['report'] == null ? undefined : json['report'],
-    };
-}
-
-export function DocumentScanAttachmentsToJSON(json: any): DocumentScanAttachments {
-    return DocumentScanAttachmentsToJSONTyped(json, false);
-}
-
-export function DocumentScanAttachmentsToJSONTyped(value?: DocumentScanAttachments | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'report': value['report'],
-    };
-}
-

package/src/models/EnvironmentRedirectUrisAddRequest.ts

@@ -1,66 +0,0 @@
-/* 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 EnvironmentRedirectUrisAddRequest
- */
-export interface EnvironmentRedirectUrisAddRequest {
-    /**
-     * 
-     * @type {string}
-     * @memberof EnvironmentRedirectUrisAddRequest
-     */
-    uri: string;
-}
-
-/**
- * Check if a given object implements the EnvironmentRedirectUrisAddRequest interface.
- */
-export function instanceOfEnvironmentRedirectUrisAddRequest(value: object): value is EnvironmentRedirectUrisAddRequest {
-    if (!('uri' in value) || value['uri'] === undefined) return false;
-    return true;
-}
-
-export function EnvironmentRedirectUrisAddRequestFromJSON(json: any): EnvironmentRedirectUrisAddRequest {
-    return EnvironmentRedirectUrisAddRequestFromJSONTyped(json, false);
-}
-
-export function EnvironmentRedirectUrisAddRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnvironmentRedirectUrisAddRequest {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'uri': json['uri'],
-    };
-}
-
-export function EnvironmentRedirectUrisAddRequestToJSON(json: any): EnvironmentRedirectUrisAddRequest {
-    return EnvironmentRedirectUrisAddRequestToJSONTyped(json, false);
-}
-
-export function EnvironmentRedirectUrisAddRequestToJSONTyped(value?: EnvironmentRedirectUrisAddRequest | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'uri': value['uri'],
-    };
-}
-

package/src/models/ExternalMdlFieldData.ts

@@ -1,85 +0,0 @@
-/* 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/FieldAvailability.ts

@@ -1,54 +0,0 @@
-/* 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.
- */
-
-
-/**
- * Indicates when a field will be available in verification results.
- * @export
- */
-export const FieldAvailability = {
-    Never: 'Never',
-    Sometimes: 'Sometimes',
-    Always: 'Always'
-} as const;
-export type FieldAvailability = typeof FieldAvailability[keyof typeof FieldAvailability];
-
-
-export function instanceOfFieldAvailability(value: any): boolean {
-    for (const key in FieldAvailability) {
-        if (Object.prototype.hasOwnProperty.call(FieldAvailability, key)) {
-            if (FieldAvailability[key as keyof typeof FieldAvailability] === value) {
-                return true;
-            }
-        }
-    }
-    return false;
-}
-
-export function FieldAvailabilityFromJSON(json: any): FieldAvailability {
-    return FieldAvailabilityFromJSONTyped(json, false);
-}
-
-export function FieldAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldAvailability {
-    return json as FieldAvailability;
-}
-
-export function FieldAvailabilityToJSON(value?: FieldAvailability | null): any {
-    return value as any;
-}
-
-export function FieldAvailabilityToJSONTyped(value: any, ignoreDiscriminator: boolean): FieldAvailability {
-    return value as FieldAvailability;
-}
-

package/src/models/FinalizeMdlExchangeRequest.ts

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