Skip to main content

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

Interface: Account

Defined in: sdk/server/src/index.ts:170

Properties​

config​

TypeScript
config: AccountConfig;

Defined in: sdk/server/src/index.ts:174


country?​

TypeScript
country?: AccountCountry;

Defined in: sdk/server/src/index.ts:187

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​

TypeScript
created_at: string;

Defined in: sdk/server/src/index.ts:229


customer_approval_required_effective?​

TypeScript
customer_approval_required_effective?: boolean;

Defined in: sdk/server/src/index.ts:228

Whether every hardware order for this account needs the customer's approval before it is placed, with the customer_approval_required override resolved against the platform default.


customer_ordering_effective?​

TypeScript
customer_ordering_effective?: boolean;

Defined in: sdk/server/src/index.ts:222

Whether the account's users may order hardware themselves, with the customer_ordering_enabled override resolved against the platform default.


default_button_template​

TypeScript
default_button_template: string | null;

Defined in: sdk/server/src/index.ts:180

Button template inherited by newly created deskphones and DECT handsets.


email​

TypeScript
email: string | null;

Defined in: sdk/server/src/index.ts:172


hold_music_clip_id​

TypeScript
hold_music_clip_id: string | null;

Defined in: sdk/server/src/index.ts:175


id​

TypeScript
id: string;

Defined in: sdk/server/src/index.ts:171


main_location_id​

TypeScript
main_location_id: string | null;

Defined in: sdk/server/src/index.ts:178


outbound_announcement_clip​

TypeScript
outbound_announcement_clip: string | null;

Defined in: sdk/server/src/index.ts:177

Audio clip played to both parties when an outbound call to an external number is answered.


primary_contact_name​

TypeScript
primary_contact_name: string | null;

Defined in: sdk/server/src/index.ts:173


tos_accepted_at?​

TypeScript
tos_accepted_at?: string | null;

Defined in: sdk/server/src/index.ts:210

When the current agreement was accepted; null unless the account has a valid acceptance. Set both when tos_status is signed and when a previously signed account has been asked to re-sign — pair it with tos_resign_by to tell those apart.


tos_resign_by?​

TypeScript
tos_resign_by?: string | null;

Defined in: sdk/server/src/index.ts:217

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
tos_status?: "signed" | "unsigned" | "not_required";

Defined in: sdk/server/src/index.ts:203

Subscription-agreement (SSA/TOS) coverage status. signed — a live account whose acceptance matches the current agreement version; unsigned — a live account not yet accepted, accepted against a superseded version, or asked to re-sign (see tos_resign_by); not_required — a non-live account, never prompted. Filter the list with tos_status. The full agreement + evidence is on the account tos resource.


tos_variant?​

TypeScript
tos_variant?: TosVariant;

Defined in: sdk/server/src/index.ts:194

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/server/src/index.ts:230