Merge pull request #101 from developer88/add_signed_evidence_download…

…_endpoint

Add signed evidence file download endpoint

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v2.8.0 24 November 2023
+
+- Added `signed_evidence_file` method for WorkflowRuns
+
 ## v2.7.2, 14 June 2023
 
 - Added `sandbox` field to Check.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "Node.js library for the Onfido API",
   "keywords": [
     "onfido",
@@ -61,4 +61,4 @@
     "axios": "^1.6.1",
     "form-data": "^3.0.0"
   }
-}
+}

src/resources/WorkflowRuns.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { OnfidoDownload } from "../OnfidoDownload";
 import { Method, Resource } from "../Resource";
 
 export type WorkflowRunRequest = {
@@ -8,15 +9,15 @@ export type WorkflowRunRequest = {
 };
 
 type WorkflowRunError = {
-  type:	string;
+  type: string;
   message: string;
 }
 
 type WorkflowRunLink = {
-  url:	string;
-  completed_redirect_url:	string;
-  expired_redirect_url:	string;
-  expires_at:	string;
+  url: string;
+  completed_redirect_url: string;
+  expired_redirect_url: string;
+  expires_at: string;
   language: string;
 }
 
@@ -63,4 +64,8 @@ export class WorkflowRuns extends Resource<WorkflowRunRequest> {
 
     return workflowRuns;
   }
+
+  public async evidence(id: string): Promise<OnfidoDownload> {
+    return super.download(`${id}/signed_evidence_file`);
+  }
 }

test/resources/WorkflowRuns.test.ts

@@ -1,4 +1,4 @@
-import { Applicant, WorkflowRun } from "onfido-node";
+import { Applicant, WorkflowRun, OnfidoDownload } from "onfido-node";
 
 import { exampleWorkflowRun } from "../testExamples";
 import {
@@ -79,3 +79,15 @@ it("lists workflow runs", async () => {
     ])
   );
 });
+
+it("downloads a signed evidence file", async () => {
+  const workflowRun = await createWorkflowRun(applicant, workflow_id);
+
+  createNock()
+    .get("/workflow_runs/" + workflowRun.id + "/signed_evidence_file")
+    .reply(200, {});
+
+  const file = await onfido.workflowRun.evidence(workflowRun.id);
+
+  expect(file).toBeInstanceOf(OnfidoDownload);
+});