cloudflare 4.4.1 → 5.0.0

package/src/resources/filters.ts

@@ -17,9 +17,9 @@ export class Filters extends APIResource {
     params: FilterCreateParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
-    const { zone_id, ...body } = params;
+    const { zone_id, body } = params;
     return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
-      body,
+      body: body,
       method: 'post',
       ...options,
     });
@@ -35,12 +35,11 @@ export class Filters extends APIResource {
     params: FilterUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<FirewallFilter> {
-    const { zone_id, body } = params;
+    const { zone_id, ...body } = params;
     return (
-      this._client.put(`/zones/${zone_id}/filters/${filterId}`, {
-        body: body,
-        ...options,
-      }) as Core.APIPromise<{ result: FirewallFilter }>
+      this._client.put(`/zones/${zone_id}/filters/${filterId}`, { body, ...options }) as Core.APIPromise<{
+        result: FirewallFilter;
+      }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -70,11 +69,11 @@ export class Filters extends APIResource {
     filterId: string,
     params: FilterDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<FirewallFilter> {
+  ): Core.APIPromise<FilterDeleteResponse> {
     const { zone_id } = params;
     return (
       this._client.delete(`/zones/${zone_id}/filters/${filterId}`, options) as Core.APIPromise<{
-        result: FirewallFilter;
+        result: FilterDeleteResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -87,12 +86,13 @@ export class Filters extends APIResource {
   bulkDelete(
     params: FilterBulkDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
-    const { zone_id } = params;
-    return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
-      method: 'delete',
-      ...options,
-    });
+  ): Core.APIPromise<FilterBulkDeleteResponse | null> {
+    const { zone_id, id } = params;
+    return (
+      this._client.delete(`/zones/${zone_id}/filters`, { query: { id }, ...options }) as Core.APIPromise<{
+        result: FilterBulkDeleteResponse | null;
+      }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -104,9 +104,9 @@ export class Filters extends APIResource {
     params: FilterBulkUpdateParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<FirewallFiltersSinglePage, FirewallFilter> {
-    const { zone_id, ...body } = params;
+    const { zone_id, body } = params;
     return this._client.getAPIList(`/zones/${zone_id}/filters`, FirewallFiltersSinglePage, {
-      body,
+      body: body,
       method: 'put',
       ...options,
     });
@@ -186,6 +186,24 @@ export interface FirewallFilterParam {
   ref?: string;
 }
 
+export interface FilterDeleteResponse {
+  /**
+   * The unique identifier of the filter.
+   */
+  id: string;
+}
+
+export type FilterBulkDeleteResponse = Array<FilterBulkDeleteResponse.FilterBulkDeleteResponseItem>;
+
+export namespace FilterBulkDeleteResponse {
+  export interface FilterBulkDeleteResponseItem {
+    /**
+     * The unique identifier of the filter.
+     */
+    id?: string;
+  }
+}
+
 export interface FilterCreateParams {
   /**
    * Path param: Defines an identifier.
@@ -193,10 +211,9 @@ export interface FilterCreateParams {
   zone_id: string;
 
   /**
-   * Body param: The filter expression. For more information, refer to
-   * [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
+   * Body param:
    */
-  expression: string;
+  body: Array<FirewallFilterParam>;
 }
 
 export interface FilterUpdateParams {
@@ -206,9 +223,25 @@ export interface FilterUpdateParams {
   zone_id: string;
 
   /**
-   * Body param:
+   * Body param: An informative summary of the filter.
+   */
+  description?: string;
+
+  /**
+   * Body param: The filter expression. For more information, refer to
+   * [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
+   */
+  expression?: string;
+
+  /**
+   * Body param: When true, indicates that the filter is currently paused.
+   */
+  paused?: boolean;
+
+  /**
+   * Body param: A short reference tag. Allows you to select related filters.
    */
-  body: unknown;
+  ref?: string;
 }
 
 export interface FilterListParams extends V4PagePaginationArrayParams {
@@ -253,16 +286,51 @@ export interface FilterDeleteParams {
 
 export interface FilterBulkDeleteParams {
   /**
-   * Defines an identifier.
+   * Path param: Defines an identifier.
    */
   zone_id: string;
+
+  /**
+   * Query param:
+   */
+  id: Array<string>;
 }
 
 export interface FilterBulkUpdateParams {
   /**
-   * Defines an identifier.
+   * Path param: Defines an identifier.
    */
   zone_id: string;
+
+  /**
+   * Body param:
+   */
+  body: Array<FilterBulkUpdateParams.Body>;
+}
+
+export namespace FilterBulkUpdateParams {
+  export interface Body {
+    /**
+     * An informative summary of the filter.
+     */
+    description?: string;
+
+    /**
+     * The filter expression. For more information, refer to
+     * [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
+     */
+    expression?: string;
+
+    /**
+     * When true, indicates that the filter is currently paused.
+     */
+    paused?: boolean;
+
+    /**
+     * A short reference tag. Allows you to select related filters.
+     */
+    ref?: string;
+  }
 }
 
 export interface FilterGetParams {
@@ -278,6 +346,8 @@ Filters.FirewallFiltersV4PagePaginationArray = FirewallFiltersV4PagePaginationAr
 export declare namespace Filters {
   export {
     type FirewallFilter as FirewallFilter,
+    type FilterDeleteResponse as FilterDeleteResponse,
+    type FilterBulkDeleteResponse as FilterBulkDeleteResponse,
     FirewallFiltersSinglePage as FirewallFiltersSinglePage,
     FirewallFiltersV4PagePaginationArray as FirewallFiltersV4PagePaginationArray,
     type FilterCreateParams as FilterCreateParams,

package/src/resources/firewall/lockdowns.ts

@@ -271,8 +271,8 @@ export interface LockdownCreateParams {
   urls: Array<OverridesAPI.OverrideURLParam>;
 
   /**
-   * Body param: An informative summary of the rate limit. This value is sanitized
-   * and any tags will be removed.
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
    */
   description?: string;
 

package/src/resources/firewall/ua-rules.ts

@@ -133,9 +133,97 @@ export class UARules extends APIResource {
 
 export class UARuleListResponsesV4PagePaginationArray extends V4PagePaginationArray<UARuleListResponse> {}
 
-export type UARuleCreateResponse = unknown | string | null;
+export interface UARuleCreateResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleCreateResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleCreateResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
 
-export type UARuleUpdateResponse = unknown | string | null;
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
+
+export interface UARuleUpdateResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleUpdateResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleUpdateResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
 
 export interface UARuleListResponse {
   /**
@@ -188,9 +276,92 @@ export interface UARuleDeleteResponse {
    * The unique identifier of the User Agent Blocking rule.
    */
   id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleDeleteResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+}
+
+export namespace UARuleDeleteResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
+
+export interface UARuleGetResponse {
+  /**
+   * The unique identifier of the User Agent Blocking rule.
+   */
+  id?: string;
+
+  /**
+   * The configuration object for the current rule.
+   */
+  configuration?: UARuleGetResponse.Configuration;
+
+  /**
+   * An informative summary of the rule.
+   */
+  description?: string;
+
+  /**
+   * The action to apply to a matched request.
+   */
+  mode?: 'block' | 'challenge' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
-export type UARuleGetResponse = unknown | string | null;
+export namespace UARuleGetResponse {
+  /**
+   * The configuration object for the current rule.
+   */
+  export interface Configuration {
+    /**
+     * The configuration target for this rule. You must set the target to `ua` for User
+     * Agent Blocking rules.
+     */
+    target?: string;
+
+    /**
+     * The exact user agent string to match. This value will be compared to the
+     * received `User-Agent` HTTP header value.
+     */
+    value?: string;
+  }
+}
 
 export interface UARuleCreateParams {
   /**
@@ -207,6 +378,17 @@ export interface UARuleCreateParams {
    * Body param: The action to apply to a matched request.
    */
   mode: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
+   */
+  description?: string;
+
+  /**
+   * Body param: When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
 export namespace UARuleCreateParams {
@@ -244,6 +426,17 @@ export interface UARuleUpdateParams {
    * Body param: The action to apply to a matched request.
    */
   mode: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
+
+  /**
+   * Body param: An informative summary of the rule. This value is sanitized and any
+   * tags will be removed.
+   */
+  description?: string;
+
+  /**
+   * Body param: When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
 }
 
 export interface UARuleListParams extends V4PagePaginationArrayParams {
@@ -258,14 +451,14 @@ export interface UARuleListParams extends V4PagePaginationArrayParams {
   description?: string;
 
   /**
-   * Query param: A string to search for in the description of existing rules.
+   * Query param: When true, indicates that the rule is currently paused.
    */
-  description_search?: string;
+  paused?: boolean;
 
   /**
    * Query param: A string to search for in the user agent values of existing rules.
    */
-  ua_search?: string;
+  user_agent?: string;
 }
 
 export interface UARuleDeleteParams {

package/src/resources/firewall/waf/overrides.ts

@@ -129,10 +129,10 @@ export interface Override {
    * creating a new URI-based WAF override, you must provide a `groups` object or a
    * `rules` object.
    */
-  groups?: Record<string, unknown>;
+  groups?: { [key: string]: unknown };
 
   /**
-   * When true, indicates that the WAF package is currently paused.
+   * When true, indicates that the rule is currently paused.
    */
   paused?: boolean;
 
@@ -239,7 +239,7 @@ export interface RewriteActionParam {
  * group that this WAF rule belongs to. When creating a new URI-based WAF override,
  * you must provide a `groups` object or a `rules` object.
  */
-export type WAFRule = Record<string, 'challenge' | 'block' | 'simulate' | 'disable' | 'default'>;
+export type WAFRule = { [key: string]: 'challenge' | 'block' | 'simulate' | 'disable' | 'default' };
 
 /**
  * An object that allows you to override the action of specific WAF rules. Each key
@@ -248,7 +248,7 @@ export type WAFRule = Record<string, 'challenge' | 'block' | 'simulate' | 'disab
  * group that this WAF rule belongs to. When creating a new URI-based WAF override,
  * you must provide a `groups` object or a `rules` object.
  */
-export type WAFRuleParam = Record<string, 'challenge' | 'block' | 'simulate' | 'disable' | 'default'>;
+export type WAFRuleParam = { [key: string]: 'challenge' | 'block' | 'simulate' | 'disable' | 'default' };
 
 export interface OverrideDeleteResponse {
   /**

package/src/resources/healthchecks/healthchecks.ts

@@ -339,7 +339,7 @@ export interface HTTPConfiguration {
    * The HTTP request headers to send in the health check. It is recommended you set
    * a Host header by default. The User-Agent header cannot be overridden.
    */
-  header?: Record<string, Array<string>> | null;
+  header?: { [key: string]: Array<string> } | null;
 
   /**
    * The HTTP method to use for the health check.
@@ -388,7 +388,7 @@ export interface HTTPConfigurationParam {
    * The HTTP request headers to send in the health check. It is recommended you set
    * a Host header by default. The User-Agent header cannot be overridden.
    */
-  header?: Record<string, Array<string>> | null;
+  header?: { [key: string]: Array<string> } | null;
 
   /**
    * The HTTP method to use for the health check.

package/src/resources/hyperdrive/configs.ts

@@ -207,6 +207,12 @@ export interface ConfigCreateParams {
    * Body param:
    */
   mtls?: ConfigCreateParams.MTLS;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigCreateParams {
@@ -356,6 +362,12 @@ export interface ConfigUpdateParams {
    * Body param:
    */
   mtls?: ConfigUpdateParams.MTLS;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigUpdateParams {
@@ -520,6 +532,12 @@ export interface ConfigEditParams {
     | ConfigEditParams.HyperdriveHyperdriveDatabase
     | ConfigEditParams.HyperdriveInternetOrigin
     | ConfigEditParams.HyperdriveOverAccessOrigin;
+
+  /**
+   * Body param: The (soft) maximum number of connections the Hyperdrive is allowed
+   * to make to the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace ConfigEditParams {

package/src/resources/hyperdrive/hyperdrive.ts

@@ -102,6 +102,12 @@ export interface Hyperdrive {
   modified_on?: string;
 
   mtls?: Hyperdrive.MTLS;
+
+  /**
+   * The (soft) maximum number of connections the Hyperdrive is allowed to make to
+   * the origin database.
+   */
+  origin_connection_limit?: number;
 }
 
 export namespace Hyperdrive {

package/src/resources/iam/iam.ts

@@ -20,7 +20,7 @@ import {
   ResourceGroupGetResponse,
   ResourceGroupListParams,
   ResourceGroupListResponse,
-  ResourceGroupListResponsesV4PagePaginationArray,
+  ResourceGroupListResponsesSinglePage,
   ResourceGroupUpdateParams,
   ResourceGroupUpdateResponse,
   ResourceGroups,
@@ -52,7 +52,7 @@ export class IAM extends APIResource {
 IAM.PermissionGroups = PermissionGroups;
 IAM.PermissionGroupListResponsesV4PagePaginationArray = PermissionGroupListResponsesV4PagePaginationArray;
 IAM.ResourceGroups = ResourceGroups;
-IAM.ResourceGroupListResponsesV4PagePaginationArray = ResourceGroupListResponsesV4PagePaginationArray;
+IAM.ResourceGroupListResponsesSinglePage = ResourceGroupListResponsesSinglePage;
 IAM.UserGroups = UserGroups;
 IAM.UserGroupListResponsesV4PagePaginationArray = UserGroupListResponsesV4PagePaginationArray;
 
@@ -73,7 +73,7 @@ export declare namespace IAM {
     type ResourceGroupListResponse as ResourceGroupListResponse,
     type ResourceGroupDeleteResponse as ResourceGroupDeleteResponse,
     type ResourceGroupGetResponse as ResourceGroupGetResponse,
-    ResourceGroupListResponsesV4PagePaginationArray as ResourceGroupListResponsesV4PagePaginationArray,
+    ResourceGroupListResponsesSinglePage as ResourceGroupListResponsesSinglePage,
     type ResourceGroupCreateParams as ResourceGroupCreateParams,
     type ResourceGroupUpdateParams as ResourceGroupUpdateParams,
     type ResourceGroupListParams as ResourceGroupListParams,

package/src/resources/iam/index.ts

@@ -10,7 +10,7 @@ export {
   type PermissionGroupGetParams,
 } from './permission-groups';
 export {
-  ResourceGroupListResponsesV4PagePaginationArray,
+  ResourceGroupListResponsesSinglePage,
   ResourceGroups,
   type ResourceGroupCreateResponse,
   type ResourceGroupUpdateResponse,

package/src/resources/iam/resource-groups.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
+import { SinglePage } from '../../pagination';
 
 export class ResourceGroups extends APIResource {
   /**
@@ -73,11 +73,11 @@ export class ResourceGroups extends APIResource {
   list(
     params: ResourceGroupListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ResourceGroupListResponsesV4PagePaginationArray, ResourceGroupListResponse> {
+  ): Core.PagePromise<ResourceGroupListResponsesSinglePage, ResourceGroupListResponse> {
     const { account_id, ...query } = params;
     return this._client.getAPIList(
       `/accounts/${account_id}/iam/resource_groups`,
-      ResourceGroupListResponsesV4PagePaginationArray,
+      ResourceGroupListResponsesSinglePage,
       { query, ...options },
     );
   }
@@ -129,7 +129,7 @@ export class ResourceGroups extends APIResource {
   }
 }
 
-export class ResourceGroupListResponsesV4PagePaginationArray extends V4PagePaginationArray<ResourceGroupListResponse> {}
+export class ResourceGroupListResponsesSinglePage extends SinglePage<ResourceGroupListResponse> {}
 
 /**
  * A group of scoped resources.
@@ -491,7 +491,7 @@ export namespace ResourceGroupUpdateParams {
   }
 }
 
-export interface ResourceGroupListParams extends V4PagePaginationArrayParams {
+export interface ResourceGroupListParams {
   /**
    * Path param: Account identifier tag.
    */
@@ -522,8 +522,7 @@ export interface ResourceGroupGetParams {
   account_id: string;
 }
 
-ResourceGroups.ResourceGroupListResponsesV4PagePaginationArray =
-  ResourceGroupListResponsesV4PagePaginationArray;
+ResourceGroups.ResourceGroupListResponsesSinglePage = ResourceGroupListResponsesSinglePage;
 
 export declare namespace ResourceGroups {
   export {
@@ -532,7 +531,7 @@ export declare namespace ResourceGroups {
     type ResourceGroupListResponse as ResourceGroupListResponse,
     type ResourceGroupDeleteResponse as ResourceGroupDeleteResponse,
     type ResourceGroupGetResponse as ResourceGroupGetResponse,
-    ResourceGroupListResponsesV4PagePaginationArray as ResourceGroupListResponsesV4PagePaginationArray,
+    ResourceGroupListResponsesSinglePage as ResourceGroupListResponsesSinglePage,
     type ResourceGroupCreateParams as ResourceGroupCreateParams,
     type ResourceGroupUpdateParams as ResourceGroupUpdateParams,
     type ResourceGroupListParams as ResourceGroupListParams,