Check deposits: Get front/back image (#226)

* getImages, tests needed

* tests

* another try to getImage

* getImage will return string

* remove comments

* lint-fix

* update test

* add response encoding and type

Co-authored-by: Ilya Merman <[email protected]>

Author: axshani

package-lock.json

@@ -22,7 +22,7 @@
   "homepage": "https://github.com/unit-finance/unit-node-sdk#readme",
   "devDependencies": {
     "@types/jest": "^27.0.1",
-    "@types/node": "^15.0.2",
+    "@types/node": "^15.14.9",
     "@typescript-eslint/eslint-plugin": "^5.1.0",
     "@typescript-eslint/parser": "^5.1.0",
     "dotenv": "^10.0.0",

package.json

@@ -1,7 +1,8 @@
 import { Account, Customer, Transaction } from "../types"
-import { CheckDeposit, CreateCheckDepositRequest, PatchCheckDepositRequest, UploadCheckDepositRequest } from "../types/checkDeposit"
-import { UnitResponse, Include, UnitConfig, BaseListParams } from "../types/common"
+import { CheckDeposit, CreateCheckDepositRequest, PatchCheckDepositRequest, UploadCheckDepositRequest } from "../types"
+import { UnitResponse, Include, UnitConfig, BaseListParams } from "../types"
 import { BaseResource } from "./baseResource"
+import {responseEncoding, ResponseType} from "axios"
 
 export class CheckDeposits extends BaseResource {
 
@@ -44,6 +45,11 @@ export class CheckDeposits extends BaseResource {
 
             return this.httpPut<UnitResponse<CheckDeposit>>(path, request.file, {headers})
         }
+
+    public async getImage(id: string, front = true, responseEncoding: responseEncoding = "binary", responseType: ResponseType = "blob"): Promise<string> {
+        const p = front ? "front" : "back"
+        return this.httpGet<string>(`/${id}/${p}`, {responseEncoding, responseType})
+    }
 }
 
 export interface CheckDepositListParams extends BaseListParams {

resources/checkDeposit.ts

@@ -0,0 +1,58 @@
+import { CreateCheckDepositRequest, Unit, UploadCheckDepositRequest } from "../unit"
+import axios from "axios"
+import dotenv from "dotenv"
+import { createIndividualAccount } from "./testHelpers"
+dotenv.config()
+const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
+
+async function createCheckDepositReqeust(amount = 20000): Promise<CreateCheckDepositRequest> {
+    const accountId = (await createIndividualAccount(unit)).data.id
+    return {
+        "type": "checkDeposit",
+        "attributes": {
+            "amount": amount,
+            "description": "Check deposit"
+        },
+        "relationships": {
+            "account": {
+                "data": {
+                    "type": "depositAccount",
+                    "id": accountId
+                }
+            }
+        }
+    }
+}
+
+describe("CheckDeposit Create Test", () => {
+    test("Create CheckDeposit", async () => {
+        const req = await createCheckDepositReqeust()
+        const res = await unit.checkDeposits.create(req)
+        expect(res.data.type).toBe("checkDeposit")
+        expect(res.data.attributes.amount).toBe(20000)
+    })
+})
+
+describe("Upload Check", () => {
+    test("Create CheckDeposit and upload image", async () => {
+        const createReq = await createCheckDepositReqeust(15000)
+        const checkDeposit = await unit.checkDeposits.create(createReq)
+        expect(checkDeposit.data.type).toBe("checkDeposit")
+        expect(checkDeposit.data.attributes.amount).toBe(15000)
+
+        const checkDepositId = checkDeposit.data.id
+
+        const response = await axios.get("https://image.shutterstock.com/image-illustration/blank-check-design-open-spacing-260nw-76703974.jpg", { responseType: "arraybuffer" })
+        const buffer = Buffer.from(response.data, "utf-8")
+        const uploadReq: UploadCheckDepositRequest = {
+            checkDepositId: checkDepositId,
+            file: buffer
+        }
+
+        const uploadRes = await unit.checkDeposits.upload(uploadReq)
+        expect(uploadRes.data.type).toBe("checkDeposit")
+
+        const image = await unit.checkDeposits.getImage(checkDepositId)
+        expect(image).not.toBeNull()
+    })
+})