@trinsic/api 2.0.0-alpha2 → 2.0.0-alpha3

package/.openapi-generator/FILES

@@ -31,14 +31,18 @@ src/models/GetSessionResultRequest.ts
 src/models/GetSessionResultResponse.ts
 src/models/HttpValidationProblemDetails.ts
 src/models/IdentityData.ts
+src/models/IndonesiaNikInput.ts
 src/models/IntegrationCapability.ts
 src/models/IntegrationLaunchMethod.ts
 src/models/IntegrationStep.ts
+src/models/KenyaNidInput.ts
 src/models/KnownAddress.ts
 src/models/KnownIdentityData.ts
 src/models/KnownPersonData.ts
 src/models/ListProvidersResponse.ts
 src/models/ListSessionsResponse.ts
+src/models/MexicoCurpInput.ts
+src/models/NigeriaNinInput.ts
 src/models/OrderDirection.ts
 src/models/PersonData.ts
 src/models/PhilippineMatchInput.ts
@@ -58,6 +62,7 @@ src/models/Session.ts
 src/models/SessionErrorCode.ts
 src/models/SessionOrdering.ts
 src/models/Sex.ts
+src/models/SouthAfricaNidInput.ts
 src/models/StepRefreshInfo.ts
 src/models/index.ts
 src/runtime.ts

package/dist/apis/NetworkApi.d.ts

@@ -35,7 +35,7 @@ export interface NetworkApiInterface {
      */
     listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * @summary Recommend Providers
      * @param {RecommendRequest} [recommendRequest]
      * @param {*} [options] Override http request option.
@@ -44,7 +44,7 @@ export interface NetworkApiInterface {
      */
     recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse>;
@@ -64,12 +64,12 @@ export declare class NetworkApi extends runtime.BaseAPI implements NetworkApiInt
      */
     listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse>;

package/dist/apis/NetworkApi.js

@@ -64,7 +64,7 @@ class NetworkApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProvidersRaw(requestParameters, initOverrides) {
@@ -90,7 +90,7 @@ class NetworkApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest, initOverrides) {

package/dist/esm/apis/NetworkApi.d.ts

@@ -35,7 +35,7 @@ export interface NetworkApiInterface {
      */
     listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * @summary Recommend Providers
      * @param {RecommendRequest} [recommendRequest]
      * @param {*} [options] Override http request option.
@@ -44,7 +44,7 @@ export interface NetworkApiInterface {
      */
     recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse>;
@@ -64,12 +64,12 @@ export declare class NetworkApi extends runtime.BaseAPI implements NetworkApiInt
      */
     listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProvidersRaw(requestParameters: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecommendResponse>>;
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest?: RecommendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendResponse>;

package/dist/esm/apis/NetworkApi.js

@@ -61,7 +61,7 @@ export class NetworkApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProvidersRaw(requestParameters, initOverrides) {
@@ -87,7 +87,7 @@ export class NetworkApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Generate provider recommendations based on the given signals (phone number, countries, states). This is an experimental feature and may not be accurate
+     * Generate provider recommendations based on the given signals (phone number, countries, states).
      * Recommend Providers
      */
     recommendProviders(recommendRequest, initOverrides) {

package/dist/esm/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/esm/models/AadhaarInput.js

@@ -35,6 +35,6 @@ export 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/esm/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/esm/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/esm/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/esm/models/BangladeshNationalIdInput.js

@@ -37,7 +37,7 @@ export 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/esm/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/esm/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/esm/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/esm/models/CreateHostedProviderSessionResponse.d.ts

@@ -32,7 +32,7 @@ export interface CreateHostedProviderSessionResponse {
      * @type {string}
      * @memberof CreateHostedProviderSessionResponse
      */
-    launchUrl?: string;
+    launchUrl?: string | null;
 }
 /**
  * Check if a given object implements the CreateHostedProviderSessionResponse interface.

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

@@ -24,13 +24,13 @@ export interface CreateWidgetSessionRequest {
      * @type {string}
      * @memberof CreateWidgetSessionRequest
      */
-    redirectUrl?: string;
+    redirectUrl?: string | null;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      * @type {Array<string>}
      * @memberof CreateWidgetSessionRequest
      */
-    providers?: Array<string>;
+    providers?: Array<string> | null;
     /**
      * Known identity data of an individual being verified.
      *
@@ -38,7 +38,7 @@ export interface CreateWidgetSessionRequest {
      * @type {KnownIdentityData}
      * @memberof CreateWidgetSessionRequest
      */
-    knownIdentityData?: KnownIdentityData;
+    knownIdentityData?: KnownIdentityData | null;
 }
 /**
  * Check if a given object implements the CreateWidgetSessionRequest interface.

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

@@ -30,7 +30,7 @@ export interface CreateWidgetSessionResponse {
      * @type {string}
      * @memberof CreateWidgetSessionResponse
      */
-    launchUrl?: string;
+    launchUrl?: string | null;
 }
 /**
  * Check if a given object implements the CreateWidgetSessionResponse interface.

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

@@ -21,37 +21,37 @@ export interface DocumentData {
      * @type {DocumentType}
      * @memberof DocumentData
      */
-    type?: DocumentType;
+    type?: DocumentType | null;
     /**
      *
      * @type {string}
      * @memberof DocumentData
      */
-    number?: string;
+    number?: string | null;
     /**
      *
      * @type {Date}
      * @memberof DocumentData
      */
-    issueDate?: Date;
+    issueDate?: Date | null;
     /**
      *
      * @type {Date}
      * @memberof DocumentData
      */
-    expirationDate?: Date;
+    expirationDate?: Date | null;
     /**
      *
      * @type {string}
      * @memberof DocumentData
      */
-    issuingCountry?: string;
+    issuingCountry?: string | null;
     /**
      *
      * @type {string}
      * @memberof DocumentData
      */
-    issuingAuthority?: string;
+    issuingAuthority?: string | null;
 }
 /**
  * Check if a given object implements the DocumentData interface.

package/dist/esm/models/DocumentData.js

@@ -41,8 +41,8 @@ export function DocumentDataToJSON(value) {
     return {
         'type': DocumentTypeToJSON(value['type']),
         'number': value['number'],
-        'issueDate': value['issueDate'] == null ? undefined : ((value['issueDate']).toISOString().substring(0, 10)),
-        'expirationDate': value['expirationDate'] == null ? undefined : ((value['expirationDate']).toISOString().substring(0, 10)),
+        'issueDate': value['issueDate'] == null ? undefined : (value['issueDate'].toISOString().substring(0, 10)),
+        'expirationDate': value['expirationDate'] == null ? undefined : (value['expirationDate'].toISOString().substring(0, 10)),
         'issuingCountry': value['issuingCountry'],
         'issuingAuthority': value['issuingAuthority'],
     };

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

@@ -20,7 +20,7 @@ export interface DocumentScanAttachments {
      * @type {string}
      * @memberof DocumentScanAttachments
      */
-    report?: string;
+    report?: string | null;
 }
 /**
  * Check if a given object implements the DocumentScanAttachments interface.

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

@@ -28,7 +28,7 @@ export interface GetSessionResultResponse {
      * @type {IdentityData}
      * @memberof GetSessionResultResponse
      */
-    identityData?: IdentityData;
+    identityData?: IdentityData | null;
 }
 /**
  * Check if a given object implements the GetSessionResultResponse interface.

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

@@ -20,31 +20,31 @@ export interface HttpValidationProblemDetails {
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    type?: string;
+    type?: string | null;
     /**
      *
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    title?: string;
+    title?: string | null;
     /**
      *
      * @type {number}
      * @memberof HttpValidationProblemDetails
      */
-    status?: number;
+    status?: number | null;
     /**
      *
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    detail?: string;
+    detail?: string | null;
     /**
      *
      * @type {string}
      * @memberof HttpValidationProblemDetails
      */
-    instance?: string;
+    instance?: string | null;
     /**
      *
      * @type {{ [key: string]: Array<string>; }}

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

@@ -23,25 +23,25 @@ export interface IdentityData {
      * @type {string}
      * @memberof IdentityData
      */
-    originatingProviderId?: string;
+    originatingProviderId?: string | null;
     /**
      *
      * @type {PersonData}
      * @memberof IdentityData
      */
-    person?: PersonData;
+    person?: PersonData | null;
     /**
      *
      * @type {DocumentData}
      * @memberof IdentityData
      */
-    document?: DocumentData;
+    document?: DocumentData | null;
     /**
      *
      * @type {AttachmentAccessKeys}
      * @memberof IdentityData
      */
-    attachmentAccessKeys?: AttachmentAccessKeys;
+    attachmentAccessKeys?: AttachmentAccessKeys | null;
 }
 /**
  * Check if a given object implements the IdentityData interface.

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

@@ -0,0 +1,43 @@
+/**
+ * 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 IndonesiaNikInput
+ */
+export interface IndonesiaNikInput {
+    /**
+     * The user's full name
+     * @type {string}
+     * @memberof IndonesiaNikInput
+     */
+    fullName: string;
+    /**
+     * The user's date of birth, in `YYYY-MM-DD` format
+     * @type {Date}
+     * @memberof IndonesiaNikInput
+     */
+    dateOfBirth: Date;
+    /**
+     * The user's Indonesia NIK ID number
+     * @type {string}
+     * @memberof IndonesiaNikInput
+     */
+    nikIdNumber: string;
+}
+/**
+ * Check if a given object implements the IndonesiaNikInput interface.
+ */
+export declare function instanceOfIndonesiaNikInput(value: object): value is IndonesiaNikInput;
+export declare function IndonesiaNikInputFromJSON(json: any): IndonesiaNikInput;
+export declare function IndonesiaNikInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndonesiaNikInput;
+export declare function IndonesiaNikInputToJSON(value?: IndonesiaNikInput | null): any;

package/dist/esm/models/IndonesiaNikInput.js

@@ -0,0 +1,48 @@
+/* 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 IndonesiaNikInput interface.
+ */
+export function instanceOfIndonesiaNikInput(value) {
+    if (!('fullName' in value) || value['fullName'] === undefined)
+        return false;
+    if (!('dateOfBirth' in value) || value['dateOfBirth'] === undefined)
+        return false;
+    if (!('nikIdNumber' in value) || value['nikIdNumber'] === undefined)
+        return false;
+    return true;
+}
+export function IndonesiaNikInputFromJSON(json) {
+    return IndonesiaNikInputFromJSONTyped(json, false);
+}
+export function IndonesiaNikInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fullName': json['fullName'],
+        'dateOfBirth': (new Date(json['dateOfBirth'])),
+        'nikIdNumber': json['nikIdNumber'],
+    };
+}
+export function IndonesiaNikInputToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fullName': value['fullName'],
+        'dateOfBirth': ((value['dateOfBirth']).toISOString().substring(0, 10)),
+        'nikIdNumber': value['nikIdNumber'],
+    };
+}

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

@@ -34,7 +34,7 @@ export interface IntegrationStep {
      * @type {StepRefreshInfo}
      * @memberof IntegrationStep
      */
-    refresh: StepRefreshInfo;
+    refresh: StepRefreshInfo | null;
 }
 /**
  * Check if a given object implements the IntegrationStep interface.