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

Interface: DIDConfig

Defined in: sdk/js/src/types/phone-numbers.ts:65

DID-level configuration blob (fax notification recipients today, more sub-keys later). Mirrors lib/models/did.go DIDConfig.

Properties

fax_notifications?

TypeScript

optional fax_notifications?: object;

Defined in: sdk/js/src/types/phone-numbers.ts:66

attach_pdf?

TypeScript

optional attach_pdf?: boolean;

Deprecated, kept only for backwards compatibility. Accepted on input but ignored (not stored, no effect) and always returned as true. Use delete_documents to control document handling.

Deprecated

Use delete_documents instead.

delete_documents?

TypeScript

optional delete_documents?: boolean;

When true, fax documents are not retained on the server (defaults false). Inbound: the received fax is attached to the notification email and the stored copy is removed after sending. Outbound: the uploaded source is deleted once the fax reaches a terminal status (delivered or failed). When false, the email includes a time-bounded link to the received fax and documents are retained.

Requires at least one entry in recipients: enabling this with an empty recipient list is rejected, since a received fax would be neither stored nor delivered.

recipients?

TypeScript

optional recipients?: string[];