@trinsic/api 2.2.0 → 2.3.0-alpha2

package/src/models/ContractIdentifierField.ts

@@ -0,0 +1,94 @@
+/* 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 { FieldAvailability } from './FieldAvailability';
+import {
+    FieldAvailabilityFromJSON,
+    FieldAvailabilityFromJSONTyped,
+    FieldAvailabilityToJSON,
+    FieldAvailabilityToJSONTyped,
+} from './FieldAvailability';
+
+/**
+ * Information about an identifier a Provider returns in verification results.
+ * @export
+ * @interface ContractIdentifierField
+ */
+export interface ContractIdentifierField {
+    /**
+     * The scope of the identifier as it appears in verification results.
+     * @type {string}
+     * @memberof ContractIdentifierField
+     */
+    scope: string;
+    /**
+     * Indicates when this field will be present in verification results.
+     * @type {FieldAvailability}
+     * @memberof ContractIdentifierField
+     */
+    outputted: FieldAvailability;
+    /**
+     * A human-readable description of the identifier, written by Trinsic.
+     * @type {string}
+     * @memberof ContractIdentifierField
+     */
+    description: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ContractIdentifierField interface.
+ */
+export function instanceOfContractIdentifierField(value: object): value is ContractIdentifierField {
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('outputted' in value) || value['outputted'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function ContractIdentifierFieldFromJSON(json: any): ContractIdentifierField {
+    return ContractIdentifierFieldFromJSONTyped(json, false);
+}
+
+export function ContractIdentifierFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContractIdentifierField {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'scope': json['scope'],
+        'outputted': FieldAvailabilityFromJSON(json['outputted']),
+        'description': json['description'],
+    };
+}
+
+export function ContractIdentifierFieldToJSON(json: any): ContractIdentifierField {
+    return ContractIdentifierFieldToJSONTyped(json, false);
+}
+
+export function ContractIdentifierFieldToJSONTyped(value?: ContractIdentifierField | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'scope': value['scope'],
+        'outputted': FieldAvailabilityToJSON(value['outputted']),
+        'description': value['description'],
+    };
+}
+

package/src/models/CreateVerificationProfileResponse.ts

@@ -0,0 +1,66 @@
+/* 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 CreateVerificationProfileResponse
+ */
+export interface CreateVerificationProfileResponse {
+    /**
+     * The ID of the verification profile
+     * @type {string}
+     * @memberof CreateVerificationProfileResponse
+     */
+    id: string;
+}
+
+/**
+ * Check if a given object implements the CreateVerificationProfileResponse interface.
+ */
+export function instanceOfCreateVerificationProfileResponse(value: object): value is CreateVerificationProfileResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function CreateVerificationProfileResponseFromJSON(json: any): CreateVerificationProfileResponse {
+    return CreateVerificationProfileResponseFromJSONTyped(json, false);
+}
+
+export function CreateVerificationProfileResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateVerificationProfileResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+    };
+}
+
+export function CreateVerificationProfileResponseToJSON(json: any): CreateVerificationProfileResponse {
+    return CreateVerificationProfileResponseToJSONTyped(json, false);
+}
+
+export function CreateVerificationProfileResponseToJSONTyped(value?: CreateVerificationProfileResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+    };
+}
+

package/src/models/EnvironmentRedirectUrisAddRequest.ts

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

@@ -0,0 +1,68 @@
+/* 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 FaydaProviderOutput
+ */
+export interface FaydaProviderOutput {
+    /**
+     * A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered.
+     *             
+     * Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when
+     * the user was initially registered to do a comparison of the subs to verify that it is the same person.
+     * @type {string}
+     * @memberof FaydaProviderOutput
+     */
+    sub?: string | null;
+}
+
+/**
+ * Check if a given object implements the FaydaProviderOutput interface.
+ */
+export function instanceOfFaydaProviderOutput(value: object): value is FaydaProviderOutput {
+    return true;
+}
+
+export function FaydaProviderOutputFromJSON(json: any): FaydaProviderOutput {
+    return FaydaProviderOutputFromJSONTyped(json, false);
+}
+
+export function FaydaProviderOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): FaydaProviderOutput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sub': json['sub'] == null ? undefined : json['sub'],
+    };
+}
+
+export function FaydaProviderOutputToJSON(json: any): FaydaProviderOutput {
+    return FaydaProviderOutputToJSONTyped(json, false);
+}
+
+export function FaydaProviderOutputToJSONTyped(value?: FaydaProviderOutput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sub': value['sub'],
+    };
+}
+

package/src/models/Identifier.ts

@@ -0,0 +1,84 @@
+/* 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 Identifier
+ */
+export interface Identifier {
+    /**
+     * 
+     * @type {string}
+     * @memberof Identifier
+     */
+    identifier: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Identifier
+     */
+    scope: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Identifier
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the Identifier interface.
+ */
+export function instanceOfIdentifier(value: object): value is Identifier {
+    if (!('identifier' in value) || value['identifier'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function IdentifierFromJSON(json: any): Identifier {
+    return IdentifierFromJSONTyped(json, false);
+}
+
+export function IdentifierFromJSONTyped(json: any, ignoreDiscriminator: boolean): Identifier {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'identifier': json['identifier'],
+        'scope': json['scope'],
+        'description': json['description'],
+    };
+}
+
+export function IdentifierToJSON(json: any): Identifier {
+    return IdentifierToJSONTyped(json, false);
+}
+
+export function IdentifierToJSONTyped(value?: Identifier | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'identifier': value['identifier'],
+        'scope': value['scope'],
+        'description': value['description'],
+    };
+}
+

package/src/models/IdentityData.ts

@@ -27,6 +27,20 @@ import {
     PersonDataToJSON,
     PersonDataToJSONTyped,
 } from './PersonData';
+import type { Identifier } from './Identifier';
+import {
+    IdentifierFromJSON,
+    IdentifierFromJSONTyped,
+    IdentifierToJSON,
+    IdentifierToJSONTyped,
+} from './Identifier';
+import type { ProviderOutput } from './ProviderOutput';
+import {
+    ProviderOutputFromJSON,
+    ProviderOutputFromJSONTyped,
+    ProviderOutputToJSON,
+    ProviderOutputToJSONTyped,
+} from './ProviderOutput';
 import type { AttachmentAccessKeys } from './AttachmentAccessKeys';
 import {
     AttachmentAccessKeysFromJSON,
@@ -84,12 +98,25 @@ export interface IdentityData {
      * @memberof IdentityData
      */
     attachmentAccessKeys?: AttachmentAccessKeys | null;
+    /**
+     * 
+     * @type {ProviderOutput}
+     * @memberof IdentityData
+     */
+    providerOutput?: ProviderOutput | null;
+    /**
+     * 
+     * @type {Array<Identifier>}
+     * @memberof IdentityData
+     */
+    identifiers: Array<Identifier>;
 }
 
 /**
  * Check if a given object implements the IdentityData interface.
  */
 export function instanceOfIdentityData(value: object): value is IdentityData {
+    if (!('identifiers' in value) || value['identifiers'] === undefined) return false;
     return true;
 }
 
@@ -109,6 +136,8 @@ export function IdentityDataFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'document': json['document'] == null ? undefined : DocumentDataFromJSON(json['document']),
         'match': json['match'] == null ? undefined : MatchDataFromJSON(json['match']),
         'attachmentAccessKeys': json['attachmentAccessKeys'] == null ? undefined : AttachmentAccessKeysFromJSON(json['attachmentAccessKeys']),
+        'providerOutput': json['providerOutput'] == null ? undefined : ProviderOutputFromJSON(json['providerOutput']),
+        'identifiers': ((json['identifiers'] as Array<any>).map(IdentifierFromJSON)),
     };
 }
 
@@ -129,6 +158,8 @@ export function IdentityDataToJSONTyped(value?: IdentityData | null, ignoreDiscr
         'document': DocumentDataToJSON(value['document']),
         'match': MatchDataToJSON(value['match']),
         'attachmentAccessKeys': AttachmentAccessKeysToJSON(value['attachmentAccessKeys']),
+        'providerOutput': ProviderOutputToJSON(value['providerOutput']),
+        'identifiers': ((value['identifiers'] as Array<any>).map(IdentifierToJSON)),
     };
 }
 

package/src/models/KenyaNidBiometric2Input.ts

@@ -0,0 +1,84 @@
+/* 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 KenyaNidBiometric2Input
+ */
+export interface KenyaNidBiometric2Input {
+    /**
+     * The user's Kenyan National ID number
+     * @type {string}
+     * @memberof KenyaNidBiometric2Input
+     */
+    idNumber?: string | null;
+    /**
+     * An array of exactly 8 images required for biometric liveness verification.
+     * The first 7 images should be liveness frames captured during the liveness detection process,
+     * and the last image (8th) should be a selfie of the user. All images must be in JPEG format
+     * and each image must be less than 15MB in size.
+     * @type {Array<string>}
+     * @memberof KenyaNidBiometric2Input
+     */
+    livenessImages?: Array<string> | null;
+    /**
+     * Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
+     * @type {string}
+     * @memberof KenyaNidBiometric2Input
+     */
+    testSelfie?: string | null;
+}
+
+/**
+ * Check if a given object implements the KenyaNidBiometric2Input interface.
+ */
+export function instanceOfKenyaNidBiometric2Input(value: object): value is KenyaNidBiometric2Input {
+    return true;
+}
+
+export function KenyaNidBiometric2InputFromJSON(json: any): KenyaNidBiometric2Input {
+    return KenyaNidBiometric2InputFromJSONTyped(json, false);
+}
+
+export function KenyaNidBiometric2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): KenyaNidBiometric2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+        'livenessImages': json['livenessImages'] == null ? undefined : json['livenessImages'],
+        'testSelfie': json['testSelfie'] == null ? undefined : json['testSelfie'],
+    };
+}
+
+export function KenyaNidBiometric2InputToJSON(json: any): KenyaNidBiometric2Input {
+    return KenyaNidBiometric2InputToJSONTyped(json, false);
+}
+
+export function KenyaNidBiometric2InputToJSONTyped(value?: KenyaNidBiometric2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+        'livenessImages': value['livenessImages'],
+        'testSelfie': value['testSelfie'],
+    };
+}
+

package/src/models/KenyaNidInput.ts

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

package/src/models/KenyaNidLookup2Input.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 KenyaNidLookup2Input
+ */
+export interface KenyaNidLookup2Input {
+    /**
+     * The user's National ID number
+     * @type {string}
+     * @memberof KenyaNidLookup2Input
+     */
+    idNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the KenyaNidLookup2Input interface.
+ */
+export function instanceOfKenyaNidLookup2Input(value: object): value is KenyaNidLookup2Input {
+    return true;
+}
+
+export function KenyaNidLookup2InputFromJSON(json: any): KenyaNidLookup2Input {
+    return KenyaNidLookup2InputFromJSONTyped(json, false);
+}
+
+export function KenyaNidLookup2InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): KenyaNidLookup2Input {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'idNumber': json['idNumber'] == null ? undefined : json['idNumber'],
+    };
+}
+
+export function KenyaNidLookup2InputToJSON(json: any): KenyaNidLookup2Input {
+    return KenyaNidLookup2InputToJSONTyped(json, false);
+}
+
+export function KenyaNidLookup2InputToJSONTyped(value?: KenyaNidLookup2Input | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'idNumber': value['idNumber'],
+    };
+}
+