Download Document (#306)

* download document

* npm run lint-fix

* response type and encoding

* lint-fix

---------

Co-authored-by: ilyamerman <[email protected]>

Author: axshani

resources/application.ts

@@ -1,4 +1,4 @@
-import { Application, ApplicationDocument, CreateApplicationRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest } from "../types/application"
+import { Application, ApplicationDocument, CreateApplicationRequest, DownloadDocumentRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest } from "../types/application"
 import { UnitResponse, Include, UnitConfig, BaseListParams, BeneficialOwner } from "../types/common"
 import { BaseResource } from "./baseResource"
 
@@ -84,6 +84,17 @@ export class Applications extends BaseResource {
     public async cancel(request: CancelApplicationRequest): Promise<UnitResponse<Application> & Include<ApplicationDocument[]>> {
         return this.httpPost<UnitResponse<Application> & Include<ApplicationDocument[]>>(`/${request.applicationId}/cancel`, { data: request.data })
     }
+
+    public async download(request: DownloadDocumentRequest): Promise<Buffer> {
+        let path = `/${request.applicationId}/documents/${request.documentId}/download`
+        if (request.isBackSide)
+            path += "/back"
+        
+        const responseEncoding = request.responseEncoding || "binary"
+        const responseType = request.responseType || "arraybuffer"
+
+        return this.httpGet(path, {responseEncoding, responseType})
+    }
 }
 
 export interface ApplicationListParams extends BaseListParams {

types/application.ts

@@ -1,3 +1,4 @@
+import {responseEncoding, ResponseType} from "axios"
 import { Address, BeneficialOwner, BusinessContact, FullName, Officer, Phone, State, Relationship, DeviceFingerprint, Agent, RelationshipsArray, Beneficiary, Grantor, TrustContact, Trustee, UnimplementedRelationships, UnimplementedFields, EvaluationParams, Industry } from "./common"
 
 /**
@@ -605,6 +606,14 @@ export interface UploadDocumentRequest {
     fileType: "jpeg" | "png" | "pdf"
 }
 
+export interface DownloadDocumentRequest {
+    applicationId: string
+    documentId: string
+    isBackSide?: boolean
+    responseEncoding?: responseEncoding
+    responseType?: ResponseType
+}
+
 export interface PatchApplicationRequest {
     applicationId: string