crossbar-client 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,959 @@
+interface CredentialsAuth {
+    type: "credentials";
+    credentials: string;
+    accountName?: string;
+    accountId?: string;
+}
+interface ApiKeyAuth {
+    type: "api_key";
+    apiKey: string;
+}
+interface TokenAuth {
+    type: "token";
+    token: string;
+}
+type AuthConfig = CredentialsAuth | ApiKeyAuth | TokenAuth;
+interface RetryConfig {
+    /** Number of times to retry on 5xx server errors. Default: 1 */
+    maxRetries?: number;
+    /** Re-authenticate and retry once on 401 Unauthorized. Requires credentials or api_key auth. Default: true */
+    reAuthOn401?: boolean;
+    /** Delay in ms between retries. Default: 0 */
+    retryDelay?: number;
+}
+interface CrossbarConfig {
+    url: string;
+    version?: string;
+    headers?: Record<string, string>;
+    auth?: AuthConfig;
+    timeout?: number;
+    retry?: RetryConfig;
+}
+interface RequestOptions {
+    headers?: Record<string, string>;
+    query?: Record<string, string | number | boolean | undefined>;
+    timeout?: number;
+    signal?: AbortSignal;
+}
+interface CrossbarResponse<T = unknown> {
+    data: T;
+    auth_token?: string;
+    status: string;
+    request_id: string;
+    page_size?: number;
+    next_start_key?: string;
+    start_key?: string;
+}
+interface ListOptions extends RequestOptions {
+    paginate?: boolean;
+}
+declare function mergePaginate(options?: ListOptions): RequestOptions | undefined;
+interface CrossbarHttpClient {
+    get<T = unknown>(path: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    put<T = unknown>(path: string, data?: unknown, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    post<T = unknown>(path: string, data?: unknown, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch<T = unknown>(path: string, data?: unknown, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    delete<T = unknown>(path: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+interface CallerIdEntry {
+    name?: string;
+    number?: string;
+}
+interface CallerId {
+    internal?: CallerIdEntry;
+    external?: CallerIdEntry;
+    emergency?: CallerIdEntry;
+    asserted?: CallerIdEntry & {
+        realm?: string;
+    };
+}
+interface CallerIdOptions {
+    outbound_privacy?: "full" | "name" | "number" | "none";
+    show_rate?: boolean;
+}
+interface CallRestrictionEntry {
+    action?: "inherit" | "deny";
+}
+interface CallRecordingEndpoint {
+    enabled?: boolean;
+    format?: "mp3" | "wav";
+    url?: string;
+    time_limit?: number;
+    record_on_answer?: boolean;
+    record_on_bridge?: boolean;
+    record_sample_rate?: number;
+}
+interface CallRecordingDirection {
+    onnet?: CallRecordingEndpoint;
+    offnet?: CallRecordingEndpoint;
+    any?: CallRecordingEndpoint;
+}
+interface CallRecording {
+    account?: CallRecordingDirection;
+    endpoint?: CallRecordingDirection;
+}
+interface Notifications {
+    first_occurrence?: {
+        sent_initial_call?: boolean;
+        sent_initial_registration?: boolean;
+    };
+    low_balance?: {
+        enabled?: boolean;
+        last_notification?: number;
+        sent_low_balance?: boolean;
+        threshold?: number;
+    };
+}
+interface Account {
+    id?: string;
+    name: string;
+    enabled?: boolean;
+    realm?: string;
+    language?: string;
+    timezone?: string;
+    org?: string;
+    caller_id?: CallerId;
+    caller_id_options?: CallerIdOptions;
+    call_recording?: CallRecording;
+    call_restriction?: Record<string, CallRestrictionEntry>;
+    call_waiting?: {
+        enabled?: boolean;
+    };
+    dial_plan?: Record<string, unknown>;
+    do_not_disturb?: {
+        enabled?: boolean;
+    };
+    flags?: string[];
+    formatters?: Record<string, unknown>;
+    metaflows?: Record<string, unknown>;
+    music_on_hold?: {
+        media_id?: string;
+    };
+    notifications?: Notifications;
+    preflow?: {
+        always?: string;
+    };
+    ringtones?: {
+        internal?: string;
+        external?: string;
+    };
+    topup?: {
+        threshold?: number;
+    };
+    voicemail?: {
+        notify?: {
+            callback?: Record<string, unknown>;
+        };
+    };
+    zones?: Record<string, unknown>;
+}
+interface AccountSummary {
+    id: string;
+    name: string;
+    realm?: string;
+}
+interface CallForward {
+    enabled?: boolean;
+    number?: string;
+    require_keypress?: boolean;
+    keep_caller_id?: boolean;
+    direct_calls_only?: boolean;
+    failover?: boolean;
+    ignore_early_media?: boolean;
+    substitute?: boolean;
+}
+type DeviceType = "sip_device" | "cellphone" | "softphone" | "fax" | "sip_uri" | "smartphone";
+interface SipCredentials {
+    username?: string;
+    password?: string;
+    realm?: string;
+    method?: string;
+    invite_format?: string;
+    route?: string;
+    ip?: string;
+    custom_sip_headers?: Record<string, string>;
+    registration_expiration?: number;
+}
+interface User {
+    id?: string;
+    username: string;
+    first_name?: string;
+    last_name?: string;
+    email?: string;
+    enabled?: boolean;
+    priv_level?: "admin" | "user";
+    caller_id?: CallerId;
+    presence_id?: string;
+    call_forward?: CallForward;
+    hotdesk?: {
+        enabled?: boolean;
+        id?: string;
+        require_pin?: boolean;
+        pin?: string;
+        keep_logged_in_elsewhere?: boolean;
+    };
+    directories?: Record<string, unknown>;
+    vm_to_email_enabled?: boolean;
+    verified?: boolean;
+    timezone?: string;
+    language?: string;
+    do_not_disturb?: {
+        enabled?: boolean;
+    };
+    call_restriction?: Record<string, CallRestrictionEntry>;
+    call_recording?: CallRecording;
+    music_on_hold?: {
+        media_id?: string;
+    };
+    ringtones?: {
+        internal?: string;
+        external?: string;
+    };
+}
+interface Device {
+    id?: string;
+    name: string;
+    device_type?: DeviceType;
+    enabled?: boolean;
+    owner_id?: string;
+    sip?: SipCredentials;
+    caller_id?: CallerId;
+    call_forward?: CallForward;
+    media?: {
+        bypass_media?: boolean | "auto";
+        ignore_early_media?: boolean;
+        progress_timeout?: number;
+        audio?: {
+            codecs?: string[];
+        };
+        video?: {
+            codecs?: string[];
+        };
+        fax?: {
+            option?: string;
+        };
+        encryption?: {
+            enforce_security?: boolean;
+            methods?: string[];
+        };
+    };
+    ringtones?: {
+        internal?: string;
+        external?: string;
+    };
+    mac_address?: string;
+    provision?: {
+        endpoint_brand?: string;
+        endpoint_family?: string;
+        endpoint_model?: string;
+        id?: string;
+    };
+    do_not_disturb?: {
+        enabled?: boolean;
+    };
+    call_restriction?: Record<string, CallRestrictionEntry>;
+    music_on_hold?: {
+        media_id?: string;
+    };
+}
+interface DeviceStatus {
+    device_id: string;
+    registered: boolean;
+}
+interface CallflowAction {
+    module: string;
+    data?: Record<string, unknown>;
+    children?: Record<string, CallflowAction>;
+}
+interface Callflow {
+    id?: string;
+    name?: string;
+    numbers?: string[];
+    patterns?: string[];
+    flow?: CallflowAction;
+    featurecode?: {
+        name?: string;
+        number?: string;
+    };
+    type?: string;
+    owner_id?: string;
+}
+interface VoicemailBox {
+    id?: string;
+    name: string;
+    mailbox: string;
+    owner_id?: string;
+    pin?: string;
+    require_pin?: boolean;
+    check_if_owner?: boolean;
+    skip_greeting?: boolean;
+    skip_instructions?: boolean;
+    is_setup?: boolean;
+    timezone?: string;
+    media?: {
+        unavailable?: string;
+        temporary?: string;
+    };
+    notify?: {
+        callback?: Record<string, unknown>;
+    };
+    notify_email_addresses?: string[];
+    delete_after_notify?: boolean;
+    oldest_message_first?: boolean;
+    max_message_count?: number;
+    max_message_length?: number;
+    min_message_size?: number;
+}
+interface VoicemailMessage {
+    media_id: string;
+    message_id: string;
+    from: string;
+    to: string;
+    caller_id_name?: string;
+    caller_id_number?: string;
+    folder: "new" | "saved" | "deleted";
+    timestamp: number;
+    length?: number;
+}
+type PhoneNumberState = "discovery" | "available" | "reserved" | "in_service" | "released" | "disconnected" | "deleted" | "port_in" | "port_out";
+interface PhoneNumber {
+    id?: string;
+    state?: PhoneNumberState;
+    features?: string[];
+    used_by?: string;
+    assigned_to?: string;
+    created?: number;
+    updated?: number;
+    cnam?: {
+        inbound?: {
+            display_name?: string;
+        };
+        outbound?: {
+            display_name?: string;
+        };
+    };
+    e911?: {
+        street_address?: string;
+        extended_address?: string;
+        locality?: string;
+        region?: string;
+        postal_code?: string;
+        plus_four?: string;
+        caller_name?: string;
+        notification_contact_emails?: string[];
+    };
+    failover?: {
+        e164?: string;
+        sip?: string;
+    };
+    prepend?: {
+        enabled?: boolean;
+        name?: string;
+        number?: string;
+    };
+}
+interface Conference {
+    id?: string;
+    name: string;
+    owner_id?: string;
+    member?: {
+        pins?: string[];
+        numbers?: string[];
+        join_muted?: boolean;
+        join_deaf?: boolean;
+    };
+    moderator?: {
+        pins?: string[];
+        numbers?: string[];
+        join_muted?: boolean;
+        join_deaf?: boolean;
+    };
+    play_entry_tone?: boolean;
+    play_exit_tone?: boolean;
+    play_name?: boolean;
+    max_participants?: number;
+    max_members_media?: string;
+    caller_id?: CallerId;
+    profile?: Record<string, unknown>;
+    conference_numbers?: string[];
+}
+interface ConferenceParticipant {
+    call_id: string;
+    participant_id: number;
+    caller_id_name?: string;
+    caller_id_number?: string;
+    join_time?: number;
+    duration?: number;
+    is_moderator?: boolean;
+    muted?: boolean;
+    deaf?: boolean;
+}
+interface Media {
+    id?: string;
+    name: string;
+    description?: string;
+    language?: string;
+    media_source?: "recording" | "upload" | "tts";
+    source_type?: string;
+    source_id?: string;
+    streamable?: boolean;
+    content_type?: string;
+    content_length?: number;
+    tts?: {
+        text?: string;
+        voice?: string;
+    };
+}
+interface Menu {
+    id?: string;
+    name: string;
+    retries?: number;
+    timeout?: string;
+    max_extension_length?: number;
+    media?: {
+        greeting?: string;
+        invalid_media?: string;
+        exit_media?: string;
+        transfer_media?: string;
+    };
+    hunt?: boolean;
+    hunt_allow?: string;
+    hunt_deny?: string;
+    record_pin?: string;
+    suppress_media?: boolean;
+}
+interface TemporalRule {
+    id?: string;
+    name: string;
+    cycle?: "date" | "weekly" | "monthly" | "yearly";
+    start_date?: number;
+    end_date?: number;
+    time_window_start?: number;
+    time_window_stop?: number;
+    wdays?: Array<"monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday">;
+    days?: number[];
+    interval?: number;
+    month?: number;
+    ordinal?: "first" | "second" | "third" | "fourth" | "fifth" | "last" | "every";
+    timezone?: string;
+    enabled?: boolean;
+}
+interface Webhook {
+    id?: string;
+    name: string;
+    uri: string;
+    http_verb?: "get" | "post";
+    hook?: string;
+    retries?: number;
+    custom_data?: Record<string, string>;
+    include_internal_legs?: boolean;
+    include_subaccounts?: boolean;
+    enabled?: boolean;
+}
+interface Channel {
+    uuid: string;
+    call_id?: string;
+    answered?: boolean;
+    authorizing_id?: string;
+    authorizing_type?: string;
+    destination?: string;
+    direction?: "inbound" | "outbound";
+    other_leg?: string;
+    owner_id?: string;
+    presence_id?: string;
+    timestamp?: number;
+    username?: string;
+    node?: string;
+}
+interface Fax {
+    id?: string;
+    from_name?: string;
+    from_number?: string;
+    to_name?: string;
+    to_number?: string;
+    status?: string;
+    pages?: number;
+    fax_result_code?: string;
+    fax_result_text?: string;
+    fax_bad_rows?: number;
+    fax_transfer_rate?: number;
+    fax_timezone?: string;
+    timestamp?: number;
+    media_type?: string;
+    rx_result?: string;
+    tx_result?: string;
+    folder?: "inbox" | "outbox" | "sent" | "failed";
+}
+interface Cdr {
+    id?: string;
+    call_id?: string;
+    caller_id_name?: string;
+    caller_id_number?: string;
+    callee_id_name?: string;
+    callee_id_number?: string;
+    from?: string;
+    to?: string;
+    request?: string;
+    call_direction?: "inbound" | "outbound";
+    duration_seconds?: number;
+    billing_seconds?: number;
+    ringing_seconds?: number;
+    hangup_cause?: string;
+    hangup_code?: string;
+    disposition?: string;
+    timestamp?: number;
+    datetime?: string;
+    account_id?: string;
+    owner_id?: string;
+    authorizing_id?: string;
+    authorizing_type?: string;
+    interaction_id?: string;
+    custom_channel_vars?: Record<string, unknown>;
+    custom_sip_headers?: Record<string, string>;
+    media_recordings?: string[];
+}
+interface TokenInfo {
+    account_id: string;
+    account_name: string;
+    owner_id?: string;
+    reseller_id?: string;
+    is_reseller?: boolean;
+    language?: string;
+    method?: string;
+    id?: string;
+    apps?: Array<{
+        id: string;
+        name: string;
+        api_url?: string;
+        label?: string;
+    }>;
+}
+
+declare class AccountsResource<T extends Account = Account> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    get(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(parentAccountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    children<S extends AccountSummary = AccountSummary>(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<S[]>>;
+    descendants<S extends AccountSummary = AccountSummary>(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<S[]>>;
+    siblings<S extends AccountSummary = AccountSummary>(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<S[]>>;
+    parents(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<string[]>>;
+    tree(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<string[]>>;
+    getApiKey(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<{
+        api_key: string;
+    }>>;
+    regenerateApiKey(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<{
+        api_key: string;
+    }>>;
+    move(accountId: string, toAccountId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    promoteReseller(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    demoteReseller(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class CallflowsResource<T extends Callflow = Callflow> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, callflowId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, callflowId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, callflowId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, callflowId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+interface CdrListOptions extends ListOptions {
+    created_from?: number;
+    created_to?: number;
+}
+declare class CdrsResource<T extends Cdr = Cdr> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: CdrListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, cdrId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    listByUser(accountId: string, userId: string, options?: CdrListOptions): Promise<CrossbarResponse<T[]>>;
+}
+
+declare class ChannelsResource {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<Channel[]>>;
+    get(accountId: string, callId: string, options?: RequestOptions): Promise<CrossbarResponse<Channel>>;
+    hangup(accountId: string, callId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class ConferencesResource<T extends Conference = Conference> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, conferenceId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, conferenceId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, conferenceId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, conferenceId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    participants(accountId: string, conferenceId: string, options?: RequestOptions): Promise<CrossbarResponse<ConferenceParticipant[]>>;
+    muteParticipant(accountId: string, conferenceId: string, participantId: number, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    unmuteParticipant(accountId: string, conferenceId: string, participantId: number, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    deafParticipant(accountId: string, conferenceId: string, participantId: number, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    undeafParticipant(accountId: string, conferenceId: string, participantId: number, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    kickParticipant(accountId: string, conferenceId: string, participantId: number, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class DevicesResource<T extends Device = Device> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, deviceId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, deviceId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, deviceId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, deviceId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    status(accountId: string, options?: RequestOptions): Promise<CrossbarResponse<DeviceStatus[]>>;
+}
+
+declare class FaxesResource<T extends Fax = Fax> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    listInbox(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    listOutbox(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    getInbox(accountId: string, faxId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    getOutbox(accountId: string, faxId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    send(accountId: string, data: {
+        to_number: string;
+        from_number?: string;
+        document_url?: string;
+    }, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    removeInbox(accountId: string, faxId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+    removeOutbox(accountId: string, faxId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class MediaResource<T extends Media = Media> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, mediaId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, mediaId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, mediaId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, mediaId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+declare class MenusResource<T extends Menu = Menu> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, menuId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, menuId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, menuId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, menuId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+declare class PhoneNumbersResource<T extends PhoneNumber = PhoneNumber> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, number: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, number: string, data?: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, number: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, number: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, number: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    activate(accountId: string, number: string, data?: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    reserve(accountId: string, number: string, data?: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    portIn(accountId: string, number: string, data?: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+declare class TemporalRulesResource<T extends TemporalRule = TemporalRule> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, ruleId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, ruleId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, ruleId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, ruleId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+declare class TokenResource<T extends TokenInfo = TokenInfo> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    info(options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    invalidate(options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class UsersResource<T extends User = User> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, userId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "username">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, userId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, userId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, userId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+declare class VoicemailsResource<T extends VoicemailBox = VoicemailBox> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, vmboxId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name" | "mailbox">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, vmboxId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, vmboxId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, vmboxId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    messages(accountId: string, vmboxId: string, options?: RequestOptions): Promise<CrossbarResponse<VoicemailMessage[]>>;
+    getMessage(accountId: string, vmboxId: string, messageId: string, options?: RequestOptions): Promise<CrossbarResponse<VoicemailMessage>>;
+    updateMessage(accountId: string, vmboxId: string, messageId: string, data: {
+        folder: "new" | "saved" | "deleted";
+    }, options?: RequestOptions): Promise<CrossbarResponse<VoicemailMessage>>;
+    deleteMessage(accountId: string, vmboxId: string, messageId: string, options?: RequestOptions): Promise<CrossbarResponse<unknown>>;
+}
+
+declare class WebhooksResource<T extends Webhook = Webhook> {
+    private readonly client;
+    constructor(client: CrossbarHttpClient);
+    list(accountId: string, options?: ListOptions): Promise<CrossbarResponse<T[]>>;
+    get(accountId: string, webhookId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    create(accountId: string, data: Partial<T> & Pick<T, "name" | "uri">, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    update(accountId: string, webhookId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    patch(accountId: string, webhookId: string, data: Partial<T>, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+    remove(accountId: string, webhookId: string, options?: RequestOptions): Promise<CrossbarResponse<T>>;
+}
+
+interface CrossbarTypes {
+    account: Account;
+    tokenInfo: TokenInfo;
+    user: User;
+    device: Device;
+    callflow: Callflow;
+    voicemailBox: VoicemailBox;
+    phoneNumber: PhoneNumber;
+    cdr: Cdr;
+    conference: Conference;
+    fax: Fax;
+    media: Media;
+    menu: Menu;
+    temporalRule: TemporalRule;
+    webhook: Webhook;
+}
+type WithCrossbarTypes<T extends Partial<CrossbarTypes>> = Omit<CrossbarTypes, keyof T> & T;
+declare class CrossbarClient<T extends CrossbarTypes = CrossbarTypes> {
+    private readonly baseUrl;
+    private readonly version;
+    private readonly defaultHeaders;
+    private readonly defaultTimeout;
+    private readonly retryConfig;
+    private authConfig;
+    private authToken;
+    private readonly _http;
+    private _accounts;
+    private _tokenAuth;
+    private _users;
+    private _devices;
+    private _callflows;
+    private _voicemails;
+    private _phoneNumbers;
+    private _cdrs;
+    private _channels;
+    private _conferences;
+    private _faxes;
+    private _media;
+    private _menus;
+    private _temporalRules;
+    private _webhooks;
+    constructor(config: CrossbarConfig);
+    get http(): CrossbarHttpClient;
+    get accounts(): AccountsResource<T["account"]>;
+    get tokenAuth(): TokenResource<T["tokenInfo"]>;
+    get users(): UsersResource<T["user"]>;
+    get devices(): DevicesResource<T["device"]>;
+    get callflows(): CallflowsResource<T["callflow"]>;
+    get voicemails(): VoicemailsResource<T["voicemailBox"]>;
+    get phoneNumbers(): PhoneNumbersResource<T["phoneNumber"]>;
+    get cdrs(): CdrsResource<T["cdr"]>;
+    get channels(): ChannelsResource;
+    get conferences(): ConferencesResource<T["conference"]>;
+    get faxes(): FaxesResource<T["fax"]>;
+    get media(): MediaResource<T["media"]>;
+    get menus(): MenusResource<T["menu"]>;
+    get temporalRules(): TemporalRulesResource<T["temporalRule"]>;
+    get webhooks(): WebhooksResource<T["webhook"]>;
+    get token(): string | undefined;
+    set token(value: string | undefined);
+    authenticate<T = unknown>(): Promise<CrossbarResponse<T>>;
+    private request;
+    private canReAuth;
+    private executeRequest;
+    private buildUrl;
+    private buildHeaders;
+}
+
+declare class CrossbarError extends Error {
+    message: string;
+    status: number;
+    requestId?: string | undefined;
+    body?: unknown | undefined;
+    constructor(message: string, status: number, requestId?: string | undefined, body?: unknown | undefined);
+}
+declare class CrossbarAuthError extends CrossbarError {
+    constructor(message: string, requestId?: string, body?: unknown);
+}
+
+/** Fields present on every webhook event payload Kazoo delivers to your endpoint. */
+interface WebhookEventBase {
+    hook_event: string;
+    event_name: string;
+    event_category: string;
+    account_id: string;
+    account_name?: string;
+    /** Gregorian timestamp (seconds since year 0). */
+    timestamp: number;
+    /** Values from the webhook's `custom_data` configuration. */
+    custom_data?: Record<string, string>;
+    version?: string;
+}
+interface WebhookChannelBase extends WebhookEventBase {
+    call_id: string;
+    call_direction: "inbound" | "outbound";
+    caller_id_name?: string;
+    caller_id_number?: string;
+    callee_id_name?: string;
+    callee_id_number?: string;
+    from?: string;
+    to?: string;
+    request?: string;
+    owner_id?: string;
+    authorizing_id?: string;
+    authorizing_type?: string;
+}
+interface WebhookChannelCreateEvent extends WebhookChannelBase {
+    hook_event: "channel_create";
+}
+interface WebhookChannelAnswerEvent extends WebhookChannelBase {
+    hook_event: "channel_answer";
+}
+interface WebhookChannelBridgeEvent extends WebhookChannelBase {
+    hook_event: "channel_bridge";
+    other_leg_call_id?: string;
+}
+interface WebhookChannelDestroyEvent extends WebhookChannelBase {
+    hook_event: "channel_destroy";
+    other_leg_call_id?: string;
+    hangup_cause?: string;
+    hangup_code?: string;
+    duration_seconds?: number;
+    billing_seconds?: number;
+    ringing_seconds?: number;
+    disposition?: string;
+}
+/** Union of all channel/call webhook events. */
+type WebhookChannelEvent = WebhookChannelCreateEvent | WebhookChannelAnswerEvent | WebhookChannelBridgeEvent | WebhookChannelDestroyEvent;
+interface WebhookVoicemailBase extends WebhookEventBase {
+    voicemail_box_id: string;
+    voicemail_id: string;
+    call_id?: string;
+    caller_id_name?: string;
+    caller_id_number?: string;
+    from?: string;
+    to?: string;
+    owner_id?: string;
+    /** Message duration in seconds. */
+    length?: number;
+}
+interface WebhookVoicemailNewEvent extends WebhookVoicemailBase {
+    hook_event: "voicemail_new";
+}
+interface WebhookVoicemailSavedEvent extends WebhookVoicemailBase {
+    hook_event: "voicemail_saved";
+}
+interface WebhookVoicemailDeletedEvent extends WebhookVoicemailBase {
+    hook_event: "voicemail_deleted";
+}
+/** Union of all voicemail webhook events. */
+type WebhookVoicemailEvent = WebhookVoicemailNewEvent | WebhookVoicemailSavedEvent | WebhookVoicemailDeletedEvent;
+interface WebhookFaxBase extends WebhookEventBase {
+    fax_id?: string;
+    fax_success?: boolean;
+    fax_result_code?: string;
+    fax_result_text?: string;
+    fax_bad_rows?: number;
+    fax_transfer_rate?: number;
+    fax_ecm_used?: boolean;
+    fax_t38_used?: boolean;
+    pages?: number;
+    from?: string;
+    to?: string;
+    owner_id?: string;
+}
+interface WebhookInboundFaxEvent extends WebhookFaxBase {
+    hook_event: "inbound_fax";
+}
+interface WebhookOutboundFaxEvent extends WebhookFaxBase {
+    hook_event: "outbound_fax";
+}
+interface WebhookInboundFaxErrorEvent extends WebhookFaxBase {
+    hook_event: "inbound_fax_error";
+}
+interface WebhookOutboundFaxErrorEvent extends WebhookFaxBase {
+    hook_event: "outbound_fax_error";
+}
+/** Union of all fax webhook events. */
+type WebhookFaxEvent = WebhookInboundFaxEvent | WebhookOutboundFaxEvent | WebhookInboundFaxErrorEvent | WebhookOutboundFaxErrorEvent;
+interface WebhookDocumentBase extends WebhookEventBase {
+    /** ID of the created/edited/deleted document. */
+    object_id: string;
+    /** Kazoo document type, e.g. `"device"`, `"user"`, `"callflow"`. */
+    object_type: string;
+}
+interface WebhookDocCreatedEvent extends WebhookDocumentBase {
+    hook_event: "doc_created";
+}
+interface WebhookDocEditedEvent extends WebhookDocumentBase {
+    hook_event: "doc_edited";
+}
+interface WebhookDocDeletedEvent extends WebhookDocumentBase {
+    hook_event: "doc_deleted";
+}
+/** Union of all document CRUD webhook events. */
+type WebhookDocumentEvent = WebhookDocCreatedEvent | WebhookDocEditedEvent | WebhookDocDeletedEvent;
+interface WebhookRegistrationBase extends WebhookEventBase {
+    username: string;
+    realm: string;
+    owner_id?: string;
+    authorizing_id?: string;
+    from_user?: string;
+    from_host?: string;
+    to_user?: string;
+    to_host?: string;
+    user_agent?: string;
+    contact?: string;
+    presence_id?: string;
+    network_address?: string;
+    network_port?: string;
+    /** Registration TTL in seconds. */
+    expires?: number;
+}
+interface WebhookRegisterEvent extends WebhookRegistrationBase {
+    hook_event: "register";
+}
+interface WebhookDeregisterEvent extends WebhookRegistrationBase {
+    hook_event: "deregister";
+}
+/** Union of all registration webhook events. */
+type WebhookRegistrationEvent = WebhookRegisterEvent | WebhookDeregisterEvent;
+/**
+ * Discriminated union of all Kazoo webhook event payloads, narrowed via `hook_event`.
+ *
+ * @example
+ * function handleEvent(event: WebhookEvent) {
+ *   if (event.hook_event === "channel_destroy") {
+ *     console.log(event.hangup_cause); // typed
+ *   }
+ * }
+ */
+type WebhookEvent = WebhookChannelEvent | WebhookVoicemailEvent | WebhookFaxEvent | WebhookDocumentEvent | WebhookRegistrationEvent;
+
+export { type Account, type AccountSummary, AccountsResource, type ApiKeyAuth, type AuthConfig, type CallForward, type CallRecording, type CallRecordingDirection, type CallRecordingEndpoint, type CallRestrictionEntry, type CallerId, type CallerIdEntry, type CallerIdOptions, type Callflow, type CallflowAction, CallflowsResource, type Cdr, type CdrListOptions, CdrsResource, type Channel, ChannelsResource, type Conference, type ConferenceParticipant, ConferencesResource, type CredentialsAuth, CrossbarAuthError, CrossbarClient, type CrossbarConfig, CrossbarError, type CrossbarHttpClient, type CrossbarResponse, type CrossbarTypes, type Device, type DeviceStatus, type DeviceType, DevicesResource, type Fax, FaxesResource, type ListOptions, type Media, MediaResource, type Menu, MenusResource, type Notifications, type PhoneNumber, type PhoneNumberState, PhoneNumbersResource, type RequestOptions, type RetryConfig, type SipCredentials, type TemporalRule, TemporalRulesResource, type TokenAuth, type TokenInfo, TokenResource, type User, UsersResource, type VoicemailBox, type VoicemailMessage, VoicemailsResource, type Webhook, type WebhookChannelAnswerEvent, type WebhookChannelBridgeEvent, type WebhookChannelCreateEvent, type WebhookChannelDestroyEvent, type WebhookChannelEvent, type WebhookDeregisterEvent, type WebhookDocCreatedEvent, type WebhookDocDeletedEvent, type WebhookDocEditedEvent, type WebhookDocumentEvent, type WebhookEvent, type WebhookEventBase, type WebhookFaxEvent, type WebhookInboundFaxErrorEvent, type WebhookInboundFaxEvent, type WebhookOutboundFaxErrorEvent, type WebhookOutboundFaxEvent, type WebhookRegisterEvent, type WebhookRegistrationEvent, type WebhookVoicemailDeletedEvent, type WebhookVoicemailEvent, type WebhookVoicemailNewEvent, type WebhookVoicemailSavedEvent, WebhooksResource, type WithCrossbarTypes, mergePaginate };