Skip to main content

SDK Reference

Auto-generated from TypeScript source. Every public export of @dialstack/sdk with its signature, parameters, return type, and a link to the source line in the public SDK repo.

For narrative guides (installation, authentication, theming, getting started with React or Web Components), see SDK. This page is the exhaustive, machine-generated surface.

Entry points

The SDK publishes five entry points, each scoped to a different runtime:

ImportUse fromShips
@dialstack/sdkReact appsMain bundle — components, provider, hooks
@dialstack/sdk/reactReact appsIndividual React component imports
@dialstack/sdk/pureVanilla JS, Vue, Svelte, AngularFramework-agnostic Web Components
@dialstack/sdk/serverNode.js backendsREST client and session-token issuance
@dialstack/sdk/onboardingReact apps<OnboardingPortal> (separate bundle)

Reading this reference

Each module's page lists its exports grouped by kind:

  • Functions — the verbs (e.g., loadDialStack, initialize, hooks).
  • Variables — the components and other const exports (e.g., CallLogs, Voicemails).
  • Interfaces — the shapes of props and option objects (e.g., CallLogsProps).
  • Type aliases — discriminated unions and named types.
  • Classes — e.g., the DialStack server client.

Source links on every symbol point at the corresponding line in the public dialstack-sdk repo.