Check Deposit (#96)

* init check deposit

* done with check-deposits

* update version

* lint-fix

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

Author: axshani

resources/checkDeposit.ts

@@ -0,0 +1,91 @@
+import { Account, Customer, Transaction } from "../types"
+import { CheckDeposit, CreateCheckDepositRequest, PatchCheckDepositRequest, UploadCheckDepositRequest } from "../types/checkDeposit"
+import { UnitResponse, Include, UnitConfig } from "../types/common"
+import { BaseResource } from "./baseResource"
+
+export class CheckDeposits extends BaseResource {
+
+    constructor(token: string, basePath: string, config?: UnitConfig) {
+        super(token, basePath + "/check-deposits", config)
+    }
+
+    public async list(params?: CheckDepositListParams): Promise<UnitResponse<CheckDeposit[]>> {
+        const parameters = {
+            "page[limit]": (params?.limit ? params.limit : 100),
+            "page[offset]": (params?.offset ? params.offset : 0),
+            ...(params?.accountId && { "filter[accountId]": params.accountId }),
+            ...(params?.customerId && { "filter[customerId]": params.customerId }),
+            ...(params?.tags && { "filter[tags]": params.tags }),
+            "sort": params?.sort ? params.sort : "-createdAt",
+            "include": params?.include ? params.include : "include"
+        }
+
+        return this.httpGet<UnitResponse<CheckDeposit[]>>("", { params: parameters })
+    }
+
+    public async create(request: CreateCheckDepositRequest): Promise<UnitResponse<CheckDeposit>> {
+        return this.httpPost<UnitResponse<CheckDeposit>>("", { data: request })
+    }
+
+    public async get(id: string, include = ""): Promise<UnitResponse<CheckDeposit> & Include<(Customer | Account | Transaction)[]>> {
+        return this.httpGet<UnitResponse<CheckDeposit> & Include<(Customer | Account | Transaction)[]>>(`/${id}`, { params: { include }})
+    }
+
+    public async update(request: PatchCheckDepositRequest): Promise<UnitResponse<CheckDeposit>> {
+        return this.httpPatch<UnitResponse<CheckDeposit>>(`/${request.checkDepositId}`, { data: request.data })
+    }
+
+    public async upload(request: UploadCheckDepositRequest) : Promise<UnitResponse<CheckDeposit>> {
+
+            let path = `/${request.checkDepositId}`
+            if (request.isBackSide)
+                path += "/back"
+    
+            const headers = { "Content-Type": "image/jpeg" }
+                    
+            return this.httpPut<UnitResponse<CheckDeposit>>(path, request.file, {headers})
+        }
+}
+
+export interface CheckDepositListParams {
+    /**
+     * Maximum number of resources that will be returned. Maximum is 1000 resources. [See Pagination](https://developers.unit.co/#intro-pagination).
+     * default: 100
+     */
+    limit?: number
+
+    /**
+     * Number of resources to skip.  [See Pagination](https://developers.unit.co/#intro-pagination).
+     * default: 0
+     */
+    offset?: number
+
+    /**
+     * Optional. Filters the results by the specified account id.
+     * default: empty
+     */
+    accountId?: string
+
+    /**
+     * Optional. Filters the results by the specified customer id.
+     * default: empty
+     */
+    customerId?: string
+
+    /**
+     * Optional. Filter Applications by [Tags](https://developers.unit.co/#tags).
+     * default: empty
+     */
+    tags?: object
+
+    /**
+     * Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+     */
+    sort?: string
+
+    /**
+     * Optional. Related resource available to include: customer. See [Getting Related Resources](https://developers.unit.co/#intro-getting-related-resources).
+     * default: empty
+     */
+    include?: string
+}

resources/index.ts

@@ -17,4 +17,5 @@ export * from "./statements"
 export * from "./transactions"
 export * from "./webhooks"
 export * from "./billPays"
+export * from "./checkDeposit"
 

types/checkDeposit.ts

@@ -0,0 +1,144 @@
+import { Relationship,CheckCounterparty } from "./common"
+
+type CheckDepositStatus = "AwaitingImages" | "AwaitingFrontImage" | "AwaitingBackImage" | "Pending" | "PendingReview" |
+    "Rejected" | "Clearing" | "Sent" | "Canceled" | "Returned"
+
+export interface CheckDeposit {
+    /**
+     * Identifier of the check deposit resource.
+     */
+    id: string
+
+    /**
+     * 	Type of the check deposit resource. The value is always checkDeposit.
+     */
+    type: "checkDeposit"
+
+    /**
+     * JSON object representing the check deposit resource.
+     */
+    attributes: {
+        /**
+         * Date only. The date the resource was created.
+         * RFC3339 format. For more information: https://en.wikipedia.org/wiki/ISO_8601#RFCs
+         */
+        createdAt: string
+
+        /**
+         * One of AwaitingImages, AwaitingFrontImage, AwaitingBackImage, Pending, PendingReview, Rejected, Clearing, Sent, Canceled, Returned.
+         */
+        status: CheckDepositStatus
+
+        /**
+         * Optional. More information about the status.
+         */
+        reason?: string
+
+        /**
+         * Check Deposit description (maximum of 50 characters).
+         */
+        description: string
+
+        /**
+         * The amount (cents) of the check deposit.
+         */
+        amount: number
+
+        /**
+         * Optional. The serial number printed at the bottom of the check
+         */
+        checkNumber?: number
+
+        /**
+         * Optional. The party the check belongs to.
+         */
+        counterparty?: CheckCounterparty
+
+        /**
+         * Optional. See Tags.
+         */
+        tags?: object
+
+        /**
+         * Optional. See Idempotency.
+         */
+        idempotencyKey?: string
+        //TODO: do we need this?
+    }
+
+    /**
+     * Describes relationships between the check deposit resource and other resources
+     */
+    relationships: {
+        /**
+         * The Deposit Account receiving the check deposit.
+         */
+        account: Relationship
+
+        /**
+         * The Customer the deposit account belongs to.
+         * This relationship is only available if the account belongs to a single customer, business or individual.
+         */
+        customer?: Relationship
+
+        /**
+         * The list of Customers the deposit account belongs to.
+         * This relationship is only available if the account belongs to multiple individual customers.
+         */
+        customers?: Relationship[]
+
+        /**
+         * The Check Deposit Transaction generated by this check deposit.
+         */
+        transaction: Relationship
+    }
+}
+
+export interface CreateCheckDepositRequest {
+    type: "checkDeposit"
+    attributes: {
+        /**
+         * The check amount (in cents) to deposit.
+         */
+        amount: number
+
+        /**
+         * Optional. Description of the check deposit (maximum of 50 characters).
+         */
+        description?: string
+
+        /**
+         * Optional. See Tags.
+         */
+        tags?: object
+
+        /**
+         * Optional. See Idempotency.
+         */
+        idempotencyKey?: string
+    }
+
+    relationships: {
+        /**
+         * The account receiving the check deposit.
+         */
+        account: Relationship
+    }
+}
+
+export interface PatchCheckDepositRequest {
+    checkDepositId: string
+
+    data: {
+        type: "checkDeposit"
+        attributes: {
+            tags?: object
+        }
+    }
+}
+
+export interface UploadCheckDepositRequest {
+    checkDepositId: string
+    isBackSide?: boolean
+    file: Buffer
+}

types/common.ts

@@ -272,6 +272,23 @@ export interface WireCounterparty {
      address: Address
 }
 
+export interface CheckCounterparty {
+    /**
+     * Valid 9-digit ABA routing transit number.
+     */
+    routingNumber: string
+    
+    /**
+     * Bank account number.
+     */
+    accountNumber: string
+
+    /**
+     * Name of the person or company that owns the bank account.
+     */
+    name: string
+}
+
 export interface Coordinates {
     /**
      * The longitude value.

types/index.ts

@@ -16,3 +16,4 @@ export * from "./returns"
 export * from "./transactions"
 export * from "./webhooks"
 export * from "./billPay"
+export * from "./checkDeposit"

unit.ts

@@ -21,6 +21,7 @@ import { AccountsEndOfDay } from "./resources/accountEndOfDay"
 import { BillPays } from "./resources"
 import { Institutions } from "./resources/institutions"
 import { AtmLocations } from "./resources/atmLocations"
+import { CheckDeposits } from "./resources/checkDeposit"
 
 export class Unit {
     public applications: Applications
@@ -45,6 +46,7 @@ export class Unit {
     public billPays: BillPays
     public institutions: Institutions
     public atmLocations: AtmLocations
+    public checkDeposits: CheckDeposits
 
     constructor(token: string, basePath: string, config?: UnitConfig) {
         // remove all trailing slashes from user-provided basePath
@@ -71,6 +73,7 @@ export class Unit {
         this.billPays = new BillPays(token, basePath, config)
         this.institutions = new Institutions(token, basePath, config)
         this.atmLocations = new AtmLocations(token, basePath, config)
+        this.checkDeposits = new CheckDeposits(token, basePath, config)
         this.helpers = helpers
     }