cloudflare 6.4.0 → 6.5.0

package/src/resources/zero-trust/devices/policies/default/default.ts

@@ -126,6 +126,14 @@ export interface DefaultEditResponse {
 
   gateway_unique_id?: string;
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  global_acceleration?: DefaultEditResponse.GlobalAcceleration | null;
+
   /**
    * List of routes included in the WARP client's tunnel.
    */
@@ -181,6 +189,36 @@ export namespace DefaultEditResponse {
     description?: string;
   }
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  export interface GlobalAcceleration {
+    /**
+     * IP:port entries for the API endpoints.
+     */
+    api_endpoints: Array<string>;
+
+    /**
+     * Global acceleration settings are used only when "enabled".
+     */
+    enabled: boolean;
+
+    /**
+     * IP:port entries for the MASQUE tunnel endpoints. Either wireguard_endpoints or
+     * masque_endpoints must be provided.
+     */
+    masque_endpoints: Array<string>;
+
+    /**
+     * IP:port entries for the WireGuard tunnel endpoints. Either wireguard_endpoints
+     * or masque_endpoints must be provided.
+     */
+    wireguard_endpoints: Array<string>;
+  }
+
   export interface ServiceModeV2 {
     /**
      * The mode to run the WARP client under.
@@ -274,6 +312,14 @@ export interface DefaultGetResponse {
 
   gateway_unique_id?: string;
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  global_acceleration?: DefaultGetResponse.GlobalAcceleration | null;
+
   /**
    * List of routes included in the WARP client's tunnel.
    */
@@ -329,6 +375,36 @@ export namespace DefaultGetResponse {
     description?: string;
   }
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  export interface GlobalAcceleration {
+    /**
+     * IP:port entries for the API endpoints.
+     */
+    api_endpoints: Array<string>;
+
+    /**
+     * Global acceleration settings are used only when "enabled".
+     */
+    enabled: boolean;
+
+    /**
+     * IP:port entries for the MASQUE tunnel endpoints. Either wireguard_endpoints or
+     * masque_endpoints must be provided.
+     */
+    masque_endpoints: Array<string>;
+
+    /**
+     * IP:port entries for the WireGuard tunnel endpoints. Either wireguard_endpoints
+     * or masque_endpoints must be provided.
+     */
+    wireguard_endpoints: Array<string>;
+  }
+
   export interface ServiceModeV2 {
     /**
      * The mode to run the WARP client under.
@@ -415,6 +491,15 @@ export interface DefaultEditParams {
    */
   exclude_office_ips?: boolean;
 
+  /**
+   * Body param: Global Acceleration settings for China. When configured, WARP
+   * clients connect to the Global Accelerator addresses instead of the default ones.
+   * Please contact your account representative to enable this feature on your
+   * account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  global_acceleration?: DefaultEditParams.GlobalAcceleration | null;
+
   /**
    * Body param: List of routes included in the WARP client's tunnel. Both 'exclude'
    * and 'include' cannot be set in the same request.
@@ -487,6 +572,36 @@ export namespace DefaultEditParams {
     description?: string;
   }
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  export interface GlobalAcceleration {
+    /**
+     * IP:port entries for the API endpoints.
+     */
+    api_endpoints: Array<string>;
+
+    /**
+     * Global acceleration settings are used only when "enabled".
+     */
+    enabled: boolean;
+
+    /**
+     * IP:port entries for the MASQUE tunnel endpoints. Either wireguard_endpoints or
+     * masque_endpoints must be provided.
+     */
+    masque_endpoints: Array<string>;
+
+    /**
+     * IP:port entries for the WireGuard tunnel endpoints. Either wireguard_endpoints
+     * or masque_endpoints must be provided.
+     */
+    wireguard_endpoints: Array<string>;
+  }
+
   export interface ServiceModeV2 {
     /**
      * The mode to run the WARP client under.

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

@@ -146,6 +146,14 @@ export interface SettingsPolicy {
 
   gateway_unique_id?: string;
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  global_acceleration?: SettingsPolicy.GlobalAcceleration | null;
+
   /**
    * List of routes included in the WARP client's tunnel.
    */
@@ -236,6 +244,36 @@ export namespace SettingsPolicy {
     description?: string;
   }
 
+  /**
+   * Global Acceleration settings for China. When configured, WARP clients connect to
+   * the Global Accelerator addresses instead of the default ones. Please contact
+   * your account representative to enable this feature on your account. See
+   * https://developers.cloudflare.com/china-network/concepts/global-acceleration/.
+   */
+  export interface GlobalAcceleration {
+    /**
+     * IP:port entries for the API endpoints.
+     */
+    api_endpoints: Array<string>;
+
+    /**
+     * Global acceleration settings are used only when "enabled".
+     */
+    enabled: boolean;
+
+    /**
+     * IP:port entries for the MASQUE tunnel endpoints. Either wireguard_endpoints or
+     * masque_endpoints must be provided.
+     */
+    masque_endpoints: Array<string>;
+
+    /**
+     * IP:port entries for the WireGuard tunnel endpoints. Either wireguard_endpoints
+     * or masque_endpoints must be provided.
+     */
+    wireguard_endpoints: Array<string>;
+  }
+
   export interface ServiceModeV2 {
     /**
      * The mode to run the WARP client under.

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

@@ -222,6 +222,18 @@ export interface RegistrationListResponse {
   tunnel_type?: string | null;
 
   user?: RegistrationListResponse.User;
+
+  /**
+   * The virtual IPv4 address assigned to the network interface of the tunnel for
+   * this registration.
+   */
+  virtual_ipv4?: string | null;
+
+  /**
+   * The virtual IPv6 address assigned to the network interface of the tunnel for
+   * this registration.
+   */
+  virtual_ipv6?: string | null;
 }
 
 export namespace RegistrationListResponse {
@@ -360,6 +372,18 @@ export interface RegistrationGetResponse {
   tunnel_type?: string | null;
 
   user?: RegistrationGetResponse.User;
+
+  /**
+   * The virtual IPv4 address assigned to the network interface of the tunnel for
+   * this registration.
+   */
+  virtual_ipv4?: string | null;
+
+  /**
+   * The virtual IPv6 address assigned to the network interface of the tunnel for
+   * this registration.
+   */
+  virtual_ipv6?: string | null;
 }
 
 export namespace RegistrationGetResponse {

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

@@ -57,17 +57,18 @@ export interface ColoListResponse {
 
 export interface ColoListParams {
   /**
-   * 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 connection period in ISO (RFC3339 - ISO 8601) format
+   * Query param: Start time for connection period in ISO (RFC3339 - ISO 8601)
+   * format.
    */
   from: string;
 
   /**
-   * Query param: End time for connection period in ISO (RFC3339 - ISO 8601) format
+   * Query param: End time for connection period in ISO (RFC3339 - ISO 8601) format.
    */
   to: string;
 

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
@@ -57,7 +57,7 @@ export class Commands extends APIResource {
    *   {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
    *     page: 1,
-   *     per_page: 50,
+   *     per_page: 10,
    *   },
    * )) {
    *   // ...
@@ -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;
 
@@ -229,37 +229,37 @@ export namespace CommandCreateParams {
 
 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?: '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/isps.ts

@@ -15,7 +15,7 @@ export class ISPs extends APIResource {
    *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
    *   {
    *     account_id: '01a7362d577a6c3019a474fd6f485823',
-   *     per_page: 1,
+   *     per_page: 10,
    *   },
    * )) {
    *   // ...
@@ -45,17 +45,17 @@ export interface ISPs {
 export namespace ISPs {
   export interface ISP {
     /**
-     * The test that generated this result
+     * The test that generated this result.
      */
     test_id: string;
 
     /**
-     * The specific test result
+     * The specific test result.
      */
     test_result_id: string;
 
     /**
-     * Timestamp of when the ISP was observed
+     * Timestamp of when the ISP was observed.
      */
     time_start: string;
 
@@ -82,12 +82,12 @@ export namespace ISPs {
       address?: string;
 
       /**
-       * Autonomous System Number
+       * Autonomous System Number.
        */
       asn?: number;
 
       /**
-       * Autonomous System Organization name
+       * Autonomous System Organization name.
        */
       aso?: string;
 
@@ -109,7 +109,7 @@ export namespace ISPs {
       netmask?: string;
 
       /**
-       * IP version (`1` for IPv4, `2` for IPv6, `0` if unknown)
+       * IP version (`1` for IPv4, `2` for IPv6, `0` if unknown).
        */
       version?: number;
     }
@@ -146,7 +146,7 @@ export namespace ISPs {
 
 export interface ISPListParams 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;
 
@@ -156,22 +156,22 @@ export interface ISPListParams extends V4PagePaginationParams {
   cursor?: string;
 
   /**
-   * Query param: Start time for the query in ISO 8601 format
+   * Query param: Start time for the query in ISO 8601 format.
    */
   from?: string;
 
   /**
-   * Query param: The field to sort results by
+   * Query param: The field to sort results by.
    */
   sort_by?: 'time_start';
 
   /**
-   * Query param: The order to sort results
+   * Query param: The order to sort results.
    */
   sort_order?: 'ASC' | 'DESC';
 
   /**
-   * Query param: End time for the query in ISO 8601 format
+   * Query param: End time for the query in ISO 8601 format.
    */
   to?: string;
 }

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

@@ -79,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;
 
@@ -145,6 +145,9 @@ export interface NetworkPathResponse {
    */
   id: string;
 
+  /**
+   * Name of the device that ran the test.
+   */
   deviceName?: string;
 
   /**
@@ -159,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;
 }