@trinsic/api 2.0.0-alpha3 → 2.0.0

package/src/models/ProviderInput.ts

@@ -13,36 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
-import type { PhilippineQRInput } from './PhilippineQRInput';
-import {
-    PhilippineQRInputFromJSON,
-    PhilippineQRInputFromJSONTyped,
-    PhilippineQRInputToJSON,
-} from './PhilippineQRInput';
 import type { BangladeshNationalIdInput } from './BangladeshNationalIdInput';
 import {
     BangladeshNationalIdInputFromJSON,
     BangladeshNationalIdInputFromJSONTyped,
     BangladeshNationalIdInputToJSON,
 } from './BangladeshNationalIdInput';
-import type { AadhaarInput } from './AadhaarInput';
-import {
-    AadhaarInputFromJSON,
-    AadhaarInputFromJSONTyped,
-    AadhaarInputToJSON,
-} from './AadhaarInput';
-import type { KenyaNidInput } from './KenyaNidInput';
-import {
-    KenyaNidInputFromJSON,
-    KenyaNidInputFromJSONTyped,
-    KenyaNidInputToJSON,
-} from './KenyaNidInput';
-import type { NigeriaNinInput } from './NigeriaNinInput';
-import {
-    NigeriaNinInputFromJSON,
-    NigeriaNinInputFromJSONTyped,
-    NigeriaNinInputToJSON,
-} from './NigeriaNinInput';
 import type { BrazilCpfCheckInput } from './BrazilCpfCheckInput';
 import {
     BrazilCpfCheckInputFromJSON,
@@ -61,12 +37,18 @@ import {
     BrazilDigitalCnhInputFromJSONTyped,
     BrazilDigitalCnhInputToJSON,
 } from './BrazilDigitalCnhInput';
-import type { IndonesiaNikInput } from './IndonesiaNikInput';
+import type { TrinsicTestSubProvidersInput } from './TrinsicTestSubProvidersInput';
 import {
-    IndonesiaNikInputFromJSON,
-    IndonesiaNikInputFromJSONTyped,
-    IndonesiaNikInputToJSON,
-} from './IndonesiaNikInput';
+    TrinsicTestSubProvidersInputFromJSON,
+    TrinsicTestSubProvidersInputFromJSONTyped,
+    TrinsicTestSubProvidersInputToJSON,
+} from './TrinsicTestSubProvidersInput';
+import type { SpidInput } from './SpidInput';
+import {
+    SpidInputFromJSON,
+    SpidInputFromJSONTyped,
+    SpidInputToJSON,
+} from './SpidInput';
 import type { SouthAfricaNidInput } from './SouthAfricaNidInput';
 import {
     SouthAfricaNidInputFromJSON,
@@ -79,6 +61,60 @@ import {
     PhilippineMatchInputFromJSONTyped,
     PhilippineMatchInputToJSON,
 } from './PhilippineMatchInput';
+import type { PhilippineQRInput } from './PhilippineQRInput';
+import {
+    PhilippineQRInputFromJSON,
+    PhilippineQRInputFromJSONTyped,
+    PhilippineQRInputToJSON,
+} from './PhilippineQRInput';
+import type { AadhaarInput } from './AadhaarInput';
+import {
+    AadhaarInputFromJSON,
+    AadhaarInputFromJSONTyped,
+    AadhaarInputToJSON,
+} from './AadhaarInput';
+import type { KenyaNidInput } from './KenyaNidInput';
+import {
+    KenyaNidInputFromJSON,
+    KenyaNidInputFromJSONTyped,
+    KenyaNidInputToJSON,
+} from './KenyaNidInput';
+import type { NigeriaNinInput } from './NigeriaNinInput';
+import {
+    NigeriaNinInputFromJSON,
+    NigeriaNinInputFromJSONTyped,
+    NigeriaNinInputToJSON,
+} from './NigeriaNinInput';
+import type { SmartIdInput } from './SmartIdInput';
+import {
+    SmartIdInputFromJSON,
+    SmartIdInputFromJSONTyped,
+    SmartIdInputToJSON,
+} from './SmartIdInput';
+import type { MobileIdInput } from './MobileIdInput';
+import {
+    MobileIdInputFromJSON,
+    MobileIdInputFromJSONTyped,
+    MobileIdInputToJSON,
+} from './MobileIdInput';
+import type { TrinsicTestDatabaseLookupInput } from './TrinsicTestDatabaseLookupInput';
+import {
+    TrinsicTestDatabaseLookupInputFromJSON,
+    TrinsicTestDatabaseLookupInputFromJSONTyped,
+    TrinsicTestDatabaseLookupInputToJSON,
+} from './TrinsicTestDatabaseLookupInput';
+import type { IndonesiaNikInput } from './IndonesiaNikInput';
+import {
+    IndonesiaNikInputFromJSON,
+    IndonesiaNikInputFromJSONTyped,
+    IndonesiaNikInputToJSON,
+} from './IndonesiaNikInput';
+import type { IdinInput } from './IdinInput';
+import {
+    IdinInputFromJSON,
+    IdinInputFromJSONTyped,
+    IdinInputToJSON,
+} from './IdinInput';
 
 /**
  * 
@@ -87,71 +123,111 @@ import {
  */
 export interface ProviderInput {
     /**
-     * Input for the `f-indonesia-nik` integration
+     * Input for the `f-indonesia-nik` provider
      * @type {IndonesiaNikInput}
      * @memberof ProviderInput
      */
     indonesiaNik?: IndonesiaNikInput | null;
     /**
-     * Input for the `f-mexico-curp` integration
+     * Input for the `f-mexico-curp` provider
      * @type {MexicoCurpInput}
      * @memberof ProviderInput
      */
     mexicoCurp?: MexicoCurpInput | null;
     /**
-     * Input for the `f-south-africa-nid` integration
+     * Input for the `f-south-africa-nid` provider
      * @type {SouthAfricaNidInput}
      * @memberof ProviderInput
      */
     southAfricaNid?: SouthAfricaNidInput | null;
     /**
-     * Input for the `f-kenya-nid` integration
+     * Input for the `f-kenya-nid` provider
      * @type {KenyaNidInput}
      * @memberof ProviderInput
      */
     kenyaNid?: KenyaNidInput | null;
     /**
-     * Input for the `f-nigeria-nin` integration
+     * Input for the `f-nigeria-nin` provider
      * @type {NigeriaNinInput}
      * @memberof ProviderInput
      */
     nigeriaNin?: NigeriaNinInput | null;
     /**
-     * Input for the `f-india-aadhaar-match` integration
+     * Input for the `f-india-aadhaar-match` provider
      * @type {AadhaarInput}
      * @memberof ProviderInput
      */
     aadhaar?: AadhaarInput | null;
     /**
-     * Input for the `bangladesh-nid` integration
+     * Input for the `bangladesh-nid` provider
      * @type {BangladeshNationalIdInput}
      * @memberof ProviderInput
      */
     bangladeshNationalId?: BangladeshNationalIdInput | null;
     /**
-     * Input for the `g-brazil-cpf` integration
+     * Input for the `g-brazil-cpf` provider
      * @type {BrazilCpfCheckInput}
      * @memberof ProviderInput
      */
     brazilCpfCheck?: BrazilCpfCheckInput | null;
     /**
-     * Input for the `g-brazil-digital-cnh` integration
+     * Input for the `g-brazil-digital-cnh` provider
      * @type {BrazilDigitalCnhInput}
      * @memberof ProviderInput
      */
     brazilDigitalCnh?: BrazilDigitalCnhInput | null;
     /**
-     * Input for the `b-philsys-biometric` integration
+     * Input for the `b-philsys-biometric` provider
      * @type {PhilippineMatchInput}
      * @memberof ProviderInput
      */
     philippineMatch?: PhilippineMatchInput | null;
     /**
-     * Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` integrations
+     * Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` providers
      * @type {PhilippineQRInput}
      * @memberof ProviderInput
      */
     philippineQR?: PhilippineQRInput | null;
+    /**
+     * Input for the `smart-id` provider
+     * @type {SmartIdInput}
+     * @memberof ProviderInput
+     */
+    smartId?: SmartIdInput | null;
+    /**
+     * Input for the `mobile-id` provider
+     * @type {MobileIdInput}
+     * @memberof ProviderInput
+     */
+    mobileId?: MobileIdInput | null;
+    /**
+     * Input for the `idin` provider
+     * @type {IdinInput}
+     * @memberof ProviderInput
+     */
+    idin?: IdinInput | null;
+    /**
+     * Input for the `spid` provider
+     * @type {SpidInput}
+     * @memberof ProviderInput
+     */
+    spid?: SpidInput | null;
+    /**
+     * *TEST MODE ONLY.*
+     *             
+     * Input for the `trinsic-test-database-lookup` provider
+     * @type {TrinsicTestDatabaseLookupInput}
+     * @memberof ProviderInput
+     */
+    trinsicTestDatabaseLookup?: TrinsicTestDatabaseLookupInput | null;
+    /**
+     * *TEST MODE ONLY.*
+     *             
+     * Input for the `trinsic-test-sub-providers` provider
+     * @type {TrinsicTestSubProvidersInput}
+     * @memberof ProviderInput
+     */
+    trinsicTestSubProviders?: TrinsicTestSubProvidersInput | null;
 }
 
 /**
@@ -182,6 +258,12 @@ export function ProviderInputFromJSONTyped(json: any, ignoreDiscriminator: boole
         'brazilDigitalCnh': json['brazilDigitalCnh'] == null ? undefined : BrazilDigitalCnhInputFromJSON(json['brazilDigitalCnh']),
         'philippineMatch': json['philippineMatch'] == null ? undefined : PhilippineMatchInputFromJSON(json['philippineMatch']),
         'philippineQR': json['philippineQR'] == null ? undefined : PhilippineQRInputFromJSON(json['philippineQR']),
+        'smartId': json['smartId'] == null ? undefined : SmartIdInputFromJSON(json['smartId']),
+        'mobileId': json['mobileId'] == null ? undefined : MobileIdInputFromJSON(json['mobileId']),
+        'idin': json['idin'] == null ? undefined : IdinInputFromJSON(json['idin']),
+        'spid': json['spid'] == null ? undefined : SpidInputFromJSON(json['spid']),
+        'trinsicTestDatabaseLookup': json['trinsicTestDatabaseLookup'] == null ? undefined : TrinsicTestDatabaseLookupInputFromJSON(json['trinsicTestDatabaseLookup']),
+        'trinsicTestSubProviders': json['trinsicTestSubProviders'] == null ? undefined : TrinsicTestSubProvidersInputFromJSON(json['trinsicTestSubProviders']),
     };
 }
 
@@ -202,6 +284,12 @@ export function ProviderInputToJSON(value?: ProviderInput | null): any {
         'brazilDigitalCnh': BrazilDigitalCnhInputToJSON(value['brazilDigitalCnh']),
         'philippineMatch': PhilippineMatchInputToJSON(value['philippineMatch']),
         'philippineQR': PhilippineQRInputToJSON(value['philippineQR']),
+        'smartId': SmartIdInputToJSON(value['smartId']),
+        'mobileId': MobileIdInputToJSON(value['mobileId']),
+        'idin': IdinInputToJSON(value['idin']),
+        'spid': SpidInputToJSON(value['spid']),
+        'trinsicTestDatabaseLookup': TrinsicTestDatabaseLookupInputToJSON(value['trinsicTestDatabaseLookup']),
+        'trinsicTestSubProviders': TrinsicTestSubProvidersInputToJSON(value['trinsicTestSubProviders']),
     };
 }
 

package/src/models/RecommendRequest.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RecommendationInfo } from './RecommendationInfo';
+import {
+    RecommendationInfoFromJSON,
+    RecommendationInfoFromJSONTyped,
+    RecommendationInfoToJSON,
+} from './RecommendationInfo';
+
 /**
  * 
  * @export
@@ -20,35 +27,11 @@ import { mapValues } from '../runtime';
  */
 export interface RecommendRequest {
     /**
-     * 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
-     * @type {string}
-     * @memberof RecommendRequest
-     */
-    phoneNumber?: string | null;
-    /**
-     * A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user's country of residence, nationality, etc.
-     * @type {Array<string>}
-     * @memberof RecommendRequest
-     */
-    countries?: Array<string> | null;
-    /**
-     * If one of the countries has subdivisions, for example the US states, you can specify a list of these to further refine the recommendation (e.g., CA, UT, NY)
-     * @type {Array<string>}
-     * @memberof RecommendRequest
-     */
-    subdivisions?: Array<string> | null;
-    /**
-     * Provide the IP addresses of the user you wish to generate a recommendation for. Will be used to look up the user's geographic location.
-     * @type {Array<string>}
-     * @memberof RecommendRequest
-     */
-    ipAddresses?: Array<string> | null;
-    /**
-     * If true, the recommendation will include providers that are disabled for the app
-     * @type {boolean}
+     * Information about the user you wish to generate a recommendation for.
+     * @type {RecommendationInfo}
      * @memberof RecommendRequest
      */
-    includeDisabledProviders?: boolean | null;
+    recommendationInfo?: RecommendationInfo | null;
 }
 
 /**
@@ -68,11 +51,7 @@ export function RecommendRequestFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     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'],
-        'includeDisabledProviders': json['includeDisabledProviders'] == null ? undefined : json['includeDisabledProviders'],
+        'recommendationInfo': json['recommendationInfo'] == null ? undefined : RecommendationInfoFromJSON(json['recommendationInfo']),
     };
 }
 
@@ -82,11 +61,7 @@ export function RecommendRequestToJSON(value?: RecommendRequest | null): any {
     }
     return {
         
-        'phoneNumber': value['phoneNumber'],
-        'countries': value['countries'],
-        'subdivisions': value['subdivisions'],
-        'ipAddresses': value['ipAddresses'],
-        'includeDisabledProviders': value['includeDisabledProviders'],
+        'recommendationInfo': RecommendationInfoToJSON(value['recommendationInfo']),
     };
 }
 

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/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 | null;
+    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,25 +33,25 @@ 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

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/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