Skip to main content

@dialstack/sdk-dev / js/src / DialStackInstanceImplClass

Class: DialStackInstanceImplClass

Defined in: sdk/js/src/core/instance.ts:243

Internal implementation of DialStack SDK instance

Implements​

Constructors​

Constructor​

TypeScript
new DialStackInstanceImplClass(params): DialStackInstanceImplClass;

Defined in: sdk/js/src/core/instance.ts:277

Parameters​

params​

DialStackInitParams

Returns​

DialStackInstanceImplClass

Properties​

account​

TypeScript
account: object;

Defined in: sdk/js/src/core/instance.ts:1725

effectivePricing​

TypeScript
effectivePricing: object;
effectivePricing.retrieve​
TypeScript
retrieve: () => Promise<EffectivePricing>;

Retrieve what this account is billed today, plus any agreed change that has not started yet. Read this rather than the agreed pricing whenever you are showing a customer what something costs: a rate change takes effect at the start of the next month, so the agreed rates are not always the ones being charged.

Returns​

Promise<EffectivePricing>

retrieve​

TypeScript
retrieve: () => Promise<Account>;
Returns​

Promise<Account>

tos​

TypeScript
tos: object;
tos.accept​
TypeScript
accept: (version) => Promise<Tos>;

Record acceptance of the agreement at version for this account. The server snapshots the account's pricing and derives the capture method from the session. Throws an ApiError on a stale version (409) or when pricing has not been set (422) so callers can branch on error.status.

Parameters​
version​

string

Returns​

Promise<Tos>

tos.retrieve​
TypeScript
retrieve: (options?) => Promise<Tos>;

Retrieve the current subscription agreement and this account's acceptance state. Pass expand: ['pricing'] to include the pricing the customer is agreeing to.

Parameters​
options?​
expand?​

string[]

Returns​

Promise<Tos>

update​

TypeScript
update: (request) => Promise<Account>;
Parameters​
request​

UpdateAccountRequest

Returns​

Promise<Account>

Implementation of​

DialStackInstanceImpl.account

addresses​

TypeScript
addresses: object;

Defined in: sdk/js/src/core/instance.ts:1923

getPlaceDetails​

TypeScript
getPlaceDetails: (placeId) => Promise<ResolvedAddress>;
Parameters​
placeId​

string

Returns​

Promise<ResolvedAddress>

suggest​

TypeScript
suggest: (query, country?) => Promise<AddressSuggestion[]>;
Parameters​
query​

string

country?​

string

Returns​

Promise<AddressSuggestion[]>

Implementation of​

DialStackInstanceImpl.addresses

aiAgents​

TypeScript
aiAgents: object;

Defined in: sdk/js/src/core/instance.ts:1060

list​

TypeScript
list: (options?) => Promise<AIAgent[]>;
Parameters​
options?​
limit?​

number

Returns​

Promise<AIAgent[]>

retrieve​

TypeScript
retrieve: (aiAgentId) => Promise<AIAgent>;
Parameters​
aiAgentId​

string

Returns​

Promise<AIAgent>

update​

TypeScript
update: (aiAgentId, data) => Promise<AIAgent>;
Parameters​
aiAgentId​

string

data​

UpdateAIAgentRequest

Returns​

Promise<AIAgent>

Implementation of​

DialStackInstanceImpl.aiAgents

audioClips​

TypeScript
audioClips: object;

Defined in: sdk/js/src/core/instance.ts:903

list​

TypeScript
list: () => Promise<NamedResource[]>;
Returns​

Promise<NamedResource[]>

Implementation of​

DialStackInstanceImpl.audioClips

availablePhoneNumbers​

TypeScript
availablePhoneNumbers: object;

Defined in: sdk/js/src/core/instance.ts:682

TypeScript
search: (options) => Promise<AvailablePhoneNumber[]>;
Parameters​
options​

SearchAvailableNumbersOptions

Returns​

Promise<AvailablePhoneNumber[]>

Implementation of​

DialStackInstanceImpl.availablePhoneNumbers

buttonTemplates​

TypeScript
buttonTemplates: object;

Defined in: sdk/js/src/core/instance.ts:1431

buttons​

TypeScript
buttons: object;
buttons.create​
TypeScript
create: (templateId, request) => Promise<TemplateButton>;
Parameters​
templateId​

string

request​

CreateTemplateButtonRequest

Returns​

Promise<TemplateButton>

buttons.del​
TypeScript
del: (templateId, buttonId) => Promise<void>;
Parameters​
templateId​

string

buttonId​

string

Returns​

Promise<void>

buttons.list​
TypeScript
list: (templateId, options?) => Promise<PaginatedResponse<TemplateButton>>;
Parameters​
templateId​

string

options?​
ending_before?​

string

limit?​

number

starting_after?​

string

Returns​

Promise<PaginatedResponse<TemplateButton>>

buttons.update​
TypeScript
update: (templateId, buttonId, request) => Promise<TemplateButton>;
Parameters​
templateId​

string

buttonId​

string

request​

UpdateTemplateButtonRequest

Returns​

Promise<TemplateButton>

create​

TypeScript
create: (request) => Promise<ButtonTemplate>;
Parameters​
request​

CreateButtonTemplateRequest

Returns​

Promise<ButtonTemplate>

del​

TypeScript
del: (templateId) => Promise<void>;
Parameters​
templateId​

string

Returns​

Promise<void>

list​

TypeScript
list: (options?) => Promise<PaginatedResponse<ButtonTemplate>>;
Parameters​
options?​
ending_before?​

string

limit?​

number

starting_after?​

string

Returns​

Promise<PaginatedResponse<ButtonTemplate>>

retrieve​

TypeScript
retrieve: (templateId, options?) => Promise<ButtonTemplateWithDetails>;
Parameters​
templateId​

string

options?​
expand?​

"buttons"[]

for_device?​

string

Returns​

Promise<ButtonTemplateWithDetails>

update​

TypeScript
update: (templateId, request) => Promise<ButtonTemplate>;
Parameters​
templateId​

string

request​

UpdateButtonTemplateRequest

Returns​

Promise<ButtonTemplate>

Implementation of​

DialStackInstanceImpl.buttonTemplates

calls​

TypeScript
calls: object;

Defined in: sdk/js/src/core/instance.ts:521

create​

TypeScript
create: (params) => Promise<void>;
Parameters​
params​
dialString​

string

userId​

string

Returns​

Promise<void>

retrieve​

TypeScript
retrieve: (callId) => Promise<CallLog>;
Parameters​
callId​

string

Returns​

Promise<CallLog>

transcripts​

TypeScript
transcripts: object;
transcripts.retrieve​
TypeScript
retrieve: (callId) => Promise<Transcript>;
Parameters​
callId​

string

Returns​

Promise<Transcript>

Implementation of​

DialStackInstanceImpl.calls

dectBases​

TypeScript
dectBases: object;

Defined in: sdk/js/src/core/instance.ts:1567

create​

TypeScript
create: (data) => Promise<DECTBase>;
Parameters​
data​

CreateDECTBaseRequest

Returns​

Promise<DECTBase>

del​

TypeScript
del: (id) => Promise<void>;
Parameters​
id​

string

Returns​

Promise<void>

extensions​

TypeScript
extensions: object;
extensions.create​
TypeScript
create: (baseId, handsetId, data) => Promise<DECTExtension>;
Parameters​
baseId​

string

handsetId​

string

data​

CreateDECTExtensionRequest

Returns​

Promise<DECTExtension>

extensions.del​
TypeScript
del: (baseId, handsetId, extensionId) => Promise<void>;
Parameters​
baseId​

string

handsetId​

string

extensionId​

string

Returns​

Promise<void>

extensions.list​
TypeScript
list: (baseId, handsetId) => Promise<DECTExtension[]>;
Parameters​
baseId​

string

handsetId​

string

Returns​

Promise<DECTExtension[]>

handsets​

TypeScript
handsets: object;
handsets.create​
TypeScript
create: (baseId, data) => Promise<DECTHandset>;
Parameters​
baseId​

string

data​

CreateDECTHandsetRequest

Returns​

Promise<DECTHandset>

handsets.del​
TypeScript
del: (baseId, handsetId) => Promise<void>;
Parameters​
baseId​

string

handsetId​

string

Returns​

Promise<void>

handsets.list​
TypeScript
list: (baseId) => Promise<DECTHandset[]>;
Parameters​
baseId​

string

Returns​

Promise<DECTHandset[]>

handsets.retrieve​
TypeScript
retrieve: (baseId, handsetId) => Promise<DECTHandset>;
Parameters​
baseId​

string

handsetId​

string

Returns​

Promise<DECTHandset>

handsets.update​
TypeScript
update: (baseId, handsetId, data) => Promise<DECTHandset>;
Parameters​
baseId​

string

handsetId​

string

data​

UpdateDECTHandsetRequest

Returns​

Promise<DECTHandset>

list​

TypeScript
list: (options?) => Promise<DECTBase[]>;
Parameters​
options?​

DeviceListOptions

Returns​

Promise<DECTBase[]>

retrieve​

TypeScript
retrieve: (id) => Promise<DECTBase>;
Parameters​
id​

string

Returns​

Promise<DECTBase>

update​

TypeScript
update: (id, data) => Promise<DECTBase>;
Parameters​
id​

string

data​

UpdateDECTBaseRequest

Returns​

Promise<DECTBase>

Implementation of​

DialStackInstanceImpl.dectBases

deskphones​

TypeScript
deskphones: object;

Defined in: sdk/js/src/core/instance.ts:1155

create​

TypeScript
create: (data) => Promise<ProvisionedDevice>;
Parameters​
data​

CreateDeskphoneRequest

Returns​

Promise<ProvisionedDevice>

del​

TypeScript
del: (id) => Promise<void>;
Parameters​
id​

string

Returns​

Promise<void>

lines​

TypeScript
lines: object;
lines.create​
TypeScript
create: (deskphoneId, data) => Promise<DeviceLine>;
Parameters​
deskphoneId​

string

data​

CreateDeskphoneLineRequest

Returns​

Promise<DeviceLine>

lines.del​
TypeScript
del: (deskphoneId, lineId) => Promise<void>;
Parameters​
deskphoneId​

string

lineId​

string

Returns​

Promise<void>

lines.list​
TypeScript
list: (deskphoneId) => Promise<DeviceLine[]>;
Parameters​
deskphoneId​

string

Returns​

Promise<DeviceLine[]>

lines.update​
TypeScript
update: (deskphoneId, lineId, data) => Promise<DeviceLine>;
Parameters​
deskphoneId​

string

lineId​

string

data​

UpdateDeskphoneLineRequest

Returns​

Promise<DeviceLine>

provisioningEvents​

TypeScript
provisioningEvents: object;
provisioningEvents.list​
TypeScript
list: (deskphoneId, options?) => Promise<ProvisioningEvent[]>;
Parameters​
deskphoneId​

string

options?​

ProvisioningEventListOptions

Returns​

Promise<ProvisioningEvent[]>

update​

TypeScript
update: (id, data) => Promise<ProvisionedDevice>;
Parameters​
id​

string

data​

UpdateDeskphoneRequest

Returns​

Promise<ProvisionedDevice>

Implementation of​

DialStackInstanceImpl.deskphones

devices​

TypeScript
devices: object;

Defined in: sdk/js/src/core/instance.ts:1269

create​

TypeScript
create: (request) => Promise<CreateDeviceResponse>;
Parameters​
request​

CreateDeviceRequest

Returns​

Promise<CreateDeviceResponse>

createButtonOverride​

TypeScript
createButtonOverride: (id, request) => Promise<DeviceButtonOverride>;
Parameters​
id​

string

request​

CreateDeviceButtonOverrideRequest

Returns​

Promise<DeviceButtonOverride>

deleteButtonOverride​

TypeScript
deleteButtonOverride: (id, overrideId) => Promise<void>;
Parameters​
id​

string

overrideId​

string

Returns​

Promise<void>

list​

TypeScript
list: (options?) => Promise<Device[]>;
Parameters​
options?​

DeviceListOptions

Returns​

Promise<Device[]>

listButtonOverrides​

TypeScript
listButtonOverrides: (id, options?) => Promise<PaginatedResponse<DeviceButtonOverride>>;
Parameters​
id​

string

options?​
ending_before?​

string

limit?​

number

starting_after?​

string

Returns​

Promise<PaginatedResponse<DeviceButtonOverride>>

listButtons​

TypeScript
listButtons: (id) => Promise<PaginatedResponse<MaterializedButton>>;
Parameters​
id​

string

Returns​

Promise<PaginatedResponse<MaterializedButton>>

listCompatibleButtonTemplates​

TypeScript
listCompatibleButtonTemplates: (id, options?) => Promise<PaginatedResponse<ButtonTemplate>>;
Parameters​
id​

string

options?​
ending_before?​

string

limit?​

number

starting_after?​

string

Returns​

Promise<PaginatedResponse<ButtonTemplate>>

retrieve​

TypeScript
retrieve: (id) => Promise<Device>;
Parameters​
id​

string

Returns​

Promise<Device>

update​

TypeScript
update: (id, request) => Promise<Device>;
Parameters​
id​

string

request​

UpdateDeviceRequest

Returns​

Promise<Device>

users​

TypeScript
users: object;
users.create​
TypeScript
create: (deviceId, request) => Promise<DeviceUserAssignment>;
Parameters​
deviceId​

string

request​

AssignDeviceUserRequest

Returns​

Promise<DeviceUserAssignment>

users.del​
TypeScript
del: (deviceId, userId) => Promise<void>;
Parameters​
deviceId​

string

userId​

string

Returns​

Promise<void>

users.list​
TypeScript
list: (deviceId) => Promise<DeviceUserAssignment[]>;
Parameters​
deviceId​

string

Returns​

Promise<DeviceUserAssignment[]>

Implementation of​

DialStackInstanceImpl.devices

dialPlans​

TypeScript
dialPlans: object;

Defined in: sdk/js/src/core/instance.ts:915

create​

TypeScript
create: (data) => Promise<DialPlan>;
Parameters​
data​

Record<string, unknown>

Returns​

Promise<DialPlan>

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
expand?​

string[]

limit?​

number

Returns​

Promise<NamedResource[]>

retrieve​

TypeScript
retrieve: (dialPlanId) => Promise<DialPlan>;
Parameters​
dialPlanId​

string

Returns​

Promise<DialPlan>

update​

TypeScript
update: (dialPlanId, data) => Promise<DialPlan>;
Parameters​
dialPlanId​

string

data​

Record<string, unknown>

Returns​

Promise<DialPlan>

Implementation of​

DialStackInstanceImpl.dialPlans

extensions​

TypeScript
extensions: object;

Defined in: sdk/js/src/core/instance.ts:1123

create​

TypeScript
create: (request) => Promise<Extension>;
Parameters​
request​

CreateExtensionRequest

Returns​

Promise<Extension>

list​

TypeScript
list: (options?) => Promise<Extension[]>;
Parameters​
options?​
limit?​

number

target?​

string

Returns​

Promise<Extension[]>

Implementation of​

DialStackInstanceImpl.extensions

livemode​

TypeScript
readonly livemode: boolean;

Defined in: sdk/js/src/core/instance.ts:252

Whether this instance is operating on live data, from the publishable key's prefix. pk_test_ keys reach sandbox and demo accounts, which are never billed; pk_live_ keys reach live accounts only, which the API enforces. Lets a component tell the two apart without reading the account.

Implementation of​

DialStackInstanceImpl.livemode

locations​

TypeScript
locations: object;

Defined in: sdk/js/src/core/instance.ts:1857

create​

TypeScript
create: (request) => Promise<OnboardingLocation>;
Parameters​
request​

CreateLocationRequest

Returns​

Promise<OnboardingLocation>

list​

TypeScript
list: () => Promise<OnboardingLocation[]>;
Returns​

Promise<OnboardingLocation[]>

provisionE911​

TypeScript
provisionE911: (locationId) => Promise<OnboardingLocation>;
Parameters​
locationId​

string

Returns​

Promise<OnboardingLocation>

retrieve​

TypeScript
retrieve: (locationId) => Promise<OnboardingLocation>;
Parameters​
locationId​

string

Returns​

Promise<OnboardingLocation>

update​

TypeScript
update: (locationId, request) => Promise<OnboardingLocation>;
Parameters​
locationId​

string

request​

UpdateLocationRequest

Returns​

Promise<OnboardingLocation>

validateE911​

TypeScript
validateE911: (locationId) => Promise<E911ValidationResult>;
Parameters​
locationId​

string

Returns​

Promise<E911ValidationResult>

Implementation of​

DialStackInstanceImpl.locations

phoneNumberOrders​

TypeScript
phoneNumberOrders: object;

Defined in: sdk/js/src/core/instance.ts:711

create​

TypeScript
create: (phoneNumbers) => Promise<NumberOrder>;
Parameters​
phoneNumbers​

string[]

Returns​

Promise<NumberOrder>

list​

TypeScript
list: (options?) => Promise<PaginatedResponse<NumberOrder>>;
Parameters​
options?​
limit?​

number

order_type?​

string

status?​

string

Returns​

Promise<PaginatedResponse<NumberOrder>>

retrieve​

TypeScript
retrieve: (orderId) => Promise<NumberOrder>;
Parameters​
orderId​

string

Returns​

Promise<NumberOrder>

Implementation of​

DialStackInstanceImpl.phoneNumberOrders

phoneNumbers​

TypeScript
phoneNumbers: object;

Defined in: sdk/js/src/core/instance.ts:589

list​

TypeScript
list: (options?) => Promise<PaginatedResponse<DIDItem>>;
Parameters​
options?​
limit?​

number

status?​

string

Returns​

Promise<PaginatedResponse<DIDItem>>

retrieve​

TypeScript
retrieve: (phoneNumberId) => Promise<DIDItem>;
Parameters​
phoneNumberId​

string

Returns​

Promise<DIDItem>

retrieveSmsPortOut​

TypeScript
retrieveSmsPortOut: (phoneNumberId) => Promise<SmsPortOutWindow>;
Parameters​
phoneNumberId​

string

Returns​

Promise<SmsPortOutWindow>

update​

TypeScript
update: (phoneNumberId, data) => Promise<DIDItem>;
Parameters​
phoneNumberId​

string

data​

UpdatePhoneNumberRequest

Returns​

Promise<DIDItem>

updateRoute​

TypeScript
updateRoute: (phoneNumberId, routingTarget) => Promise<DIDItem>;
Parameters​
phoneNumberId​

string

routingTarget​

string | null

Returns​

Promise<DIDItem>

updateSmsPortOut​

TypeScript
updateSmsPortOut: (phoneNumberId, data) => Promise<SmsPortOutWindow>;
Parameters​
phoneNumberId​

string

data​

UpdateSmsPortOutRequest

Returns​

Promise<SmsPortOutWindow>

Implementation of​

DialStackInstanceImpl.phoneNumbers

portOrders​

TypeScript
portOrders: object;

Defined in: sdk/js/src/core/instance.ts:755

approve​

TypeScript
approve: (orderId, request) => Promise<SDKPortOrder>;
Parameters​
orderId​

string

request​

ApprovePortOrderRequest

Returns​

Promise<SDKPortOrder>

cancel​

TypeScript
cancel: (orderId) => Promise<SDKPortOrder>;
Parameters​
orderId​

string

Returns​

Promise<SDKPortOrder>

checkEligibility​

TypeScript
checkEligibility: (phoneNumbers) => Promise<PortEligibilityResult>;
Parameters​
phoneNumbers​

string[]

Returns​

Promise<PortEligibilityResult>

create​

TypeScript
create: (request) => Promise<SDKPortOrder>;
Parameters​
request​

SDKCreatePortOrderRequest

Returns​

Promise<SDKPortOrder>

downloadBillCopy​

TypeScript
downloadBillCopy: (orderId) => Promise<Blob>;
Parameters​
orderId​

string

Returns​

Promise<Blob>

downloadCSR​

TypeScript
downloadCSR: (orderId) => Promise<Blob>;
Parameters​
orderId​

string

Returns​

Promise<Blob>

list​

TypeScript
list: (options?) => Promise<PaginatedResponse<SDKPortOrder>>;
Parameters​
options?​
limit?​

number

status?​

string

Returns​

Promise<PaginatedResponse<SDKPortOrder>>

retrieve​

TypeScript
retrieve: (orderId) => Promise<SDKPortOrder>;
Parameters​
orderId​

string

Returns​

Promise<SDKPortOrder>

submit​

TypeScript
submit: (orderId) => Promise<SDKPortOrder>;
Parameters​
orderId​

string

Returns​

Promise<SDKPortOrder>

uploadBillCopy​

TypeScript
uploadBillCopy: (orderId, file) => Promise<void>;
Parameters​
orderId​

string

file​

File

Returns​

Promise<void>

uploadCSR​

TypeScript
uploadCSR: (orderId, file) => Promise<void>;
Parameters​
orderId​

string

file​

File

Returns​

Promise<void>

Implementation of​

DialStackInstanceImpl.portOrders

queues​

TypeScript
queues: object;

Defined in: sdk/js/src/core/instance.ts:1016

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
expand?​

string[]

limit?​

number

Returns​

Promise<NamedResource[]>

Implementation of​

DialStackInstanceImpl.queues

ringGroups​

TypeScript
ringGroups: object;

Defined in: sdk/js/src/core/instance.ts:994

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
expand?​

string[]

limit?​

number

Returns​

Promise<NamedResource[]>

Implementation of​

DialStackInstanceImpl.ringGroups

schedules​

TypeScript
schedules: object;

Defined in: sdk/js/src/core/instance.ts:969

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
limit?​

number

Returns​

Promise<NamedResource[]>

retrieve​

TypeScript
retrieve: (scheduleId) => Promise<NamedResource>;
Parameters​
scheduleId​

string

Returns​

Promise<NamedResource>

Implementation of​

DialStackInstanceImpl.schedules

sharedVoicemailBoxes​

TypeScript
sharedVoicemailBoxes: object;

Defined in: sdk/js/src/core/instance.ts:1105

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
limit?​

number

Returns​

Promise<NamedResource[]>

Implementation of​

DialStackInstanceImpl.sharedVoicemailBoxes

users​

TypeScript
users: object;

Defined in: sdk/js/src/core/instance.ts:1815

create​

TypeScript
create: (request) => Promise<OnboardingUser>;
Parameters​
request​

CreateUserRequest

Returns​

Promise<OnboardingUser>

del​

TypeScript
del: (userId) => Promise<void>;
Parameters​
userId​

string

Returns​

Promise<void>

list​

TypeScript
list: (options?) => Promise<OnboardingUser[]>;
Parameters​
options?​
expand?​

string[]

limit?​

number

Returns​

Promise<OnboardingUser[]>

Implementation of​

DialStackInstanceImpl.users

voiceApps​

TypeScript
voiceApps: object;

Defined in: sdk/js/src/core/instance.ts:1038

list​

TypeScript
list: (options?) => Promise<NamedResource[]>;
Parameters​
options?​
expand?​

string[]

limit?​

number

Returns​

Promise<NamedResource[]>

Implementation of​

DialStackInstanceImpl.voiceApps

voicemails​

TypeScript
voicemails: object;

Defined in: sdk/js/src/core/instance.ts:558

delete​

TypeScript
delete: (voicemailId) => Promise<void>;
Parameters​
voicemailId​

string

Returns​

Promise<void>

markAsRead​

TypeScript
markAsRead: (voicemailId) => Promise<void>;
Parameters​
voicemailId​

string

Returns​

Promise<void>

retrieveTranscript​

TypeScript
retrieveTranscript: (voicemailId) => Promise<VoicemailTranscript>;
Parameters​
voicemailId​

string

Returns​

Promise<VoicemailTranscript>

Implementation of​

DialStackInstanceImpl.voicemails

Methods​

addAppearanceTarget()​

TypeScript
addAppearanceTarget(element): void;

Defined in: sdk/js/src/core/instance.ts:2123

Register an arbitrary host element to receive appearance-update events. Used by React-only SDK components (e.g. DialPlan, OnboardingPortal) that aren't backed by a custom element created via create().

Note: the element joins the same this.components set that custom elements use, so it will also receive dialstack-logout events and be cleared on logout (see logout()). Detached targets created by useAppearance ignore logout, so this is harmless today — but anything dispatched to this.components in the future will reach these targets too.

Parameters​

element​

HTMLElement

Returns​

void

Implementation of​

DialStackInstanceImpl.addAppearanceTarget

create()​

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

Defined in: sdk/js/src/core/instance.ts:2095

Create a new component

Type Parameters​

T​

T extends ComponentTagName

Parameters​

tagName​

T

Returns​

ComponentElement[T]

Implementation of​

DialStackInstanceImpl.create

fetchAllPages()​

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

Defined in: sdk/js/src/core/instance.ts:2073

Fetch all pages of a paginated list endpoint, following next_page_url links.

Type Parameters​

T​

T

Parameters​

fetchFn​

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

Returns​

Promise<T[]>

Implementation of​

DialStackInstanceImpl.fetchAllPages

fetchApi()​

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

Defined in: sdk/js/src/core/instance.ts:491

Make an authenticated API request. On a 401/403 the cached secret has been rejected (expired or revoked), so drop it, re-fetch a fresh one, and retry once — otherwise a stale secret fails every subsequent call until something else refreshes the session. A second 401/403 is returned as-is for the caller to handle. Auth-rejected requests never reach business logic, so the retry is safe for non-idempotent verbs.

Parameters​

path​

string

options?​

RequestInit = {}

Returns​

Promise<Response>

Implementation of​

DialStackInstanceImpl.fetchApi

getAppearance()​

TypeScript
getAppearance(): AppearanceOptions | undefined;

Defined in: sdk/js/src/core/instance.ts:448

Get current appearance options

Returns​

AppearanceOptions | undefined

Implementation of​

DialStackInstanceImpl.getAppearance

getClientSecret()​

TypeScript
getClientSecret(): Promise<string>;

Defined in: sdk/js/src/core/instance.ts:426

Get current client secret (waits for session if needed)

Returns​

Promise<string>

Implementation of​

DialStackInstanceImpl.getClientSecret

logout()​

TypeScript
logout(): Promise<void>;

Defined in: sdk/js/src/core/instance.ts:2407

Log out and clean up

Returns​

Promise<void>

Implementation of​

DialStackInstanceImpl.logout

off()​

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

Defined in: sdk/js/src/core/instance.ts:2168

Unsubscribe from call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler?​

CallEventHandler<CallEventMap[K]>

Returns​

void

Implementation of​

DialStackInstanceImpl.off

on()​

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

Defined in: sdk/js/src/core/instance.ts:2153

Subscribe to call events

Type Parameters​

K​

K extends "call.incoming"

Parameters​

event​

K

handler​

CallEventHandler<CallEventMap[K]>

Returns​

void

Implementation of​

DialStackInstanceImpl.on

removeAppearanceTarget()​

TypeScript
removeAppearanceTarget(element): void;

Defined in: sdk/js/src/core/instance.ts:2130

Unregister a host element previously passed to addAppearanceTarget().

Parameters​

element​

HTMLElement

Returns​

void

Implementation of​

DialStackInstanceImpl.removeAppearanceTarget

resolveRoutingTarget()​

TypeScript
resolveRoutingTarget(target): Promise<
  | {
  extension_number?: string | null;
  id: string;
  name: string | null;
  timeout_seconds?: number | null;
  type: RoutingTargetType;
}
| null>;

Defined in: sdk/js/src/core/instance.ts:1957

Resolve a routing target TypeID to its type, display name, and how long it rings a caller on its own — see timeout_seconds on the return.

Parameters​

target​

string

Returns​

Promise< | { extension_number?: string | null; id: string; name: string | null; timeout_seconds?: number | null; type: RoutingTargetType; } | null>

Implementation of​

DialStackInstanceImpl.resolveRoutingTarget

routingTargets()​

TypeScript
routingTargets(): Promise<RoutingTarget[]>;

Defined in: sdk/js/src/core/instance.ts:2014

List all selectable inbound-routing targets for the current account.

"Routing target" is not a first-class resource — this fans out over the underlying resource lists and merges them into one flat list whose id values are exactly what phoneNumbers.updateRoute accepts. A list that fails (e.g. a resource the session isn't scoped for) is skipped rather than failing the whole aggregation.

Returns​

Promise<RoutingTarget[]>

Implementation of​

DialStackInstanceImpl.routingTargets

startSession()​

TypeScript
startSession(): Promise<void>;

Defined in: sdk/js/src/core/instance.ts:299

Start session management (called by initialize)

Returns​

Promise<void>

update()​

TypeScript
update(updateOptions): void;

Defined in: sdk/js/src/core/instance.ts:2137

Update appearance for all components

Parameters​

updateOptions​

UpdateOptions

Returns​

void

Implementation of​

DialStackInstanceImpl.update

On this page