UD-15182 Missing Fields For CDD/EDD Applications && UD-15302

.github/workflows/CI.yml

@@ -16,6 +16,7 @@ jobs:
       - run: |
           touch .env
           echo UNIT_TOKEN=${{ secrets.UNIT_TOKEN }} >> .env
+          echo UNIT_THREAD_TOKEN=${{ secrets.UNIT_THREAD_TOKEN }} >> .env
           echo UNIT_API_URL=${{ secrets.UNIT_API_URL }} >> .env
           echo TEST_COUNTERPARTY_PLAID_TOKEN=${{ secrets.TEST_COUNTERPARTY_PLAID_TOKEN }} >> .env
       - run: npm run test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unit-finance/unit-node-sdk",
-  "version": "1.3.17",
+  "version": "1.4.0",
   "description": "",
   "main": "dist/unit.js",
   "types": "dist/unit.d.ts",

resources/application.ts

@@ -1,4 +1,5 @@
-import { Application, BeneficialOwner, BeneficialOwnerDTO, ApplicationDocument, CreateApplicationRequest, DownloadDocumentRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest, PatchBusinessApplicationBeneficialOwner, ApplicationStatus } from "../types/application"
+import { Application, BeneficialOwner, BeneficialOwnerDTO, ApplicationDocument, CreateApplicationRequest, DownloadDocumentRequest, PatchApplicationRequest, UploadDocumentRequest, VerifyDocumentRequest, CancelApplicationRequest, PatchBusinessApplicationBeneficialOwner, ApplicationStatus, ApplicationMissingFields } from "../types/application"
+import { CreateThreadApplicationRequest, UpdateThreadApplicationRequest, ThreadApplication, BeneficialOwnerThreadApplication, UpdateBusinessBeneficialOwnerThreadApplicationRequest, UpgradeToThreadApplicationRequest } from "../types/threadApplication"
 import { UnitResponse, Include, UnitConfig, BaseListParams, Tags, Sort } from "../types/common"
 import { BaseResource } from "./baseResource"
 
@@ -33,6 +34,22 @@ export class Applications extends BaseResource {
         return this.httpPost<UnitResponse<Application> & Include<ApplicationDocument[] | BeneficialOwner[]>>("", { data: request })
     }
 
+    public async createThreadApplication(request: CreateThreadApplicationRequest): Promise<UnitResponse<ThreadApplication> & Include<ApplicationDocument[] | BeneficialOwner[]>> {
+        return this.httpPost<UnitResponse<ThreadApplication> & Include<ApplicationDocument[] | BeneficialOwner[]>>("", { data: request })
+    }
+
+    public async updateThreadApplication(request: Exclude<UpdateThreadApplicationRequest, UpdateBusinessBeneficialOwnerThreadApplicationRequest>): Promise<UnitResponse<ThreadApplication>> {
+        return this.httpPatch<UnitResponse<ThreadApplication>>(`/${request.applicationId}`, { data: request.data })
+    }
+
+    public async updateThreadApplicationBeneficialOwner(request: UpdateBusinessBeneficialOwnerThreadApplicationRequest): Promise<UnitResponse<BeneficialOwnerThreadApplication>> {
+        return this.httpPatchFullPath<UnitResponse<BeneficialOwnerThreadApplication>>(`${this.basePath}/beneficial-owner/${request.beneficialOwnerId}`, { data: request.data })
+    }
+
+    public async upgradeToThreadApplication(request: UpgradeToThreadApplicationRequest): Promise<UnitResponse<ThreadApplication>> {
+        return this.httpPatch<UnitResponse<ThreadApplication>>(`/${request.applicationId}`, { data: request.data })
+    }
+
     public async upload(request: UploadDocumentRequest) : Promise<UnitResponse<ApplicationDocument>> {
 
         let path = `/${request.applicationId}/documents/${request.documentId}`
@@ -102,6 +119,10 @@ export class Applications extends BaseResource {
     public async updateBeneficialOwner(request: PatchBusinessApplicationBeneficialOwner): Promise<UnitResponse<BeneficialOwnerDTO>> {
         return this.httpPatchFullPath<UnitResponse<BeneficialOwnerDTO>>(`${this.basePath}/beneficial-owner/${request.beneficialOwnerId}`, {data: request.data})
     }
+
+    public async getMissingFields(applicationId: string): Promise<UnitResponse<ApplicationMissingFields>> {
+        return this.httpGet<UnitResponse<ApplicationMissingFields>>(`/${applicationId}/missing-fields`)
+    }
 }
 
 export interface ApplicationListParams extends BaseListParams {

tests/applications.spec.ts

@@ -1,12 +1,15 @@
 import { createAddress, createFullName, createPhone } from "../helpers"
 import {
     Agent,
+    ApplicationMissingFields,
     BusinessApplication,
     CancelApplicationRequest,
     CreateBusinessApplicationRequest,
     CreateIndividualApplicationRequest,
     CreateSoleProprietorApplicationRequest,
     IndividualApplication,
+    IndividualApplicationMissingFields,
+    BusinessApplicationMissingFields,
     PatchApplicationRequest,
     PatchBusinessApplicationBeneficialOwner,
     RelationshipsArrayData,
@@ -943,6 +946,74 @@ describe("Create Document", () => {
     }, 90000)
 })
 
+describe("Get Missing Fields", () => {
+    test("Get Missing Fields for Individual Application", async () => {
+        const createRes = await createIndividualApplication(unit)
+        const res = await unit.applications.getMissingFields(createRes.data.id)
+
+        expect(res.data.type).toBe("individualApplicationMissingFields")
+        expect(res.data.attributes.missingFields).toBeInstanceOf(Array)
+    })
+
+    test("Get Missing Fields for Business Application", async () => {
+        const createRes = await createBusinessApplication(unit)
+        const res = await unit.applications.getMissingFields(createRes.data.id)
+
+        expect(res.data.type).toBe("businessApplicationMissingFields")
+        expect(res.data.attributes.missingFields).toBeInstanceOf(Array)
+    })
+
+    test("Simulate IndividualApplicationMissingFields response from API", () => {
+        const missingFields: IndividualApplicationMissingFields = {
+            type: "individualApplicationMissingFields",
+            attributes: {
+                missingFields: [
+                    {
+                        fieldName: "usNexus",
+                        description: "usNexus is required"
+                    },
+                    {
+                        fieldName: "transactionVolume",
+                        description: "transactionVolume is required. transactionVolumeDescription is required when transaction volume is one of the following: Between30KAnd60K, GreaterThan60K"
+                    }
+                ]
+            }
+        }
+
+        expect(missingFields.type).toBe("individualApplicationMissingFields")
+        expect(missingFields.attributes.missingFields).toHaveLength(2)
+        expect(missingFields.attributes.missingFields[0].fieldName).toBe("usNexus")
+    })
+
+    test("Simulate BusinessApplicationMissingFields response from API", () => {
+        const missingFields: BusinessApplicationMissingFields = {
+            type: "businessApplicationMissingFields",
+            attributes: {
+                missingFields: [
+                    {
+                        fieldName: "sourceOfFunds",
+                        description: "sourceOfFunds is required"
+                    }
+                ]
+            }
+        }
+
+        expect(missingFields.type).toBe("businessApplicationMissingFields")
+        expect(missingFields.attributes.missingFields).toHaveLength(1)
+    })
+
+    test("Simulate empty missingFields array", () => {
+        const missingFields: ApplicationMissingFields = {
+            type: "individualApplicationMissingFields",
+            attributes: {
+                missingFields: []
+            }
+        }
+
+        expect(missingFields.attributes.missingFields).toHaveLength(0)
+    })
+})
+
 describe("Create and Close Application", () => {
     test("Create and Close Individual Application", async () => {