@onfido/api 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -29,6 +29,24 @@ import { URL } from 'url';
29
29
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
30
30
  // @ts-ignore
31
31
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
32
+ import { FileTransfer } from './file-transfer';
33
+ import { AxiosHeaders } from 'axios';
34
+ globalAxios.interceptors.response.use((response) => __awaiter(void 0, void 0, void 0, function* () {
35
+ if (response.headers instanceof AxiosHeaders && response.headers['content-type']) {
36
+ if (!response.headers['content-type'].toString().includes('application/json')) {
37
+ const contentDisposition = response.headers['content-disposition'];
38
+ var filename = "";
39
+ if (contentDisposition && contentDisposition != "") {
40
+ const matcher = contentDisposition.match(/filename=['\"]?([^'\"\s]+)['\"]?/);
41
+ if (matcher != null) {
42
+ filename = matcher[1].replace(/.*[/\\\\]/g, "");
43
+ }
44
+ }
45
+ response.data = new FileTransfer(response.data, filename);
46
+ }
47
+ }
48
+ return response;
49
+ }));
32
50
  export const CheckStatusEnum = {
33
51
  InProgress: 'in_progress',
34
52
  AwaitingApplicant: 'awaiting_applicant',
@@ -577,6 +595,16 @@ export const WatchlistMonitorReportNameEnum = {
577
595
  Aml: 'watchlist_aml',
578
596
  UnknownDefaultOpenApi: '11184809'
579
597
  };
598
+ export const WatchlistMonitorBuilderReportNameEnum = {
599
+ Standard: 'watchlist_standard',
600
+ Aml: 'watchlist_aml',
601
+ UnknownDefaultOpenApi: '11184809'
602
+ };
603
+ export const WatchlistMonitorSharedReportNameEnum = {
604
+ Standard: 'watchlist_standard',
605
+ Aml: 'watchlist_aml',
606
+ UnknownDefaultOpenApi: '11184809'
607
+ };
580
608
  /**
581
609
  *
582
610
  * @export
@@ -674,17 +702,17 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
674
702
  * @summary Complete Task
675
703
  * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
676
704
  * @param {string} taskId The identifier of the Task you want to complete.
677
- * @param {CompleteTaskRequest} completeTaskRequest
705
+ * @param {CompleteTaskBuilder} completeTaskBuilder
678
706
  * @param {*} [options] Override http request option.
679
707
  * @throws {RequiredError}
680
708
  */
681
- completeTask: (workflowRunId, taskId, completeTaskRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
709
+ completeTask: (workflowRunId, taskId, completeTaskBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
682
710
  // verify required parameter 'workflowRunId' is not null or undefined
683
711
  assertParamExists('completeTask', 'workflowRunId', workflowRunId);
684
712
  // verify required parameter 'taskId' is not null or undefined
685
713
  assertParamExists('completeTask', 'taskId', taskId);
686
- // verify required parameter 'completeTaskRequest' is not null or undefined
687
- assertParamExists('completeTask', 'completeTaskRequest', completeTaskRequest);
714
+ // verify required parameter 'completeTaskBuilder' is not null or undefined
715
+ assertParamExists('completeTask', 'completeTaskBuilder', completeTaskBuilder);
688
716
  const localVarPath = `/workflow_runs/{workflow_run_id}/tasks/{task_id}/complete`
689
717
  .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)))
690
718
  .replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
@@ -703,7 +731,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
703
731
  setSearchParams(localVarUrlObj, localVarQueryParameter);
704
732
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
705
733
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
706
- localVarRequestOptions.data = serializeDataIfNeeded(completeTaskRequest, localVarRequestOptions, configuration);
734
+ localVarRequestOptions.data = serializeDataIfNeeded(completeTaskBuilder, localVarRequestOptions, configuration);
707
735
  return {
708
736
  url: toPathString(localVarUrlObj),
709
737
  options: localVarRequestOptions,
@@ -773,16 +801,47 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
773
801
  options: localVarRequestOptions,
774
802
  };
775
803
  }),
804
+ /**
805
+ * Triggers the generation of the Timeline File for the designated Workflow Run.
806
+ * @summary Create Timeline File for Workflow Run
807
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
808
+ * @param {*} [options] Override http request option.
809
+ * @throws {RequiredError}
810
+ */
811
+ createTimelineFile: (workflowRunId, options = {}) => __awaiter(this, void 0, void 0, function* () {
812
+ // verify required parameter 'workflowRunId' is not null or undefined
813
+ assertParamExists('createTimelineFile', 'workflowRunId', workflowRunId);
814
+ const localVarPath = `/workflow_runs/{workflow_run_id}/timeline_file`
815
+ .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)));
816
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
817
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
818
+ let baseOptions;
819
+ if (configuration) {
820
+ baseOptions = configuration.baseOptions;
821
+ }
822
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
823
+ const localVarHeaderParameter = {};
824
+ const localVarQueryParameter = {};
825
+ // authentication Token required
826
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
827
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
828
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
829
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
830
+ return {
831
+ url: toPathString(localVarUrlObj),
832
+ options: localVarRequestOptions,
833
+ };
834
+ }),
776
835
  /**
777
836
  * Creates a new monitor for the applicant
778
837
  * @summary Create monitor
779
- * @param {WatchlistMonitor} watchlistMonitor
838
+ * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
780
839
  * @param {*} [options] Override http request option.
781
840
  * @throws {RequiredError}
782
841
  */
783
- createWatchlistMonitor: (watchlistMonitor, options = {}) => __awaiter(this, void 0, void 0, function* () {
784
- // verify required parameter 'watchlistMonitor' is not null or undefined
785
- assertParamExists('createWatchlistMonitor', 'watchlistMonitor', watchlistMonitor);
842
+ createWatchlistMonitor: (watchlistMonitorBuilder, options = {}) => __awaiter(this, void 0, void 0, function* () {
843
+ // verify required parameter 'watchlistMonitorBuilder' is not null or undefined
844
+ assertParamExists('createWatchlistMonitor', 'watchlistMonitorBuilder', watchlistMonitorBuilder);
786
845
  const localVarPath = `/watchlist_monitors`;
787
846
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
788
847
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -799,7 +858,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
799
858
  setSearchParams(localVarUrlObj, localVarQueryParameter);
800
859
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
801
860
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
802
- localVarRequestOptions.data = serializeDataIfNeeded(watchlistMonitor, localVarRequestOptions, configuration);
861
+ localVarRequestOptions.data = serializeDataIfNeeded(watchlistMonitorBuilder, localVarRequestOptions, configuration);
803
862
  return {
804
863
  url: toPathString(localVarUrlObj),
805
864
  options: localVarRequestOptions,
@@ -1620,6 +1679,41 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1620
1679
  options: localVarRequestOptions,
1621
1680
  };
1622
1681
  }),
1682
+ /**
1683
+ * Retrieves the Timeline File for the designated Workflow Run.
1684
+ * @summary Retrieve Timeline File for Workflow Run
1685
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
1686
+ * @param {string} timelineFileId The unique identifier for the Timefile File.
1687
+ * @param {*} [options] Override http request option.
1688
+ * @throws {RequiredError}
1689
+ */
1690
+ findTimelineFile: (workflowRunId, timelineFileId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1691
+ // verify required parameter 'workflowRunId' is not null or undefined
1692
+ assertParamExists('findTimelineFile', 'workflowRunId', workflowRunId);
1693
+ // verify required parameter 'timelineFileId' is not null or undefined
1694
+ assertParamExists('findTimelineFile', 'timelineFileId', timelineFileId);
1695
+ const localVarPath = `/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}`
1696
+ .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)))
1697
+ .replace(`{${"timeline_file_id"}}`, encodeURIComponent(String(timelineFileId)));
1698
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1699
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1700
+ let baseOptions;
1701
+ if (configuration) {
1702
+ baseOptions = configuration.baseOptions;
1703
+ }
1704
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1705
+ const localVarHeaderParameter = {};
1706
+ const localVarQueryParameter = {};
1707
+ // authentication Token required
1708
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1709
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1710
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1711
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1712
+ return {
1713
+ url: toPathString(localVarUrlObj),
1714
+ options: localVarRequestOptions,
1715
+ };
1716
+ }),
1623
1717
  /**
1624
1718
  * Retrieves a single monitor
1625
1719
  * @summary Retrieve monitor
@@ -1720,9 +1814,9 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
1720
1814
  * @param {*} [options] Override http request option.
1721
1815
  * @throws {RequiredError}
1722
1816
  */
1723
- forceNewRecordCreation: (monitorId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1817
+ forceReportCreationFromWatchlistMonitor: (monitorId, options = {}) => __awaiter(this, void 0, void 0, function* () {
1724
1818
  // verify required parameter 'monitorId' is not null or undefined
1725
- assertParamExists('forceNewRecordCreation', 'monitorId', monitorId);
1819
+ assertParamExists('forceReportCreationFromWatchlistMonitor', 'monitorId', monitorId);
1726
1820
  const localVarPath = `/watchlist_monitors/{monitor_id}/new_report`
1727
1821
  .replace(`{${"monitor_id"}}`, encodeURIComponent(String(monitorId)));
1728
1822
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -2478,15 +2572,15 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2478
2572
  * Update the status of the given matches
2479
2573
  * @summary Set match status (BETA)
2480
2574
  * @param {string} monitorId
2481
- * @param {UpdateMonitorMatchRequest} updateMonitorMatchRequest
2575
+ * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
2482
2576
  * @param {*} [options] Override http request option.
2483
2577
  * @throws {RequiredError}
2484
2578
  */
2485
- updateMonitorMatch: (monitorId, updateMonitorMatchRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
2579
+ updateWatchlistMonitorMatch: (monitorId, watchlistMonitorMatchesUpdater, options = {}) => __awaiter(this, void 0, void 0, function* () {
2486
2580
  // verify required parameter 'monitorId' is not null or undefined
2487
- assertParamExists('updateMonitorMatch', 'monitorId', monitorId);
2488
- // verify required parameter 'updateMonitorMatchRequest' is not null or undefined
2489
- assertParamExists('updateMonitorMatch', 'updateMonitorMatchRequest', updateMonitorMatchRequest);
2581
+ assertParamExists('updateWatchlistMonitorMatch', 'monitorId', monitorId);
2582
+ // verify required parameter 'watchlistMonitorMatchesUpdater' is not null or undefined
2583
+ assertParamExists('updateWatchlistMonitorMatch', 'watchlistMonitorMatchesUpdater', watchlistMonitorMatchesUpdater);
2490
2584
  const localVarPath = `/watchlist_monitors/{monitor_id}/matches`
2491
2585
  .replace(`{${"monitor_id"}}`, encodeURIComponent(String(monitorId)));
2492
2586
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -2504,7 +2598,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2504
2598
  setSearchParams(localVarUrlObj, localVarQueryParameter);
2505
2599
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2506
2600
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2507
- localVarRequestOptions.data = serializeDataIfNeeded(updateMonitorMatchRequest, localVarRequestOptions, configuration);
2601
+ localVarRequestOptions.data = serializeDataIfNeeded(watchlistMonitorMatchesUpdater, localVarRequestOptions, configuration);
2508
2602
  return {
2509
2603
  url: toPathString(localVarUrlObj),
2510
2604
  options: localVarRequestOptions,
@@ -2551,7 +2645,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2551
2645
  * @summary Upload a document
2552
2646
  * @param {string} type The type of document
2553
2647
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
2554
- * @param {File} file The file to be uploaded.
2648
+ * @param {FileTransfer} file The file to be uploaded.
2555
2649
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
2556
2650
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
2557
2651
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
@@ -2596,7 +2690,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2596
2690
  localVarFormParams.append('applicant_id', applicantId);
2597
2691
  }
2598
2692
  if (file !== undefined) {
2599
- localVarFormParams.append('file', file);
2693
+ localVarFormParams.append('file', file.buffer, file.filename);
2600
2694
  }
2601
2695
  if (validateImageQuality !== undefined) {
2602
2696
  localVarFormParams.append('validate_image_quality', String(validateImageQuality));
@@ -2618,7 +2712,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2618
2712
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
2619
2713
  * @summary Upload ID photo
2620
2714
  * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
2621
- * @param {File} [file] The file to be uploaded.
2715
+ * @param {FileTransfer} [file] The file to be uploaded.
2622
2716
  * @param {*} [options] Override http request option.
2623
2717
  * @throws {RequiredError}
2624
2718
  */
@@ -2640,7 +2734,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2640
2734
  localVarFormParams.append('applicant_id', applicantId);
2641
2735
  }
2642
2736
  if (file !== undefined) {
2643
- localVarFormParams.append('file', file);
2737
+ localVarFormParams.append('file', file.buffer, file.filename);
2644
2738
  }
2645
2739
  localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
2646
2740
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -2656,7 +2750,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2656
2750
  * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
2657
2751
  * @summary Upload live photo
2658
2752
  * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
2659
- * @param {File} [file] The file to be uploaded.
2753
+ * @param {FileTransfer} [file] The file to be uploaded.
2660
2754
  * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
2661
2755
  * @param {*} [options] Override http request option.
2662
2756
  * @throws {RequiredError}
@@ -2679,7 +2773,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2679
2773
  localVarFormParams.append('applicant_id', applicantId);
2680
2774
  }
2681
2775
  if (file !== undefined) {
2682
- localVarFormParams.append('file', file);
2776
+ localVarFormParams.append('file', file.buffer, file.filename);
2683
2777
  }
2684
2778
  if (advancedValidation !== undefined) {
2685
2779
  localVarFormParams.append('advanced_validation', String(advancedValidation));
@@ -2724,14 +2818,14 @@ export const DefaultApiFp = function (configuration) {
2724
2818
  * @summary Complete Task
2725
2819
  * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
2726
2820
  * @param {string} taskId The identifier of the Task you want to complete.
2727
- * @param {CompleteTaskRequest} completeTaskRequest
2821
+ * @param {CompleteTaskBuilder} completeTaskBuilder
2728
2822
  * @param {*} [options] Override http request option.
2729
2823
  * @throws {RequiredError}
2730
2824
  */
2731
- completeTask(workflowRunId, taskId, completeTaskRequest, options) {
2825
+ completeTask(workflowRunId, taskId, completeTaskBuilder, options) {
2732
2826
  var _a, _b, _c;
2733
2827
  return __awaiter(this, void 0, void 0, function* () {
2734
- const localVarAxiosArgs = yield localVarAxiosParamCreator.completeTask(workflowRunId, taskId, completeTaskRequest, options);
2828
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.completeTask(workflowRunId, taskId, completeTaskBuilder, options);
2735
2829
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2736
2830
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.completeTask']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2737
2831
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2769,17 +2863,33 @@ export const DefaultApiFp = function (configuration) {
2769
2863
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2770
2864
  });
2771
2865
  },
2866
+ /**
2867
+ * Triggers the generation of the Timeline File for the designated Workflow Run.
2868
+ * @summary Create Timeline File for Workflow Run
2869
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
2870
+ * @param {*} [options] Override http request option.
2871
+ * @throws {RequiredError}
2872
+ */
2873
+ createTimelineFile(workflowRunId, options) {
2874
+ var _a, _b, _c;
2875
+ return __awaiter(this, void 0, void 0, function* () {
2876
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createTimelineFile(workflowRunId, options);
2877
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2878
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.createTimelineFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2879
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2880
+ });
2881
+ },
2772
2882
  /**
2773
2883
  * Creates a new monitor for the applicant
2774
2884
  * @summary Create monitor
2775
- * @param {WatchlistMonitor} watchlistMonitor
2885
+ * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
2776
2886
  * @param {*} [options] Override http request option.
2777
2887
  * @throws {RequiredError}
2778
2888
  */
2779
- createWatchlistMonitor(watchlistMonitor, options) {
2889
+ createWatchlistMonitor(watchlistMonitorBuilder, options) {
2780
2890
  var _a, _b, _c;
2781
2891
  return __awaiter(this, void 0, void 0, function* () {
2782
- const localVarAxiosArgs = yield localVarAxiosParamCreator.createWatchlistMonitor(watchlistMonitor, options);
2892
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createWatchlistMonitor(watchlistMonitorBuilder, options);
2783
2893
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2784
2894
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.createWatchlistMonitor']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2785
2895
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3202,6 +3312,23 @@ export const DefaultApiFp = function (configuration) {
3202
3312
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3203
3313
  });
3204
3314
  },
3315
+ /**
3316
+ * Retrieves the Timeline File for the designated Workflow Run.
3317
+ * @summary Retrieve Timeline File for Workflow Run
3318
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
3319
+ * @param {string} timelineFileId The unique identifier for the Timefile File.
3320
+ * @param {*} [options] Override http request option.
3321
+ * @throws {RequiredError}
3322
+ */
3323
+ findTimelineFile(workflowRunId, timelineFileId, options) {
3324
+ var _a, _b, _c;
3325
+ return __awaiter(this, void 0, void 0, function* () {
3326
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.findTimelineFile(workflowRunId, timelineFileId, options);
3327
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3328
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.findTimelineFile']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3329
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3330
+ });
3331
+ },
3205
3332
  /**
3206
3333
  * Retrieves a single monitor
3207
3334
  * @summary Retrieve monitor
@@ -3257,12 +3384,12 @@ export const DefaultApiFp = function (configuration) {
3257
3384
  * @param {*} [options] Override http request option.
3258
3385
  * @throws {RequiredError}
3259
3386
  */
3260
- forceNewRecordCreation(monitorId, options) {
3387
+ forceReportCreationFromWatchlistMonitor(monitorId, options) {
3261
3388
  var _a, _b, _c;
3262
3389
  return __awaiter(this, void 0, void 0, function* () {
3263
- const localVarAxiosArgs = yield localVarAxiosParamCreator.forceNewRecordCreation(monitorId, options);
3390
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.forceReportCreationFromWatchlistMonitor(monitorId, options);
3264
3391
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3265
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.forceNewRecordCreation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3392
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.forceReportCreationFromWatchlistMonitor']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3266
3393
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3267
3394
  });
3268
3395
  },
@@ -3628,16 +3755,16 @@ export const DefaultApiFp = function (configuration) {
3628
3755
  * Update the status of the given matches
3629
3756
  * @summary Set match status (BETA)
3630
3757
  * @param {string} monitorId
3631
- * @param {UpdateMonitorMatchRequest} updateMonitorMatchRequest
3758
+ * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
3632
3759
  * @param {*} [options] Override http request option.
3633
3760
  * @throws {RequiredError}
3634
3761
  */
3635
- updateMonitorMatch(monitorId, updateMonitorMatchRequest, options) {
3762
+ updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options) {
3636
3763
  var _a, _b, _c;
3637
3764
  return __awaiter(this, void 0, void 0, function* () {
3638
- const localVarAxiosArgs = yield localVarAxiosParamCreator.updateMonitorMatch(monitorId, updateMonitorMatchRequest, options);
3765
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options);
3639
3766
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3640
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.updateMonitorMatch']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3767
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.updateWatchlistMonitorMatch']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3641
3768
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3642
3769
  });
3643
3770
  },
@@ -3663,7 +3790,7 @@ export const DefaultApiFp = function (configuration) {
3663
3790
  * @summary Upload a document
3664
3791
  * @param {string} type The type of document
3665
3792
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
3666
- * @param {File} file The file to be uploaded.
3793
+ * @param {FileTransfer} file The file to be uploaded.
3667
3794
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
3668
3795
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
3669
3796
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
@@ -3685,7 +3812,7 @@ export const DefaultApiFp = function (configuration) {
3685
3812
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
3686
3813
  * @summary Upload ID photo
3687
3814
  * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
3688
- * @param {File} [file] The file to be uploaded.
3815
+ * @param {FileTransfer} [file] The file to be uploaded.
3689
3816
  * @param {*} [options] Override http request option.
3690
3817
  * @throws {RequiredError}
3691
3818
  */
@@ -3702,7 +3829,7 @@ export const DefaultApiFp = function (configuration) {
3702
3829
  * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
3703
3830
  * @summary Upload live photo
3704
3831
  * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
3705
- * @param {File} [file] The file to be uploaded.
3832
+ * @param {FileTransfer} [file] The file to be uploaded.
3706
3833
  * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
3707
3834
  * @param {*} [options] Override http request option.
3708
3835
  * @throws {RequiredError}
@@ -3740,12 +3867,12 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
3740
3867
  * @summary Complete Task
3741
3868
  * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
3742
3869
  * @param {string} taskId The identifier of the Task you want to complete.
3743
- * @param {CompleteTaskRequest} completeTaskRequest
3870
+ * @param {CompleteTaskBuilder} completeTaskBuilder
3744
3871
  * @param {*} [options] Override http request option.
3745
3872
  * @throws {RequiredError}
3746
3873
  */
3747
- completeTask(workflowRunId, taskId, completeTaskRequest, options) {
3748
- return localVarFp.completeTask(workflowRunId, taskId, completeTaskRequest, options).then((request) => request(axios, basePath));
3874
+ completeTask(workflowRunId, taskId, completeTaskBuilder, options) {
3875
+ return localVarFp.completeTask(workflowRunId, taskId, completeTaskBuilder, options).then((request) => request(axios, basePath));
3749
3876
  },
3750
3877
  /**
3751
3878
  * Creates a single applicant. Returns an applicant object.
@@ -3767,15 +3894,25 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
3767
3894
  createCheck(checkBuilder, options) {
3768
3895
  return localVarFp.createCheck(checkBuilder, options).then((request) => request(axios, basePath));
3769
3896
  },
3897
+ /**
3898
+ * Triggers the generation of the Timeline File for the designated Workflow Run.
3899
+ * @summary Create Timeline File for Workflow Run
3900
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
3901
+ * @param {*} [options] Override http request option.
3902
+ * @throws {RequiredError}
3903
+ */
3904
+ createTimelineFile(workflowRunId, options) {
3905
+ return localVarFp.createTimelineFile(workflowRunId, options).then((request) => request(axios, basePath));
3906
+ },
3770
3907
  /**
3771
3908
  * Creates a new monitor for the applicant
3772
3909
  * @summary Create monitor
3773
- * @param {WatchlistMonitor} watchlistMonitor
3910
+ * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
3774
3911
  * @param {*} [options] Override http request option.
3775
3912
  * @throws {RequiredError}
3776
3913
  */
3777
- createWatchlistMonitor(watchlistMonitor, options) {
3778
- return localVarFp.createWatchlistMonitor(watchlistMonitor, options).then((request) => request(axios, basePath));
3914
+ createWatchlistMonitor(watchlistMonitorBuilder, options) {
3915
+ return localVarFp.createWatchlistMonitor(watchlistMonitorBuilder, options).then((request) => request(axios, basePath));
3779
3916
  },
3780
3917
  /**
3781
3918
  * Registers a webhook. Returns a webhook object.
@@ -4038,6 +4175,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4038
4175
  findTask(workflowRunId, taskId, options) {
4039
4176
  return localVarFp.findTask(workflowRunId, taskId, options).then((request) => request(axios, basePath));
4040
4177
  },
4178
+ /**
4179
+ * Retrieves the Timeline File for the designated Workflow Run.
4180
+ * @summary Retrieve Timeline File for Workflow Run
4181
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
4182
+ * @param {string} timelineFileId The unique identifier for the Timefile File.
4183
+ * @param {*} [options] Override http request option.
4184
+ * @throws {RequiredError}
4185
+ */
4186
+ findTimelineFile(workflowRunId, timelineFileId, options) {
4187
+ return localVarFp.findTimelineFile(workflowRunId, timelineFileId, options).then((request) => request(axios, basePath));
4188
+ },
4041
4189
  /**
4042
4190
  * Retrieves a single monitor
4043
4191
  * @summary Retrieve monitor
@@ -4075,8 +4223,8 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4075
4223
  * @param {*} [options] Override http request option.
4076
4224
  * @throws {RequiredError}
4077
4225
  */
4078
- forceNewRecordCreation(monitorId, options) {
4079
- return localVarFp.forceNewRecordCreation(monitorId, options).then((request) => request(axios, basePath));
4226
+ forceReportCreationFromWatchlistMonitor(monitorId, options) {
4227
+ return localVarFp.forceReportCreationFromWatchlistMonitor(monitorId, options).then((request) => request(axios, basePath));
4080
4228
  },
4081
4229
  /**
4082
4230
  * Generates an SDK token. Returns a token object containing the SDK token.
@@ -4308,12 +4456,12 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4308
4456
  * Update the status of the given matches
4309
4457
  * @summary Set match status (BETA)
4310
4458
  * @param {string} monitorId
4311
- * @param {UpdateMonitorMatchRequest} updateMonitorMatchRequest
4459
+ * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
4312
4460
  * @param {*} [options] Override http request option.
4313
4461
  * @throws {RequiredError}
4314
4462
  */
4315
- updateMonitorMatch(monitorId, updateMonitorMatchRequest, options) {
4316
- return localVarFp.updateMonitorMatch(monitorId, updateMonitorMatchRequest, options).then((request) => request(axios, basePath));
4463
+ updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options) {
4464
+ return localVarFp.updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options).then((request) => request(axios, basePath));
4317
4465
  },
4318
4466
  /**
4319
4467
  * Edits a webhook. Returns the updated webhook object.
@@ -4331,7 +4479,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4331
4479
  * @summary Upload a document
4332
4480
  * @param {string} type The type of document
4333
4481
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
4334
- * @param {File} file The file to be uploaded.
4482
+ * @param {FileTransfer} file The file to be uploaded.
4335
4483
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
4336
4484
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
4337
4485
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
@@ -4347,7 +4495,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4347
4495
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
4348
4496
  * @summary Upload ID photo
4349
4497
  * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
4350
- * @param {File} [file] The file to be uploaded.
4498
+ * @param {FileTransfer} [file] The file to be uploaded.
4351
4499
  * @param {*} [options] Override http request option.
4352
4500
  * @throws {RequiredError}
4353
4501
  */
@@ -4358,7 +4506,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4358
4506
  * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
4359
4507
  * @summary Upload live photo
4360
4508
  * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
4361
- * @param {File} [file] The file to be uploaded.
4509
+ * @param {FileTransfer} [file] The file to be uploaded.
4362
4510
  * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
4363
4511
  * @param {*} [options] Override http request option.
4364
4512
  * @throws {RequiredError}
@@ -4391,13 +4539,13 @@ export class DefaultApi extends BaseAPI {
4391
4539
  * @summary Complete Task
4392
4540
  * @param {string} workflowRunId The unique identifier of the Workflow Run to which the Task belongs.
4393
4541
  * @param {string} taskId The identifier of the Task you want to complete.
4394
- * @param {CompleteTaskRequest} completeTaskRequest
4542
+ * @param {CompleteTaskBuilder} completeTaskBuilder
4395
4543
  * @param {*} [options] Override http request option.
4396
4544
  * @throws {RequiredError}
4397
4545
  * @memberof DefaultApi
4398
4546
  */
4399
- completeTask(workflowRunId, taskId, completeTaskRequest, options) {
4400
- return DefaultApiFp(this.configuration).completeTask(workflowRunId, taskId, completeTaskRequest, options).then((request) => request(this.axios, this.basePath));
4547
+ completeTask(workflowRunId, taskId, completeTaskBuilder, options) {
4548
+ return DefaultApiFp(this.configuration).completeTask(workflowRunId, taskId, completeTaskBuilder, options).then((request) => request(this.axios, this.basePath));
4401
4549
  }
4402
4550
  /**
4403
4551
  * Creates a single applicant. Returns an applicant object.
@@ -4421,16 +4569,27 @@ export class DefaultApi extends BaseAPI {
4421
4569
  createCheck(checkBuilder, options) {
4422
4570
  return DefaultApiFp(this.configuration).createCheck(checkBuilder, options).then((request) => request(this.axios, this.basePath));
4423
4571
  }
4572
+ /**
4573
+ * Triggers the generation of the Timeline File for the designated Workflow Run.
4574
+ * @summary Create Timeline File for Workflow Run
4575
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
4576
+ * @param {*} [options] Override http request option.
4577
+ * @throws {RequiredError}
4578
+ * @memberof DefaultApi
4579
+ */
4580
+ createTimelineFile(workflowRunId, options) {
4581
+ return DefaultApiFp(this.configuration).createTimelineFile(workflowRunId, options).then((request) => request(this.axios, this.basePath));
4582
+ }
4424
4583
  /**
4425
4584
  * Creates a new monitor for the applicant
4426
4585
  * @summary Create monitor
4427
- * @param {WatchlistMonitor} watchlistMonitor
4586
+ * @param {WatchlistMonitorBuilder} watchlistMonitorBuilder
4428
4587
  * @param {*} [options] Override http request option.
4429
4588
  * @throws {RequiredError}
4430
4589
  * @memberof DefaultApi
4431
4590
  */
4432
- createWatchlistMonitor(watchlistMonitor, options) {
4433
- return DefaultApiFp(this.configuration).createWatchlistMonitor(watchlistMonitor, options).then((request) => request(this.axios, this.basePath));
4591
+ createWatchlistMonitor(watchlistMonitorBuilder, options) {
4592
+ return DefaultApiFp(this.configuration).createWatchlistMonitor(watchlistMonitorBuilder, options).then((request) => request(this.axios, this.basePath));
4434
4593
  }
4435
4594
  /**
4436
4595
  * Registers a webhook. Returns a webhook object.
@@ -4719,6 +4878,18 @@ export class DefaultApi extends BaseAPI {
4719
4878
  findTask(workflowRunId, taskId, options) {
4720
4879
  return DefaultApiFp(this.configuration).findTask(workflowRunId, taskId, options).then((request) => request(this.axios, this.basePath));
4721
4880
  }
4881
+ /**
4882
+ * Retrieves the Timeline File for the designated Workflow Run.
4883
+ * @summary Retrieve Timeline File for Workflow Run
4884
+ * @param {string} workflowRunId The unique identifier of the Workflow Run.
4885
+ * @param {string} timelineFileId The unique identifier for the Timefile File.
4886
+ * @param {*} [options] Override http request option.
4887
+ * @throws {RequiredError}
4888
+ * @memberof DefaultApi
4889
+ */
4890
+ findTimelineFile(workflowRunId, timelineFileId, options) {
4891
+ return DefaultApiFp(this.configuration).findTimelineFile(workflowRunId, timelineFileId, options).then((request) => request(this.axios, this.basePath));
4892
+ }
4722
4893
  /**
4723
4894
  * Retrieves a single monitor
4724
4895
  * @summary Retrieve monitor
@@ -4760,8 +4931,8 @@ export class DefaultApi extends BaseAPI {
4760
4931
  * @throws {RequiredError}
4761
4932
  * @memberof DefaultApi
4762
4933
  */
4763
- forceNewRecordCreation(monitorId, options) {
4764
- return DefaultApiFp(this.configuration).forceNewRecordCreation(monitorId, options).then((request) => request(this.axios, this.basePath));
4934
+ forceReportCreationFromWatchlistMonitor(monitorId, options) {
4935
+ return DefaultApiFp(this.configuration).forceReportCreationFromWatchlistMonitor(monitorId, options).then((request) => request(this.axios, this.basePath));
4765
4936
  }
4766
4937
  /**
4767
4938
  * Generates an SDK token. Returns a token object containing the SDK token.
@@ -5015,13 +5186,13 @@ export class DefaultApi extends BaseAPI {
5015
5186
  * Update the status of the given matches
5016
5187
  * @summary Set match status (BETA)
5017
5188
  * @param {string} monitorId
5018
- * @param {UpdateMonitorMatchRequest} updateMonitorMatchRequest
5189
+ * @param {WatchlistMonitorMatchesUpdater} watchlistMonitorMatchesUpdater
5019
5190
  * @param {*} [options] Override http request option.
5020
5191
  * @throws {RequiredError}
5021
5192
  * @memberof DefaultApi
5022
5193
  */
5023
- updateMonitorMatch(monitorId, updateMonitorMatchRequest, options) {
5024
- return DefaultApiFp(this.configuration).updateMonitorMatch(monitorId, updateMonitorMatchRequest, options).then((request) => request(this.axios, this.basePath));
5194
+ updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options) {
5195
+ return DefaultApiFp(this.configuration).updateWatchlistMonitorMatch(monitorId, watchlistMonitorMatchesUpdater, options).then((request) => request(this.axios, this.basePath));
5025
5196
  }
5026
5197
  /**
5027
5198
  * Edits a webhook. Returns the updated webhook object.
@@ -5040,7 +5211,7 @@ export class DefaultApi extends BaseAPI {
5040
5211
  * @summary Upload a document
5041
5212
  * @param {string} type The type of document
5042
5213
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
5043
- * @param {File} file The file to be uploaded.
5214
+ * @param {FileTransfer} file The file to be uploaded.
5044
5215
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
5045
5216
  * @param {UploadDocumentSideEnum} [side] The side of the document, if applicable. The possible values are front and back
5046
5217
  * @param {CountryCodes} [issuingCountry] The issuing country of the document, a 3-letter ISO code.
@@ -5057,7 +5228,7 @@ export class DefaultApi extends BaseAPI {
5057
5228
  * You can upload ID photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB.
5058
5229
  * @summary Upload ID photo
5059
5230
  * @param {string} [applicantId] The ID of the applicant whose ID photo is being uploaded.
5060
- * @param {File} [file] The file to be uploaded.
5231
+ * @param {FileTransfer} [file] The file to be uploaded.
5061
5232
  * @param {*} [options] Override http request option.
5062
5233
  * @throws {RequiredError}
5063
5234
  * @memberof DefaultApi
@@ -5069,7 +5240,7 @@ export class DefaultApi extends BaseAPI {
5069
5240
  * You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.
5070
5241
  * @summary Upload live photo
5071
5242
  * @param {string} [applicantId] The ID of the applicant whose live photo is being uploaded.
5072
- * @param {File} [file] The file to be uploaded.
5243
+ * @param {FileTransfer} [file] The file to be uploaded.
5073
5244
  * @param {boolean} [advancedValidation] Validates that the live photo contains exactly one face.
5074
5245
  * @param {*} [options] Override http request option.
5075
5246
  * @throws {RequiredError}