cloudflare 6.3.0 → 6.5.0

package/src/resources/zero-trust/dex/commands/commands.ts

@@ -21,7 +21,7 @@ export class Commands extends APIResource {
   quota: QuotaAPI.Quota = new QuotaAPI.Quota(this._client);
 
   /**
-   * Initiate commands for up to 10 devices per account
+   * Initiate commands for up to 10 devices per account.
    *
    * @example
    * ```ts
@@ -29,8 +29,8 @@ export class Commands extends APIResource {
    *   account_id: '01a7362d577a6c3019a474fd6f485823',
    *   commands: [
    *     {
-   *       command_type: 'pcap',
    *       device_id: 'device_id',
+   *       type: 'pcap',
    *       user_email: 'user_email',
    *     },
    *   ],
@@ -57,7 +57,7 @@ export class Commands extends APIResource {
    *   {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
    *     page: 1,
-   *     per_page: 50,
+   *     per_page: 10,
    *   },
    * )) {
    *   // ...
@@ -114,7 +114,7 @@ export namespace CommandCreateResponse {
     status?: 'PENDING_EXEC' | 'PENDING_UPLOAD' | 'SUCCESS' | 'FAILED';
 
     /**
-     * Type of the command (e.g., "pcap" or "warp-diag")
+     * Type of the command (e.g., "pcap", "speed-test", or "warp-diag")
      */
     type?: string;
   }
@@ -151,7 +151,7 @@ export namespace CommandListResponse {
 
 export interface CommandCreateParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
@@ -164,21 +164,24 @@ export interface CommandCreateParams {
 export namespace CommandCreateParams {
   export interface Command {
     /**
-     * Type of command to execute on the device
+     * Unique identifier for the physical device
      */
-    command_type: 'pcap' | 'warp-diag';
+    device_id: string;
 
     /**
-     * Unique identifier for the physical device
+     * Type of command to execute on the device
      */
-    device_id: string;
+    type: 'pcap' | 'speed-test' | 'warp-diag';
 
     /**
      * Email tied to the device
      */
     user_email: string;
 
-    command_args?: Command.CommandArgs;
+    /**
+     * Command arguments. Allowed fields depend on `type`.
+     */
+    args?: Command.WARPDiagArgs | Command.PCAPArgs | Command.SpeedTestArgs;
 
     /**
      * Unique identifier for the device registration. Required for multi-user devices
@@ -188,16 +191,19 @@ export namespace CommandCreateParams {
   }
 
   export namespace Command {
-    export interface CommandArgs {
+    export interface WARPDiagArgs {
       /**
-       * List of interfaces to capture packets on
+       * Test an IP address from all included or excluded ranges. Essentially the same as
+       * running 'route get <ip>' and collecting the results. This option may increase
+       * the time taken to collect the warp-diag.
        */
-      interfaces?: Array<'default' | 'tunnel'>;
+      'test-all-routes'?: boolean;
+    }
 
+    export interface PCAPArgs {
       /**
-       * Maximum file size (in MB) for the capture file. Specifies the maximum file size
-       * of the warp-diag zip artifact that can be uploaded. If the zip artifact exceeds
-       * the specified max file size, it will NOT be uploaded
+       * Maximum file size (in MB) for the capture file. If the capture artifact exceeds
+       * the specified max file size, it will NOT be uploaded.
        */
       'max-file-size-mb'?: number;
 
@@ -207,54 +213,53 @@ export namespace CommandCreateParams {
       'packet-size-bytes'?: number;
 
       /**
-       * Test an IP address from all included or excluded ranges. Tests an IP address
-       * from all included or excluded ranges. Essentially the same as running 'route get
-       * <ip>'' and collecting the results. This option may increase the time taken to
-       * collect the warp-diag
+       * Limit on capture duration (in minutes)
        */
-      'test-all-routes'?: boolean;
+      'time-limit-min'?: number;
+    }
 
+    export interface SpeedTestArgs {
       /**
-       * Limit on capture duration (in minutes)
+       * List of interfaces to run the speed test on
        */
-      'time-limit-min'?: number;
+      interfaces?: Array<'default' | 'tunnel'>;
     }
   }
 }
 
 export interface CommandListParams extends V4PagePaginationParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
   /**
-   * Query param: Optionally filter executed commands by command type
+   * Query param: Optionally filter executed commands by command type.
    */
-  command_type?: string;
+  command_type?: 'pcap' | 'speed-test' | 'warp-diag';
 
   /**
-   * Query param: Unique identifier for a device
+   * Query param: Unique identifier for a device.
    */
   device_id?: string;
 
   /**
-   * Query param: Start time for the query in ISO (RFC3339 - ISO 8601) format
+   * Query param: Start time for the query in ISO (RFC3339 - ISO 8601) format.
    */
   from?: string;
 
   /**
-   * Query param: Optionally filter executed commands by status
+   * Query param: Optionally filter executed commands by status.
    */
   status?: 'PENDING_EXEC' | 'PENDING_UPLOAD' | 'SUCCESS' | 'FAILED';
 
   /**
-   * Query param: End time for the query in ISO (RFC3339 - ISO 8601) format
+   * Query param: End time for the query in ISO (RFC3339 - ISO 8601) format.
    */
   to?: string;
 
   /**
-   * Query param: Email tied to the device
+   * Query param: Email tied to the device.
    */
   user_email?: string;
 }

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

@@ -16,7 +16,7 @@ export class Devices extends APIResource {
    *   {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
    *     page: 1,
-   *     per_page: 1,
+   *     per_page: 10,
    *   },
    * )) {
    *   // ...
@@ -73,7 +73,7 @@ export namespace DeviceListResponse {
     personEmail?: string;
 
     /**
-     * Operating system
+     * Operating system.
      */
     platform?: string;
 
@@ -84,17 +84,14 @@ export namespace DeviceListResponse {
     registrationId?: string;
 
     /**
-     * Network status
+     * Network status.
      */
     status?: string;
 
-    /**
-     * Timestamp in ISO format
-     */
     timestamp?: string;
 
     /**
-     * WARP client version
+     * WARP client version.
      */
     version?: string;
   }
@@ -102,12 +99,12 @@ export namespace DeviceListResponse {
 
 export interface DeviceListParams extends V4PagePaginationParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
   /**
-   * Query param: Filter devices by name or email
+   * Query param: Filter devices by name or email.
    */
   search?: string;
 }

package/src/resources/zero-trust/dex/commands/downloads.ts

@@ -38,7 +38,7 @@ export class Downloads extends APIResource {
 
 export interface DownloadGetParams {
   /**
-   * unique identifier linked to an account in the API request path
+   * Unique identifier linked to an account.
    */
   account_id: string;
 }

package/src/resources/zero-trust/dex/commands/quota.ts

@@ -27,24 +27,24 @@ export class Quota extends APIResource {
 
 export interface QuotaGetResponse {
   /**
-   * The remaining number of commands that can be initiated for an account
+   * The total number of commands that can be initiated for an account.
    */
   quota: number;
 
   /**
-   * The number of commands that have been initiated for an account
+   * The number of commands that have been initiated for an account.
    */
   quota_usage: number;
 
   /**
-   * The time when the quota resets
+   * The time when the quota resets.
    */
   reset_time: string;
 }
 
 export interface QuotaGetParams {
   /**
-   * unique identifier linked to an account in the API request path
+   * Unique identifier linked to an account.
    */
   account_id: string;
 }

package/src/resources/zero-trust/dex/devices/devices.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as ISPsAPI from './isps';
+import { ISPListParams, ISPs, ISPsV4PagePagination } from './isps';
+
+export class Devices extends APIResource {
+  isps: ISPsAPI.ISPs = new ISPsAPI.ISPs(this._client);
+}
+
+Devices.ISPsV4PagePagination = ISPsV4PagePagination;
+
+export declare namespace Devices {
+  export {
+    type ISPs as ISPs,
+    ISPsV4PagePagination as ISPsV4PagePagination,
+    type ISPListParams as ISPListParams,
+  };
+}

package/src/resources/zero-trust/dex/devices/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Devices } from './devices';
+export { ISPsV4PagePagination, ISPs, type ISPListParams } from './isps';

package/src/resources/zero-trust/dex/devices/isps.ts

@@ -0,0 +1,187 @@
+// 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 ISPs extends APIResource {
+  /**
+   * List ISP information observed for a specific device during traceroute tests.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const isps of client.zeroTrust.dex.devices.isps.list(
+   *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *   {
+   *     account_id: '01a7362d577a6c3019a474fd6f485823',
+   *     per_page: 10,
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    deviceId: string,
+    params: ISPListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<ISPsV4PagePagination, ISPs> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/dex/devices/${deviceId}/isps`,
+      ISPsV4PagePagination,
+      { query, ...options },
+    );
+  }
+}
+
+export class ISPsV4PagePagination extends V4PagePagination<ISPs> {}
+
+export interface ISPs {
+  isps: Array<ISPs.ISP>;
+}
+
+export namespace ISPs {
+  export interface ISP {
+    /**
+     * The test that generated this result.
+     */
+    test_id: string;
+
+    /**
+     * The specific test result.
+     */
+    test_result_id: string;
+
+    /**
+     * Timestamp of when the ISP was observed.
+     */
+    time_start: string;
+
+    /**
+     * IP address information for the ISP hop. Fields marked as PII-gated (`name`,
+     * `address`, `netmask`, and all `location` sub-fields) will be returned as the
+     * literal string `"REDACTED"` for callers that do not have the PII permission.
+     * `asn`, `aso`, and `version` are always returned regardless of PII access.
+     */
+    ip?: ISP.IP;
+  }
+
+  export namespace ISP {
+    /**
+     * IP address information for the ISP hop. Fields marked as PII-gated (`name`,
+     * `address`, `netmask`, and all `location` sub-fields) will be returned as the
+     * literal string `"REDACTED"` for callers that do not have the PII permission.
+     * `asn`, `aso`, and `version` are always returned regardless of PII access.
+     */
+    export interface IP {
+      /**
+       * IP address. Returned as `"REDACTED"` without PII permission.
+       */
+      address?: string;
+
+      /**
+       * Autonomous System Number.
+       */
+      asn?: number;
+
+      /**
+       * Autonomous System Organization name.
+       */
+      aso?: string;
+
+      /**
+       * Geographic location information. All fields are returned as the literal string
+       * `"REDACTED"` for callers that do not have the PII permission.
+       */
+      location?: IP.Location;
+
+      /**
+       * Named IP address (reverse DNS hostname when available). Returned as `"REDACTED"`
+       * without PII permission.
+       */
+      name?: string;
+
+      /**
+       * Network mask. Returned as `"REDACTED"` without PII permission.
+       */
+      netmask?: string;
+
+      /**
+       * IP version (`1` for IPv4, `2` for IPv6, `0` if unknown).
+       */
+      version?: number;
+    }
+
+    export namespace IP {
+      /**
+       * Geographic location information. All fields are returned as the literal string
+       * `"REDACTED"` for callers that do not have the PII permission.
+       */
+      export interface Location {
+        /**
+         * City name. Returned as `"REDACTED"` without PII permission.
+         */
+        city?: string;
+
+        /**
+         * Country ISO code. Returned as `"REDACTED"` without PII permission.
+         */
+        country_iso?: string;
+
+        /**
+         * State/province ISO code. Returned as `"REDACTED"` without PII permission.
+         */
+        state_iso?: string;
+
+        /**
+         * ZIP/postal code. Returned as `"REDACTED"` without PII permission.
+         */
+        zip?: string;
+      }
+    }
+  }
+}
+
+export interface ISPListParams extends V4PagePaginationParams {
+  /**
+   * Path param: Unique identifier linked to an account.
+   */
+  account_id: string;
+
+  /**
+   * Query param: Cursor for cursor-based pagination. Mutually exclusive with page.
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Start time for the query in ISO 8601 format.
+   */
+  from?: string;
+
+  /**
+   * Query param: The field to sort results by.
+   */
+  sort_by?: 'time_start';
+
+  /**
+   * Query param: The order to sort results.
+   */
+  sort_order?: 'ASC' | 'DESC';
+
+  /**
+   * Query param: End time for the query in ISO 8601 format.
+   */
+  to?: string;
+}
+
+ISPs.ISPsV4PagePagination = ISPsV4PagePagination;
+
+export declare namespace ISPs {
+  export {
+    type ISPs as ISPs,
+    ISPsV4PagePagination as ISPsV4PagePagination,
+    type ISPListParams as ISPListParams,
+  };
+}

package/src/resources/zero-trust/dex/devices.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './devices/index';

package/src/resources/zero-trust/dex/dex.ts

@@ -38,6 +38,8 @@ import {
   CommandListResponsesV4PagePagination,
   Commands,
 } from './commands/commands';
+import * as DevicesAPI from './devices/devices';
+import { Devices } from './devices/devices';
 import * as FleetStatusAPI from './fleet-status/fleet-status';
 import {
   FleetStatus,
@@ -67,6 +69,7 @@ export class DEX extends APIResource {
     new TracerouteTestResultsAPI.TracerouteTestResults(this._client);
   tracerouteTests: TracerouteTestsAPI.TracerouteTests = new TracerouteTestsAPI.TracerouteTests(this._client);
   rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
+  devices: DevicesAPI.Devices = new DevicesAPI.Devices(this._client);
 }
 
 export interface DigitalExperienceMonitor {
@@ -76,7 +79,7 @@ export interface DigitalExperienceMonitor {
   id: string;
 
   /**
-   * Whether the policy is the default for the account
+   * Whether the policy is the default for the account.
    */
   default: boolean;
 
@@ -142,6 +145,9 @@ export interface NetworkPathResponse {
    */
   id: string;
 
+  /**
+   * Name of the device that ran the test.
+   */
   deviceName?: string;
 
   /**
@@ -156,29 +162,29 @@ export interface NetworkPathResponse {
   networkPath?: NetworkPath | null;
 
   /**
-   * The host of the Traceroute synthetic application test
+   * The host of the Traceroute synthetic application test.
    */
   url?: string;
 }
 
 export interface Percentiles {
   /**
-   * p50 observed in the time period
+   * p50 observed in the time period.
    */
   p50?: number | null;
 
   /**
-   * p90 observed in the time period
+   * p90 observed in the time period.
    */
   p90?: number | null;
 
   /**
-   * p95 observed in the time period
+   * p95 observed in the time period.
    */
   p95?: number | null;
 
   /**
-   * p99 observed in the time period
+   * p99 observed in the time period.
    */
   p99?: number | null;
 }
@@ -195,6 +201,7 @@ DEX.TracerouteTestResults = TracerouteTestResults;
 DEX.TracerouteTests = TracerouteTests;
 DEX.Rules = Rules;
 DEX.RuleListResponsesV4PagePagination = RuleListResponsesV4PagePagination;
+DEX.Devices = Devices;
 
 export declare namespace DEX {
   export {
@@ -273,4 +280,6 @@ export declare namespace DEX {
     type RuleDeleteParams as RuleDeleteParams,
     type RuleGetParams as RuleGetParams,
   };
+
+  export { Devices as Devices };
 }