@onfido/api 4.4.0 → 4.5.0

package/dist/api.d.ts

@@ -10790,6 +10790,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     downloadDocumentVideo: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -11339,6 +11347,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -11888,6 +11904,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -12453,6 +12477,15 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo

package/dist/api.js

@@ -1260,6 +1260,37 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder: (workflowRunId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadEvidenceFolder', 'workflowRunId', workflowRunId);
+            const localVarPath = `/workflow_runs/{workflow_run_id}/evidence_folder`
+                .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)));
+            // 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,
+            };
+        }),
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -3209,6 +3240,22 @@ const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder(workflowRunId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadEvidenceFolder(workflowRunId, 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.downloadEvidenceFolder']) === 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);
+            });
+        },
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -4198,6 +4245,16 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
         downloadDocumentVideo(documentId, options) {
             return localVarFp.downloadDocumentVideo(documentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder(workflowRunId, options) {
+            return localVarFp.downloadEvidenceFolder(workflowRunId, options).then((request) => request(axios, basePath));
+        },
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -4895,6 +4952,17 @@ class DefaultApi extends base_1.BaseAPI {
     downloadDocumentVideo(documentId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).downloadDocumentVideo(documentId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadEvidenceFolder(workflowRunId, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).downloadEvidenceFolder(workflowRunId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo

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

package/dist/esm/api.d.ts

@@ -10790,6 +10790,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     downloadDocumentVideo: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder: (workflowRunId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -11339,6 +11347,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -11888,6 +11904,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo
@@ -12453,6 +12477,15 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     downloadDocumentVideo(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadEvidenceFolder(workflowRunId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo

package/dist/esm/api.js

@@ -1256,6 +1256,37 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder: (workflowRunId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            assertParamExists('downloadEvidenceFolder', 'workflowRunId', workflowRunId);
+            const localVarPath = `/workflow_runs/{workflow_run_id}/evidence_folder`
+                .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, 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 setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -3204,6 +3235,22 @@ export const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder(workflowRunId, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadEvidenceFolder(workflowRunId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadEvidenceFolder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -4192,6 +4239,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
         downloadDocumentVideo(documentId, options) {
             return localVarFp.downloadDocumentVideo(documentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the evidence folder for the designated Workflow Run
+         * @summary Retrieve Workflow Run Evidence Folder
+         * @param {string} workflowRunId Workflow Run ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadEvidenceFolder(workflowRunId, options) {
+            return localVarFp.downloadEvidenceFolder(workflowRunId, options).then((request) => request(axios, basePath));
+        },
         /**
          * ID photos are downloaded using this endpoint.
          * @summary Download ID photo
@@ -4888,6 +4945,17 @@ export class DefaultApi extends BaseAPI {
     downloadDocumentVideo(documentId, options) {
         return DefaultApiFp(this.configuration).downloadDocumentVideo(documentId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the evidence folder for the designated Workflow Run
+     * @summary Retrieve Workflow Run Evidence Folder
+     * @param {string} workflowRunId Workflow Run ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadEvidenceFolder(workflowRunId, options) {
+        return DefaultApiFp(this.configuration).downloadEvidenceFolder(workflowRunId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * ID photos are downloaded using this endpoint.
      * @summary Download ID photo

package/dist/esm/configuration.js

@@ -29,7 +29,7 @@ export class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || 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.4.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.5.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Node.js library for the Onfido API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {