@dialstack/sdk-dev / js/src / Account
Interface: Account
Defined in: sdk/js/src/types/account-onboarding.ts:137
Properties
config
config: AccountConfig;
Defined in: sdk/js/src/types/account-onboarding.ts:154
country?
country?: AccountCountry;
Defined in: sdk/js/src/types/account-onboarding.ts:153
Where the account does business: US or CA. Set when the account is
created and never changed. The account's locations must be in this country,
and it decides how dialed numbers are read, including which are emergency
numbers.
created_at
created_at: string;
Defined in: sdk/js/src/types/account-onboarding.ts:194
customer_ordering_effective?
customer_ordering_effective?: boolean;
Defined in: sdk/js/src/types/account-onboarding.ts:183
Whether the account's users may order hardware themselves, with the
customer_ordering_enabled override resolved against the platform default.
default_button_template
default_button_template: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:193
Button template inherited by newly created deskphones and DECT handsets.
email?
email?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:140
hold_music_clip?
hold_music_clip?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:184
hold_music_clip_id?
hold_music_clip_id?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:186
Deprecated
Use hold_music_clip. Retained for backwards compatibility.
id
id: string;
Defined in: sdk/js/src/types/account-onboarding.ts:138
main_location?
main_location?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:189
main_location_id?
main_location_id?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:191
Deprecated
Use main_location. Retained for backwards compatibility.
name?
name?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:139
onboarding_complete
onboarding_complete: boolean;
Defined in: sdk/js/src/types/account-onboarding.ts:156
True when the account has completed every onboarding step.
outbound_announcement_clip?
outbound_announcement_clip?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:188
Audio clip played to both parties when an outbound call to an external number is answered.
phone?
phone?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:145
Deprecated
No longer collected during onboarding or required for it. Removed in the next major.
primary_contact_name?
primary_contact_name?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:146
tos_resign_by?
tos_resign_by?: string | null;
Defined in: sdk/js/src/types/account-onboarding.ts:178
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?
tos_status?: "signed" | "unsigned" | "not_required";
Defined in: sdk/js/src/types/account-onboarding.ts:171
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?
tos_variant?: TosVariant;
Defined in: sdk/js/src/types/account-onboarding.ts:163
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
updated_at: string;
Defined in: sdk/js/src/types/account-onboarding.ts:195