Skip to main content

@dialstack/sdk / index / DialStackInstance

Interface: DialStackInstance

Defined in: sdk/src/types/core.ts:524

The DialStack SDK instance returned by loadDialstackAndInitialize()

Properties​

account​

account: AccountResource;

Defined in: sdk/src/types/core.ts:589

addresses​

addresses: AddressesResource;

Defined in: sdk/src/types/core.ts:592

aiAgents​

aiAgents: AIAgentsResource;

Defined in: sdk/src/types/core.ts:582

audioClips​

audioClips: AudioClipsResource;

Defined in: sdk/src/types/core.ts:576

availablePhoneNumbers​

availablePhoneNumbers: AvailablePhoneNumbersResource;

Defined in: sdk/src/types/core.ts:573

buttonTemplates​

buttonTemplates: ButtonTemplatesResource;

Defined in: sdk/src/types/core.ts:587

calls​

calls: CallsResource;

Defined in: sdk/src/types/core.ts:570

dectBases​

dectBases: DECTBasesResource;

Defined in: sdk/src/types/core.ts:588

deskphones​

deskphones: DeskphonesResource;

Defined in: sdk/src/types/core.ts:585

devices​

devices: DevicesResource;

Defined in: sdk/src/types/core.ts:586

dialPlans​

dialPlans: DialPlansResource;

Defined in: sdk/src/types/core.ts:577

extensions​

extensions: ExtensionsResource;

Defined in: sdk/src/types/core.ts:584

locations​

locations: LocationsResource;

Defined in: sdk/src/types/core.ts:591

phoneNumberOrders​

phoneNumberOrders: PhoneNumberOrdersResource;

Defined in: sdk/src/types/core.ts:574

phoneNumbers​

phoneNumbers: PhoneNumbersResource;

Defined in: sdk/src/types/core.ts:572

portOrders​

portOrders: PortOrdersResource;

Defined in: sdk/src/types/core.ts:575

queues​

queues: QueuesResource;

Defined in: sdk/src/types/core.ts:580

ringGroups​

ringGroups: RingGroupsResource;

Defined in: sdk/src/types/core.ts:579

schedules​

schedules: SchedulesResource;

Defined in: sdk/src/types/core.ts:578

sharedVoicemailBoxes​

sharedVoicemailBoxes: SharedVoicemailBoxesResource;

Defined in: sdk/src/types/core.ts:583

users​

users: UsersResource;

Defined in: sdk/src/types/core.ts:590

voiceApps​

voiceApps: VoiceAppsResource;

Defined in: sdk/src/types/core.ts:581

voicemails​

voicemails: VoicemailsResource;

Defined in: sdk/src/types/core.ts:571

Methods​

addAppearanceTarget()​

addAppearanceTarget(element): void;

Defined in: sdk/src/types/core.ts:539

Internal

Register an arbitrary host element to receive dialstack-appearance-update events when DialStackInstance.update is called. Used internally by React-only SDK components (no underlying custom element) so they participate in the same notification path as web components.

Parameters​

element​

HTMLElement

Returns​

void

create()​

create<T>(tagName): ComponentElement[T];

Defined in: sdk/src/types/core.ts:530

Create a new embedded component

Type Parameters​

T​

T extends ComponentTagName

Parameters​

tagName​

T

Returns​

ComponentElement[T]

fetchAllPages()​

fetchAllPages<T>(fetchFn): Promise<T[]>;

Defined in: sdk/src/types/core.ts:549

Fetch all pages of a paginated list endpoint

Type Parameters​

T​

T

Parameters​

fetchFn​

(opts) => Promise<PaginatedResponse<T>>

Returns​

Promise<T[]>

fetchApi()​

fetchApi(path, options?): Promise<Response>;

Defined in: sdk/src/types/core.ts:547

Make an authenticated API request

Parameters​

path​

string

options?​

RequestInit

Returns​

Promise<Response>

getAppearance()​

getAppearance(): AppearanceOptions | undefined;

Defined in: sdk/src/types/core.ts:564

Get current appearance options

Returns​

AppearanceOptions | undefined

logout()​

logout(): Promise<void>;

Defined in: sdk/src/types/core.ts:545

Log out and clean up the session

Returns​

Promise<void>

off()​

off<K>(event, handler?): void;

Defined in: sdk/src/types/core.ts:555

Unsubscribe from real-time call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler?​

CallEventHandler<CallEventMap[K]>

Returns​

void

on()​

on<K>(event, handler): void;

Defined in: sdk/src/types/core.ts:553

Subscribe to real-time call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler​

CallEventHandler<CallEventMap[K]>

Returns​

void

removeAppearanceTarget()​

removeAppearanceTarget(element): void;

Defined in: sdk/src/types/core.ts:541

Internal

Inverse of DialStackInstance.addAppearanceTarget.

Parameters​

element​

HTMLElement

Returns​

void

resolveRoutingTarget()​

resolveRoutingTarget(target): Promise<
  | {
  extension_number?: string | null;
  id: string;
  name: string | null;
  type:   | "voice_app"
     | "user"
     | "dial_plan"
     | "ring_group"
     | "queue"
     | "shared_voicemail";
}
| null>;

Defined in: sdk/src/types/core.ts:557

Resolve a routing target TypeID to its type and display name

Parameters​

target​

string

Returns​

Promise< | { extension_number?: string | null; id: string; name: string | null; type: | "voice_app" | "user" | "dial_plan" | "ring_group" | "queue" | "shared_voicemail"; } | null>

update()​

update(updateOptions): void;

Defined in: sdk/src/types/core.ts:543

Update appearance for all components

Parameters​

updateOptions​

UpdateOptions

Returns​

void