Version 0.45.0 (#455)

* Credit Applications (#451)

* implementation of CreditApplication

* small test

* annualIncome is optional

* two kinds of CreateCreditApplicationRequest

* test for create credit application

* lint fix

* update interfaces, more work to be done

* lint-fix

* refactoring: Account Limits (#452)

* credit account limits and new attributes to deposit account limits

* added a test

* limits id

* lint-fix

* New repayments (#454)

* feat: configured types for Partner repayments

* feat: repayment tests

* fix: repayment tests cleanup

* fix: updated repayment statuses

* fix: fixed book repayment test failing

* fix: updated counterparty creation in repayments to use a plaid token

* fix: fixed incorrect check in tests

* feat: repayment test adjustments to use another credit account with different lending terms

* fix: added new credit terms into tests

* feat: added recurring repayment to repayment list filters

* 0.45.0

* 0.45.0

* Add check payment daily and monthly sent

---------

Co-authored-by: Alex Shani <[email protected]>
Co-authored-by: Yehor Zhukovskyi <[email protected]>

Author: 3 people

.github/workflows/CI.yml

@@ -17,4 +17,5 @@ jobs:
           touch .env
           echo UNIT_TOKEN=${{ secrets.UNIT_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-lock.json

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

package.json

@@ -0,0 +1,74 @@
+import { BaseResource } from "./baseResource"
+import { UnitConfig, UnitResponse, CreditApplication, BaseListParams, DeniedCreditApplication, ApprovedCreditApplication, PatchCreditApplicationRequest, CreateCreditApplicationRequest } from "../types"
+
+export class CreditApplications extends BaseResource {
+    constructor(token: string, basePath: string, config?: UnitConfig) {
+        super(token, basePath + "/credit-applications", config)
+    }
+
+    public async create(request: CreateCreditApplicationRequest) {
+        return this.httpPost<UnitResponse<CreditApplication>>("", { data: request })
+    }
+
+    public async approve(credit_application_id: string) {
+        return this.httpPost<UnitResponse<ApprovedCreditApplication>>(`/approve/${credit_application_id}/`)
+    }
+
+    public async deny(credit_application_id: string) {
+        return this.httpPost<UnitResponse<DeniedCreditApplication>>(`/deny/${credit_application_id}/`)
+    }
+
+    public async update(request: PatchCreditApplicationRequest) {
+        return this.httpPatch<UnitResponse<CreditApplication>>(`/${request.id}`, { data: request.data })
+    }
+
+    public async get(credit_application_id: string) {
+        return this.httpGet<UnitResponse<CreditApplication>>(`/${credit_application_id}`)
+    }
+
+    public async list(params?: CreditApplicationListParams) {
+        const parameters: any = {
+            "page[limit]": (params?.limit ? params?.limit : 100),
+            "page[offset]": (params?.offset ? params?.offset : 0),
+            ...(params?.lendingProgramId && { "filter[lendingProgramId]": params?.lendingProgramId }),
+            ...(params?.orgId && { "filter[orgId]": params?.orgId }),
+            ...(params?.applicationId && { "filter[applicationId]": params?.applicationId }),
+            ...(params?.bankId && { "filter[bankId]": params?.bankId }),
+            ...(params?.customerId && { "filter[customerId]": params?.customerId })
+        }
+
+        return this.httpGet<UnitResponse<CreditApplication[]>>("", { params: parameters })
+    }
+}
+
+export interface CreditApplicationListParams extends BaseListParams {
+    /**
+     * Optional. Search resources by lending program id.
+     * default: empty
+     */
+    lendingProgramId?: string
+
+    /**
+     * Optional. Search resources by organization id.
+     * default: empty
+     */
+    orgId?: string
+
+    /**
+     * Optional. Search resources by lending program id.
+     * default: empty
+     */
+    bankId?: string
+
+    /**
+     * Optional. Search resources by application id.
+     * default: empty
+     */
+    applicationId?: string
+
+    /**
+     * Optional. Search resources by customer id.
+     * default: empty
+     */
+    customerId?: string
+}

resources/creditApplication.ts

@@ -31,3 +31,4 @@ export * from "./transactions"
 export * from "./webhooks"
 export * from "./chargeback"
 export * from "./taxForms"
+export * from "./creditApplication"

resources/index.ts

@@ -66,4 +66,9 @@ export interface RepaymentListParams extends BaseListParams {
      * Optional. Filter repayments by Repayment type. such as (AchRepayment, BookRepayment). Usage example: filter[type][0]=AchRepayment&filter[type][1]=BookRepayment
      */
     type?: string[]
+
+    /**
+     * Optional. Filters the result according to the associated [Recurring Repayment](https://www.unit.co/docs/api/recurring-repayments/) id
+     */
+    recurringRepayment?: string
 }

resources/repayments.ts

@@ -1,6 +1,6 @@
 import { BaseResource } from "."
-import { AtmAuthorizationRequest, CardTransactionAuthorizationRequest, CheckPayment, CreateAtmAuthorizationRequestSimulation,
-     CreateCardPurchaseAuthorizationRequestSimulation, CreateCardTransactionAuthorizationRequestSimulation, CreateCheckPaymentSimulation, PurchaseAuthorizationRequest, UnitConfig, UnitResponse } from "../types"
+import { AtmAuthorizationRequest, AtmTransaction, AtmWithdrawalRequestSimulation, CardTransactionAuthorizationRequest, CheckPayment, CreateAtmAuthorizationRequestSimulation,
+     CreateCardPurchaseAuthorizationRequestSimulation, CreateCardTransactionAuthorizationRequestSimulation, CreateCheckPaymentSimulation, PurchaseAuthorizationRequest, Relationship, UnitConfig, UnitResponse } from "../types"
 import { AchReceivedPayment, Application, ApplicationDocument, AchPayment } from "../types"
 import {
     ApproveApplicationSimulation,
@@ -178,4 +178,21 @@ export class Simulations extends BaseResource {
     public async activateCard(id: string): Promise<UnitResponse<Card>> {
         return this.httpPost<UnitResponse<Card>>(`/cards/${id}/activate`)
     }
+
+    public async atmWithdrawal(amount: number, account: Relationship): Promise<UnitResponse<AtmTransaction>> {
+        const req: AtmWithdrawalRequestSimulation = {
+                "type":"atmTransaction",
+                "attributes": {
+                    "amount": amount,
+                    "atmName": "HOME FED SAV BK",
+                    "atmLocation": "Cupertino, CA, US",
+                    "last4Digits": "0019"
+                },
+                "relationships": {
+                    account
+                }
+        }
+
+        return this.httpPost<UnitResponse<AtmTransaction>>("/atm-withdrawals", req)
+    }
 }

resources/simulations.ts

@@ -81,4 +81,15 @@ describe("Close Account", () => {
         expect(account.type).toBe("depositAccount")
         expect(closedAccount.attributes.status).toBe("Closed")
     })
+})
+
+describe("Account Limits", () => {
+    test("Get Accounts List and Limits", async () => {
+        const res = await unit.accounts.list()
+        res.data.forEach(async account => {
+            const limits = (await unit.accounts.limits(account.id)).data
+            expect(limits.type).toContain("limits")
+            expect(limits.id).not.toBe(undefined)
+        })
+    })
 })

tests/accounts.spec.ts

@@ -0,0 +1,44 @@
+import dotenv from "dotenv"
+import { CreateExistingCustomerCreditApplicationRequest, Unit } from "../unit"
+import { createBusinessApplication } from "./testHelpers"
+import { createRelationship } from "../helpers"
+
+dotenv.config()
+const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
+
+describe("Get Credit Applications", () => {
+    test("Test Get endpoint", async () => {
+        const res = await unit.creditApplications.list()
+        expect(res.data).toBeInstanceOf(Array)
+        res.data.forEach(async element => {
+            expect(element.type).toContain("CreditApplication")
+            const app = await (await unit.creditApplications.get(element.id)).data
+            expect(element.type).toBe(app.type)
+            expect(element.id).toBe(app.id)
+        })
+    })
+
+    test("Get List of Credit Applications", async () => {
+        const res = await unit.creditApplications.list()
+        expect(res.data).toBeInstanceOf(Array)
+    })
+})
+
+describe("Create Credit Application", () => {
+    test("Test Create Credit Application", async () => {
+        const businessApplication = (await createBusinessApplication(unit)).data
+        const customerId = businessApplication.relationships.customer?.data.id || ""
+
+        const request: CreateExistingCustomerCreditApplicationRequest = {
+            type: "createExistingCustomerCreditApplication",
+            attributes: {},
+            relationships: {
+                customer: createRelationship("customer", customerId),
+                lendingProgram: createRelationship("lendingProgram", "51")
+            }
+        }
+
+        const creditApplication = (await unit.creditApplications.create(request)).data
+        expect(creditApplication.type).toBe("existingCustomerCreditApplication")
+    })
+})