@onfido/api 4.6.0 → 5.0.0

package/dist/api.js

@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.ListWorkflowRunsSortEnum = exports.DefaultApi = 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.DocumentPropertiesSecurityTierEnum = exports.DocumentPropertiesHasIssuanceConfirmationEnum = exports.DocumentPropertiesNistIdentityEvidenceStrengthEnum = exports.DocumentSideEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceDocumentCaptureEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceIpReputationEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceAuthenticationTypeEnum = exports.DeviceIntelligenceBreakdownPropertiesDeviceSdkSourceEnum = exports.CountryCodes = exports.CheckStatus = exports.CheckResponseResultEnum = exports.CheckResultEnum = exports.ApplicantConsentName = void 0;
+exports.UploadDocumentSideEnum = void 0;
 const axios_1 = require("axios");
 // URLSearchParams not necessarily used
 // @ts-ignore
@@ -372,13 +372,6 @@ exports.DeviceIntelligenceBreakdownPropertiesDeviceBiometricCaptureEnum = {
     UnknownMethod: 'unknown_method',
     UnknownDefaultOpenApi: '11184809'
 };
-exports.DocumentFileTypeEnum = {
-    Jpg: 'jpg',
-    Jpeg: 'jpeg',
-    Png: 'png',
-    Pdf: 'pdf',
-    UnknownDefaultOpenApi: '11184809'
-};
 exports.DocumentSideEnum = {
     Front: 'front',
     Back: 'back',
@@ -408,13 +401,6 @@ exports.DocumentPropertiesSecurityTierEnum = {
     UnspecifiedSecurityTier: 'unspecified_security_tier',
     UnknownDefaultOpenApi: '11184809'
 };
-exports.DocumentSharedFileTypeEnum = {
-    Jpg: 'jpg',
-    Jpeg: 'jpeg',
-    Png: 'png',
-    Pdf: 'pdf',
-    UnknownDefaultOpenApi: '11184809'
-};
 exports.DocumentSharedSideEnum = {
     Front: 'front',
     Back: 'back',
@@ -777,7 +763,6 @@ exports.WebhookEventType = {
     ReportAwaitingApproval: 'report.awaiting_approval',
     ReportCompleted: 'report.completed',
     WorkflowTimelineFileCreated: 'workflow_timeline_file.created',
-    WorkflowSignedEvidenceFileCreated: 'workflow_signed_evidence_file.created',
     WorkflowRunEvidenceFolderCreated: 'workflow_run_evidence_folder.created',
     UnknownDefaultOpenApi: '11184809'
 };
@@ -1478,6 +1463,37 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+         * @summary Download NFC face
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadNfcFace: (documentId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'documentId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadNfcFace', 'documentId', documentId);
+            const localVarPath = `/documents/{document_id}/nfc_face`
+                .replace(`{${"document_id"}}`, encodeURIComponent(String(documentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Token required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieves the signed document or application form depending on the file_id provided.
          * @summary Retrieves the signed document or application form
@@ -2522,10 +2538,11 @@ const DefaultApiAxiosParamCreator = function (configuration) {
          * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
          * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
          * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \'desc\' or \'asc\' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \'desc\'.
+         * @param {string} [applicantId] the applicant\'s id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflowRuns: (page, status, createdAtGt, createdAtLt, sort, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        listWorkflowRuns: (page, status, createdAtGt, createdAtLt, sort, applicantId, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/workflow_runs`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -2557,6 +2574,9 @@ const DefaultApiAxiosParamCreator = function (configuration) {
             if (sort !== undefined) {
                 localVarQueryParameter['sort'] = sort;
             }
+            if (applicantId !== undefined) {
+                localVarQueryParameter['applicant_id'] = applicantId;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -2863,7 +2883,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
          * @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
+         * @param {string} [fileType] The file type of the uploaded file
          * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
          * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
          * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -3353,6 +3373,22 @@ const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+         * @summary Download NFC face
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadNfcFace(documentId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadNfcFace(documentId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.downloadNfcFace']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieves the signed document or application form depending on the file_id provided.
          * @summary Retrieves the signed document or application form
@@ -3878,13 +3914,14 @@ const DefaultApiFp = function (configuration) {
          * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
          * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
          * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \'desc\' or \'asc\' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \'desc\'.
+         * @param {string} [applicantId] the applicant\'s id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options) {
+        listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options) {
             var _a, _b, _c;
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.listWorkflowRuns']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -4042,7 +4079,7 @@ const DefaultApiFp = function (configuration) {
          * @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
+         * @param {string} [fileType] The file type of the uploaded file
          * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
          * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
          * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -4316,6 +4353,16 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
         downloadMotionCaptureFrame(motionCaptureId, options) {
             return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+         * @summary Download NFC face
+         * @param {string} documentId
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadNfcFace(documentId, options) {
+            return localVarFp.downloadNfcFace(documentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves the signed document or application form depending on the file_id provided.
          * @summary Retrieves the signed document or application form
@@ -4649,11 +4696,12 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
          * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
          * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
          * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \'desc\' or \'asc\' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \'desc\'.
+         * @param {string} [applicantId] the applicant\'s id.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options) {
-            return localVarFp.listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options).then((request) => request(axios, basePath));
+        listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options) {
+            return localVarFp.listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options).then((request) => request(axios, basePath));
         },
         /**
          * Run a health check on the Onfido API
@@ -4753,7 +4801,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
          * @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
+         * @param {string} [fileType] The file type of the uploaded file
          * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
          * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
          * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -5030,6 +5078,17 @@ class DefaultApi extends base_1.BaseAPI {
     downloadMotionCaptureFrame(motionCaptureId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Downloads digital photos extracted from specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.
+     * @summary Download NFC face
+     * @param {string} documentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadNfcFace(documentId, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).downloadNfcFace(documentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves the signed document or application form depending on the file_id provided.
      * @summary Retrieves the signed document or application form
@@ -5395,12 +5454,13 @@ class DefaultApi extends base_1.BaseAPI {
      * @param {string} [createdAtGt] A ISO-8601 date to filter results with a created date greater than (after) the one provided.
      * @param {string} [createdAtLt] A ISO-8601 date to filter results with a created date less than (before) the one provided.
      * @param {ListWorkflowRunsSortEnum} [sort] A string with the value \'desc\' or \'asc\' that allows to sort the returned list by the completed datetime either descending or ascending, respectively. If not specified, defaults to \'desc\'.
+     * @param {string} [applicantId] the applicant\'s id.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi
      */
-    listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options) {
-        return (0, exports.DefaultApiFp)(this.configuration).listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, options).then((request) => request(this.axios, this.basePath));
+    listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).listWorkflowRuns(page, status, createdAtGt, createdAtLt, sort, applicantId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Run a health check on the Onfido API
@@ -5509,7 +5569,7 @@ class DefaultApi extends base_1.BaseAPI {
      * @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
+     * @param {string} [fileType] The file type of the uploaded file
      * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
      * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
      * @param {boolean} [validateImageQuality] Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
@@ -5556,16 +5616,6 @@ exports.ListWorkflowRunsSortEnum = {
     Asc: 'asc',
     UnknownDefaultOpenApi: '11184809'
 };
-/**
- * @export
- */
-exports.UploadDocumentFileTypeEnum = {
-    Jpg: 'jpg',
-    Jpeg: 'jpeg',
-    Png: 'png',
-    Pdf: 'pdf',
-    UnknownDefaultOpenApi: '11184809'
-};
 /**
  * @export
  */

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/4.6.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/5.0.0" }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**