@trinsic/api 1.2.0 → 2.0.0-alpha3

package/src/models/BangladeshNationalIdInput.ts

@@ -0,0 +1,84 @@
+/* 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 BangladeshNationalIdInput
+ */
+export interface BangladeshNationalIdInput {
+    /**
+     * The user's Bangladesh National ID number.
+     * @type {string}
+     * @memberof BangladeshNationalIdInput
+     */
+    nationalIdNumber?: string | null;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof BangladeshNationalIdInput
+     */
+    dateOfBirth?: Date | null;
+    /**
+     * The user's full name
+     * @type {string}
+     * @memberof BangladeshNationalIdInput
+     */
+    name?: string | null;
+    /**
+     * The base64-encoded bytes of the photo collected from the user
+     * @type {string}
+     * @memberof BangladeshNationalIdInput
+     */
+    photoBase64?: string | null;
+}
+
+/**
+ * Check if a given object implements the BangladeshNationalIdInput interface.
+ */
+export function instanceOfBangladeshNationalIdInput(value: object): value is BangladeshNationalIdInput {
+    return true;
+}
+
+export function BangladeshNationalIdInputFromJSON(json: any): BangladeshNationalIdInput {
+    return BangladeshNationalIdInputFromJSONTyped(json, false);
+}
+
+export function BangladeshNationalIdInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): BangladeshNationalIdInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'nationalIdNumber': json['nationalIdNumber'] == null ? undefined : json['nationalIdNumber'],
+        'dateOfBirth': json['dateOfBirth'] == null ? undefined : (new Date(json['dateOfBirth'])),
+        'name': json['name'] == null ? undefined : json['name'],
+        'photoBase64': json['photoBase64'] == null ? undefined : json['photoBase64'],
+    };
+}
+
+export function BangladeshNationalIdInputToJSON(value?: BangladeshNationalIdInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'nationalIdNumber': value['nationalIdNumber'],
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth'] as any).toISOString().substring(0,10)),
+        'name': value['name'],
+        'photoBase64': value['photoBase64'],
+    };
+}
+

package/src/models/BrazilCpfCheckInput.ts

@@ -0,0 +1,61 @@
+/* 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 BrazilCpfCheckInput
+ */
+export interface BrazilCpfCheckInput {
+    /**
+     * The user's 11-digit, numeric CPF Number
+     * @type {string}
+     * @memberof BrazilCpfCheckInput
+     */
+    cpfNumber: string;
+}
+
+/**
+ * Check if a given object implements the BrazilCpfCheckInput interface.
+ */
+export function instanceOfBrazilCpfCheckInput(value: object): value is BrazilCpfCheckInput {
+    if (!('cpfNumber' in value) || value['cpfNumber'] === undefined) return false;
+    return true;
+}
+
+export function BrazilCpfCheckInputFromJSON(json: any): BrazilCpfCheckInput {
+    return BrazilCpfCheckInputFromJSONTyped(json, false);
+}
+
+export function BrazilCpfCheckInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrazilCpfCheckInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'cpfNumber': json['cpfNumber'],
+    };
+}
+
+export function BrazilCpfCheckInputToJSON(value?: BrazilCpfCheckInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'cpfNumber': value['cpfNumber'],
+    };
+}
+

package/src/models/BrazilDigitalCnhInput.ts

@@ -0,0 +1,93 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface BrazilDigitalCnhInput
+ */
+export interface BrazilDigitalCnhInput {
+    /**
+     * The user's 11-digit, numeric CPF Number
+     * @type {string}
+     * @memberof BrazilDigitalCnhInput
+     */
+    cpfNumber: string;
+    /**
+     * The raw bytes of the digital CNH file collected from the user.
+     *             
+     * TODO: Lucas or JP help me describe these below vvvvvvvv
+     * This can be:
+     * - An image containing a physical or digital QR code
+     * - A PDF file exported from the CNH app
+     * - Some scary third thing?
+     * @type {string}
+     * @memberof BrazilDigitalCnhInput
+     */
+    digitalCnhFile?: string | null;
+    /**
+     * The MIME Type of the file contained in `DigitalCnhFile`.
+     *             
+     * Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
+     * @type {string}
+     * @memberof BrazilDigitalCnhInput
+     */
+    digitalCnhFileContentType?: string | null;
+    /**
+     * The raw bytes of the image of the user's face, collected for biometric comparison.
+     * @type {string}
+     * @memberof BrazilDigitalCnhInput
+     */
+    facialBiometryPhoto?: string | null;
+}
+
+/**
+ * Check if a given object implements the BrazilDigitalCnhInput interface.
+ */
+export function instanceOfBrazilDigitalCnhInput(value: object): value is BrazilDigitalCnhInput {
+    if (!('cpfNumber' in value) || value['cpfNumber'] === undefined) return false;
+    return true;
+}
+
+export function BrazilDigitalCnhInputFromJSON(json: any): BrazilDigitalCnhInput {
+    return BrazilDigitalCnhInputFromJSONTyped(json, false);
+}
+
+export function BrazilDigitalCnhInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrazilDigitalCnhInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'cpfNumber': json['cpfNumber'],
+        'digitalCnhFile': json['digitalCnhFile'] == null ? undefined : json['digitalCnhFile'],
+        'digitalCnhFileContentType': json['digitalCnhFileContentType'] == null ? undefined : json['digitalCnhFileContentType'],
+        'facialBiometryPhoto': json['facialBiometryPhoto'] == null ? undefined : json['facialBiometryPhoto'],
+    };
+}
+
+export function BrazilDigitalCnhInputToJSON(value?: BrazilDigitalCnhInput | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'cpfNumber': value['cpfNumber'],
+        'digitalCnhFile': value['digitalCnhFile'],
+        'digitalCnhFileContentType': value['digitalCnhFileContentType'],
+        'facialBiometryPhoto': value['facialBiometryPhoto'],
+    };
+}
+

package/src/models/CancelSessionResponse.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/CreateAdvancedProviderSessionRequest.ts

@@ -0,0 +1,133 @@
+/* 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 { IntegrationCapability } from './IntegrationCapability';
+import {
+    IntegrationCapabilityFromJSON,
+    IntegrationCapabilityFromJSONTyped,
+    IntegrationCapabilityToJSON,
+} from './IntegrationCapability';
+import type { ProviderInput } from './ProviderInput';
+import {
+    ProviderInputFromJSON,
+    ProviderInputFromJSONTyped,
+    ProviderInputToJSON,
+} from './ProviderInput';
+
+/**
+ * 
+ * @export
+ * @interface CreateAdvancedProviderSessionRequest
+ */
+export interface CreateAdvancedProviderSessionRequest {
+    /**
+     * The ID of the provider to launch
+     * @type {string}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    provider: string;
+    /**
+     * Provider-specific input for those providers which require it.
+     * @type {ProviderInput}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    providerInput?: ProviderInput | null;
+    /**
+     * The Redirect URL to which the user should be sent after the session is complete.
+     *             
+     * This field is required for providers which employ a redirect-based flow.
+     * @type {string}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    redirectUrl?: string | null;
+    /**
+     * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
+     *             
+     * Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.
+     * The exception being refresh content to support updating the content of the launch method.
+     *             
+     * For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.
+     * To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.
+     *             
+     * If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.
+     * If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.
+     *             
+     * Read more on how to integrate at <a href="https://docs.trinsic.id/docs/advanced-provider-sessions">the guide on Advanced Provider Sessions</a>
+     * @type {Array<IntegrationCapability>}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    capabilities: Array<IntegrationCapability>;
+    /**
+     * Whether the session should fall back to a Trinsic-hosted UI in certain instances.
+     *             
+     * Specifically, fallback will occur if any of the following are true:
+     * - You attempted to launch a provider which requires a capability you did not express support for
+     *     - In this case, Trinsic's hosted UI will perform the necessary capability
+     * - You attempted to launch a provider which requires input, and the input was either not provided or incomplete
+     *     - In this case, Trinsic's hosted UI will collect the necessary input from the user
+     *             
+     * If fallback occurs, the session's NextStep will always be LaunchBrowser,
+     * and the CollectionMethod will always be CaptureRedirect.
+     *             
+     * If this field is set to `true`, you must also:
+     * 1. Set the `RedirectUrl` field to a non-empty value
+     * 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
+     * @type {boolean}
+     * @memberof CreateAdvancedProviderSessionRequest
+     */
+    fallbackToHostedUI?: boolean | null;
+}
+
+/**
+ * Check if a given object implements the CreateAdvancedProviderSessionRequest interface.
+ */
+export function instanceOfCreateAdvancedProviderSessionRequest(value: object): value is CreateAdvancedProviderSessionRequest {
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    if (!('capabilities' in value) || value['capabilities'] === undefined) return false;
+    return true;
+}
+
+export function CreateAdvancedProviderSessionRequestFromJSON(json: any): CreateAdvancedProviderSessionRequest {
+    return CreateAdvancedProviderSessionRequestFromJSONTyped(json, false);
+}
+
+export function CreateAdvancedProviderSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAdvancedProviderSessionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'provider': json['provider'],
+        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
+        'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
+        'capabilities': ((json['capabilities'] as Array<any>).map(IntegrationCapabilityFromJSON)),
+        'fallbackToHostedUI': json['fallbackToHostedUI'] == null ? undefined : json['fallbackToHostedUI'],
+    };
+}
+
+export function CreateAdvancedProviderSessionRequestToJSON(value?: CreateAdvancedProviderSessionRequest | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'provider': value['provider'],
+        'providerInput': ProviderInputToJSON(value['providerInput']),
+        'redirectUrl': value['redirectUrl'],
+        'capabilities': ((value['capabilities'] as Array<any>).map(IntegrationCapabilityToJSON)),
+        'fallbackToHostedUI': value['fallbackToHostedUI'],
+    };
+}
+

package/src/models/CreateAdvancedProviderSessionResponse.ts

@@ -0,0 +1,92 @@
+/* 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 { ResultCollection } from './ResultCollection';
+import {
+    ResultCollectionFromJSON,
+    ResultCollectionFromJSONTyped,
+    ResultCollectionToJSON,
+} from './ResultCollection';
+import type { IntegrationStep } from './IntegrationStep';
+import {
+    IntegrationStepFromJSON,
+    IntegrationStepFromJSONTyped,
+    IntegrationStepToJSON,
+} from './IntegrationStep';
+
+/**
+ * 
+ * @export
+ * @interface CreateAdvancedProviderSessionResponse
+ */
+export interface CreateAdvancedProviderSessionResponse {
+    /**
+     * The ID of the newly-created Acceptance Session
+     * @type {string}
+     * @memberof CreateAdvancedProviderSessionResponse
+     */
+    sessionId: string;
+    /**
+     * The method by which you must collect the results of the Acceptance Session.
+     * @type {ResultCollection}
+     * @memberof CreateAdvancedProviderSessionResponse
+     */
+    resultCollection: ResultCollection;
+    /**
+     * The next step you must take to launch the user into the integration
+     * @type {IntegrationStep}
+     * @memberof CreateAdvancedProviderSessionResponse
+     */
+    nextStep: IntegrationStep;
+}
+
+/**
+ * Check if a given object implements the CreateAdvancedProviderSessionResponse interface.
+ */
+export function instanceOfCreateAdvancedProviderSessionResponse(value: object): value is CreateAdvancedProviderSessionResponse {
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('resultCollection' in value) || value['resultCollection'] === undefined) return false;
+    if (!('nextStep' in value) || value['nextStep'] === undefined) return false;
+    return true;
+}
+
+export function CreateAdvancedProviderSessionResponseFromJSON(json: any): CreateAdvancedProviderSessionResponse {
+    return CreateAdvancedProviderSessionResponseFromJSONTyped(json, false);
+}
+
+export function CreateAdvancedProviderSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAdvancedProviderSessionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sessionId': json['sessionId'],
+        'resultCollection': ResultCollectionFromJSON(json['resultCollection']),
+        'nextStep': IntegrationStepFromJSON(json['nextStep']),
+    };
+}
+
+export function CreateAdvancedProviderSessionResponseToJSON(value?: CreateAdvancedProviderSessionResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'sessionId': value['sessionId'],
+        'resultCollection': ResultCollectionToJSON(value['resultCollection']),
+        'nextStep': IntegrationStepToJSON(value['nextStep']),
+    };
+}
+

package/src/models/CreateHostedProviderSessionRequest.ts

@@ -0,0 +1,85 @@
+/* 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 { ProviderInput } from './ProviderInput';
+import {
+    ProviderInputFromJSON,
+    ProviderInputFromJSONTyped,
+    ProviderInputToJSON,
+} from './ProviderInput';
+
+/**
+ * 
+ * @export
+ * @interface CreateHostedProviderSessionRequest
+ */
+export interface CreateHostedProviderSessionRequest {
+    /**
+     * The ID of the provider to launch
+     * @type {string}
+     * @memberof CreateHostedProviderSessionRequest
+     */
+    provider: string;
+    /**
+     * The Redirect URL to which the user should be sent after the session is complete.
+     * @type {string}
+     * @memberof CreateHostedProviderSessionRequest
+     */
+    redirectUrl: string;
+    /**
+     * Provider-specific input for those providers which require it.
+     * @type {ProviderInput}
+     * @memberof CreateHostedProviderSessionRequest
+     */
+    providerInput?: ProviderInput | null;
+}
+
+/**
+ * Check if a given object implements the CreateHostedProviderSessionRequest interface.
+ */
+export function instanceOfCreateHostedProviderSessionRequest(value: object): value is CreateHostedProviderSessionRequest {
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    if (!('redirectUrl' in value) || value['redirectUrl'] === undefined) return false;
+    return true;
+}
+
+export function CreateHostedProviderSessionRequestFromJSON(json: any): CreateHostedProviderSessionRequest {
+    return CreateHostedProviderSessionRequestFromJSONTyped(json, false);
+}
+
+export function CreateHostedProviderSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateHostedProviderSessionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'provider': json['provider'],
+        'redirectUrl': json['redirectUrl'],
+        'providerInput': json['providerInput'] == null ? undefined : ProviderInputFromJSON(json['providerInput']),
+    };
+}
+
+export function CreateHostedProviderSessionRequestToJSON(value?: CreateHostedProviderSessionRequest | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'provider': value['provider'],
+        'redirectUrl': value['redirectUrl'],
+        'providerInput': ProviderInputToJSON(value['providerInput']),
+    };
+}
+

package/src/models/CreateHostedProviderSessionResponse.ts

@@ -0,0 +1,75 @@
+/* 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 CreateHostedProviderSessionResponse
+ */
+export interface CreateHostedProviderSessionResponse {
+    /**
+     * The ID of the newly-created Acceptance Session
+     * @type {string}
+     * @memberof CreateHostedProviderSessionResponse
+     */
+    sessionId: string;
+    /**
+     * The URL that should be used to launch the Hosted Provider Session on your user's device.
+     *             
+     * There are two recommended ways to do so:
+     * - Redirect their browser to the `LaunchUrl` as a top-level navigation
+     * - Open a popup window and navigate it to the `LaunchUrl`
+     *             
+     * This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
+     * @type {string}
+     * @memberof CreateHostedProviderSessionResponse
+     */
+    launchUrl?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateHostedProviderSessionResponse interface.
+ */
+export function instanceOfCreateHostedProviderSessionResponse(value: object): value is CreateHostedProviderSessionResponse {
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    return true;
+}
+
+export function CreateHostedProviderSessionResponseFromJSON(json: any): CreateHostedProviderSessionResponse {
+    return CreateHostedProviderSessionResponseFromJSONTyped(json, false);
+}
+
+export function CreateHostedProviderSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateHostedProviderSessionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sessionId': json['sessionId'],
+        'launchUrl': json['launchUrl'] == null ? undefined : json['launchUrl'],
+    };
+}
+
+export function CreateHostedProviderSessionResponseToJSON(value?: CreateHostedProviderSessionResponse | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'sessionId': value['sessionId'],
+        'launchUrl': value['launchUrl'],
+    };
+}
+