@trinsic/api 2.0.0-alpha3 → 2.0.0

package/dist/esm/models/ProviderContract.d.ts

@@ -0,0 +1,146 @@
+/**
+ * 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 type { SubProviderMetadata } from './SubProviderMetadata';
+import type { ResultCollectionMethod } from './ResultCollectionMethod';
+import type { IntegrationLaunchMethod } from './IntegrationLaunchMethod';
+/**
+ *
+ * @export
+ * @interface ProviderContract
+ */
+export interface ProviderContract {
+    /**
+     * The ID of the Provider for this contract.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    id: string;
+    /**
+     * The Provider's Name as it appears in Trinsic's Dashboard and Widget
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    name: string;
+    /**
+     * The Provider's description as it appears in Trinsic's Widget.
+     *
+     * This is flavor text, not a full, human-readable description of the provider.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    description: string;
+    /**
+     * A URL pointing to the Provider's logo on Trinsic's CDN.
+     *
+     * May be a PNG, JPG, or SVG image.
+     * @type {string}
+     * @memberof ProviderContract
+     */
+    logoUrl: string;
+    /**
+     * Whether the Provider is available for use in your App.
+     *
+     * If `false`, you will need to contact Trinsic to enable this Provider for your App.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    available: boolean;
+    /**
+     * The geographies within the Regions the Provider is available.
+     * @type {Array<string>}
+     * @memberof ProviderContract
+     */
+    geography: Array<string>;
+    /**
+     * The regions within which the Provider is available.
+     * @type {Array<string>}
+     * @memberof ProviderContract
+     */
+    regions: Array<string>;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *
+     * The `LaunchMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
+     * @type {IntegrationLaunchMethod}
+     * @memberof ProviderContract
+     */
+    launchMethod: IntegrationLaunchMethod;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *
+     * The `CollectionMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
+     * @type {ResultCollectionMethod}
+     * @memberof ProviderContract
+     */
+    collectionMethod: ResultCollectionMethod;
+    /**
+     * If `true`, then the results for this Provider may not be available immediately after the user is redirected back
+     * to your application. In this case, the `GetSessionResults` API must be called until results are available.
+     *
+     * This is an uncommon scenario, and typically only applies to Providers which use a biometric check or traditional document scan.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    resultsMayBeDelayedAfterRedirect: boolean;
+    /**
+     * Relevant only to Advanced Provider Sessions.
+     *
+     * Whether the Provider requires the `RefreshStepContent` capability.
+     *
+     * For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a
+     * resilient user flow.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    hasRefreshableContent: boolean;
+    /**
+     * Relevant to Hosted Provider Sessions and Advanced Provider Sessions.
+     *
+     * If `true`, this Provider requires provider-specific input on Session creation.
+     * If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    requiresInput: boolean;
+    /**
+     * Whether there exists a Trinsic-hosted UI for this Provider.
+     *
+     * This is `true` for any Provider which is not a simple, OIDC-like redirect flow.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    hasTrinsicInterface: boolean;
+    /**
+     * Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API.
+     *
+     * If `false`, the Provider may still be launched through Advanced Provider Sessions;
+     * however, it will necessarily require a Trinsic-hosted UI to function.
+     * @type {boolean}
+     * @memberof ProviderContract
+     */
+    supportsAdvancedProviderSessions: boolean;
+    /**
+     * Metadata about the sub-providers which are available for this Provider.
+     *
+     * For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
+     * @type {Array<SubProviderMetadata>}
+     * @memberof ProviderContract
+     */
+    subProviders?: Array<SubProviderMetadata> | null;
+}
+/**
+ * Check if a given object implements the ProviderContract interface.
+ */
+export declare function instanceOfProviderContract(value: object): value is ProviderContract;
+export declare function ProviderContractFromJSON(json: any): ProviderContract;
+export declare function ProviderContractFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderContract;
+export declare function ProviderContractToJSON(value?: ProviderContract | null): any;

package/dist/esm/models/ProviderContract.js

@@ -0,0 +1,97 @@
+/* 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 { SubProviderMetadataFromJSON, SubProviderMetadataToJSON, } from './SubProviderMetadata';
+import { ResultCollectionMethodFromJSON, ResultCollectionMethodToJSON, } from './ResultCollectionMethod';
+import { IntegrationLaunchMethodFromJSON, IntegrationLaunchMethodToJSON, } from './IntegrationLaunchMethod';
+/**
+ * Check if a given object implements the ProviderContract interface.
+ */
+export function instanceOfProviderContract(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;
+    if (!('available' in value) || value['available'] === undefined)
+        return false;
+    if (!('geography' in value) || value['geography'] === undefined)
+        return false;
+    if (!('regions' in value) || value['regions'] === undefined)
+        return false;
+    if (!('launchMethod' in value) || value['launchMethod'] === undefined)
+        return false;
+    if (!('collectionMethod' in value) || value['collectionMethod'] === undefined)
+        return false;
+    if (!('resultsMayBeDelayedAfterRedirect' in value) || value['resultsMayBeDelayedAfterRedirect'] === undefined)
+        return false;
+    if (!('hasRefreshableContent' in value) || value['hasRefreshableContent'] === undefined)
+        return false;
+    if (!('requiresInput' in value) || value['requiresInput'] === undefined)
+        return false;
+    if (!('hasTrinsicInterface' in value) || value['hasTrinsicInterface'] === undefined)
+        return false;
+    if (!('supportsAdvancedProviderSessions' in value) || value['supportsAdvancedProviderSessions'] === undefined)
+        return false;
+    return true;
+}
+export function ProviderContractFromJSON(json) {
+    return ProviderContractFromJSONTyped(json, false);
+}
+export function ProviderContractFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+        'available': json['available'],
+        'geography': json['geography'],
+        'regions': json['regions'],
+        'launchMethod': IntegrationLaunchMethodFromJSON(json['launchMethod']),
+        'collectionMethod': ResultCollectionMethodFromJSON(json['collectionMethod']),
+        'resultsMayBeDelayedAfterRedirect': json['resultsMayBeDelayedAfterRedirect'],
+        'hasRefreshableContent': json['hasRefreshableContent'],
+        'requiresInput': json['requiresInput'],
+        'hasTrinsicInterface': json['hasTrinsicInterface'],
+        'supportsAdvancedProviderSessions': json['supportsAdvancedProviderSessions'],
+        'subProviders': json['subProviders'] == null ? undefined : (json['subProviders'].map(SubProviderMetadataFromJSON)),
+    };
+}
+export function ProviderContractToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'logoUrl': value['logoUrl'],
+        'available': value['available'],
+        'geography': value['geography'],
+        'regions': value['regions'],
+        'launchMethod': IntegrationLaunchMethodToJSON(value['launchMethod']),
+        'collectionMethod': ResultCollectionMethodToJSON(value['collectionMethod']),
+        'resultsMayBeDelayedAfterRedirect': value['resultsMayBeDelayedAfterRedirect'],
+        'hasRefreshableContent': value['hasRefreshableContent'],
+        'requiresInput': value['requiresInput'],
+        'hasTrinsicInterface': value['hasTrinsicInterface'],
+        'supportsAdvancedProviderSessions': value['supportsAdvancedProviderSessions'],
+        'subProviders': value['subProviders'] == null ? undefined : (value['subProviders'].map(SubProviderMetadataToJSON)),
+    };
+}

package/dist/esm/models/ProviderInfo.d.ts

@@ -33,12 +33,6 @@ export interface ProviderInfo {
      * @memberof ProviderInfo
      */
     logoUrl: string;
-    /**
-     * List of child provider id's where the provider allows deep-launching of a specific provider.
-     * @type {Array<string>}
-     * @memberof ProviderInfo
-     */
-    childProviderIds?: Array<string> | null;
 }
 /**
  * Check if a given object implements the ProviderInfo interface.

package/dist/esm/models/ProviderInfo.js

@@ -34,7 +34,6 @@ export function ProviderInfoFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'logoUrl': json['logoUrl'],
-        'childProviderIds': json['childProviderIds'] == null ? undefined : json['childProviderIds'],
     };
 }
 export function ProviderInfoToJSON(value) {
@@ -45,6 +44,5 @@ export function ProviderInfoToJSON(value) {
         'id': value['id'],
         'name': value['name'],
         'logoUrl': value['logoUrl'],
-        'childProviderIds': value['childProviderIds'],
     };
 }

package/dist/esm/models/ProviderInformation.d.ts

@@ -20,19 +20,19 @@ export interface ProviderInformation {
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerId: string;
+    readonly providerId: string;
     /**
      *
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerDisplayName: string;
+    readonly providerDisplayName: string;
     /**
      *
      * @type {string}
      * @memberof ProviderInformation
      */
-    providerLogo: string;
+    readonly providerLogo: string;
 }
 /**
  * Check if a given object implements the ProviderInformation interface.
@@ -40,4 +40,4 @@ export interface ProviderInformation {
 export declare function instanceOfProviderInformation(value: object): value is ProviderInformation;
 export declare function ProviderInformationFromJSON(json: any): ProviderInformation;
 export declare function ProviderInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInformation;
-export declare function ProviderInformationToJSON(value?: ProviderInformation | null): any;
+export declare function ProviderInformationToJSON(value?: Omit<ProviderInformation, 'providerId' | 'providerDisplayName' | 'providerLogo'> | null): any;

package/dist/esm/models/ProviderInformation.js

@@ -40,9 +40,5 @@ export function ProviderInformationToJSON(value) {
     if (value == null) {
         return value;
     }
-    return {
-        'providerId': value['providerId'],
-        'providerDisplayName': value['providerDisplayName'],
-        'providerLogo': value['providerLogo'],
-    };
+    return {};
 }

package/dist/esm/models/ProviderInput.d.ts

@@ -9,17 +9,23 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { PhilippineQRInput } from './PhilippineQRInput';
 import type { BangladeshNationalIdInput } from './BangladeshNationalIdInput';
-import type { AadhaarInput } from './AadhaarInput';
-import type { KenyaNidInput } from './KenyaNidInput';
-import type { NigeriaNinInput } from './NigeriaNinInput';
 import type { BrazilCpfCheckInput } from './BrazilCpfCheckInput';
 import type { MexicoCurpInput } from './MexicoCurpInput';
 import type { BrazilDigitalCnhInput } from './BrazilDigitalCnhInput';
-import type { IndonesiaNikInput } from './IndonesiaNikInput';
+import type { TrinsicTestSubProvidersInput } from './TrinsicTestSubProvidersInput';
+import type { SpidInput } from './SpidInput';
 import type { SouthAfricaNidInput } from './SouthAfricaNidInput';
 import type { PhilippineMatchInput } from './PhilippineMatchInput';
+import type { PhilippineQRInput } from './PhilippineQRInput';
+import type { AadhaarInput } from './AadhaarInput';
+import type { KenyaNidInput } from './KenyaNidInput';
+import type { NigeriaNinInput } from './NigeriaNinInput';
+import type { SmartIdInput } from './SmartIdInput';
+import type { MobileIdInput } from './MobileIdInput';
+import type { TrinsicTestDatabaseLookupInput } from './TrinsicTestDatabaseLookupInput';
+import type { IndonesiaNikInput } from './IndonesiaNikInput';
+import type { IdinInput } from './IdinInput';
 /**
  *
  * @export
@@ -27,71 +33,111 @@ import type { PhilippineMatchInput } from './PhilippineMatchInput';
  */
 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;
 }
 /**
  * Check if a given object implements the ProviderInput interface.

package/dist/esm/models/ProviderInput.js

@@ -11,17 +11,23 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { PhilippineQRInputFromJSON, PhilippineQRInputToJSON, } from './PhilippineQRInput';
 import { BangladeshNationalIdInputFromJSON, BangladeshNationalIdInputToJSON, } from './BangladeshNationalIdInput';
-import { AadhaarInputFromJSON, AadhaarInputToJSON, } from './AadhaarInput';
-import { KenyaNidInputFromJSON, KenyaNidInputToJSON, } from './KenyaNidInput';
-import { NigeriaNinInputFromJSON, NigeriaNinInputToJSON, } from './NigeriaNinInput';
 import { BrazilCpfCheckInputFromJSON, BrazilCpfCheckInputToJSON, } from './BrazilCpfCheckInput';
 import { MexicoCurpInputFromJSON, MexicoCurpInputToJSON, } from './MexicoCurpInput';
 import { BrazilDigitalCnhInputFromJSON, BrazilDigitalCnhInputToJSON, } from './BrazilDigitalCnhInput';
-import { IndonesiaNikInputFromJSON, IndonesiaNikInputToJSON, } from './IndonesiaNikInput';
+import { TrinsicTestSubProvidersInputFromJSON, TrinsicTestSubProvidersInputToJSON, } from './TrinsicTestSubProvidersInput';
+import { SpidInputFromJSON, SpidInputToJSON, } from './SpidInput';
 import { SouthAfricaNidInputFromJSON, SouthAfricaNidInputToJSON, } from './SouthAfricaNidInput';
 import { PhilippineMatchInputFromJSON, PhilippineMatchInputToJSON, } from './PhilippineMatchInput';
+import { PhilippineQRInputFromJSON, PhilippineQRInputToJSON, } from './PhilippineQRInput';
+import { AadhaarInputFromJSON, AadhaarInputToJSON, } from './AadhaarInput';
+import { KenyaNidInputFromJSON, KenyaNidInputToJSON, } from './KenyaNidInput';
+import { NigeriaNinInputFromJSON, NigeriaNinInputToJSON, } from './NigeriaNinInput';
+import { SmartIdInputFromJSON, SmartIdInputToJSON, } from './SmartIdInput';
+import { MobileIdInputFromJSON, MobileIdInputToJSON, } from './MobileIdInput';
+import { TrinsicTestDatabaseLookupInputFromJSON, TrinsicTestDatabaseLookupInputToJSON, } from './TrinsicTestDatabaseLookupInput';
+import { IndonesiaNikInputFromJSON, IndonesiaNikInputToJSON, } from './IndonesiaNikInput';
+import { IdinInputFromJSON, IdinInputToJSON, } from './IdinInput';
 /**
  * Check if a given object implements the ProviderInput interface.
  */
@@ -47,6 +53,12 @@ export function ProviderInputFromJSONTyped(json, ignoreDiscriminator) {
         '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']),
     };
 }
 export function ProviderInputToJSON(value) {
@@ -65,5 +77,11 @@ export function ProviderInputToJSON(value) {
         '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/dist/esm/models/RecommendRequest.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { RecommendationInfo } from './RecommendationInfo';
 /**
  *
  * @export
@@ -16,35 +17,11 @@
  */
 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}
+     * Information about the user you wish to generate a recommendation for.
+     * @type {RecommendationInfo}
      * @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}
-     * @memberof RecommendRequest
-     */
-    includeDisabledProviders?: boolean | null;
+    recommendationInfo?: RecommendationInfo | null;
 }
 /**
  * Check if a given object implements the RecommendRequest interface.

package/dist/esm/models/RecommendRequest.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { RecommendationInfoFromJSON, RecommendationInfoToJSON, } from './RecommendationInfo';
 /**
  * Check if a given object implements the RecommendRequest interface.
  */
@@ -25,11 +26,7 @@ export function RecommendRequestFromJSONTyped(json, ignoreDiscriminator) {
         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'],
-        'includeDisabledProviders': json['includeDisabledProviders'] == null ? undefined : json['includeDisabledProviders'],
+        'recommendationInfo': json['recommendationInfo'] == null ? undefined : RecommendationInfoFromJSON(json['recommendationInfo']),
     };
 }
 export function RecommendRequestToJSON(value) {
@@ -37,10 +34,6 @@ export function RecommendRequestToJSON(value) {
         return value;
     }
     return {
-        'phoneNumber': value['phoneNumber'],
-        'countries': value['countries'],
-        'subdivisions': value['subdivisions'],
-        'ipAddresses': value['ipAddresses'],
-        'includeDisabledProviders': value['includeDisabledProviders'],
+        'recommendationInfo': RecommendationInfoToJSON(value['recommendationInfo']),
     };
 }

package/dist/esm/models/RecommendationInfo.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 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 declare function instanceOfRecommendationInfo(value: object): value is RecommendationInfo;
+export declare function RecommendationInfoFromJSON(json: any): RecommendationInfo;
+export declare function RecommendationInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RecommendationInfo;
+export declare function RecommendationInfoToJSON(value?: RecommendationInfo | null): any;