Add support for (a subset of) sandbox simulations (#207)

Author: ali-sharif

resources/index.ts

@@ -14,6 +14,7 @@ export * from "./fee"
 export * from "./payments"
 export * from "./receivedPayments"
 export * from "./returns"
+export * from "./simulations"
 export * from "./statements"
 export * from "./transactions"
 export * from "./webhooks"

resources/simulations.ts

@@ -0,0 +1,81 @@
+import { BaseResource } from "."
+import { UnitConfig, UnitResponse } from "../types"
+import { AchReceivedPayment, Application, ApplicationDocument } from "../types"
+import {
+    ApproveApplicationSimulation,
+    DenyApplicationSimulation,
+    RejectDocumentSimulation,
+    CreateAchReceivedPaymentSimulation,
+} from "../types"
+
+export class Simulations extends BaseResource {
+    constructor(token: string, basePath: string, config?: UnitConfig) {
+        super(token, basePath + "/sandbox", config)
+    }
+
+    public async approveApplication(
+        applicationId: string,
+        request: ApproveApplicationSimulation
+    ): Promise<UnitResponse<Application>> {
+        return this.httpPost<UnitResponse<Application>>(
+            `/applications/${applicationId}/approve`,
+            {
+                data: request,
+            }
+        )
+    }
+
+    public async denyApplication(
+        applicationId: string,
+        request: DenyApplicationSimulation
+    ): Promise<UnitResponse<Application>> {
+        return this.httpPost<UnitResponse<Application>>(
+            `/applications/${applicationId}/deny`,
+            {
+                data: request,
+            }
+        )
+    }
+
+    public async approveDocument(
+        applicationId: string,
+        documentId: string
+    ): Promise<UnitResponse<ApplicationDocument>> {
+        return this.httpPost<UnitResponse<ApplicationDocument>>(
+            `/applications/${applicationId}/documents/${documentId}/approve`,
+            undefined
+        )
+    }
+
+    public async rejectDocument(
+        applicationId: string,
+        documentId: string,
+        request: RejectDocumentSimulation
+    ): Promise<UnitResponse<ApplicationDocument>> {
+        return this.httpPost<UnitResponse<ApplicationDocument>>(
+            `/applications/${applicationId}/documents/${documentId}/reject`,
+            {
+                data: request,
+            }
+        )
+    }
+
+    public async createAchReceivedPayment(
+        request: CreateAchReceivedPaymentSimulation
+    ): Promise<UnitResponse<AchReceivedPayment>> {
+        return this.httpPost<UnitResponse<AchReceivedPayment>>(
+            "/received-payments",
+            {
+                data: request,
+            }
+        )
+    }
+
+    public async completeAchReceivedPayment(
+        id: string,
+    ): Promise<UnitResponse<AchReceivedPayment>> {
+        return this.httpPost<UnitResponse<AchReceivedPayment>>(
+            `/received-payments/${id}/complete`,
+        )
+    }
+}

types/index.ts

@@ -13,6 +13,7 @@ export * from "./events"
 export * from "./fee"
 export * from "./payments"
 export * from "./returns"
+export * from "./simulations"
 export * from "./transactions"
 export * from "./webhooks"
 export * from "./billPay"

types/simulations.ts

@@ -0,0 +1,154 @@
+import { ReasonCode } from "."
+
+export interface ApproveApplicationSimulation {
+    type: "applicationApprove"
+    attributes: {
+        reason: string
+    }
+}
+
+export interface DenyApplicationSimulation {
+    type: "applicationDeny"
+    attributes: {
+        reason: string
+    }
+}
+
+export interface RejectDocumentSimulation {
+    type: "documentReject"
+    attributes: {
+        reason: string
+        reasonCode: ReasonCode
+    }
+}
+
+export interface ReceiveAchPaymentSimulation {
+    type: "achPayment"
+    attributes: {
+        amount: number
+        direction: "Credit" | "Debit"
+        description: string
+    }
+    relationships: {
+        account: {
+            type: "depositAccount"
+            id: string
+        }
+    }
+}
+
+export interface TransmitAchPaymentSimulation {
+    type: "transmitAchPayment"
+    relationships: {
+        payment: {
+            type: "achPayment"
+            id: string
+        }
+    }
+}
+
+export interface ClearAchPaymentSimulation {
+    type: "clearAchPayment"
+    relationships: {
+        payment: {
+            type: "achPayment"
+            id: string
+        }
+    }
+}
+
+export interface ReturnAchPaymentSimulation {
+    type: "returnAchPayment"
+    relationships: {
+        payment: {
+            type: "achPayment"
+            id: string
+        }
+    }
+}
+
+export interface ReceiveWirePaymentSimulation {
+    type: "wirePayment"
+    attributes: {
+        amount: number
+        description: string
+    }
+    relationships: {
+        account: {
+            data: {
+                type: "depositAccount"
+                id: string
+            }
+        }
+    }
+}
+
+export interface CreateCardAuthorizationSimulation {
+    type: "authorization"
+    attributes: {
+        amount: number
+        cardLast4Digits: string
+        merchantName: string
+        /**
+         * The 4-digit ISO 18245 merchant category code (MCC). Use any number (e.g. 1000 for testing).
+         */
+        merchantType: number
+        merchantLocation: string
+        recurring?: boolean
+    }
+    relationships: {
+        account: {
+            data: {
+                type: "depositAccount"
+                id: string
+            }
+        }
+    }
+}
+
+export interface CreateCardPurchaseSimulation {
+    type: "purchaseTransaction"
+    attributes: {
+        amount: number
+        direction: string
+        merchantName: string
+        /**
+         * The 4-digit ISO 18245 merchant category code (MCC). Use any number (e.g. 1000 for testing).
+         */
+        merchantType: number
+        merchantLocation: string
+        coordinates?: {
+            longitude: number
+            latitude: number
+        }
+        last4Digits: string
+        recurring: false
+    }
+    relationships: {
+        account: {
+            data: {
+                type: "depositAccount"
+                id: string
+            }
+        }
+    }
+}
+
+export interface CreateAchReceivedPaymentSimulation {
+    type: "achReceivedPayment"
+    attributes: {
+        amount: number
+        description: string
+        companyName: string
+        completionDate: string
+        secCode: string
+    }
+    relationships: {
+        account: {
+            data: {
+                type: "depositAccount"
+                id: string
+            }
+        }
+    }
+}

unit.ts

@@ -25,6 +25,7 @@ import { CheckDeposits } from "./resources/checkDeposit"
 import { ReceivedPayments } from "./resources/receivedPayments"
 import { RecurringPayments } from "./resources/recurringPayments"
 import { OrgTokens } from "./resources/orgToken"
+import { Simulations } from "./resources/simulations"
 
 export class Unit {
     public applications: Applications
@@ -54,6 +55,7 @@ export class Unit {
     public rewards: Rewards
     public recurringPayments: RecurringPayments
     public orgTokens: OrgTokens
+    public simulations: Simulations
 
     constructor(token: string, basePath: string, config?: UnitConfig) {
         // remove all trailing slashes from user-provided basePath
@@ -85,6 +87,7 @@ export class Unit {
         this.rewards = new Rewards(token, basePath, config)
         this.recurringPayments = new RecurringPayments(token, basePath, config)
         this.orgTokens = new OrgTokens(token, basePath, config)
+        this.simulations = new Simulations(token, basePath, config)
         this.helpers = helpers
     }