fleeta-api-lib/dist/lib/device/api.d.ts

A comprehensive library for fleet management applications - API, Auth, Device management

/**
 * BlackVue Fleeta Device List API Functions
 * Handles device management and listing functionality
 */
import type { DeviceListParams, DeviceListResponse, DeviceStatusParams, DeviceStatusResponse, DeviceRegistrationInfo } from './types';
/**
 * Get device list from BlackVue Fleeta Cloud
 * Retrieves list of registered devices and groups
 *
 * @param params - Request parameters (optional - uses auth config if not provided)
 * @returns Promise with device list response
 */
export declare function getDeviceList(params?: Partial<DeviceListParams>): Promise<DeviceListResponse>;
/**
 * Check device registration status
 * Checks if device is already registered before cloud registration
 *
 * @param params - Device status check parameters
 * @returns Promise with device registration status
 */
export declare function getDeviceStatus(params: DeviceStatusParams): Promise<DeviceStatusResponse>;
/**
 * Check if device is available for cloud registration
 * Convenience function that interprets device status response
 *
 * @param psn - Device PSN to check
 * @returns Promise with boolean indicating if device is available for registration
 */
export declare function isDeviceAvailableForRegistration(psn: string): Promise<{
    available: boolean;
    reason?: string;
    deviceInfo?: DeviceRegistrationInfo;
}>;
/**
 * Check if device API is ready (authentication configured)
 * @returns True if authentication is configured
 */
export declare function isDeviceApiReady(): boolean;
//# sourceMappingURL=api.d.ts.map