add institution endpoint for teller client

libs/teller-api/src/teller-api.ts

@@ -8,6 +8,7 @@ import type {
     GetTransactionsResponse,
     DeleteAccountResponse,
     GetAccountDetailsResponse,
+    GetInstitutionsResponse,
 } from './types'
 import axios from 'axios'
 import * as fs from 'fs'
@@ -104,6 +105,16 @@ export class TellerApi {
         return this.get<GetIdentityResponse>(`/identity`)
     }
 
+    /**
+     * Get list of supported institutions
+     *
+     * https://teller.io/docs/api/identity
+     */
+
+    async getInstitutions(): Promise<GetInstitutionsResponse> {
+        return this.get<GetInstitutionsResponse>(`/institutions`)
+    }
+
     private async getApi(): Promise<AxiosInstance> {
         const cert = fs.readFileSync('../../../certs/teller-certificate.pem', 'utf8')
         const key = fs.readFileSync('../../../certs/teller-private-key.pem', 'utf8')

libs/teller-api/src/types/index.ts

@@ -3,5 +3,6 @@ export * from './account-balance'
 export * from './account-details'
 export * from './authentication'
 export * from './identity'
+export * from './institutions'
 export * from './transactions'
 export * from './webhooks'

libs/teller-api/src/types/institutions.ts

@@ -0,0 +1,14 @@
+// https://api.teller.io/institutions
+// Note: Teller says this is subject to change, specifically the `capabilities` field
+
+export type Institution = {
+    id: string
+    name: string
+    capabilities: Capability[]
+}
+
+type Capability = 'detail' | 'balance' | 'transaction' | 'identity'
+
+export type GetInstitutionsResponse = {
+    institutions: Institution[]
+}