Skip to main content

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

Interface: Account

Defined in: sdk/js/src/types/account-onboarding.ts:114

Properties​

config​

TypeScript
config: AccountConfig;

Defined in: sdk/js/src/types/account-onboarding.ts:120

created_at​

TypeScript
created_at: string;

Defined in: sdk/js/src/types/account-onboarding.ts:153

default_button_template​

TypeScript
default_button_template: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:152

Button template inherited by newly created deskphones and DECT handsets.

email?​

TypeScript
optional email?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:117

hold_music_clip?​

TypeScript
optional hold_music_clip?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:145

hold_music_clip_id?​

TypeScript
optional hold_music_clip_id?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:147

Deprecated​

Use hold_music_clip. Retained for backwards compatibility.

id​

TypeScript
id: string;

Defined in: sdk/js/src/types/account-onboarding.ts:115

main_location?​

TypeScript
optional main_location?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:148

main_location_id?​

TypeScript
optional main_location_id?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:150

Deprecated​

Use main_location. Retained for backwards compatibility.

name?​

TypeScript
optional name?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:116

onboarding_complete​

TypeScript
onboarding_complete: boolean;

Defined in: sdk/js/src/types/account-onboarding.ts:122

True when the account has completed every onboarding step.

phone?​

TypeScript
optional phone?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:118

primary_contact_name?​

TypeScript
optional primary_contact_name?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:119

tos_resign_by?​

TypeScript
optional tos_resign_by?: string | null;

Defined in: sdk/js/src/types/account-onboarding.ts:144

When a re-signature has been requested, the deadline for it; otherwise null. While set, the account keeps full service and tos_status reads unsigned so the agreement is presented again. Past the deadline the account is treated as unsigned outright.

tos_status?​

TypeScript
optional tos_status?: "signed" | "unsigned" | "not_required";

Defined in: sdk/js/src/types/account-onboarding.ts:137

Subscription-agreement coverage. not_required — a non-live (sandbox/demo) account, never prompted to accept. unsigned — acceptance is owed (none recorded, the recorded one is for a superseded version, or a re-signature has been requested — see tos_resign_by). signed — the current agreement is accepted with nothing outstanding.

tos_variant?​

TypeScript
optional tos_variant?: TosVariant;

Defined in: sdk/js/src/types/account-onboarding.ts:129

Which Service Subscription Agreement this account must sign. standard is the ordinary agreement; hipaa is the healthcare agreement incorporating the Business Associate Agreement, for customers handling protected health information.

updated_at​

TypeScript
updated_at: string;

Defined in: sdk/js/src/types/account-onboarding.ts:154

On this page