Types
Typed request and response shapes for the Node.js SDK.
The Node.js SDK is fully typed. Every method returns a typed response — you never
deal with any or unknown. Import the shared types directly from
@branofy/voice-sdk-node:
import type {
CreateVoiceAgent,
VoiceAgent,
VoiceAgentsList,
VoiceCallDispatch,
} from "@branofy/voice-sdk-node";Types are exposed with clean names — the internal Dto suffix is not part of
the public API. You import CreateVoiceAgent, not CreateVoiceAgentDto.
By convention: CreateVoice… types are request bodies, Voice…List types
are list responses, and the bare Voice… types are single-resource
responses.
| Public type | Role |
|---|---|
CreateVoiceAgent / VoiceAgent / VoiceAgentsList | Agent create body / single / list |
CreateVoiceCall / VoiceCallDispatch / VoiceCall / VoiceCallsList | Call dispatch body / result / single / list |
CreateVoiceTool / VoiceTool / VoiceToolsList | Tool create body / single / list |
CreateVoiceDid / VoiceDid / VoiceDidsList | BYO number create body / single / list |
ManagedDidCatalog / SelectManagedDid / SubmitManagedKyc / FinalizeManagedDid | Managed business-number flow bodies/responses |
ManagedDidJob / ManagedDidJobStep | Number provisioning job / checklist step |
CreateVoiceSchedule / VoiceSchedule / VoiceSchedulesList | Schedule create body / single / list |
CreateVoiceWebhook / VoiceWebhook / VoiceWebhooksList | Webhook create body / single / list |
CreateVoiceApiKey / VoiceApiKey / VoiceApiKeyCreated / VoiceApiKeysList | API key create body / metadata / created (with rawKey) / list |
VoiceOverview / VoiceOverviewMetric | Workspace summary / metric entry |
VoiceBilling / VoiceTopup / VoiceTopupResponse | Billing summary / top-up body / top-up order |
VoicePayment / VoiceWalletTransaction | Payment order / wallet ledger entry |
Responses are inferred
// `agents` is typed as VoiceAgentsList — autocomplete works on agents.data[0]
const agents = await voice.agents.get();