@trinsic/api 2.0.0-alpha2 → 2.0.0

package/dist/models/RecommendationInfo.js

@@ -0,0 +1,50 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfRecommendationInfo = instanceOfRecommendationInfo;
+exports.RecommendationInfoFromJSON = RecommendationInfoFromJSON;
+exports.RecommendationInfoFromJSONTyped = RecommendationInfoFromJSONTyped;
+exports.RecommendationInfoToJSON = RecommendationInfoToJSON;
+/**
+ * Check if a given object implements the RecommendationInfo interface.
+ */
+function instanceOfRecommendationInfo(value) {
+    return true;
+}
+function RecommendationInfoFromJSON(json) {
+    return RecommendationInfoFromJSONTyped(json, false);
+}
+function RecommendationInfoFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function RecommendationInfoToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'phoneNumber': value['phoneNumber'],
+        'countries': value['countries'],
+        'subdivisions': value['subdivisions'],
+        'ipAddresses': value['ipAddresses'],
+    };
+}

package/dist/models/RefreshStepContentRequest.d.ts

@@ -20,7 +20,7 @@ export interface RefreshStepContentRequest {
      * @type {string}
      * @memberof RefreshStepContentRequest
      */
-    resultsAccessKey?: string;
+    resultsAccessKey?: string | null;
 }
 /**
  * Check if a given object implements the RefreshStepContentRequest interface.

package/dist/models/ResultCollection.d.ts

@@ -23,11 +23,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;
 }
 /**
  * Check if a given object implements the ResultCollection interface.

package/dist/models/ResultCollection.js

@@ -24,6 +24,8 @@ const ResultCollectionMethod_1 = require("./ResultCollectionMethod");
 function instanceOfResultCollection(value) {
     if (!('method' in value) || value['method'] === undefined)
         return false;
+    if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined)
+        return false;
     return true;
 }
 function ResultCollectionFromJSON(json) {
@@ -35,7 +37,7 @@ function ResultCollectionFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'method': (0, ResultCollectionMethod_1.ResultCollectionMethodFromJSON)(json['method']),
-        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+        'resultsAccessKey': json['resultsAccessKey'],
     };
 }
 function ResultCollectionToJSON(value) {

package/dist/models/Session.d.ts

@@ -46,7 +46,7 @@ export interface Session {
      * @type {SessionErrorCode}
      * @memberof Session
      */
-    errorCode?: SessionErrorCode;
+    errorCode?: SessionErrorCode | null;
     /**
      * The unix timestamp, in seconds, when this session was created
      * @type {number}

package/dist/models/SmartIdInput.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfSmartIdInput(value: object): value is SmartIdInput;
+export declare function SmartIdInputFromJSON(json: any): SmartIdInput;
+export declare function SmartIdInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmartIdInput;
+export declare function SmartIdInputToJSON(value?: SmartIdInput | null): any;

package/dist/models/SmartIdInput.js

@@ -0,0 +1,44 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSmartIdInput = instanceOfSmartIdInput;
+exports.SmartIdInputFromJSON = SmartIdInputFromJSON;
+exports.SmartIdInputFromJSONTyped = SmartIdInputFromJSONTyped;
+exports.SmartIdInputToJSON = SmartIdInputToJSON;
+/**
+ * Check if a given object implements the SmartIdInput interface.
+ */
+function instanceOfSmartIdInput(value) {
+    return true;
+}
+function SmartIdInputFromJSON(json) {
+    return SmartIdInputFromJSONTyped(json, false);
+}
+function SmartIdInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'smartIdDocumentNumber': json['smartIdDocumentNumber'] == null ? undefined : json['smartIdDocumentNumber'],
+    };
+}
+function SmartIdInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'smartIdDocumentNumber': value['smartIdDocumentNumber'],
+    };
+}

package/dist/models/SouthAfricaNidInput.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfSouthAfricaNidInput(value: object): value is SouthAfricaNidInput;
+export declare function SouthAfricaNidInputFromJSON(json: any): SouthAfricaNidInput;
+export declare function SouthAfricaNidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SouthAfricaNidInput;
+export declare function SouthAfricaNidInputToJSON(value?: SouthAfricaNidInput | null): any;

package/dist/models/SouthAfricaNidInput.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSouthAfricaNidInput = instanceOfSouthAfricaNidInput;
+exports.SouthAfricaNidInputFromJSON = SouthAfricaNidInputFromJSON;
+exports.SouthAfricaNidInputFromJSONTyped = SouthAfricaNidInputFromJSONTyped;
+exports.SouthAfricaNidInputToJSON = SouthAfricaNidInputToJSON;
+/**
+ * Check if a given object implements the SouthAfricaNidInput interface.
+ */
+function instanceOfSouthAfricaNidInput(value) {
+    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;
+}
+function SouthAfricaNidInputFromJSON(json) {
+    return SouthAfricaNidInputFromJSONTyped(json, false);
+}
+function SouthAfricaNidInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fullName': json['fullName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'gender': json['gender'],
+        'nationalIdNumber': json['nationalIdNumber'],
+    };
+}
+function SouthAfricaNidInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fullName': value['fullName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'gender': value['gender'],
+        'nationalIdNumber': value['nationalIdNumber'],
+    };
+}

package/dist/models/SpidInput.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfSpidInput(value: object): value is SpidInput;
+export declare function SpidInputFromJSON(json: any): SpidInput;
+export declare function SpidInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): SpidInput;
+export declare function SpidInputToJSON(value?: SpidInput | null): any;

package/dist/models/SpidInput.js

@@ -0,0 +1,44 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSpidInput = instanceOfSpidInput;
+exports.SpidInputFromJSON = SpidInputFromJSON;
+exports.SpidInputFromJSONTyped = SpidInputFromJSONTyped;
+exports.SpidInputToJSON = SpidInputToJSON;
+/**
+ * Check if a given object implements the SpidInput interface.
+ */
+function instanceOfSpidInput(value) {
+    return true;
+}
+function SpidInputFromJSON(json) {
+    return SpidInputFromJSONTyped(json, false);
+}
+function SpidInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+    };
+}
+function SpidInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subProviderId': value['subProviderId'],
+    };
+}

package/dist/models/SubProviderMetadata.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfSubProviderMetadata(value: object): value is SubProviderMetadata;
+export declare function SubProviderMetadataFromJSON(json: any): SubProviderMetadata;
+export declare function SubProviderMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubProviderMetadata;
+export declare function SubProviderMetadataToJSON(value?: SubProviderMetadata | null): any;

package/dist/models/SubProviderMetadata.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfSubProviderMetadata = instanceOfSubProviderMetadata;
+exports.SubProviderMetadataFromJSON = SubProviderMetadataFromJSON;
+exports.SubProviderMetadataFromJSONTyped = SubProviderMetadataFromJSONTyped;
+exports.SubProviderMetadataToJSON = SubProviderMetadataToJSON;
+/**
+ * Check if a given object implements the SubProviderMetadata interface.
+ */
+function instanceOfSubProviderMetadata(value) {
+    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;
+}
+function SubProviderMetadataFromJSON(json) {
+    return SubProviderMetadataFromJSONTyped(json, false);
+}
+function SubProviderMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+    };
+}
+function SubProviderMetadataToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'logoUrl': value['logoUrl'],
+    };
+}

package/dist/models/TrinsicTestDatabaseLookupInput.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfTrinsicTestDatabaseLookupInput(value: object): value is TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputFromJSON(json: any): TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputToJSON(value?: TrinsicTestDatabaseLookupInput | null): any;

package/dist/models/TrinsicTestDatabaseLookupInput.js

@@ -0,0 +1,50 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfTrinsicTestDatabaseLookupInput = instanceOfTrinsicTestDatabaseLookupInput;
+exports.TrinsicTestDatabaseLookupInputFromJSON = TrinsicTestDatabaseLookupInputFromJSON;
+exports.TrinsicTestDatabaseLookupInputFromJSONTyped = TrinsicTestDatabaseLookupInputFromJSONTyped;
+exports.TrinsicTestDatabaseLookupInputToJSON = TrinsicTestDatabaseLookupInputToJSON;
+/**
+ * Check if a given object implements the TrinsicTestDatabaseLookupInput interface.
+ */
+function instanceOfTrinsicTestDatabaseLookupInput(value) {
+    return true;
+}
+function TrinsicTestDatabaseLookupInputFromJSON(json) {
+    return TrinsicTestDatabaseLookupInputFromJSONTyped(json, false);
+}
+function TrinsicTestDatabaseLookupInputFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function TrinsicTestDatabaseLookupInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'givenName': value['givenName'],
+        'familyName': value['familyName'],
+        'identityCode': value['identityCode'],
+        'selfieBase64': value['selfieBase64'],
+    };
+}

package/dist/models/TrinsicTestSubProvidersInput.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @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 declare function instanceOfTrinsicTestSubProvidersInput(value: object): value is TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputFromJSON(json: any): TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputToJSON(value?: TrinsicTestSubProvidersInput | null): any;