Repayment Info and Version Bump (#498)

* feat: add type and resource for the repayment-information endpoint

* version bump to 1.2.2

* fix: statement list test limit to prevent timeouts

---------

Co-authored-by: chris fowlkes <[email protected]>

Author: YegorZh

package-lock.json

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

package.json

@@ -8,7 +8,8 @@ import {
     AccountDepositProduct,
     CloseAccountRequest,
     FreezeAccountRequest,
-    AccountOwnersRequest
+    AccountOwnersRequest,
+    RepaymentInformation
 } from "../types/account"
 import {BaseResource} from "./baseResource"
 
@@ -98,6 +99,10 @@ export class Accounts extends BaseResource {
     public async deactivateDaca(accountId: string): Promise<UnitResponse<Account>> {
         return this.httpGet<UnitResponse<Account>>(`/${accountId}/deactivate-daca`)
     }
+
+    public async getRepaymentInformation(accountId: string): Promise<UnitResponse<RepaymentInformation>> {
+        return this.httpGet<UnitResponse<RepaymentInformation>>(`/${accountId}/repayment-information`)
+    }
 }
 
 export interface AccountListParams extends BaseListParams {

resources/account.ts

@@ -1,13 +1,14 @@
-import { Unit } from "../unit"
+import { StatementsListParams, Unit } from "../unit"
 import dotenv from "dotenv"
-import {createIndividualAccount} from "./testHelpers"
+import { createIndividualAccount } from "./testHelpers"
 dotenv.config()
 const unit = new Unit(process.env.UNIT_TOKEN || "test", process.env.UNIT_API_URL || "test")
 const statementId: string[] = []
 
 describe("Statements List", () => {
     test("Get Statements List", async () => {
-        const res = await unit.statements.list()
+        const params: StatementsListParams = { limit: 50 }
+        const res = await unit.statements.list(params)
         expect(res.data.length).toBeGreaterThan(0)
         res.data.forEach(element => {
             if(element.relationships.customer){

tests/statements.spec.ts

@@ -170,6 +170,36 @@ export interface CreditAccount {
     } & UnimplementedFields
 }
 
+export interface RepaymentInformation {
+    type: "creditAccountRepaymentInformation"
+    attributes: {
+        /**
+         * The amount (cents) of the total amount due, including the remainingAmountOverdue.
+         */
+        remainingAmountDue: number
+        /**
+         * The amount (cents) of the amount overdue for the current payment period.
+         */
+        remainingAmountOverdue: number
+        /**
+         * The number of repayments that have been initiated but not yet settled to a final state.
+         */
+        initiatedRepayments: number
+        /**
+         * The start date in YYYY-MM-DD format for the current statement period.
+         */
+        statementPeriodStart: string
+        /**
+         * The end date in YYYY-MM-DD format for the current statement period.
+         */
+        statementPeriodEnd: string
+        /**
+         * The date in YYYY-MM-DD format for the expected repayment for the statement period start and end.
+         */
+        nextRepaymentDueDate: string
+    }
+}
+
 export type CreateAccountRequest = CreateDepositAccountRequest | CreateBatchAccountRequest | CreateCreditAccountRequest
 
 export interface CreateDepositAccountRequest {