@trinsic/api 2.0.0-alpha2 → 2.0.0

package/src/models/RecommendationInfo.ts

@@ -0,0 +1,90 @@
+/* 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';
+/**
+ * Information relating to a user; used to generated Identity Provider recommendations.
+ * @export
+ * @interface RecommendationInfo
+ */
+export interface RecommendationInfo {
+    /**
+     * The phone number of the user you wish to generate a recommendation for.
+     *             
+     * Will be used to look up the user's identity in the network, as well as to determine the user's geographic location.
+     * @type {string}
+     * @memberof RecommendationInfo
+     */
+    phoneNumber?: string | null;
+    /**
+     * A list of countries, in alpha-2 ISO 3166 format, which the user is related to.
+     *             
+     * This can include the user's country of residence, nationality, etc.
+     * @type {Array<string>}
+     * @memberof RecommendationInfo
+     */
+    countries?: Array<string> | null;
+    /**
+     * If one of the countries has subdivisions (for example: US states), specify those related to the user here (e.g., CA, UT, NY)
+     * @type {Array<string>}
+     * @memberof RecommendationInfo
+     */
+    subdivisions?: Array<string> | null;
+    /**
+     * Any IP addresses related to the user.
+     *             
+     * Will be used to determine the user's geographic location.
+     * @type {Array<string>}
+     * @memberof RecommendationInfo
+     */
+    ipAddresses?: Array<string> | null;
+}
+
+/**
+ * Check if a given object implements the RecommendationInfo interface.
+ */
+export function instanceOfRecommendationInfo(value: object): value is RecommendationInfo {
+    return true;
+}
+
+export function RecommendationInfoFromJSON(json: any): RecommendationInfo {
+    return RecommendationInfoFromJSONTyped(json, false);
+}
+
+export function RecommendationInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendationInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'countries': json['countries'] == null ? undefined : json['countries'],
+        'subdivisions': json['subdivisions'] == null ? undefined : json['subdivisions'],
+        'ipAddresses': json['ipAddresses'] == null ? undefined : json['ipAddresses'],
+    };
+}
+
+export function RecommendationInfoToJSON(value?: RecommendationInfo | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'phoneNumber': value['phoneNumber'],
+        'countries': value['countries'],
+        'subdivisions': value['subdivisions'],
+        'ipAddresses': value['ipAddresses'],
+    };
+}
+

package/src/models/RefreshStepContentRequest.ts

@@ -24,7 +24,7 @@ export interface RefreshStepContentRequest {
      * @type {string}
      * @memberof RefreshStepContentRequest
      */
-    resultsAccessKey?: string;
+    resultsAccessKey?: string | null;
 }
 
 /**

package/src/models/ResultCollection.ts

@@ -33,11 +33,17 @@ export interface ResultCollection {
      */
     method: ResultCollectionMethod;
     /**
-     * If the method is `PollResult`, this is the key that should be used to poll for the results.
+     * The `resultsAccessKey` for the Acceptance Session.
+     *             
+     * This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.
+     *             
+     * Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.
+     *             
+     * Trinsic cannot access a Session's Data Vault without this key.
      * @type {string}
      * @memberof ResultCollection
      */
-    resultsAccessKey?: string;
+    resultsAccessKey: string;
 }
 
 
@@ -47,6 +53,7 @@ export interface ResultCollection {
  */
 export function instanceOfResultCollection(value: object): value is ResultCollection {
     if (!('method' in value) || value['method'] === undefined) return false;
+    if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined) return false;
     return true;
 }
 
@@ -61,7 +68,7 @@ export function ResultCollectionFromJSONTyped(json: any, ignoreDiscriminator: bo
     return {
         
         'method': ResultCollectionMethodFromJSON(json['method']),
-        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+        'resultsAccessKey': json['resultsAccessKey'],
     };
 }
 

package/src/models/Session.ts

@@ -33,30 +33,30 @@ export interface Session {
      */
     id: string;
     /**
-     * Whether the Session is in a terminal / final state.
-     *             
+     * Whether the Session is in a terminal / final state.
+     *             
      * If this is `true`, inspect the value of `Success` to determine whether the Session was successful.
      * @type {boolean}
      * @memberof Session
      */
     done: boolean;
     /**
-     * Whether the Session has completed successfully.
-     *             
-     * If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information.
+     * Whether the Session has completed successfully.
+     *             
+     * If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information.
      * If this is `true`, the Session has completed successfully.
      * @type {boolean}
      * @memberof Session
      */
     success: boolean;
     /**
-     * The reason for the Session's failure.
-     *             
+     * The reason for the Session's failure.
+     *             
      * Only present if `Success` is `false`.
      * @type {SessionErrorCode}
      * @memberof Session
      */
-    errorCode?: SessionErrorCode;
+    errorCode?: SessionErrorCode | null;
     /**
      * The unix timestamp, in seconds, when this session was created
      * @type {number}

package/src/models/SmartIdInput.ts

@@ -0,0 +1,60 @@
+/* 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 SmartIdInput
+ */
+export interface SmartIdInput {
+    /**
+     * The user's Smart ID Document Number
+     * @type {string}
+     * @memberof SmartIdInput
+     */
+    smartIdDocumentNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the SmartIdInput interface.
+ */
+export function instanceOfSmartIdInput(value: object): value is SmartIdInput {
+    return true;
+}
+
+export function SmartIdInputFromJSON(json: any): SmartIdInput {
+    return SmartIdInputFromJSONTyped(json, false);
+}
+
+export function SmartIdInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmartIdInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'smartIdDocumentNumber': json['smartIdDocumentNumber'] == null ? undefined : json['smartIdDocumentNumber'],
+    };
+}
+
+export function SmartIdInputToJSON(value?: SmartIdInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'smartIdDocumentNumber': value['smartIdDocumentNumber'],
+    };
+}
+

package/src/models/SouthAfricaNidInput.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 SouthAfricaNidInput
+ */
+export interface SouthAfricaNidInput {
+    /**
+     * The user's full name as it appears in their National ID
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    fullName: string;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof SouthAfricaNidInput
+     */
+    dateOfBirth: Date;
+    /**
+     * The user's gender as it appears in their National ID (e.g., male, female)
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    gender: string;
+    /**
+     * The user's South African National ID number
+     * @type {string}
+     * @memberof SouthAfricaNidInput
+     */
+    nationalIdNumber: string;
+}
+
+/**
+ * Check if a given object implements the SouthAfricaNidInput interface.
+ */
+export function instanceOfSouthAfricaNidInput(value: object): value is SouthAfricaNidInput {
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined) return false;
+    if (!('gender' in value) || value['gender'] === undefined) return false;
+    if (!('nationalIdNumber' in value) || value['nationalIdNumber'] === undefined) return false;
+    return true;
+}
+
+export function SouthAfricaNidInputFromJSON(json: any): SouthAfricaNidInput {
+    return SouthAfricaNidInputFromJSONTyped(json, false);
+}
+
+export function SouthAfricaNidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'fullName': json['fullName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'gender': json['gender'],
+        'nationalIdNumber': json['nationalIdNumber'],
+    };
+}
+
+export function SouthAfricaNidInputToJSON(value?: SouthAfricaNidInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'fullName': value['fullName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0,10)),
+        'gender': value['gender'],
+        'nationalIdNumber': value['nationalIdNumber'],
+    };
+}
+

package/src/models/SpidInput.ts

@@ -0,0 +1,62 @@
+/* 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 SpidInput
+ */
+export interface SpidInput {
+    /**
+     * The ID of the specific IDP to invoke within SPID.
+     *             
+     * If not specified, the user will be prompted to select an IDP.
+     * @type {string}
+     * @memberof SpidInput
+     */
+    subProviderId?: string | null;
+}
+
+/**
+ * Check if a given object implements the SpidInput interface.
+ */
+export function instanceOfSpidInput(value: object): value is SpidInput {
+    return true;
+}
+
+export function SpidInputFromJSON(json: any): SpidInput {
+    return SpidInputFromJSONTyped(json, false);
+}
+
+export function SpidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SpidInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+    };
+}
+
+export function SpidInputToJSON(value?: SpidInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'subProviderId': value['subProviderId'],
+    };
+}
+

package/src/models/StepRefreshInfo.ts

@@ -20,8 +20,8 @@ import { mapValues } from '../runtime';
  */
 export interface StepRefreshInfo {
     /**
-     * The UTC date/time at which the step `content` will expire and should no longer be used.
-     *             
+     * The UTC date/time at which the step `content` will expire and should no longer be used.
+     *             
      * Use the `Refresh Step Content` API to obtain a new value for `content`.
      * @type {Date}
      * @memberof StepRefreshInfo

package/src/models/SubProviderMetadata.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';
+/**
+ * Information about a sub-provider.
+ * @export
+ * @interface SubProviderMetadata
+ */
+export interface SubProviderMetadata {
+    /**
+     * The ID of the sub-provider.
+     *             
+     * This cannot be used as a standalone Provider ID when creating a Session. It must
+     * be passed in via the Provider-specific input.
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    id: string;
+    /**
+     * The name of the sub-provider
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    name: string;
+    /**
+     * Flavor text for the sub-provider
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    description: string;
+    /**
+     * A URL pointing to the logo on Trinsic's CDN.
+     *             
+     * May be a PNG, JPG, or SVG image.
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    logoUrl: string;
+}
+
+/**
+ * Check if a given object implements the SubProviderMetadata interface.
+ */
+export function instanceOfSubProviderMetadata(value: object): value is SubProviderMetadata {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined) return false;
+    return true;
+}
+
+export function SubProviderMetadataFromJSON(json: any): SubProviderMetadata {
+    return SubProviderMetadataFromJSONTyped(json, false);
+}
+
+export function SubProviderMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubProviderMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+    };
+}
+
+export function SubProviderMetadataToJSON(value?: SubProviderMetadata | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'logoUrl': value['logoUrl'],
+    };
+}
+

package/src/models/TrinsicTestDatabaseLookupInput.ts

@@ -0,0 +1,101 @@
+/* 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 TrinsicTestDatabaseLookupInput
+ */
+export interface TrinsicTestDatabaseLookupInput {
+    /**
+     * The given name to use for the output of the test Session.
+     *             
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *             
+     * Can be any non-empty value.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    givenName?: string | null;
+    /**
+     * The family name to use for the output of the test Session.
+     *             
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *             
+     * Can be any non-empty value.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    familyName?: string | null;
+    /**
+     * A 6-digit code; must be "123456" for the Session to succeed.
+     *             
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *             
+     * Any other value will cause the Session to fail.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    identityCode?: string | null;
+    /**
+     * An optional selfie image, base64-encoded.
+     *             
+     * Will replace the existing test selfie attachment output if provided.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    selfieBase64?: string | null;
+}
+
+/**
+ * Check if a given object implements the TrinsicTestDatabaseLookupInput interface.
+ */
+export function instanceOfTrinsicTestDatabaseLookupInput(value: object): value is TrinsicTestDatabaseLookupInput {
+    return true;
+}
+
+export function TrinsicTestDatabaseLookupInputFromJSON(json: any): TrinsicTestDatabaseLookupInput {
+    return TrinsicTestDatabaseLookupInputFromJSONTyped(json, false);
+}
+
+export function TrinsicTestDatabaseLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestDatabaseLookupInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'givenName': json['givenName'] == null ? undefined : json['givenName'],
+        'familyName': json['familyName'] == null ? undefined : json['familyName'],
+        'identityCode': json['identityCode'] == null ? undefined : json['identityCode'],
+        'selfieBase64': json['selfieBase64'] == null ? undefined : json['selfieBase64'],
+    };
+}
+
+export function TrinsicTestDatabaseLookupInputToJSON(value?: TrinsicTestDatabaseLookupInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'identityCode': value['identityCode'],
+        'selfieBase64': value['selfieBase64'],
+    };
+}
+

package/src/models/TrinsicTestSubProvidersInput.ts

@@ -0,0 +1,64 @@
+/* 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 TrinsicTestSubProvidersInput
+ */
+export interface TrinsicTestSubProvidersInput {
+    /**
+     * The ID of the specific IDP to invoke within the test federated provider.
+     *             
+     * Valid options are `sub-provider-a` and `sub-provider-b`.
+     *             
+     * If not specified, the user will be prompted to select one.
+     * @type {string}
+     * @memberof TrinsicTestSubProvidersInput
+     */
+    subProviderId?: string | null;
+}
+
+/**
+ * Check if a given object implements the TrinsicTestSubProvidersInput interface.
+ */
+export function instanceOfTrinsicTestSubProvidersInput(value: object): value is TrinsicTestSubProvidersInput {
+    return true;
+}
+
+export function TrinsicTestSubProvidersInputFromJSON(json: any): TrinsicTestSubProvidersInput {
+    return TrinsicTestSubProvidersInputFromJSONTyped(json, false);
+}
+
+export function TrinsicTestSubProvidersInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestSubProvidersInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+    };
+}
+
+export function TrinsicTestSubProvidersInputToJSON(value?: TrinsicTestSubProvidersInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'subProviderId': value['subProviderId'],
+    };
+}
+