cloudflare 6.4.0 → 6.5.0

package/src/resources/zero-trust/dex/http-tests/percentiles.ts

@@ -49,17 +49,17 @@ export interface TestStatOverTime {
   slots: Array<TestStatOverTime.Slot>;
 
   /**
-   * average observed in the time period
+   * average observed in the time period.
    */
   avg?: number | null;
 
   /**
-   * highest observed in the time period
+   * highest observed in the time period.
    */
   max?: number | null;
 
   /**
-   * lowest observed in the time period
+   * lowest observed in the time period.
    */
   min?: number | null;
 }
@@ -74,17 +74,17 @@ export namespace TestStatOverTime {
 
 export interface PercentileGetParams {
   /**
-   * 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: 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: 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;
 

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

@@ -6,7 +6,7 @@ import { V4PagePagination, type V4PagePaginationParams } from '../../../paginati
 
 export class Rules extends APIResource {
   /**
-   * Create a DEX Rule
+   * Create a DEX Rule.
    *
    * @example
    * ```ts
@@ -27,7 +27,7 @@ export class Rules extends APIResource {
   }
 
   /**
-   * Update a DEX Rule
+   * Update a DEX Rule.
    *
    * @example
    * ```ts
@@ -52,7 +52,7 @@ export class Rules extends APIResource {
   }
 
   /**
-   * List DEX Rules
+   * List DEX Rules.
    *
    * @example
    * ```ts
@@ -61,7 +61,7 @@ export class Rules extends APIResource {
    *   {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
    *     page: 1,
-   *     per_page: 1,
+   *     per_page: 10,
    *   },
    * )) {
    *   // ...
@@ -80,7 +80,7 @@ export class Rules extends APIResource {
   }
 
   /**
-   * Delete a DEX Rule
+   * Delete a DEX Rule.
    *
    * @example
    * ```ts
@@ -104,7 +104,7 @@ export class Rules extends APIResource {
   }
 
   /**
-   * Get details for a DEX Rule
+   * Get details for a DEX Rule.
    *
    * @example
    * ```ts
@@ -372,7 +372,7 @@ export namespace RuleGetResponse {
 
 export interface RuleCreateParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
@@ -394,7 +394,7 @@ export interface RuleCreateParams {
 
 export interface RuleUpdateParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
@@ -416,36 +416,36 @@ export interface RuleUpdateParams {
 
 export interface RuleListParams 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 results by rule name
+   * Query param: Filter results by rule name.
    */
   name?: string;
 
   /**
-   * Query param: Which property to sort results by
+   * Query param: Which property to sort results by.
    */
   sort_by?: 'name' | 'created_at' | 'updated_at';
 
   /**
-   * Query param: Sort direction for sort_by property
+   * Query param: Sort direction for sort_by property.
    */
   sort_order?: 'ASC' | 'DESC';
 }
 
 export interface RuleDeleteParams {
   /**
-   * unique identifier linked to an account in the API request path
+   * Unique identifier linked to an account.
    */
   account_id: string;
 }
 
 export interface RuleGetParams {
   /**
-   * 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/tests/tests.ts

@@ -12,7 +12,7 @@ export class Tests extends APIResource {
   uniqueDevices: UniqueDevicesAPI.UniqueDevices = new UniqueDevicesAPI.UniqueDevices(this._client);
 
   /**
-   * List DEX tests with overview metrics
+   * List DEX tests with overview metrics.
    *
    * @example
    * ```ts
@@ -61,12 +61,12 @@ export namespace Tests {
     testsTotal: number;
 
     /**
-     * percentage availability for all HTTP test results in response
+     * percentage availability for all HTTP test results in response.
      */
     avgHttpAvailabilityPct?: number | null;
 
     /**
-     * percentage availability for all traceroutes results in response
+     * percentage availability for all traceroutes results in response.
      */
     avgTracerouteAvailabilityPct?: number | null;
   }
@@ -297,7 +297,7 @@ export namespace Tests {
 
 export interface TestListParams 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;
 
@@ -314,7 +314,7 @@ export interface TestListParams extends V4PagePaginationParams {
   deviceId?: Array<string>;
 
   /**
-   * Query param: Filter by test type
+   * Query param: Filter by test type.
    */
   kind?: 'http' | 'traceroute';
 
@@ -325,7 +325,7 @@ export interface TestListParams extends V4PagePaginationParams {
   registration_id?: string;
 
   /**
-   * Query param: Optionally filter results by test name
+   * Query param: Optionally filter results by test name.
    */
   testName?: string;
 }

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

@@ -36,7 +36,7 @@ export interface UniqueDevices {
 
 export interface UniqueDeviceListParams {
   /**
-   * Path param: unique identifier linked to an account in the API request path.
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
@@ -47,7 +47,7 @@ export interface UniqueDeviceListParams {
   deviceId?: Array<string>;
 
   /**
-   * Query param: Optionally filter results by test name
+   * Query param: Optionally filter results by test name.
    */
   testName?: string;
 }

package/src/resources/zero-trust/dex/traceroute-test-results/network-path.ts

@@ -34,7 +34,7 @@ export class NetworkPath extends APIResource {
 
 export interface NetworkPathGetResponse {
   /**
-   * an array of the hops taken by the device to reach the end destination
+   * An array of the hops taken by the device to reach the end destination.
    */
   hops: Array<NetworkPathGetResponse.Hop>;
 
@@ -44,19 +44,36 @@ export interface NetworkPathGetResponse {
   resultId: string;
 
   /**
-   * name of the device associated with this network path response
+   * Cloudflare colo airport code.
+   */
+  colo?: string;
+
+  /**
+   * Name of the device associated with this network path response.
    */
   deviceName?: string;
 
+  /**
+   * Whether the test was run inside or outside of the WARP tunnel.
+   */
+  execution_context?: 'EXECUTION_CONTEXT_INVALID' | 'OUT_OF_TUNNEL' | 'IN_TUNNEL';
+
   /**
    * API Resource UUID tag.
    */
   testId?: string;
 
   /**
-   * name of the tracroute test
+   * Name of the traceroute test.
    */
   testName?: string;
+
+  /**
+   * Timestamp indicating when the traceroute test execution began.
+   */
+  time_start?: string;
+
+  tunnel_type?: string | null;
 }
 
 export namespace NetworkPathGetResponse {
@@ -93,7 +110,7 @@ export namespace NetworkPathGetResponse {
 
 export interface NetworkPathGetParams {
   /**
-   * unique identifier linked to an account
+   * Unique identifier linked to an account.
    */
   account_id: string;
 }

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

@@ -7,7 +7,7 @@ import * as PercentilesAPI from './http-tests/percentiles';
 
 export class TracerouteTests extends APIResource {
   /**
-   * Get test details and aggregate performance metrics for an traceroute test for a
+   * Get test details and aggregate performance metrics for a traceroute test for a
    * given time period between 1 hour and 7 days.
    *
    * @example
@@ -39,7 +39,7 @@ export class TracerouteTests extends APIResource {
   }
 
   /**
-   * Get a breakdown of metrics by hop for individual traceroute test runs
+   * Get a breakdown of metrics by hop for individual traceroute test runs.
    *
    * @example
    * ```ts
@@ -104,7 +104,7 @@ export class TracerouteTests extends APIResource {
 
 export interface Traceroute {
   /**
-   * The host of the Traceroute synthetic application test
+   * The host of the Traceroute synthetic application test.
    */
   host: string;
 
@@ -116,7 +116,7 @@ export interface Traceroute {
   kind: 'traceroute';
 
   /**
-   * The name of the Traceroute synthetic application test
+   * The name of the Traceroute synthetic application test.
    */
   name: string;
 
@@ -140,7 +140,7 @@ export namespace Traceroute {
     roundTripTimeMs: PercentilesAPI.TestStatOverTime;
 
     /**
-     * Count of unique devices that have run this test in the given time period
+     * Count of unique devices that have run this test in the given time period.
      */
     uniqueDevicesTotal: number;
   }
@@ -150,17 +150,17 @@ export namespace Traceroute {
       slots: Array<AvailabilityPct.Slot>;
 
       /**
-       * average observed in the time period
+       * average observed in the time period.
        */
       avg?: number | null;
 
       /**
-       * highest observed in the time period
+       * highest observed in the time period.
        */
       max?: number | null;
 
       /**
-       * lowest observed in the time period
+       * lowest observed in the time period.
        */
       min?: number | null;
     }
@@ -177,17 +177,17 @@ export namespace Traceroute {
       slots: Array<PacketLossPct.Slot>;
 
       /**
-       * average observed in the time period
+       * average observed in the time period.
        */
       avg?: number | null;
 
       /**
-       * highest observed in the time period
+       * highest observed in the time period.
        */
       max?: number | null;
 
       /**
-       * lowest observed in the time period
+       * lowest observed in the time period.
        */
       min?: number | null;
     }
@@ -213,7 +213,7 @@ export namespace Traceroute {
     roundTripTimeMs: PercentilesAPI.TestStatOverTime;
 
     /**
-     * Count of unique devices that have run this test in the given time period
+     * Count of unique devices that have run this test in the given time period.
      */
     uniqueDevicesTotal: number;
   }
@@ -223,17 +223,17 @@ export namespace Traceroute {
       slots: Array<AvailabilityPct.Slot>;
 
       /**
-       * average observed in the time period
+       * average observed in the time period.
        */
       avg?: number | null;
 
       /**
-       * highest observed in the time period
+       * highest observed in the time period.
        */
       max?: number | null;
 
       /**
-       * lowest observed in the time period
+       * lowest observed in the time period.
        */
       min?: number | null;
     }
@@ -250,17 +250,17 @@ export namespace Traceroute {
       slots: Array<PacketLossPct.Slot>;
 
       /**
-       * average observed in the time period
+       * average observed in the time period.
        */
       avg?: number | null;
 
       /**
-       * highest observed in the time period
+       * highest observed in the time period.
        */
       max?: number | null;
 
       /**
-       * lowest observed in the time period
+       * lowest observed in the time period.
        */
       min?: number | null;
     }
@@ -285,12 +285,12 @@ export interface TracerouteTestPercentilesResponse {
 
 export interface TracerouteTestGetParams {
   /**
-   * Path param: Unique identifier linked to an account
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
   /**
-   * Query param: Start time for aggregate metrics in ISO ms
+   * Query param: Start time for aggregate metrics in ISO ms.
    */
   from: string;
 
@@ -300,7 +300,7 @@ export interface TracerouteTestGetParams {
   interval: 'minute' | 'hour';
 
   /**
-   * Query param: End time for aggregate metrics in ISO ms
+   * Query param: End time for aggregate metrics in ISO ms.
    */
   to: string;
 
@@ -319,17 +319,17 @@ export interface TracerouteTestGetParams {
 
 export interface TracerouteTestNetworkPathParams {
   /**
-   * Path param: unique identifier linked to an account
+   * Path param: Unique identifier linked to an account.
    */
   account_id: string;
 
   /**
-   * Query param: Device to filter tracroute result runs to
+   * Query param: Device to filter traceroute result runs to.
    */
   deviceId: string;
 
   /**
-   * Query param: Start time for aggregate metrics in ISO ms
+   * Query param: Start time for aggregate metrics in ISO ms.
    */
   from: string;
 
@@ -339,24 +339,24 @@ export interface TracerouteTestNetworkPathParams {
   interval: 'minute' | 'hour';
 
   /**
-   * Query param: End time for aggregate metrics in ISO ms
+   * Query param: End time for aggregate metrics in ISO ms.
    */
   to: string;
 }
 
 export interface TracerouteTestPercentilesParams {
   /**
-   * 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: 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: 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;
 

package/src/resources/zero-trust/dex/warp-change-events.ts

@@ -14,7 +14,7 @@ export class WARPChangeEvents extends APIResource {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
    *     from: '2023-09-20T17:00:00Z',
    *     page: 1,
-   *     per_page: 1,
+   *     per_page: 10,
    *     to: '2023-09-20T17:00:00Z',
    *   });
    * ```
@@ -51,32 +51,32 @@ export namespace WARPChangeEventGetResponse {
     account_tag?: string;
 
     /**
-     * API Resource UUID tag.
+     * The device ID.
      */
     device_id?: string;
 
     /**
-     * API Resource UUID tag.
+     * @deprecated Use `registration_id` instead.
      */
     device_registration?: string;
 
     /**
-     * The hostname of the machine the event is from
+     * The hostname of the machine the event is from.
      */
     hostname?: string;
 
     /**
-     * API Resource UUID tag.
+     * The device registration ID.
      */
     registration_id?: string;
 
     /**
-     * The serial number of the machine the event is from
+     * The serial number of the machine the event is from.
      */
     serial_number?: string;
 
     /**
-     * Timestamp in ISO format
+     * The event time.
      */
     timestamp?: string;
 
@@ -86,53 +86,62 @@ export namespace WARPChangeEventGetResponse {
     toggle?: 'on' | 'off';
 
     /**
-     * Email tied to the device
+     * Email tied to the device.
      */
     user_email?: string;
   }
 
   export interface DigitalExperienceMonitoringWARPConfigChangeEvent {
     /**
-     * API Resource UUID tag.
+     * The device ID.
      */
     device_id?: string;
 
     /**
-     * API Resource UUID tag.
+     * @deprecated Use `registration_id` instead.
      */
     device_registration?: string;
 
+    /**
+     * The details for the WARP configuration that was switched from.
+     */
     from?: DigitalExperienceMonitoringWARPConfigChangeEvent.From;
 
     /**
-     * The hostname of the machine the event is from
+     * The hostname of the machine the event is from.
      */
     hostname?: string;
 
     /**
-     * API Resource UUID tag.
+     * The device registration ID.
      */
     registration_id?: string;
 
     /**
-     * The serial number of the machine the event is from
+     * The serial number of the machine the event is from.
      */
     serial_number?: string;
 
     /**
-     * Timestamp in ISO format
+     * The event time.
      */
     timestamp?: string;
 
+    /**
+     * The details for the WARP configuration that was switched to.
+     */
     to?: DigitalExperienceMonitoringWARPConfigChangeEvent.To;
 
     /**
-     * Email tied to the device
+     * Email tied to the device.
      */
     user_email?: string;
   }
 
   export namespace DigitalExperienceMonitoringWARPConfigChangeEvent {
+    /**
+     * The details for the WARP configuration that was switched from.
+     */
     export interface From {
       /**
        * The account name.
@@ -140,7 +149,7 @@ export namespace WARPChangeEventGetResponse {
       account_name?: string;
 
       /**
-       * API Resource UUID tag.
+       * The public account identifier.
        */
       account_tag?: string;
 
@@ -150,6 +159,9 @@ export namespace WARPChangeEventGetResponse {
       config_name?: string;
     }
 
+    /**
+     * The details for the WARP configuration that was switched to.
+     */
     export interface To {
       /**
        * The account name.
@@ -157,7 +169,7 @@ export namespace WARPChangeEventGetResponse {
       account_name?: string;
 
       /**
-       * API Resource UUID tag.
+       * The public account identifier.
        */
       account_tag?: string;
 
@@ -171,27 +183,27 @@ export namespace WARPChangeEventGetResponse {
 
 export interface WARPChangeEventGetParams {
   /**
-   * 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: 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: Page number of paginated results
+   * Query param: Page number of paginated results.
    */
   page: number;
 
   /**
-   * Query param: Number of items per page
+   * Query param: Number of results per page.
    */
   per_page: number;
 
   /**
-   * 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;
 
@@ -218,7 +230,7 @@ export interface WARPChangeEventGetParams {
   toggle?: 'on' | 'off';
 
   /**
-   * Query param: Filter events by type 'config' or 'toggle'
+   * Query param: Filter events by type 'config' or 'toggle'.
    */
   type?: 'config' | 'toggle';
 }