@onfido/api 3.5.0 → 4.0.0

package/dist/api.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunSharedLinkLanguageEnum = exports.WorkflowRunResponseStatusEnum = exports.WorkflowRunStatusEnum = exports.WebhookEventType = exports.WatchlistMonitorSharedReportNameEnum = exports.WatchlistMonitorBuilderReportNameEnum = exports.WatchlistMonitorReportNameEnum = exports.UsDrivingLicenceSharedGenderEnum = exports.UsDrivingLicenceSharedEyeColorCodeEnum = exports.UsDrivingLicenceSharedDocumentCategoryEnum = exports.UsDrivingLicenceBuilderGenderEnum = exports.UsDrivingLicenceBuilderEyeColorCodeEnum = exports.UsDrivingLicenceBuilderDocumentCategoryEnum = exports.ResultsFeedbackExpectedResultEnum = exports.ReportSubResult = exports.ReportStatus = exports.ReportResult = exports.ReportName = exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = exports.RepeatAttemptsListRepeatAttemptsInnerNamesEnum = exports.RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = exports.ProofOfAddressPropertiesDocumentTypeEnum = exports.IdNumberTypeEnum = exports.ExtractionExtractedDataGenderEnum = exports.ExtractionDocumentClassificationSubtypeEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentSharedFileTypeEnum = exports.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DocumentFileTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.ConsentItemNameEnum = exports.CheckResponseResultEnum = exports.CheckResponseStatusEnum = exports.CheckResultEnum = exports.CheckStatusEnum = void 0;
+exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.WorkflowRunStatus = exports.WorkflowRunLinkLanguageEnum = exports.WebhookEventType = exports.WebhookEventResourceType = exports.WebhookEventObjectStatus = exports.WatchlistMonitorSharedReportNameEnum = exports.WatchlistMonitorBuilderReportNameEnum = exports.WatchlistMonitorReportNameEnum = exports.UsDrivingLicenceSharedGenderEnum = exports.UsDrivingLicenceSharedEyeColorCodeEnum = exports.UsDrivingLicenceSharedDocumentCategoryEnum = exports.UsDrivingLicenceBuilderGenderEnum = exports.UsDrivingLicenceBuilderEyeColorCodeEnum = exports.UsDrivingLicenceBuilderDocumentCategoryEnum = exports.ResultsFeedbackExpectedResultEnum = exports.ReportSubResult = exports.ReportStatus = exports.ReportResult = exports.ReportName = exports.RepeatAttemptsListRepeatAttemptsInnerResultEnum = exports.RepeatAttemptsListRepeatAttemptsInnerNamesEnum = exports.RepeatAttemptsListRepeatAttemptsInnerDateOfBirthEnum = exports.ProofOfAddressPropertiesDocumentTypeEnum = exports.IdNumberTypeEnum = exports.ExtractionExtractedDataGenderEnum = exports.ExtractionDocumentClassificationSubtypeEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesSecurityTierEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesHasIssuanceConfirmationEnum = exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentTypes = exports.DocumentSharedSideEnum = exports.DocumentSharedFileTypeEnum = exports.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DocumentFileTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
 exports.UploadDocumentSideEnum = exports.UploadDocumentFileTypeEnum = exports.ListWorkflowRunsSortEnum = exports.DefaultApi = void 0;
 const axios_1 = require("axios");
 // URLSearchParams not necessarily used
@@ -51,13 +51,15 @@ axios_1.default.interceptors.response.use((response) => __awaiter(void 0, void 0
     }
     return response;
 }));
-exports.CheckStatusEnum = {
-    InProgress: 'in_progress',
-    AwaitingApplicant: 'awaiting_applicant',
-    Complete: 'complete',
-    Withdrawn: 'withdrawn',
-    Paused: 'paused',
-    Reopened: 'reopened',
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+exports.ApplicantConsentName = {
+    PrivacyNoticesRead: 'privacy_notices_read',
+    SsnVerification: 'ssn_verification',
+    PhoneNumberVerification: 'phone_number_verification',
     UnknownDefaultOpenApi: '11184809'
 };
 exports.CheckResultEnum = {
@@ -65,7 +67,17 @@ exports.CheckResultEnum = {
     Consider: 'consider',
     UnknownDefaultOpenApi: '11184809'
 };
-exports.CheckResponseStatusEnum = {
+exports.CheckResponseResultEnum = {
+    Clear: 'clear',
+    Consider: 'consider',
+    UnknownDefaultOpenApi: '11184809'
+};
+/**
+ * The current state of the check in the checking process.
+ * @export
+ * @enum {string}
+ */
+exports.CheckStatus = {
     InProgress: 'in_progress',
     AwaitingApplicant: 'awaiting_applicant',
     Complete: 'complete',
@@ -74,17 +86,6 @@ exports.CheckResponseStatusEnum = {
     Reopened: 'reopened',
     UnknownDefaultOpenApi: '11184809'
 };
-exports.CheckResponseResultEnum = {
-    Clear: 'clear',
-    Consider: 'consider',
-    UnknownDefaultOpenApi: '11184809'
-};
-exports.ConsentItemNameEnum = {
-    PrivacyNoticesRead: 'privacy_notices_read',
-    SsnVerification: 'ssn_verification',
-    PhoneNumberVerification: 'phone_number_verification',
-    UnknownDefaultOpenApi: '11184809'
-};
 /**
  *
  * @export
@@ -450,6 +451,11 @@ exports.DocumentTypes = {
     ProfessionalQualificationCard: 'professional_qualification_card',
     ConsularId: 'consular_id',
     InternationalDrivingLicence: 'international_driving_licence',
+    HomeOfficeLetter: 'home_office_letter',
+    BirthCertificate: 'birth_certificate',
+    VehicleRegistrationCertificate: 'vehicle_registration_certificate',
+    FormForAffixingTheVisa: 'form_for_affixing_the_visa',
+    IdentificationNumberDocument: 'identification_number_document',
     UnknownDefaultOpenApi: '11184809'
 };
 exports.DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
@@ -659,6 +665,47 @@ exports.WatchlistMonitorSharedReportNameEnum = {
     Aml: 'watchlist_aml',
     UnknownDefaultOpenApi: '11184809'
 };
+/**
+ * The current state of the object, if available.
+ * @export
+ * @enum {string}
+ */
+exports.WebhookEventObjectStatus = {
+    Processing: 'processing',
+    AwaitingInput: 'awaiting_input',
+    AwaitingClientInput: 'awaiting_client_input',
+    Approved: 'approved',
+    Declined: 'declined',
+    Review: 'review',
+    Abandoned: 'abandoned',
+    Error: 'error',
+    Started: 'started',
+    Cancelled: 'cancelled',
+    Completed: 'completed',
+    AwaitingData: 'awaiting_data',
+    AwaitingApproval: 'awaiting_approval',
+    Complete: 'complete',
+    Withdrawn: 'withdrawn',
+    InProgress: 'in_progress',
+    AwaitingApplicant: 'awaiting_applicant',
+    Paused: 'paused',
+    Reopened: 'reopened',
+    UnknownDefaultOpenApi: '11184809'
+};
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+exports.WebhookEventResourceType = {
+    Check: 'check',
+    Report: 'report',
+    AuditLog: 'audit_log',
+    WorkflowRun: 'workflow_run',
+    WorkflowTask: 'workflow_task',
+    WatchlistMonitor: 'watchlist_monitor',
+    UnknownDefaultOpenApi: '11184809'
+};
 /**
  *
  * @export
@@ -684,27 +731,7 @@ exports.WebhookEventType = {
     WorkflowSignedEvidenceFileCreated: 'workflow_signed_evidence_file.created',
     UnknownDefaultOpenApi: '11184809'
 };
-exports.WorkflowRunStatusEnum = {
-    AwaitingInput: 'awaiting_input',
-    Processing: 'processing',
-    Abandoned: 'abandoned',
-    Error: 'error',
-    Approved: 'approved',
-    Review: 'review',
-    Declined: 'declined',
-    UnknownDefaultOpenApi: '11184809'
-};
-exports.WorkflowRunResponseStatusEnum = {
-    AwaitingInput: 'awaiting_input',
-    Processing: 'processing',
-    Abandoned: 'abandoned',
-    Error: 'error',
-    Approved: 'approved',
-    Review: 'review',
-    Declined: 'declined',
-    UnknownDefaultOpenApi: '11184809'
-};
-exports.WorkflowRunSharedLinkLanguageEnum = {
+exports.WorkflowRunLinkLanguageEnum = {
     EnUs: 'en_US',
     DeDe: 'de_DE',
     EsEs: 'es_ES',
@@ -714,6 +741,22 @@ exports.WorkflowRunSharedLinkLanguageEnum = {
     NlNl: 'nl_NL',
     UnknownDefaultOpenApi: '11184809'
 };
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+exports.WorkflowRunStatus = {
+    Processing: 'processing',
+    AwaitingInput: 'awaiting_input',
+    AwaitingClientInput: 'awaiting_client_input',
+    Approved: 'approved',
+    Declined: 'declined',
+    Review: 'review',
+    Abandoned: 'abandoned',
+    Error: 'error',
+    UnknownDefaultOpenApi: '11184809'
+};
 /**
  * DefaultApi - axios parameter creator
  * @export
@@ -2736,7 +2779,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
         /**
          * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
          * @summary Upload a document
-         * @param {string} type The type of document
+         * @param {DocumentTypes} type The type of document
          * @param {string} applicantId The ID of the applicant whose document is being uploaded.
          * @param {FileTransfer} file The file to be uploaded.
          * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -3899,7 +3942,7 @@ const DefaultApiFp = function (configuration) {
         /**
          * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
          * @summary Upload a document
-         * @param {string} type The type of document
+         * @param {DocumentTypes} type The type of document
          * @param {string} applicantId The ID of the applicant whose document is being uploaded.
          * @param {FileTransfer} file The file to be uploaded.
          * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -4600,7 +4643,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
         /**
          * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
          * @summary Upload a document
-         * @param {string} type The type of document
+         * @param {DocumentTypes} type The type of document
          * @param {string} applicantId The ID of the applicant whose document is being uploaded.
          * @param {FileTransfer} file The file to be uploaded.
          * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -5345,7 +5388,7 @@ class DefaultApi extends base_1.BaseAPI {
     /**
      * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
      * @summary Upload a document
-     * @param {string} type The type of document
+     * @param {DocumentTypes} type The type of document
      * @param {string} applicantId The ID of the applicant whose document is being uploaded.
      * @param {FileTransfer} file The file to be uploaded.
      * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.5.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/4.0.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**