cloudflare/src/resources/zero-trust/dex/commands/devices.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../../resource';
import * as Core from '../../../../core';
import { V4PagePagination, type V4PagePaginationParams } from '../../../../pagination';

export class Devices extends APIResource {
  /**
   * List devices with WARP client support for remote captures which have been
   * connected in the last 1 hour.
   */
  list(
    params: DeviceListParams,
    options?: Core.RequestOptions,
  ): Core.PagePromise<DeviceListResponsesV4PagePagination, DeviceListResponse> {
    const { account_id, ...query } = params;
    return this._client.getAPIList(
      `/accounts/${account_id}/dex/commands/devices`,
      DeviceListResponsesV4PagePagination,
      { query, ...options },
    );
  }
}

export class DeviceListResponsesV4PagePagination extends V4PagePagination<DeviceListResponse> {}

export interface DeviceListResponse {
  /**
   * List of eligible devices
   */
  devices?: Array<DeviceListResponse.Device>;
}

export namespace DeviceListResponse {
  export interface Device {
    /**
     * Device identifier (UUID v4)
     */
    deviceId?: string;

    /**
     * Device identifier (human readable)
     */
    deviceName?: string;

    /**
     * Whether the device is eligible for remote captures
     */
    eligible?: boolean;

    /**
     * If the device is not eligible, the reason why.
     */
    ineligibleReason?: string;

    /**
     * User contact email address
     */
    personEmail?: string;

    /**
     * Operating system
     */
    platform?: string;

    /**
     * Network status
     */
    status?: string;

    /**
     * Timestamp in ISO format
     */
    timestamp?: string;

    /**
     * WARP client version
     */
    version?: string;
  }
}

export interface DeviceListParams extends V4PagePaginationParams {
  /**
   * Path param: unique identifier linked to an account in the API request path
   */
  account_id: string;

  /**
   * Query param: Filter devices by name or email
   */
  search?: string;
}

Devices.DeviceListResponsesV4PagePagination = DeviceListResponsesV4PagePagination;

export declare namespace Devices {
  export {
    type DeviceListResponse as DeviceListResponse,
    DeviceListResponsesV4PagePagination as DeviceListResponsesV4PagePagination,
    type DeviceListParams as DeviceListParams,
  };
}