@trinsic/api 1.2.0 → 2.0.0-alpha2

package/src/models/ProviderInput.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { 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 { BrazilCpfCheckInput } from './BrazilCpfCheckInput';
+import {
+    BrazilCpfCheckInputFromJSON,
+    BrazilCpfCheckInputFromJSONTyped,
+    BrazilCpfCheckInputToJSON,
+} from './BrazilCpfCheckInput';
+import type { BrazilDigitalCnhInput } from './BrazilDigitalCnhInput';
+import {
+    BrazilDigitalCnhInputFromJSON,
+    BrazilDigitalCnhInputFromJSONTyped,
+    BrazilDigitalCnhInputToJSON,
+} from './BrazilDigitalCnhInput';
+import type { PhilippineMatchInput } from './PhilippineMatchInput';
+import {
+    PhilippineMatchInputFromJSON,
+    PhilippineMatchInputFromJSONTyped,
+    PhilippineMatchInputToJSON,
+} from './PhilippineMatchInput';
+
+/**
+ * 
+ * @export
+ * @interface ProviderInput
+ */
+export interface ProviderInput {
+    /**
+     * Input for the `f-india-aadhaar-match` integration
+     * @type {AadhaarInput}
+     * @memberof ProviderInput
+     */
+    aadhaar?: AadhaarInput;
+    /**
+     * Input for the `bangladesh-nid` integration
+     * @type {BangladeshNationalIdInput}
+     * @memberof ProviderInput
+     */
+    bangladeshNationalId?: BangladeshNationalIdInput;
+    /**
+     * Input for the `g-brazil-cpf` integration
+     * @type {BrazilCpfCheckInput}
+     * @memberof ProviderInput
+     */
+    brazilCpfCheck?: BrazilCpfCheckInput;
+    /**
+     * Input for the `g-brazil-digital-cnh` integration
+     * @type {BrazilDigitalCnhInput}
+     * @memberof ProviderInput
+     */
+    brazilDigitalCnh?: BrazilDigitalCnhInput;
+    /**
+     * Input for the `b-philsys-biometric` integration
+     * @type {PhilippineMatchInput}
+     * @memberof ProviderInput
+     */
+    philippineMatch?: PhilippineMatchInput;
+    /**
+     * Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` integrations
+     * @type {PhilippineQRInput}
+     * @memberof ProviderInput
+     */
+    philippineQR?: PhilippineQRInput;
+}
+
+/**
+ * Check if a given object implements the ProviderInput interface.
+ */
+export function instanceOfProviderInput(value: object): value is ProviderInput {
+    return true;
+}
+
+export function ProviderInputFromJSON(json: any): ProviderInput {
+    return ProviderInputFromJSONTyped(json, false);
+}
+
+export function ProviderInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProviderInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'aadhaar': json['aadhaar'] == null ? undefined : AadhaarInputFromJSON(json['aadhaar']),
+        'bangladeshNationalId': json['bangladeshNationalId'] == null ? undefined : BangladeshNationalIdInputFromJSON(json['bangladeshNationalId']),
+        'brazilCpfCheck': json['brazilCpfCheck'] == null ? undefined : BrazilCpfCheckInputFromJSON(json['brazilCpfCheck']),
+        'brazilDigitalCnh': json['brazilDigitalCnh'] == null ? undefined : BrazilDigitalCnhInputFromJSON(json['brazilDigitalCnh']),
+        'philippineMatch': json['philippineMatch'] == null ? undefined : PhilippineMatchInputFromJSON(json['philippineMatch']),
+        'philippineQR': json['philippineQR'] == null ? undefined : PhilippineQRInputFromJSON(json['philippineQR']),
+    };
+}
+
+export function ProviderInputToJSON(value?: ProviderInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'aadhaar': AadhaarInputToJSON(value['aadhaar']),
+        'bangladeshNationalId': BangladeshNationalIdInputToJSON(value['bangladeshNationalId']),
+        'brazilCpfCheck': BrazilCpfCheckInputToJSON(value['brazilCpfCheck']),
+        'brazilDigitalCnh': BrazilDigitalCnhInputToJSON(value['brazilDigitalCnh']),
+        'philippineMatch': PhilippineMatchInputToJSON(value['philippineMatch']),
+        'philippineQR': PhilippineQRInputToJSON(value['philippineQR']),
+    };
+}
+

package/src/models/RecommendRequest.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -20,11 +20,11 @@ import { mapValues } from '../runtime';
  */
 export interface RecommendRequest {
     /**
-     * The phone number of the user you whish to generate a recommendation for. Will be used to lookup the user's identity in the network
+     * 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;
+    phoneNumber?: string;
     /**
      * 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>}
@@ -32,18 +32,23 @@ export interface RecommendRequest {
      */
     countries?: Array<string>;
     /**
-     * If one of the countries is US, you can specify a list of US states to further refine the recommendation (e.g., CA, UT, NY)
+     * 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
      */
-    states?: Array<string>;
+    subdivisions?: Array<string>;
+    /**
+     * If true, the recommendation will include providers that are disabled for the app
+     * @type {boolean}
+     * @memberof RecommendRequest
+     */
+    includeDisabledProviders?: boolean;
 }
 
 /**
  * Check if a given object implements the RecommendRequest interface.
  */
 export function instanceOfRecommendRequest(value: object): value is RecommendRequest {
-    if (!('phoneNumber' in value) || value['phoneNumber'] === undefined) return false;
     return true;
 }
 
@@ -57,9 +62,10 @@ export function RecommendRequestFromJSONTyped(json: any, ignoreDiscriminator: bo
     }
     return {
         
-        'phoneNumber': json['phoneNumber'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
         'countries': json['countries'] == null ? undefined : json['countries'],
-        'states': json['states'] == null ? undefined : json['states'],
+        'subdivisions': json['subdivisions'] == null ? undefined : json['subdivisions'],
+        'includeDisabledProviders': json['includeDisabledProviders'] == null ? undefined : json['includeDisabledProviders'],
     };
 }
 
@@ -71,7 +77,8 @@ export function RecommendRequestToJSON(value?: RecommendRequest | null): any {
         
         'phoneNumber': value['phoneNumber'],
         'countries': value['countries'],
-        'states': value['states'],
+        'subdivisions': value['subdivisions'],
+        'includeDisabledProviders': value['includeDisabledProviders'],
     };
 }
 

package/src/models/RecommendResponse.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1

package/src/models/RefreshStepContentRequest.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 RefreshStepContentRequest
+ */
+export interface RefreshStepContentRequest {
+    /**
+     * The `ResultsAccessKey` returned when the Session was created
+     * @type {string}
+     * @memberof RefreshStepContentRequest
+     */
+    resultsAccessKey?: string;
+}
+
+/**
+ * Check if a given object implements the RefreshStepContentRequest interface.
+ */
+export function instanceOfRefreshStepContentRequest(value: object): value is RefreshStepContentRequest {
+    return true;
+}
+
+export function RefreshStepContentRequestFromJSON(json: any): RefreshStepContentRequest {
+    return RefreshStepContentRequestFromJSONTyped(json, false);
+}
+
+export function RefreshStepContentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefreshStepContentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+    };
+}
+
+export function RefreshStepContentRequestToJSON(value?: RefreshStepContentRequest | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'resultsAccessKey': value['resultsAccessKey'],
+    };
+}
+

package/src/models/RefreshStepContentResponse.ts

@@ -0,0 +1,68 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { IntegrationStep } from './IntegrationStep';
+import {
+    IntegrationStepFromJSON,
+    IntegrationStepFromJSONTyped,
+    IntegrationStepToJSON,
+} from './IntegrationStep';
+
+/**
+ * 
+ * @export
+ * @interface RefreshStepContentResponse
+ */
+export interface RefreshStepContentResponse {
+    /**
+     * The integration's next step with refreshed content
+     * @type {IntegrationStep}
+     * @memberof RefreshStepContentResponse
+     */
+    nextStep: IntegrationStep;
+}
+
+/**
+ * Check if a given object implements the RefreshStepContentResponse interface.
+ */
+export function instanceOfRefreshStepContentResponse(value: object): value is RefreshStepContentResponse {
+    if (!('nextStep' in value) || value['nextStep'] === undefined) return false;
+    return true;
+}
+
+export function RefreshStepContentResponseFromJSON(json: any): RefreshStepContentResponse {
+    return RefreshStepContentResponseFromJSONTyped(json, false);
+}
+
+export function RefreshStepContentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefreshStepContentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nextStep': IntegrationStepFromJSON(json['nextStep']),
+    };
+}
+
+export function RefreshStepContentResponseToJSON(value?: RefreshStepContentResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'nextStep': IntegrationStepToJSON(value['nextStep']),
+    };
+}
+

package/src/models/ResultCollection.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ResultCollectionMethod } from './ResultCollectionMethod';
+import {
+    ResultCollectionMethodFromJSON,
+    ResultCollectionMethodFromJSONTyped,
+    ResultCollectionMethodToJSON,
+} from './ResultCollectionMethod';
+
+/**
+ * 
+ * @export
+ * @interface ResultCollection
+ */
+export interface ResultCollection {
+    /**
+     * The method by which the results of the Acceptance Session should be collected.
+     * @type {ResultCollectionMethod}
+     * @memberof ResultCollection
+     */
+    method: ResultCollectionMethod;
+    /**
+     * If the method is `PollResult`, this is the key that should be used to poll for the results.
+     * @type {string}
+     * @memberof ResultCollection
+     */
+    resultsAccessKey?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ResultCollection interface.
+ */
+export function instanceOfResultCollection(value: object): value is ResultCollection {
+    if (!('method' in value) || value['method'] === undefined) return false;
+    return true;
+}
+
+export function ResultCollectionFromJSON(json: any): ResultCollection {
+    return ResultCollectionFromJSONTyped(json, false);
+}
+
+export function ResultCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultCollection {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'method': ResultCollectionMethodFromJSON(json['method']),
+        'resultsAccessKey': json['resultsAccessKey'] == null ? undefined : json['resultsAccessKey'],
+    };
+}
+
+export function ResultCollectionToJSON(value?: ResultCollection | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'method': ResultCollectionMethodToJSON(value['method']),
+        'resultsAccessKey': value['resultsAccessKey'],
+    };
+}
+

package/src/models/ResultCollectionMethod.ts

@@ -0,0 +1,49 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const ResultCollectionMethod = {
+    PollResult: 'PollResult',
+    CaptureRedirect: 'CaptureRedirect'
+} as const;
+export type ResultCollectionMethod = typeof ResultCollectionMethod[keyof typeof ResultCollectionMethod];
+
+
+export function instanceOfResultCollectionMethod(value: any): boolean {
+    for (const key in ResultCollectionMethod) {
+        if (Object.prototype.hasOwnProperty.call(ResultCollectionMethod, key)) {
+            if (ResultCollectionMethod[key as keyof typeof ResultCollectionMethod] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ResultCollectionMethodFromJSON(json: any): ResultCollectionMethod {
+    return ResultCollectionMethodFromJSONTyped(json, false);
+}
+
+export function ResultCollectionMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResultCollectionMethod {
+    return json as ResultCollectionMethod;
+}
+
+export function ResultCollectionMethodToJSON(value?: ResultCollectionMethod | null): any {
+    return value as any;
+}
+

package/src/models/Session.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1
@@ -13,30 +13,12 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SessionState } from './SessionState';
+import type { SessionErrorCode } from './SessionErrorCode';
 import {
-    SessionStateFromJSON,
-    SessionStateFromJSONTyped,
-    SessionStateToJSON,
-} from './SessionState';
-import type { DisclosedFields } from './DisclosedFields';
-import {
-    DisclosedFieldsFromJSON,
-    DisclosedFieldsFromJSONTyped,
-    DisclosedFieldsToJSON,
-} from './DisclosedFields';
-import type { SessionFailCode } from './SessionFailCode';
-import {
-    SessionFailCodeFromJSON,
-    SessionFailCodeFromJSONTyped,
-    SessionFailCodeToJSON,
-} from './SessionFailCode';
-import type { Verification } from './Verification';
-import {
-    VerificationFromJSON,
-    VerificationFromJSONTyped,
-    VerificationToJSON,
-} from './Verification';
+    SessionErrorCodeFromJSON,
+    SessionErrorCodeFromJSONTyped,
+    SessionErrorCodeToJSON,
+} from './SessionErrorCode';
 
 /**
  * 
@@ -51,29 +33,30 @@ export interface Session {
      */
     id: string;
     /**
-     * The state of the session
-     * @type {SessionState}
-     * @memberof Session
-     */
-    state: SessionState;
-    /**
-     * If the session is in state `IdvFailed`, this field contains the reason for failure.
-     * @type {SessionFailCode}
+     * 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
      */
-    failCode?: SessionFailCode;
+    done: boolean;
     /**
-     * The underlying verification for this Session
-     * @type {Verification}
+     * 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
      */
-    verification: Verification;
+    success: boolean;
     /**
-     * The fields that were requested to be disclosed when the Session was created
-     * @type {DisclosedFields}
+     * The reason for the Session's failure.
+     *             
+     * Only present if `Success` is `false`.
+     * @type {SessionErrorCode}
      * @memberof Session
      */
-    disclosedFields: DisclosedFields;
+    errorCode?: SessionErrorCode;
     /**
      * The unix timestamp, in seconds, when this session was created
      * @type {number}
@@ -95,9 +78,8 @@ export interface Session {
  */
 export function instanceOfSession(value: object): value is Session {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('state' in value) || value['state'] === undefined) return false;
-    if (!('verification' in value) || value['verification'] === undefined) return false;
-    if (!('disclosedFields' in value) || value['disclosedFields'] === undefined) return false;
+    if (!('done' in value) || value['done'] === undefined) return false;
+    if (!('success' in value) || value['success'] === undefined) return false;
     if (!('created' in value) || value['created'] === undefined) return false;
     if (!('updated' in value) || value['updated'] === undefined) return false;
     return true;
@@ -114,10 +96,9 @@ export function SessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): S
     return {
         
         'id': json['id'],
-        'state': SessionStateFromJSON(json['state']),
-        'failCode': json['failCode'] == null ? undefined : SessionFailCodeFromJSON(json['failCode']),
-        'verification': VerificationFromJSON(json['verification']),
-        'disclosedFields': DisclosedFieldsFromJSON(json['disclosedFields']),
+        'done': json['done'],
+        'success': json['success'],
+        'errorCode': json['errorCode'] == null ? undefined : SessionErrorCodeFromJSON(json['errorCode']),
         'created': json['created'],
         'updated': json['updated'],
     };
@@ -130,10 +111,9 @@ export function SessionToJSON(value?: Session | null): any {
     return {
         
         'id': value['id'],
-        'state': SessionStateToJSON(value['state']),
-        'failCode': SessionFailCodeToJSON(value['failCode']),
-        'verification': VerificationToJSON(value['verification']),
-        'disclosedFields': DisclosedFieldsToJSON(value['disclosedFields']),
+        'done': value['done'],
+        'success': value['success'],
+        'errorCode': SessionErrorCodeToJSON(value['errorCode']),
         'created': value['created'],
         'updated': value['updated'],
     };

package/src/models/SessionErrorCode.ts

@@ -0,0 +1,57 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const SessionErrorCode = {
+    Internal: 'Internal',
+    Other: 'Other',
+    Canceled: 'Canceled',
+    UserAbandoned: 'UserAbandoned',
+    UserTimedOut: 'UserTimedOut',
+    Expired: 'Expired',
+    InvalidImage: 'InvalidImage',
+    Inauthentic: 'Inauthentic',
+    UnsupportedDocument: 'UnsupportedDocument',
+    AssuranceLevelNotMet: 'AssuranceLevelNotMet'
+} as const;
+export type SessionErrorCode = typeof SessionErrorCode[keyof typeof SessionErrorCode];
+
+
+export function instanceOfSessionErrorCode(value: any): boolean {
+    for (const key in SessionErrorCode) {
+        if (Object.prototype.hasOwnProperty.call(SessionErrorCode, key)) {
+            if (SessionErrorCode[key as keyof typeof SessionErrorCode] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SessionErrorCodeFromJSON(json: any): SessionErrorCode {
+    return SessionErrorCodeFromJSONTyped(json, false);
+}
+
+export function SessionErrorCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionErrorCode {
+    return json as SessionErrorCode;
+}
+
+export function SessionErrorCodeToJSON(value?: SessionErrorCode | null): any {
+    return value as any;
+}
+

package/src/models/SessionOrdering.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Connect API
+ * Trinsic API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
  * The version of the OpenAPI document: v1