@trinsic/api 2.0.0-alpha2 → 2.0.0

package/dist/esm/models/SpidInput.js

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

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

@@ -0,0 +1,54 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information about a sub-provider.
+ * @export
+ * @interface SubProviderMetadata
+ */
+export interface SubProviderMetadata {
+    /**
+     * The ID of the sub-provider.
+     *
+     * This cannot be used as a standalone Provider ID when creating a Session. It must
+     * be passed in via the Provider-specific input.
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    id: string;
+    /**
+     * The name of the sub-provider
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    name: string;
+    /**
+     * Flavor text for the sub-provider
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    description: string;
+    /**
+     * A URL pointing to the logo on Trinsic's CDN.
+     *
+     * May be a PNG, JPG, or SVG image.
+     * @type {string}
+     * @memberof SubProviderMetadata
+     */
+    logoUrl: string;
+}
+/**
+ * Check if a given object implements the SubProviderMetadata interface.
+ */
+export declare function instanceOfSubProviderMetadata(value: object): value is SubProviderMetadata;
+export declare function SubProviderMetadataFromJSON(json: any): SubProviderMetadata;
+export declare function SubProviderMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubProviderMetadata;
+export declare function SubProviderMetadataToJSON(value?: SubProviderMetadata | null): any;

package/dist/esm/models/SubProviderMetadata.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the SubProviderMetadata interface.
+ */
+export function instanceOfSubProviderMetadata(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined)
+        return false;
+    return true;
+}
+export function SubProviderMetadataFromJSON(json) {
+    return SubProviderMetadataFromJSONTyped(json, false);
+}
+export function SubProviderMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'logoUrl': json['logoUrl'],
+    };
+}
+export function SubProviderMetadataToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'logoUrl': value['logoUrl'],
+    };
+}

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

@@ -0,0 +1,66 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface TrinsicTestDatabaseLookupInput
+ */
+export interface TrinsicTestDatabaseLookupInput {
+    /**
+     * The given name to use for the output of the test Session.
+     *
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *
+     * Can be any non-empty value.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    givenName?: string | null;
+    /**
+     * The family name to use for the output of the test Session.
+     *
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *
+     * Can be any non-empty value.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    familyName?: string | null;
+    /**
+     * A 6-digit code; must be "123456" for the Session to succeed.
+     *
+     * This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it
+     * from the user.
+     *
+     * Any other value will cause the Session to fail.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    identityCode?: string | null;
+    /**
+     * An optional selfie image, base64-encoded.
+     *
+     * Will replace the existing test selfie attachment output if provided.
+     * @type {string}
+     * @memberof TrinsicTestDatabaseLookupInput
+     */
+    selfieBase64?: string | null;
+}
+/**
+ * Check if a given object implements the TrinsicTestDatabaseLookupInput interface.
+ */
+export declare function instanceOfTrinsicTestDatabaseLookupInput(value: object): value is TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputFromJSON(json: any): TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestDatabaseLookupInput;
+export declare function TrinsicTestDatabaseLookupInputToJSON(value?: TrinsicTestDatabaseLookupInput | null): any;

package/dist/esm/models/TrinsicTestDatabaseLookupInput.js

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

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

@@ -0,0 +1,35 @@
+/**
+ * Trinsic API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface TrinsicTestSubProvidersInput
+ */
+export interface TrinsicTestSubProvidersInput {
+    /**
+     * The ID of the specific IDP to invoke within the test federated provider.
+     *
+     * Valid options are `sub-provider-a` and `sub-provider-b`.
+     *
+     * If not specified, the user will be prompted to select one.
+     * @type {string}
+     * @memberof TrinsicTestSubProvidersInput
+     */
+    subProviderId?: string | null;
+}
+/**
+ * Check if a given object implements the TrinsicTestSubProvidersInput interface.
+ */
+export declare function instanceOfTrinsicTestSubProvidersInput(value: object): value is TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputFromJSON(json: any): TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrinsicTestSubProvidersInput;
+export declare function TrinsicTestSubProvidersInputToJSON(value?: TrinsicTestSubProvidersInput | null): any;

package/dist/esm/models/TrinsicTestSubProvidersInput.js

@@ -0,0 +1,38 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the TrinsicTestSubProvidersInput interface.
+ */
+export function instanceOfTrinsicTestSubProvidersInput(value) {
+    return true;
+}
+export function TrinsicTestSubProvidersInputFromJSON(json) {
+    return TrinsicTestSubProvidersInputFromJSONTyped(json, false);
+}
+export function TrinsicTestSubProvidersInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
+    };
+}
+export function TrinsicTestSubProvidersInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subProviderId': value['subProviderId'],
+    };
+}

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

@@ -21,25 +21,32 @@ export * from './GetSessionResultRequest';
 export * from './GetSessionResultResponse';
 export * from './HttpValidationProblemDetails';
 export * from './IdentityData';
+export * from './IdinInput';
+export * from './IndonesiaNikInput';
 export * from './IntegrationCapability';
 export * from './IntegrationLaunchMethod';
 export * from './IntegrationStep';
-export * from './KnownAddress';
-export * from './KnownIdentityData';
-export * from './KnownPersonData';
+export * from './KenyaNidInput';
+export * from './Language';
+export * from './ListProviderContractsResponse';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
+export * from './MexicoCurpInput';
+export * from './MobileIdInput';
+export * from './NigeriaNinInput';
 export * from './OrderDirection';
 export * from './PersonData';
 export * from './PhilippineMatchInput';
 export * from './PhilippineQRInput';
 export * from './ProblemDetails';
 export * from './ProviderAttachments';
+export * from './ProviderContract';
 export * from './ProviderInfo';
 export * from './ProviderInformation';
 export * from './ProviderInput';
 export * from './RecommendRequest';
 export * from './RecommendResponse';
+export * from './RecommendationInfo';
 export * from './RefreshStepContentRequest';
 export * from './RefreshStepContentResponse';
 export * from './ResultCollection';
@@ -48,4 +55,10 @@ export * from './Session';
 export * from './SessionErrorCode';
 export * from './SessionOrdering';
 export * from './Sex';
+export * from './SmartIdInput';
+export * from './SouthAfricaNidInput';
+export * from './SpidInput';
 export * from './StepRefreshInfo';
+export * from './SubProviderMetadata';
+export * from './TrinsicTestDatabaseLookupInput';
+export * from './TrinsicTestSubProvidersInput';

package/dist/esm/models/index.js

@@ -23,25 +23,32 @@ export * from './GetSessionResultRequest';
 export * from './GetSessionResultResponse';
 export * from './HttpValidationProblemDetails';
 export * from './IdentityData';
+export * from './IdinInput';
+export * from './IndonesiaNikInput';
 export * from './IntegrationCapability';
 export * from './IntegrationLaunchMethod';
 export * from './IntegrationStep';
-export * from './KnownAddress';
-export * from './KnownIdentityData';
-export * from './KnownPersonData';
+export * from './KenyaNidInput';
+export * from './Language';
+export * from './ListProviderContractsResponse';
 export * from './ListProvidersResponse';
 export * from './ListSessionsResponse';
+export * from './MexicoCurpInput';
+export * from './MobileIdInput';
+export * from './NigeriaNinInput';
 export * from './OrderDirection';
 export * from './PersonData';
 export * from './PhilippineMatchInput';
 export * from './PhilippineQRInput';
 export * from './ProblemDetails';
 export * from './ProviderAttachments';
+export * from './ProviderContract';
 export * from './ProviderInfo';
 export * from './ProviderInformation';
 export * from './ProviderInput';
 export * from './RecommendRequest';
 export * from './RecommendResponse';
+export * from './RecommendationInfo';
 export * from './RefreshStepContentRequest';
 export * from './RefreshStepContentResponse';
 export * from './ResultCollection';
@@ -50,4 +57,10 @@ export * from './Session';
 export * from './SessionErrorCode';
 export * from './SessionOrdering';
 export * from './Sex';
+export * from './SmartIdInput';
+export * from './SouthAfricaNidInput';
+export * from './SpidInput';
 export * from './StepRefreshInfo';
+export * from './SubProviderMetadata';
+export * from './TrinsicTestDatabaseLookupInput';
+export * from './TrinsicTestSubProvidersInput';

package/dist/models/AadhaarInput.d.ts

@@ -20,13 +20,13 @@ export interface AadhaarInput {
      * @type {string}
      * @memberof AadhaarInput
      */
-    fullName?: string;
+    fullName?: string | null;
     /**
      * The user's date of birth, in `YYYY-MM-DD` format
      * @type {Date}
      * @memberof AadhaarInput
      */
-    dateOfBirth?: Date;
+    dateOfBirth?: Date | null;
 }
 /**
  * Check if a given object implements the AadhaarInput interface.

package/dist/models/AadhaarInput.js

@@ -41,6 +41,6 @@ function AadhaarInputToJSON(value) {
     }
     return {
         'fullName': value['fullName'],
-        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
     };
 }

package/dist/models/Address.d.ts

@@ -20,49 +20,49 @@ export interface Address {
      * @type {string}
      * @memberof Address
      */
-    line1?: string;
+    line1?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    line2?: string;
+    line2?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    line3?: string;
+    line3?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    city?: string;
+    city?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    subdivision?: string;
+    subdivision?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    postalCode?: string;
+    postalCode?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    country?: string;
+    country?: string | null;
     /**
      *
      * @type {string}
      * @memberof Address
      */
-    fullAddress?: string;
+    fullAddress?: string | null;
 }
 /**
  * Check if a given object implements the Address interface.

package/dist/models/AttachmentAccessKeys.d.ts

@@ -21,25 +21,25 @@ export interface AttachmentAccessKeys {
      * @type {string}
      * @memberof AttachmentAccessKeys
      */
-    selfie?: string;
+    selfie?: string | null;
     /**
      *
      * @type {string}
      * @memberof AttachmentAccessKeys
      */
-    documentFront?: string;
+    documentFront?: string | null;
     /**
      *
      * @type {string}
      * @memberof AttachmentAccessKeys
      */
-    documentBack?: string;
+    documentBack?: string | null;
     /**
      *
      * @type {string}
      * @memberof AttachmentAccessKeys
      */
-    documentPortrait?: string;
+    documentPortrait?: string | null;
     /**
      *
      * @type {ProviderAttachments}

package/dist/models/BangladeshNationalIdInput.d.ts

@@ -20,25 +20,25 @@ export interface BangladeshNationalIdInput {
      * @type {string}
      * @memberof BangladeshNationalIdInput
      */
-    nationalIdNumber?: string;
+    nationalIdNumber?: string | null;
     /**
      * The user's date of birth, in `YYYY-MM-DD` format
      * @type {Date}
      * @memberof BangladeshNationalIdInput
      */
-    dateOfBirth?: Date;
+    dateOfBirth?: Date | null;
     /**
      * The user's full name
      * @type {string}
      * @memberof BangladeshNationalIdInput
      */
-    name?: string;
+    name?: string | null;
     /**
      * The base64-encoded bytes of the photo collected from the user
      * @type {string}
      * @memberof BangladeshNationalIdInput
      */
-    photoBase64?: string;
+    photoBase64?: string | null;
 }
 /**
  * Check if a given object implements the BangladeshNationalIdInput interface.

package/dist/models/BangladeshNationalIdInput.js

@@ -43,7 +43,7 @@ function BangladeshNationalIdInputToJSON(value) {
     }
     return {
         'nationalIdNumber': value['nationalIdNumber'],
-        'dateOfBirth': value['dateOfBirth'] == null ? undefined : ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'dateOfBirth': value['dateOfBirth'] == null ? undefined : (value['dateOfBirth'].toISOString().substring(0, 10)),
         'name': value['name'],
         'photoBase64': value['photoBase64'],
     };

package/dist/models/BrazilDigitalCnhInput.d.ts

@@ -32,7 +32,7 @@ export interface BrazilDigitalCnhInput {
      * @type {string}
      * @memberof BrazilDigitalCnhInput
      */
-    digitalCnhFile?: string;
+    digitalCnhFile?: string | null;
     /**
      * The MIME Type of the file contained in `DigitalCnhFile`.
      *
@@ -40,13 +40,13 @@ export interface BrazilDigitalCnhInput {
      * @type {string}
      * @memberof BrazilDigitalCnhInput
      */
-    digitalCnhFileContentType?: string;
+    digitalCnhFileContentType?: string | null;
     /**
      * The raw bytes of the image of the user's face, collected for biometric comparison.
      * @type {string}
      * @memberof BrazilDigitalCnhInput
      */
-    facialBiometryPhoto?: string;
+    facialBiometryPhoto?: string | null;
 }
 /**
  * Check if a given object implements the BrazilDigitalCnhInput interface.

package/dist/models/CreateAdvancedProviderSessionRequest.d.ts

@@ -28,7 +28,7 @@ export interface CreateAdvancedProviderSessionRequest {
      * @type {ProviderInput}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    providerInput?: ProviderInput;
+    providerInput?: ProviderInput | null;
     /**
      * The Redirect URL to which the user should be sent after the session is complete.
      *
@@ -36,7 +36,7 @@ export interface CreateAdvancedProviderSessionRequest {
      * @type {string}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    redirectUrl?: string;
+    redirectUrl?: string | null;
     /**
      * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
      *
@@ -72,7 +72,7 @@ export interface CreateAdvancedProviderSessionRequest {
      * @type {boolean}
      * @memberof CreateAdvancedProviderSessionRequest
      */
-    fallbackToHostedUI?: boolean;
+    fallbackToHostedUI?: boolean | null;
 }
 /**
  * Check if a given object implements the CreateAdvancedProviderSessionRequest interface.

package/dist/models/CreateHostedProviderSessionRequest.d.ts

@@ -33,7 +33,7 @@ export interface CreateHostedProviderSessionRequest {
      * @type {ProviderInput}
      * @memberof CreateHostedProviderSessionRequest
      */
-    providerInput?: ProviderInput;
+    providerInput?: ProviderInput | null;
 }
 /**
  * Check if a given object implements the CreateHostedProviderSessionRequest interface.

package/dist/models/CreateHostedProviderSessionResponse.d.ts

@@ -32,7 +32,19 @@ export interface CreateHostedProviderSessionResponse {
      * @type {string}
      * @memberof CreateHostedProviderSessionResponse
      */
-    launchUrl?: string;
+    launchUrl: string;
+    /**
+     * 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 CreateHostedProviderSessionResponse
+     */
+    resultsAccessKey: string;
 }
 /**
  * Check if a given object implements the CreateHostedProviderSessionResponse interface.