cloudflare 4.2.0 → 4.4.0

package/resources/rulesets/rules.d.ts

@@ -6,15 +6,41 @@ export declare class Rules extends APIResource {
     /**
      * Adds a new rule to an account or zone ruleset. The rule will be added to the end
      * of the existing list of rules in the ruleset by default.
+     *
+     * @example
+     * ```ts
+     * const rule = await client.rulesets.rules.create(
+     *   '2f2feab2026849078ba485f918791bdc',
+     *   { account_id: 'account_id' },
+     * );
+     * ```
      */
     create(rulesetId: string, params: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
     /**
      * Deletes an existing rule from an account or zone ruleset.
+     *
+     * @example
+     * ```ts
+     * const rule = await client.rulesets.rules.delete(
+     *   '2f2feab2026849078ba485f918791bdc',
+     *   '3a03d665bac047339bb530ecb439a90d',
+     *   { account_id: 'account_id' },
+     * );
+     * ```
      */
     delete(rulesetId: string, ruleId: string, params?: RuleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
     delete(rulesetId: string, ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
     /**
      * Updates an existing rule in an account or zone ruleset.
+     *
+     * @example
+     * ```ts
+     * const response = await client.rulesets.rules.edit(
+     *   '2f2feab2026849078ba485f918791bdc',
+     *   '3a03d665bac047339bb530ecb439a90d',
+     *   { account_id: 'account_id' },
+     * );
+     * ```
      */
     edit(rulesetId: string, ruleId: string, params: RuleEditParams, options?: Core.RequestOptions): Core.APIPromise<RuleEditResponse>;
 }
@@ -126,7 +152,7 @@ export declare namespace BlockRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -254,7 +280,7 @@ export declare namespace BlockRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -358,7 +384,7 @@ export declare namespace CompressResponseRule {
             /**
              * Name of compression algorithm to enable.
              */
-            name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli';
+            name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli' | 'zstd';
         }
     }
     /**
@@ -386,7 +412,7 @@ export declare namespace CompressResponseRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -478,7 +504,7 @@ export declare namespace CompressResponseRuleParam {
             /**
              * Name of compression algorithm to enable.
              */
-            name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli';
+            name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli' | 'zstd';
         }
     }
     /**
@@ -506,7 +532,7 @@ export declare namespace CompressResponseRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -618,7 +644,7 @@ export declare namespace DDoSDynamicRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -718,7 +744,7 @@ export declare namespace DDoSDynamicRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -863,7 +889,7 @@ export declare namespace ExecuteRule {
         }
         namespace Overrides {
             /**
-             * A category-level override
+             * A category-level override.
              */
             interface Category {
                 /**
@@ -884,7 +910,7 @@ export declare namespace ExecuteRule {
                 sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
             }
             /**
-             * A rule-level override
+             * A rule-level override.
              */
             interface Rule {
                 /**
@@ -935,7 +961,7 @@ export declare namespace ExecuteRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1068,7 +1094,7 @@ export declare namespace ExecuteRuleParam {
         }
         namespace Overrides {
             /**
-             * A category-level override
+             * A category-level override.
              */
             interface Category {
                 /**
@@ -1089,7 +1115,7 @@ export declare namespace ExecuteRuleParam {
                 sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
             }
             /**
-             * A rule-level override
+             * A rule-level override.
              */
             interface Rule {
                 /**
@@ -1140,7 +1166,7 @@ export declare namespace ExecuteRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1252,7 +1278,7 @@ export declare namespace ForceConnectionCloseRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1352,7 +1378,7 @@ export declare namespace ForceConnectionCloseRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1544,7 +1570,7 @@ export declare namespace LogCustomFieldRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1724,7 +1750,7 @@ export declare namespace LogCustomFieldRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1836,7 +1862,7 @@ export declare namespace LogRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -1936,7 +1962,7 @@ export declare namespace LogRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2066,7 +2092,7 @@ export declare namespace ManagedChallengeRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2166,7 +2192,7 @@ export declare namespace ManagedChallengeRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2337,7 +2363,7 @@ export declare namespace RedirectRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2496,7 +2522,7 @@ export declare namespace RedirectRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2590,7 +2616,7 @@ export declare namespace RewriteRule {
         /**
          * Map of request headers to modify.
          */
-        headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader>;
+        headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.AddStaticHeader | ActionParameters.SetStaticHeader | ActionParameters.AddDynamicHeader | ActionParameters.SetDynamicHeader>;
         /**
          * URI to rewrite the request to.
          */
@@ -2603,20 +2629,40 @@ export declare namespace RewriteRule {
         interface RemoveHeader {
             operation: 'remove';
         }
+        /**
+         * Add a request header with a static value.
+         */
+        interface AddStaticHeader {
+            operation: 'add';
+            /**
+             * Static value for the header.
+             */
+            value: string;
+        }
         /**
          * Set a request header with a static value.
          */
-        interface StaticHeader {
+        interface SetStaticHeader {
             operation: 'set';
             /**
              * Static value for the header.
              */
             value: string;
         }
+        /**
+         * Add a request header with a dynamic value.
+         */
+        interface AddDynamicHeader {
+            /**
+             * Expression for the header value.
+             */
+            expression: string;
+            operation: 'add';
+        }
         /**
          * Set a request header with a dynamic value.
          */
-        interface DynamicHeader {
+        interface SetDynamicHeader {
             /**
              * Expression for the header value.
              */
@@ -2662,7 +2708,7 @@ export declare namespace RewriteRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2744,7 +2790,7 @@ export declare namespace RewriteRuleParam {
         /**
          * Map of request headers to modify.
          */
-        headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader>;
+        headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.AddStaticHeader | ActionParameters.SetStaticHeader | ActionParameters.AddDynamicHeader | ActionParameters.SetDynamicHeader>;
         /**
          * URI to rewrite the request to.
          */
@@ -2757,20 +2803,40 @@ export declare namespace RewriteRuleParam {
         interface RemoveHeader {
             operation: 'remove';
         }
+        /**
+         * Add a request header with a static value.
+         */
+        interface AddStaticHeader {
+            operation: 'add';
+            /**
+             * Static value for the header.
+             */
+            value: string;
+        }
         /**
          * Set a request header with a static value.
          */
-        interface StaticHeader {
+        interface SetStaticHeader {
             operation: 'set';
             /**
              * Static value for the header.
              */
             value: string;
         }
+        /**
+         * Add a request header with a dynamic value.
+         */
+        interface AddDynamicHeader {
+            /**
+             * Expression for the header value.
+             */
+            expression: string;
+            operation: 'add';
+        }
         /**
          * Set a request header with a dynamic value.
          */
-        interface DynamicHeader {
+        interface SetDynamicHeader {
             /**
              * Expression for the header value.
              */
@@ -2816,7 +2882,7 @@ export declare namespace RewriteRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -2999,7 +3065,7 @@ export declare namespace RouteRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3140,7 +3206,7 @@ export declare namespace RouteRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3252,7 +3318,7 @@ export declare namespace RulesetRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3374,7 +3440,7 @@ export declare namespace ScoreRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3484,7 +3550,7 @@ export declare namespace ScoreRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3613,7 +3679,7 @@ export declare namespace ServeErrorRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3730,7 +3796,7 @@ export declare namespace ServeErrorRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -3858,7 +3924,7 @@ export declare namespace SetCacheSettingsRule {
         origin_cache_control?: boolean;
         /**
          * Generate Cloudflare error pages from issues sent from the origin server. When
-         * on, error pages will trigger for issues from the origin
+         * on, error pages will trigger for issues from the origin.
          */
         origin_error_page_passthru?: boolean;
         /**
@@ -3903,12 +3969,12 @@ export declare namespace SetCacheSettingsRule {
          */
         interface CacheKey {
             /**
-             * Separate cached content based on the visitor’s device type
+             * Separate cached content based on the visitor’s device type.
              */
             cache_by_device_type?: boolean;
             /**
              * Protect from web cache deception attacks while allowing static assets to be
-             * cached
+             * cached.
              */
             cache_deception_armor?: boolean;
             /**
@@ -4101,18 +4167,18 @@ export declare namespace SetCacheSettingsRule {
              */
             default: number;
             /**
-             * edge ttl options
+             * Edge TTL options.
              */
             mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
             /**
-             * List of single status codes, or status code ranges to apply the selected mode
+             * List of single status codes, or status code ranges to apply the selected mode.
              */
             status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
         }
         namespace EdgeTTL {
             /**
              * Specify how long Cloudflare should cache the response based on the status code
-             * from the origin. Can be a single status code or a range or status codes
+             * from the origin. Can be a single status code or a range or status codes.
              */
             interface StatusCodeTTL {
                 /**
@@ -4126,7 +4192,7 @@ export declare namespace SetCacheSettingsRule {
                  */
                 status_code_range?: StatusCodeTTL.StatusCodeRange;
                 /**
-                 * Set the ttl for responses with this specific status code
+                 * Set the TTL for responses with this specific status code.
                  */
                 status_code_value?: number;
             }
@@ -4136,11 +4202,11 @@ export declare namespace SetCacheSettingsRule {
                  */
                 interface StatusCodeRange {
                     /**
-                     * response status code lower bound
+                     * Response status code lower bound.
                      */
                     from: number;
                     /**
-                     * response status code upper bound
+                     * Response status code upper bound.
                      */
                     to: number;
                 }
@@ -4185,7 +4251,7 @@ export declare namespace SetCacheSettingsRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -4301,7 +4367,7 @@ export declare namespace SetCacheSettingsRuleParam {
         origin_cache_control?: boolean;
         /**
          * Generate Cloudflare error pages from issues sent from the origin server. When
-         * on, error pages will trigger for issues from the origin
+         * on, error pages will trigger for issues from the origin.
          */
         origin_error_page_passthru?: boolean;
         /**
@@ -4346,12 +4412,12 @@ export declare namespace SetCacheSettingsRuleParam {
          */
         interface CacheKey {
             /**
-             * Separate cached content based on the visitor’s device type
+             * Separate cached content based on the visitor’s device type.
              */
             cache_by_device_type?: boolean;
             /**
              * Protect from web cache deception attacks while allowing static assets to be
-             * cached
+             * cached.
              */
             cache_deception_armor?: boolean;
             /**
@@ -4544,18 +4610,18 @@ export declare namespace SetCacheSettingsRuleParam {
              */
             default: number;
             /**
-             * edge ttl options
+             * Edge TTL options.
              */
             mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
             /**
-             * List of single status codes, or status code ranges to apply the selected mode
+             * List of single status codes, or status code ranges to apply the selected mode.
              */
             status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
         }
         namespace EdgeTTL {
             /**
              * Specify how long Cloudflare should cache the response based on the status code
-             * from the origin. Can be a single status code or a range or status codes
+             * from the origin. Can be a single status code or a range or status codes.
              */
             interface StatusCodeTTL {
                 /**
@@ -4569,7 +4635,7 @@ export declare namespace SetCacheSettingsRuleParam {
                  */
                 status_code_range?: StatusCodeTTL.StatusCodeRange;
                 /**
-                 * Set the ttl for responses with this specific status code
+                 * Set the TTL for responses with this specific status code.
                  */
                 status_code_value?: number;
             }
@@ -4579,11 +4645,11 @@ export declare namespace SetCacheSettingsRuleParam {
                  */
                 interface StatusCodeRange {
                     /**
-                     * response status code lower bound
+                     * Response status code lower bound.
                      */
                     from: number;
                     /**
-                     * response status code upper bound
+                     * Response status code upper bound.
                      */
                     to: number;
                 }
@@ -4628,7 +4694,7 @@ export declare namespace SetCacheSettingsRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -4766,9 +4832,9 @@ export declare namespace SetConfigRule {
         /**
          * Configure the Polish level.
          */
-        polish?: 'off' | 'lossless' | 'lossy';
+        polish?: 'off' | 'lossless' | 'lossy' | 'webp';
         /**
-         * Turn on or off Rocket Loader
+         * Turn on or off Rocket Loader.
          */
         rocket_loader?: boolean;
         /**
@@ -4832,7 +4898,7 @@ export declare namespace SetConfigRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -4958,9 +5024,9 @@ export declare namespace SetConfigRuleParam {
         /**
          * Configure the Polish level.
          */
-        polish?: 'off' | 'lossless' | 'lossy';
+        polish?: 'off' | 'lossless' | 'lossy' | 'webp';
         /**
-         * Turn on or off Rocket Loader
+         * Turn on or off Rocket Loader.
          */
         rocket_loader?: boolean;
         /**
@@ -5024,7 +5090,7 @@ export declare namespace SetConfigRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -5117,7 +5183,7 @@ export declare namespace SkipRule {
     interface ActionParameters {
         /**
          * A list of phases to skip the execution of. This option is incompatible with the
-         * ruleset and rulesets options.
+         * rulesets option.
          */
         phases?: Array<RulesetsAPI.Phase>;
         /**
@@ -5131,7 +5197,7 @@ export declare namespace SkipRule {
         rules?: Record<string, Array<string>>;
         /**
          * A ruleset to skip the execution of. This option is incompatible with the
-         * rulesets, rules and phases options.
+         * rulesets option.
          */
         ruleset?: 'current';
         /**
@@ -5165,7 +5231,7 @@ export declare namespace SkipRule {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -5246,7 +5312,7 @@ export declare namespace SkipRuleParam {
     interface ActionParameters {
         /**
          * A list of phases to skip the execution of. This option is incompatible with the
-         * ruleset and rulesets options.
+         * rulesets option.
          */
         phases?: Array<RulesetsAPI.PhaseParam>;
         /**
@@ -5260,7 +5326,7 @@ export declare namespace SkipRuleParam {
         rules?: Record<string, Array<string>>;
         /**
          * A ruleset to skip the execution of. This option is incompatible with the
-         * rulesets, rules and phases options.
+         * rulesets option.
          */
         ruleset?: 'current';
         /**
@@ -5294,7 +5360,7 @@ export declare namespace SkipRuleParam {
         /**
          * Period in seconds over which the counter is being incremented.
          */
-        period: 10 | 60 | 600 | 3600;
+        period: number;
         /**
          * Defines when the ratelimit counter should be incremented. It is optional and
          * defaults to the same as the rule's expression.
@@ -5444,7 +5510,7 @@ export declare namespace RuleCreateResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -5556,7 +5622,7 @@ export declare namespace RuleCreateResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -5707,7 +5773,7 @@ export declare namespace RuleDeleteResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -5819,7 +5885,7 @@ export declare namespace RuleDeleteResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -5970,7 +6036,7 @@ export declare namespace RuleEditResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6082,7 +6148,7 @@ export declare namespace RuleEditResponse {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6256,7 +6322,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6399,7 +6465,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6505,7 +6571,7 @@ export declare namespace RuleCreateParams {
                 /**
                  * Name of compression algorithm to enable.
                  */
-                name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli';
+                name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli' | 'zstd';
             }
         }
         /**
@@ -6562,7 +6628,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6709,7 +6775,7 @@ export declare namespace RuleCreateParams {
             }
             namespace Overrides {
                 /**
-                 * A category-level override
+                 * A category-level override.
                  */
                 interface Category {
                     /**
@@ -6730,7 +6796,7 @@ export declare namespace RuleCreateParams {
                     sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
                 }
                 /**
-                 * A rule-level override
+                 * A rule-level override.
                  */
                 interface Rule {
                     /**
@@ -6810,7 +6876,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -6953,7 +7019,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7096,7 +7162,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7239,7 +7305,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7441,7 +7507,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7537,7 +7603,7 @@ export declare namespace RuleCreateParams {
             /**
              * Map of request headers to modify.
              */
-            headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader>;
+            headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.AddStaticHeader | ActionParameters.SetStaticHeader | ActionParameters.AddDynamicHeader | ActionParameters.SetDynamicHeader>;
             /**
              * URI to rewrite the request to.
              */
@@ -7550,20 +7616,40 @@ export declare namespace RuleCreateParams {
             interface RemoveHeader {
                 operation: 'remove';
             }
+            /**
+             * Add a request header with a static value.
+             */
+            interface AddStaticHeader {
+                operation: 'add';
+                /**
+                 * Static value for the header.
+                 */
+                value: string;
+            }
             /**
              * Set a request header with a static value.
              */
-            interface StaticHeader {
+            interface SetStaticHeader {
                 operation: 'set';
                 /**
                  * Static value for the header.
                  */
                 value: string;
             }
+            /**
+             * Add a request header with a dynamic value.
+             */
+            interface AddDynamicHeader {
+                /**
+                 * Expression for the header value.
+                 */
+                expression: string;
+                operation: 'add';
+            }
             /**
              * Set a request header with a dynamic value.
              */
-            interface DynamicHeader {
+            interface SetDynamicHeader {
                 /**
                  * Expression for the header value.
                  */
@@ -7638,7 +7724,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7822,7 +7908,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -7975,7 +8061,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -8135,7 +8221,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -8275,9 +8361,9 @@ export declare namespace RuleCreateParams {
             /**
              * Configure the Polish level.
              */
-            polish?: 'off' | 'lossless' | 'lossy';
+            polish?: 'off' | 'lossless' | 'lossy' | 'webp';
             /**
-             * Turn on or off Rocket Loader
+             * Turn on or off Rocket Loader.
              */
             rocket_loader?: boolean;
             /**
@@ -8370,7 +8456,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -8465,7 +8551,7 @@ export declare namespace RuleCreateParams {
         interface ActionParameters {
             /**
              * A list of phases to skip the execution of. This option is incompatible with the
-             * ruleset and rulesets options.
+             * rulesets option.
              */
             phases?: Array<RulesetsAPI.PhaseParam>;
             /**
@@ -8479,7 +8565,7 @@ export declare namespace RuleCreateParams {
             rules?: Record<string, Array<string>>;
             /**
              * A ruleset to skip the execution of. This option is incompatible with the
-             * rulesets, rules and phases options.
+             * rulesets option.
              */
             ruleset?: 'current';
             /**
@@ -8542,7 +8628,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -8672,7 +8758,7 @@ export declare namespace RuleCreateParams {
             origin_cache_control?: boolean;
             /**
              * Generate Cloudflare error pages from issues sent from the origin server. When
-             * on, error pages will trigger for issues from the origin
+             * on, error pages will trigger for issues from the origin.
              */
             origin_error_page_passthru?: boolean;
             /**
@@ -8717,12 +8803,12 @@ export declare namespace RuleCreateParams {
              */
             interface CacheKey {
                 /**
-                 * Separate cached content based on the visitor’s device type
+                 * Separate cached content based on the visitor’s device type.
                  */
                 cache_by_device_type?: boolean;
                 /**
                  * Protect from web cache deception attacks while allowing static assets to be
-                 * cached
+                 * cached.
                  */
                 cache_deception_armor?: boolean;
                 /**
@@ -8915,18 +9001,18 @@ export declare namespace RuleCreateParams {
                  */
                 default: number;
                 /**
-                 * edge ttl options
+                 * Edge TTL options.
                  */
                 mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
                 /**
-                 * List of single status codes, or status code ranges to apply the selected mode
+                 * List of single status codes, or status code ranges to apply the selected mode.
                  */
                 status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
             }
             namespace EdgeTTL {
                 /**
                  * Specify how long Cloudflare should cache the response based on the status code
-                 * from the origin. Can be a single status code or a range or status codes
+                 * from the origin. Can be a single status code or a range or status codes.
                  */
                 interface StatusCodeTTL {
                     /**
@@ -8940,7 +9026,7 @@ export declare namespace RuleCreateParams {
                      */
                     status_code_range?: StatusCodeTTL.StatusCodeRange;
                     /**
-                     * Set the ttl for responses with this specific status code
+                     * Set the TTL for responses with this specific status code.
                      */
                     status_code_value?: number;
                 }
@@ -8950,11 +9036,11 @@ export declare namespace RuleCreateParams {
                      */
                     interface StatusCodeRange {
                         /**
-                         * response status code lower bound
+                         * Response status code lower bound.
                          */
                         from: number;
                         /**
-                         * response status code upper bound
+                         * Response status code upper bound.
                          */
                         to: number;
                     }
@@ -9028,7 +9114,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9251,7 +9337,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9394,7 +9480,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9537,7 +9623,7 @@ export declare namespace RuleCreateParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9721,7 +9807,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9864,7 +9950,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -9970,7 +10056,7 @@ export declare namespace RuleEditParams {
                 /**
                  * Name of compression algorithm to enable.
                  */
-                name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli';
+                name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli' | 'zstd';
             }
         }
         /**
@@ -10027,7 +10113,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -10174,7 +10260,7 @@ export declare namespace RuleEditParams {
             }
             namespace Overrides {
                 /**
-                 * A category-level override
+                 * A category-level override.
                  */
                 interface Category {
                     /**
@@ -10195,7 +10281,7 @@ export declare namespace RuleEditParams {
                     sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
                 }
                 /**
-                 * A rule-level override
+                 * A rule-level override.
                  */
                 interface Rule {
                     /**
@@ -10275,7 +10361,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -10418,7 +10504,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -10561,7 +10647,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -10704,7 +10790,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -10906,7 +10992,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11002,7 +11088,7 @@ export declare namespace RuleEditParams {
             /**
              * Map of request headers to modify.
              */
-            headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader>;
+            headers?: Record<string, ActionParameters.RemoveHeader | ActionParameters.AddStaticHeader | ActionParameters.SetStaticHeader | ActionParameters.AddDynamicHeader | ActionParameters.SetDynamicHeader>;
             /**
              * URI to rewrite the request to.
              */
@@ -11015,20 +11101,40 @@ export declare namespace RuleEditParams {
             interface RemoveHeader {
                 operation: 'remove';
             }
+            /**
+             * Add a request header with a static value.
+             */
+            interface AddStaticHeader {
+                operation: 'add';
+                /**
+                 * Static value for the header.
+                 */
+                value: string;
+            }
             /**
              * Set a request header with a static value.
              */
-            interface StaticHeader {
+            interface SetStaticHeader {
                 operation: 'set';
                 /**
                  * Static value for the header.
                  */
                 value: string;
             }
+            /**
+             * Add a request header with a dynamic value.
+             */
+            interface AddDynamicHeader {
+                /**
+                 * Expression for the header value.
+                 */
+                expression: string;
+                operation: 'add';
+            }
             /**
              * Set a request header with a dynamic value.
              */
-            interface DynamicHeader {
+            interface SetDynamicHeader {
                 /**
                  * Expression for the header value.
                  */
@@ -11103,7 +11209,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11287,7 +11393,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11440,7 +11546,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11600,7 +11706,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11740,9 +11846,9 @@ export declare namespace RuleEditParams {
             /**
              * Configure the Polish level.
              */
-            polish?: 'off' | 'lossless' | 'lossy';
+            polish?: 'off' | 'lossless' | 'lossy' | 'webp';
             /**
-             * Turn on or off Rocket Loader
+             * Turn on or off Rocket Loader.
              */
             rocket_loader?: boolean;
             /**
@@ -11835,7 +11941,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -11930,7 +12036,7 @@ export declare namespace RuleEditParams {
         interface ActionParameters {
             /**
              * A list of phases to skip the execution of. This option is incompatible with the
-             * ruleset and rulesets options.
+             * rulesets option.
              */
             phases?: Array<RulesetsAPI.PhaseParam>;
             /**
@@ -11944,7 +12050,7 @@ export declare namespace RuleEditParams {
             rules?: Record<string, Array<string>>;
             /**
              * A ruleset to skip the execution of. This option is incompatible with the
-             * rulesets, rules and phases options.
+             * rulesets option.
              */
             ruleset?: 'current';
             /**
@@ -12007,7 +12113,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -12137,7 +12243,7 @@ export declare namespace RuleEditParams {
             origin_cache_control?: boolean;
             /**
              * Generate Cloudflare error pages from issues sent from the origin server. When
-             * on, error pages will trigger for issues from the origin
+             * on, error pages will trigger for issues from the origin.
              */
             origin_error_page_passthru?: boolean;
             /**
@@ -12182,12 +12288,12 @@ export declare namespace RuleEditParams {
              */
             interface CacheKey {
                 /**
-                 * Separate cached content based on the visitor’s device type
+                 * Separate cached content based on the visitor’s device type.
                  */
                 cache_by_device_type?: boolean;
                 /**
                  * Protect from web cache deception attacks while allowing static assets to be
-                 * cached
+                 * cached.
                  */
                 cache_deception_armor?: boolean;
                 /**
@@ -12380,18 +12486,18 @@ export declare namespace RuleEditParams {
                  */
                 default: number;
                 /**
-                 * edge ttl options
+                 * Edge TTL options.
                  */
                 mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
                 /**
-                 * List of single status codes, or status code ranges to apply the selected mode
+                 * List of single status codes, or status code ranges to apply the selected mode.
                  */
                 status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
             }
             namespace EdgeTTL {
                 /**
                  * Specify how long Cloudflare should cache the response based on the status code
-                 * from the origin. Can be a single status code or a range or status codes
+                 * from the origin. Can be a single status code or a range or status codes.
                  */
                 interface StatusCodeTTL {
                     /**
@@ -12405,7 +12511,7 @@ export declare namespace RuleEditParams {
                      */
                     status_code_range?: StatusCodeTTL.StatusCodeRange;
                     /**
-                     * Set the ttl for responses with this specific status code
+                     * Set the TTL for responses with this specific status code.
                      */
                     status_code_value?: number;
                 }
@@ -12415,11 +12521,11 @@ export declare namespace RuleEditParams {
                      */
                     interface StatusCodeRange {
                         /**
-                         * response status code lower bound
+                         * Response status code lower bound.
                          */
                         from: number;
                         /**
-                         * response status code upper bound
+                         * Response status code upper bound.
                          */
                         to: number;
                     }
@@ -12493,7 +12599,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -12716,7 +12822,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -12859,7 +12965,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.
@@ -13002,7 +13108,7 @@ export declare namespace RuleEditParams {
             /**
              * Period in seconds over which the counter is being incremented.
              */
-            period: 10 | 60 | 600 | 3600;
+            period: number;
             /**
              * Defines when the ratelimit counter should be incremented. It is optional and
              * defaults to the same as the rule's expression.