cloudflare/resources/zero-trust/dex/fleet-status/devices.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as DevicesAPI from 'cloudflare/resources/zero-trust/dex/fleet-status/devices';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class Devices extends APIResource {
    /**
     * List details for devices using WARP
     */
    list(params: DeviceListParams, options?: Core.RequestOptions): Core.PagePromise<DeviceListResponsesV4PagePaginationArray, DeviceListResponse>;
}
export declare class DeviceListResponsesV4PagePaginationArray extends V4PagePaginationArray<DeviceListResponse> {
}
export interface DeviceListResponse {
    /**
     * Cloudflare colo
     */
    colo: string;
    /**
     * Device identifier (UUID v4)
     */
    deviceId: string;
    mode: unknown;
    /**
     * Operating system
     */
    platform: string;
    /**
     * Network status
     */
    status: string;
    timestamp: unknown;
    /**
     * WARP client version
     */
    version: string;
    /**
     * Device identifier (human readable)
     */
    deviceName?: string;
    /**
     * User contact email address
     */
    personEmail?: string;
}
export interface DeviceListParams extends V4PagePaginationArrayParams {
    /**
     * Path param:
     */
    account_id: string;
    /**
     * Query param: Timestamp in ISO format
     */
    time_end: string;
    /**
     * Query param: Timestamp in ISO format
     */
    time_start: string;
    /**
     * Query param: Cloudflare colo
     */
    colo?: string;
    /**
     * Query param: Device-specific ID, given as UUID v4
     */
    device_id?: string;
    /**
     * Query param: The mode under which the WARP client is run
     */
    mode?: string;
    /**
     * Query param: Operating system
     */
    platform?: string;
    /**
     * Query param: Dimension to sort results by
     */
    sort_by?: 'colo' | 'device_id' | 'mode' | 'platform' | 'status' | 'timestamp' | 'version';
    /**
     * Query param: Network status
     */
    status?: string;
    /**
     * Query param: WARP client version
     */
    version?: string;
}
export declare namespace Devices {
    export import DeviceListResponse = DevicesAPI.DeviceListResponse;
    export import DeviceListResponsesV4PagePaginationArray = DevicesAPI.DeviceListResponsesV4PagePaginationArray;
    export import DeviceListParams = DevicesAPI.DeviceListParams;
}
//# sourceMappingURL=devices.d.ts.map