@panoptic-it-solutions/unifi-api-client/dist/types/clients.d.ts

A Node.js client library for the UniFi Controller API

/**
 * Represents a UniFi network client (wired or wireless).
 */
export interface Client {
    _id: string;
    mac: string;
    ip?: string;
    name?: string;
    hostname?: string;
    is_wired?: boolean;
    is_guest?: boolean;
    last_seen?: number;
    device_id?: string;
    site_id?: string;
    [key: string]: unknown;
}
/**
 * Statistics for a UniFi client.
 */
export interface ClientStats {
    _id: string;
    bytes?: number;
    tx_bytes?: number;
    rx_bytes?: number;
    [key: string]: unknown;
}
/**
 * Identifies a client by MAC, IP, or name.
 */
export interface ClientIdentifier {
    mac?: string;
    ip?: string;
    name?: string;
}
/**
 * Pagination options for listing clients.
 */
export interface PaginationOptions {
    start?: number;
    limit?: number;
}
/**
 * Sorting options for listing clients.
 */
export interface SortOptions {
    sortby?: string;
    sortorder?: 'asc' | 'desc';
}
export interface User {
    _id: string;
    name: string;
    email?: string;
    [key: string]: unknown;
}
export interface UserGroup {
    _id: string;
    name: string;
    [key: string]: unknown;
}