get counterparty balance (#83)

Co-authored-by: Ilya Merman <[email protected]>

Author: axshani

resources/counterparty.ts

@@ -1,5 +1,5 @@
 import { UnitConfig, UnitResponse } from "../types/common"
-import { AchCounterparty, CreateCounterpartyRequest, PatchCounterpartyRequest } from "../types/counterparty"
+import { AchCounterparty, CounterpartyBalance, CreateCounterpartyRequest, PatchCounterpartyRequest } from "../types/counterparty"
 import { BaseResource } from "./baseResource"
 
 export class Counterparties extends BaseResource {
@@ -33,6 +33,10 @@ export class Counterparties extends BaseResource {
     public async update(id: string, request: PatchCounterpartyRequest): Promise<UnitResponse<AchCounterparty>> {
         return this.httpPatch<Promise<UnitResponse<AchCounterparty>>>(`/${id}`, { data: request })
     }
+
+    public async getBalance(id: string): Promise<UnitResponse<CounterpartyBalance>> {
+        return this.httpGet<Promise<UnitResponse<CounterpartyBalance>>>(`/${id}/balance`)
+    }
 }
 
 export interface CounterpartyListParams {

types/counterparty.ts

@@ -146,10 +146,52 @@ export interface PatchCounterpartyRequest {
      * Plaid integration token
      * See Plaid processor token
      */
-    plaidProcessorToken: string	
+    plaidProcessorToken: string
 
     /**
      * Optional, default to false. Verify the name of the counterparty, if the name verification fails the request will fail with code field set to NameVerificationFailed.
      */
     verifyName?: boolean
+}
+
+export interface CounterpartyBalance {
+    /**
+     * Identifier of the Counterparty.
+     */
+    id: string
+
+    /**
+     * Type of the balance. for counterparty balance the value is always counterpartyBalance.
+     */
+    type: "counterpartyBalance"
+
+    /**
+     * JSON object representing the counterparty balance resource.
+     */
+    attributes: {
+        /**
+         * The current balance amount (in cents) of the counterparty.
+         */
+        balance: number
+
+        /**
+         * Optional. The available balance amount (in cents) of the counterparty.
+         */
+        available?: number
+    }
+
+    /**
+     * Describes relationships between the counterparty balance and the customer and counterparty.
+     */
+    relationships: {
+        /**
+         * The customer the counterparty belongs to.
+         */
+        counterparty: Relationship
+
+        /**
+         * The customer the counterparty belongs to.
+         */
+        customer: Relationship
+    }
 }