cloudflare 3.1.0 → 3.2.0

package/src/resources/rulesets/rules.ts

@@ -5,6 +5,7 @@ import { APIResource } from "../../resource";
 import { isRequestOptions } from "../../core";
 import { CloudflareError } from "../../error";
 import * as RulesAPI from "./rules";
+import * as RulesetsAPI from "./rulesets";
 
 export class Rules extends APIResource {
   /**
@@ -215,6 +216,82 @@ export namespace BlockRule {
   }
 }
 
+export interface BlockRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'block';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: BlockRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace BlockRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * The response to show when the block is applied.
+     */
+    response?: ActionParameters.Response;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * The response to show when the block is applied.
+     */
+    export interface Response {
+      /**
+       * The content to return.
+       */
+      content: string;
+
+      /**
+       * The type of the content to return.
+       */
+      content_type: string;
+
+      /**
+       * The status code to return.
+       */
+      status_code: number;
+    }
+  }
+}
+
 export interface ChallengeRule {
   /**
    * The timestamp of when the rule was last modified.
@@ -272,6 +349,48 @@ export interface ChallengeRule {
   ref?: string;
 }
 
+export interface ChallengeRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'challenge';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: unknown;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
 export interface CompressResponseRule {
   /**
    * The timestamp of when the rule was last modified.
@@ -353,6 +472,72 @@ export namespace CompressResponseRule {
   }
 }
 
+export interface CompressResponseRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'compress_response';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: CompressResponseRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace CompressResponseRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Custom order for compression algorithms.
+     */
+    algorithms?: Array<ActionParameters.Algorithm>;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Compression algorithm to enable.
+     */
+    export interface Algorithm {
+      /**
+       * Name of compression algorithm to enable.
+       */
+      name?: 'none' | 'auto' | 'default' | 'gzip' | 'brotli';
+    }
+  }
+}
+
 export interface ExecuteRule {
   /**
    * The timestamp of when the rule was last modified.
@@ -535,17 +720,7 @@ export namespace ExecuteRule {
   }
 }
 
-export interface JSChallengeRule {
-  /**
-   * The timestamp of when the rule was last modified.
-   */
-  last_updated: string;
-
-  /**
-   * The version of the rule.
-   */
-  version: string;
-
+export interface ExecuteRuleParam {
   /**
    * The unique ID of the rule.
    */
@@ -554,17 +729,12 @@ export interface JSChallengeRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'js_challenge';
+  action?: 'execute';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: unknown;
-
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
+  action_parameters?: ExecuteRuleParam.ActionParameters;
 
   /**
    * An informative description of the rule.
@@ -584,7 +754,7 @@ export interface JSChallengeRule {
   /**
    * An object configuring the rule's logging behavior.
    */
-  logging?: Logging;
+  logging?: LoggingParam;
 
   /**
    * The reference of the rule (the rule ID by default).
@@ -592,36 +762,161 @@ export interface JSChallengeRule {
   ref?: string;
 }
 
-export interface LogRule {
+export namespace ExecuteRuleParam {
   /**
-   * The timestamp of when the rule was last modified.
+   * The parameters configuring the rule's action.
    */
-  last_updated: string;
+  export interface ActionParameters {
+    /**
+     * The ID of the ruleset to execute.
+     */
+    id: string;
 
-  /**
-   * The version of the rule.
-   */
-  version: string;
+    /**
+     * The configuration to use for matched data logging.
+     */
+    matched_data?: ActionParameters.MatchedData;
 
-  /**
-   * The unique ID of the rule.
-   */
-  id?: string;
+    /**
+     * A set of overrides to apply to the target ruleset.
+     */
+    overrides?: ActionParameters.Overrides;
+  }
 
-  /**
-   * The action to perform when the rule matches.
-   */
-  action?: 'log';
+  export namespace ActionParameters {
+    /**
+     * The configuration to use for matched data logging.
+     */
+    export interface MatchedData {
+      /**
+       * The public key to encrypt matched data logs with.
+       */
+      public_key: string;
+    }
 
-  /**
-   * The parameters configuring the rule's action.
-   */
-  action_parameters?: unknown;
+    /**
+     * A set of overrides to apply to the target ruleset.
+     */
+    export interface Overrides {
+      /**
+       * An action to override all rules with. This option has lower precedence than rule
+       * and category overrides.
+       */
+      action?: string;
 
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
+      /**
+       * A list of category-level overrides. This option has the second-highest
+       * precedence after rule-level overrides.
+       */
+      categories?: Array<Overrides.Category>;
+
+      /**
+       * Whether to enable execution of all rules. This option has lower precedence than
+       * rule and category overrides.
+       */
+      enabled?: boolean;
+
+      /**
+       * A list of rule-level overrides. This option has the highest precedence.
+       */
+      rules?: Array<Overrides.Rule>;
+
+      /**
+       * A sensitivity level to set for all rules. This option has lower precedence than
+       * rule and category overrides and is only applicable for DDoS phases.
+       */
+      sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
+    }
+
+    export namespace Overrides {
+      /**
+       * A category-level override
+       */
+      export interface Category {
+        /**
+         * The name of the category to override.
+         */
+        category: string;
+
+        /**
+         * The action to override rules in the category with.
+         */
+        action?: string;
+
+        /**
+         * Whether to enable execution of rules in the category.
+         */
+        enabled?: boolean;
+
+        /**
+         * The sensitivity level to use for rules in the category.
+         */
+        sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
+      }
+
+      /**
+       * A rule-level override
+       */
+      export interface Rule {
+        /**
+         * The ID of the rule to override.
+         */
+        id: string;
+
+        /**
+         * The action to override the rule with.
+         */
+        action?: string;
+
+        /**
+         * Whether to enable execution of the rule.
+         */
+        enabled?: boolean;
+
+        /**
+         * The score threshold to use for the rule.
+         */
+        score_threshold?: number;
+
+        /**
+         * The sensitivity level to use for the rule.
+         */
+        sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
+      }
+    }
+  }
+}
+
+export interface JSChallengeRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'js_challenge';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: unknown;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
 
   /**
    * An informative description of the rule.
@@ -649,27 +944,7 @@ export interface LogRule {
   ref?: string;
 }
 
-/**
- * An object configuring the rule's logging behavior.
- */
-export interface Logging {
-  /**
-   * Whether to generate a log when the rule matches.
-   */
-  enabled: boolean;
-}
-
-export interface ManagedChallengeRule {
-  /**
-   * The timestamp of when the rule was last modified.
-   */
-  last_updated: string;
-
-  /**
-   * The version of the rule.
-   */
-  version: string;
-
+export interface JSChallengeRuleParam {
   /**
    * The unique ID of the rule.
    */
@@ -678,18 +953,13 @@ export interface ManagedChallengeRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'managed_challenge';
+  action?: 'js_challenge';
 
   /**
    * The parameters configuring the rule's action.
    */
   action_parameters?: unknown;
 
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
-
   /**
    * An informative description of the rule.
    */
@@ -708,7 +978,7 @@ export interface ManagedChallengeRule {
   /**
    * An object configuring the rule's logging behavior.
    */
-  logging?: Logging;
+  logging?: LoggingParam;
 
   /**
    * The reference of the rule (the rule ID by default).
@@ -716,7 +986,7 @@ export interface ManagedChallengeRule {
   ref?: string;
 }
 
-export interface RedirectRule {
+export interface LogRule {
   /**
    * The timestamp of when the rule was last modified.
    */
@@ -735,12 +1005,12 @@ export interface RedirectRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'redirect';
+  action?: 'log';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: RedirectRule.ActionParameters;
+  action_parameters?: unknown;
 
   /**
    * The categories of the rule.
@@ -773,77 +1043,69 @@ export interface RedirectRule {
   ref?: string;
 }
 
-export namespace RedirectRule {
+export interface LogRuleParam {
   /**
-   * The parameters configuring the rule's action.
+   * The unique ID of the rule.
    */
-  export interface ActionParameters {
-    /**
-     * Serve a redirect based on a bulk list lookup.
-     */
-    from_list?: ActionParameters.FromList;
+  id?: string;
 
-    /**
-     * Serve a redirect based on the request properties.
-     */
-    from_value?: ActionParameters.FromValue;
-  }
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'log';
 
-  export namespace ActionParameters {
-    /**
-     * Serve a redirect based on a bulk list lookup.
-     */
-    export interface FromList {
-      /**
-       * Expression that evaluates to the list lookup key.
-       */
-      key?: string;
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: unknown;
 
-      /**
-       * The name of the list to match against.
-       */
-      name?: string;
-    }
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
 
-    /**
-     * Serve a redirect based on the request properties.
-     */
-    export interface FromValue {
-      /**
-       * Keep the query string of the original request.
-       */
-      preserve_query_string?: boolean;
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
 
-      /**
-       * The status code to be used for the redirect.
-       */
-      status_code?: 301 | 302 | 303 | 307 | 308;
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
 
-      /**
-       * The URL to redirect the request to.
-       */
-      target_url?: FromValue.StaticURLRedirect | FromValue.DynamicURLRedirect;
-    }
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
 
-    export namespace FromValue {
-      export interface StaticURLRedirect {
-        /**
-         * The URL to redirect the request to.
-         */
-        value?: string;
-      }
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
 
-      export interface DynamicURLRedirect {
-        /**
-         * An expression to evaluate to get the URL to redirect the request to.
-         */
-        expression?: string;
-      }
-    }
-  }
+/**
+ * An object configuring the rule's logging behavior.
+ */
+export interface Logging {
+  /**
+   * Whether to generate a log when the rule matches.
+   */
+  enabled: boolean;
 }
 
-export interface RewriteRule {
+/**
+ * An object configuring the rule's logging behavior.
+ */
+export interface LoggingParam {
+  /**
+   * Whether to generate a log when the rule matches.
+   */
+  enabled: boolean;
+}
+
+export interface ManagedChallengeRule {
   /**
    * The timestamp of when the rule was last modified.
    */
@@ -862,12 +1124,12 @@ export interface RewriteRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'rewrite';
+  action?: 'managed_challenge';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: RewriteRule.ActionParameters;
+  action_parameters?: unknown;
 
   /**
    * The categories of the rule.
@@ -900,103 +1162,7 @@ export interface RewriteRule {
   ref?: string;
 }
 
-export namespace RewriteRule {
-  /**
-   * The parameters configuring the rule's action.
-   */
-  export interface ActionParameters {
-    /**
-     * Map of request headers to modify.
-     */
-    headers?: Record<
-      string,
-      ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader
-    >;
-
-    /**
-     * URI to rewrite the request to.
-     */
-    uri?: ActionParameters.URI;
-  }
-
-  export namespace ActionParameters {
-    /**
-     * Remove the header from the request.
-     */
-    export interface RemoveHeader {
-      operation: 'remove';
-    }
-
-    /**
-     * Set a request header with a static value.
-     */
-    export interface StaticHeader {
-      operation: 'set';
-
-      /**
-       * Static value for the header.
-       */
-      value: string;
-    }
-
-    /**
-     * Set a request header with a dynamic value.
-     */
-    export interface DynamicHeader {
-      /**
-       * Expression for the header value.
-       */
-      expression: string;
-
-      operation: 'set';
-    }
-
-    /**
-     * URI to rewrite the request to.
-     */
-    export interface URI {
-      /**
-       * Path portion rewrite.
-       */
-      path?: RulesAPI.RewriteURIPart;
-
-      /**
-       * Query portion rewrite.
-       */
-      query?: RulesAPI.RewriteURIPart;
-    }
-  }
-}
-
-export type RewriteURIPart = RewriteURIPart.StaticValue | RewriteURIPart.DynamicValue;
-
-export namespace RewriteURIPart {
-  export interface StaticValue {
-    /**
-     * Predefined replacement value.
-     */
-    value: string;
-  }
-
-  export interface DynamicValue {
-    /**
-     * Expression to evaluate for the replacement value.
-     */
-    expression: string;
-  }
-}
-
-export interface RouteRule {
-  /**
-   * The timestamp of when the rule was last modified.
-   */
-  last_updated: string;
-
-  /**
-   * The version of the rule.
-   */
-  version: string;
-
+export interface ManagedChallengeRuleParam {
   /**
    * The unique ID of the rule.
    */
@@ -1005,17 +1171,12 @@ export interface RouteRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'route';
+  action?: 'managed_challenge';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: RouteRule.ActionParameters;
-
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
+  action_parameters?: unknown;
 
   /**
    * An informative description of the rule.
@@ -1035,7 +1196,7 @@ export interface RouteRule {
   /**
    * An object configuring the rule's logging behavior.
    */
-  logging?: Logging;
+  logging?: LoggingParam;
 
   /**
    * The reference of the rule (the rule ID by default).
@@ -1043,56 +1204,7 @@ export interface RouteRule {
   ref?: string;
 }
 
-export namespace RouteRule {
-  /**
-   * The parameters configuring the rule's action.
-   */
-  export interface ActionParameters {
-    /**
-     * Rewrite the HTTP Host header.
-     */
-    host_header?: string;
-
-    /**
-     * Override the IP/TCP destination.
-     */
-    origin?: ActionParameters.Origin;
-
-    /**
-     * Override the Server Name Indication (SNI).
-     */
-    sni?: ActionParameters.Sni;
-  }
-
-  export namespace ActionParameters {
-    /**
-     * Override the IP/TCP destination.
-     */
-    export interface Origin {
-      /**
-       * Override the resolved hostname.
-       */
-      host?: string;
-
-      /**
-       * Override the destination port.
-       */
-      port?: number;
-    }
-
-    /**
-     * Override the Server Name Indication (SNI).
-     */
-    export interface Sni {
-      /**
-       * The SNI override.
-       */
-      value: string;
-    }
-  }
-}
-
-export interface RulesetRule {
+export interface RedirectRule {
   /**
    * The timestamp of when the rule was last modified.
    */
@@ -1111,12 +1223,12 @@ export interface RulesetRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: string;
+  action?: 'redirect';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: unknown;
+  action_parameters?: RedirectRule.ActionParameters;
 
   /**
    * The categories of the rule.
@@ -1149,17 +1261,77 @@ export interface RulesetRule {
   ref?: string;
 }
 
-export interface ScoreRule {
+export namespace RedirectRule {
   /**
-   * The timestamp of when the rule was last modified.
+   * The parameters configuring the rule's action.
    */
-  last_updated: string;
+  export interface ActionParameters {
+    /**
+     * Serve a redirect based on a bulk list lookup.
+     */
+    from_list?: ActionParameters.FromList;
 
-  /**
-   * The version of the rule.
-   */
-  version: string;
+    /**
+     * Serve a redirect based on the request properties.
+     */
+    from_value?: ActionParameters.FromValue;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Serve a redirect based on a bulk list lookup.
+     */
+    export interface FromList {
+      /**
+       * Expression that evaluates to the list lookup key.
+       */
+      key?: string;
+
+      /**
+       * The name of the list to match against.
+       */
+      name?: string;
+    }
+
+    /**
+     * Serve a redirect based on the request properties.
+     */
+    export interface FromValue {
+      /**
+       * Keep the query string of the original request.
+       */
+      preserve_query_string?: boolean;
+
+      /**
+       * The status code to be used for the redirect.
+       */
+      status_code?: 301 | 302 | 303 | 307 | 308;
+
+      /**
+       * The URL to redirect the request to.
+       */
+      target_url?: FromValue.StaticURLRedirect | FromValue.DynamicURLRedirect;
+    }
+
+    export namespace FromValue {
+      export interface StaticURLRedirect {
+        /**
+         * The URL to redirect the request to.
+         */
+        value?: string;
+      }
+
+      export interface DynamicURLRedirect {
+        /**
+         * An expression to evaluate to get the URL to redirect the request to.
+         */
+        expression?: string;
+      }
+    }
+  }
+}
 
+export interface RedirectRuleParam {
   /**
    * The unique ID of the rule.
    */
@@ -1168,17 +1340,12 @@ export interface ScoreRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'score';
+  action?: 'redirect';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: ScoreRule.ActionParameters;
-
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
+  action_parameters?: RedirectRuleParam.ActionParameters;
 
   /**
    * An informative description of the rule.
@@ -1198,7 +1365,7 @@ export interface ScoreRule {
   /**
    * An object configuring the rule's logging behavior.
    */
-  logging?: Logging;
+  logging?: LoggingParam;
 
   /**
    * The reference of the rule (the rule ID by default).
@@ -1206,23 +1373,80 @@ export interface ScoreRule {
   ref?: string;
 }
 
-export namespace ScoreRule {
+export namespace RedirectRuleParam {
   /**
    * The parameters configuring the rule's action.
    */
   export interface ActionParameters {
     /**
-     * Increment contains the delta to change the score and can be either positive or
-     * negative.
+     * Serve a redirect based on a bulk list lookup.
      */
-    increment?: number;
+    from_list?: ActionParameters.FromList;
+
+    /**
+     * Serve a redirect based on the request properties.
+     */
+    from_value?: ActionParameters.FromValue;
   }
-}
 
-export interface ServeErrorRule {
-  /**
-   * The timestamp of when the rule was last modified.
-   */
+  export namespace ActionParameters {
+    /**
+     * Serve a redirect based on a bulk list lookup.
+     */
+    export interface FromList {
+      /**
+       * Expression that evaluates to the list lookup key.
+       */
+      key?: string;
+
+      /**
+       * The name of the list to match against.
+       */
+      name?: string;
+    }
+
+    /**
+     * Serve a redirect based on the request properties.
+     */
+    export interface FromValue {
+      /**
+       * Keep the query string of the original request.
+       */
+      preserve_query_string?: boolean;
+
+      /**
+       * The status code to be used for the redirect.
+       */
+      status_code?: 301 | 302 | 303 | 307 | 308;
+
+      /**
+       * The URL to redirect the request to.
+       */
+      target_url?: FromValue.StaticURLRedirect | FromValue.DynamicURLRedirect;
+    }
+
+    export namespace FromValue {
+      export interface StaticURLRedirect {
+        /**
+         * The URL to redirect the request to.
+         */
+        value?: string;
+      }
+
+      export interface DynamicURLRedirect {
+        /**
+         * An expression to evaluate to get the URL to redirect the request to.
+         */
+        expression?: string;
+      }
+    }
+  }
+}
+
+export interface RewriteRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
   last_updated: string;
 
   /**
@@ -1238,12 +1462,12 @@ export interface ServeErrorRule {
   /**
    * The action to perform when the rule matches.
    */
-  action?: 'serve_error';
+  action?: 'rewrite';
 
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: ServeErrorRule.ActionParameters;
+  action_parameters?: RewriteRule.ActionParameters;
 
   /**
    * The categories of the rule.
@@ -1276,39 +1500,1178 @@ export interface ServeErrorRule {
   ref?: string;
 }
 
-export namespace ServeErrorRule {
+export namespace RewriteRule {
   /**
    * The parameters configuring the rule's action.
    */
   export interface ActionParameters {
     /**
-     * Error response content.
+     * Map of request headers to modify.
      */
-    content?: string;
+    headers?: Record<
+      string,
+      ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader
+    >;
 
     /**
-     * Content-type header to set with the response.
+     * URI to rewrite the request to.
      */
-    content_type?: 'application/json' | 'text/xml' | 'text/plain' | 'text/html';
+    uri?: ActionParameters.URI;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Remove the header from the request.
+     */
+    export interface RemoveHeader {
+      operation: 'remove';
+    }
+
+    /**
+     * Set a request header with a static value.
+     */
+    export interface StaticHeader {
+      operation: 'set';
+
+      /**
+       * Static value for the header.
+       */
+      value: string;
+    }
+
+    /**
+     * Set a request header with a dynamic value.
+     */
+    export interface DynamicHeader {
+      /**
+       * Expression for the header value.
+       */
+      expression: string;
+
+      operation: 'set';
+    }
+
+    /**
+     * URI to rewrite the request to.
+     */
+    export interface URI {
+      /**
+       * Path portion rewrite.
+       */
+      path?: RulesAPI.RewriteURIPart;
+
+      /**
+       * Query portion rewrite.
+       */
+      query?: RulesAPI.RewriteURIPart;
+    }
+  }
+}
+
+export interface RewriteRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'rewrite';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: RewriteRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace RewriteRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Map of request headers to modify.
+     */
+    headers?: Record<
+      string,
+      ActionParameters.RemoveHeader | ActionParameters.StaticHeader | ActionParameters.DynamicHeader
+    >;
+
+    /**
+     * URI to rewrite the request to.
+     */
+    uri?: ActionParameters.URI;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Remove the header from the request.
+     */
+    export interface RemoveHeader {
+      operation: 'remove';
+    }
+
+    /**
+     * Set a request header with a static value.
+     */
+    export interface StaticHeader {
+      operation: 'set';
+
+      /**
+       * Static value for the header.
+       */
+      value: string;
+    }
+
+    /**
+     * Set a request header with a dynamic value.
+     */
+    export interface DynamicHeader {
+      /**
+       * Expression for the header value.
+       */
+      expression: string;
+
+      operation: 'set';
+    }
+
+    /**
+     * URI to rewrite the request to.
+     */
+    export interface URI {
+      /**
+       * Path portion rewrite.
+       */
+      path?: RulesAPI.RewriteURIPartParam;
+
+      /**
+       * Query portion rewrite.
+       */
+      query?: RulesAPI.RewriteURIPartParam;
+    }
+  }
+}
+
+export type RewriteURIPart = RewriteURIPart.StaticValue | RewriteURIPart.DynamicValue;
+
+export namespace RewriteURIPart {
+  export interface StaticValue {
+    /**
+     * Predefined replacement value.
+     */
+    value: string;
+  }
+
+  export interface DynamicValue {
+    /**
+     * Expression to evaluate for the replacement value.
+     */
+    expression: string;
+  }
+}
+
+export type RewriteURIPartParam = RewriteURIPartParam.StaticValue | RewriteURIPartParam.DynamicValue;
+
+export namespace RewriteURIPartParam {
+  export interface StaticValue {
+    /**
+     * Predefined replacement value.
+     */
+    value: string;
+  }
+
+  export interface DynamicValue {
+    /**
+     * Expression to evaluate for the replacement value.
+     */
+    expression: string;
+  }
+}
+
+export interface RouteRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'route';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: RouteRule.ActionParameters;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: Logging;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace RouteRule {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Rewrite the HTTP Host header.
+     */
+    host_header?: string;
+
+    /**
+     * Override the IP/TCP destination.
+     */
+    origin?: ActionParameters.Origin;
+
+    /**
+     * Override the Server Name Indication (SNI).
+     */
+    sni?: ActionParameters.SNI;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Override the IP/TCP destination.
+     */
+    export interface Origin {
+      /**
+       * Override the resolved hostname.
+       */
+      host?: string;
+
+      /**
+       * Override the destination port.
+       */
+      port?: number;
+    }
+
+    /**
+     * Override the Server Name Indication (SNI).
+     */
+    export interface SNI {
+      /**
+       * The SNI override.
+       */
+      value: string;
+    }
+  }
+}
+
+export interface RouteRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'route';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: RouteRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace RouteRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Rewrite the HTTP Host header.
+     */
+    host_header?: string;
+
+    /**
+     * Override the IP/TCP destination.
+     */
+    origin?: ActionParameters.Origin;
+
+    /**
+     * Override the Server Name Indication (SNI).
+     */
+    sni?: ActionParameters.SNI;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Override the IP/TCP destination.
+     */
+    export interface Origin {
+      /**
+       * Override the resolved hostname.
+       */
+      host?: string;
+
+      /**
+       * Override the destination port.
+       */
+      port?: number;
+    }
+
+    /**
+     * Override the Server Name Indication (SNI).
+     */
+    export interface SNI {
+      /**
+       * The SNI override.
+       */
+      value: string;
+    }
+  }
+}
+
+export interface RulesetRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: string;
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: unknown;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: Logging;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export interface ScoreRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'score';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: ScoreRule.ActionParameters;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: Logging;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace ScoreRule {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Increment contains the delta to change the score and can be either positive or
+     * negative.
+     */
+    increment?: number;
+  }
+}
+
+export interface ScoreRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'score';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: ScoreRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace ScoreRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Increment contains the delta to change the score and can be either positive or
+     * negative.
+     */
+    increment?: number;
+  }
+}
+
+export interface ServeErrorRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'serve_error';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: ServeErrorRule.ActionParameters;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: Logging;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace ServeErrorRule {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Error response content.
+     */
+    content?: string;
+
+    /**
+     * Content-type header to set with the response.
+     */
+    content_type?: 'application/json' | 'text/xml' | 'text/plain' | 'text/html';
+
+    /**
+     * The status code to use for the error.
+     */
+    status_code?: number;
+  }
+}
+
+export interface ServeErrorRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'serve_error';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: ServeErrorRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace ServeErrorRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Error response content.
+     */
+    content?: string;
+
+    /**
+     * Content-type header to set with the response.
+     */
+    content_type?: 'application/json' | 'text/xml' | 'text/plain' | 'text/html';
+
+    /**
+     * The status code to use for the error.
+     */
+    status_code?: number;
+  }
+}
+
+export interface SetCacheSettingsRule {
+  /**
+   * The timestamp of when the rule was last modified.
+   */
+  last_updated: string;
+
+  /**
+   * The version of the rule.
+   */
+  version: string;
+
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'set_cache_settings';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: SetCacheSettingsRule.ActionParameters;
+
+  /**
+   * The categories of the rule.
+   */
+  categories?: Array<string>;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: Logging;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace SetCacheSettingsRule {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * List of additional ports that caching can be enabled on.
+     */
+    additional_cacheable_ports?: Array<number>;
+
+    /**
+     * Specify how long client browsers should cache the response. Cloudflare cache
+     * purge will not purge content cached on client browsers, so high browser TTLs may
+     * lead to stale content.
+     */
+    browser_ttl?: ActionParameters.BrowserTTL;
+
+    /**
+     * Mark whether the request’s response from origin is eligible for caching. Caching
+     * itself will still depend on the cache-control header and your other caching
+     * configurations.
+     */
+    cache?: boolean;
+
+    /**
+     * Define which components of the request are included or excluded from the cache
+     * key Cloudflare uses to store the response in cache.
+     */
+    cache_key?: ActionParameters.CacheKey;
+
+    /**
+     * Mark whether the request's response from origin is eligible for Cache Reserve
+     * (requires a Cache Reserve add-on plan).
+     */
+    cache_reserve?: ActionParameters.CacheReserve;
+
+    /**
+     * TTL (Time to Live) specifies the maximum time to cache a resource in the
+     * Cloudflare edge network.
+     */
+    edge_ttl?: ActionParameters.EdgeTTL;
+
+    /**
+     * When enabled, Cloudflare will aim to strictly adhere to RFC 7234.
+     */
+    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
+     */
+    origin_error_page_passthru?: boolean;
+
+    /**
+     * Define a timeout value between two successive read operations to your origin
+     * server. Historically, the timeout value between two read options from Cloudflare
+     * to an origin server is 100 seconds. If you are attempting to reduce HTTP 524
+     * errors because of timeouts from an origin server, try increasing this timeout
+     * value.
+     */
+    read_timeout?: number;
+
+    /**
+     * Specify whether or not Cloudflare should respect strong ETag (entity tag)
+     * headers. When off, Cloudflare converts strong ETag headers to weak ETag headers.
+     */
+    respect_strong_etags?: boolean;
+
+    /**
+     * Define if Cloudflare should serve stale content while getting the latest content
+     * from the origin. If on, Cloudflare will not serve stale content while getting
+     * the latest content from the origin.
+     */
+    serve_stale?: ActionParameters.ServeStale;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Specify how long client browsers should cache the response. Cloudflare cache
+     * purge will not purge content cached on client browsers, so high browser TTLs may
+     * lead to stale content.
+     */
+    export interface BrowserTTL {
+      /**
+       * Determines which browser ttl mode to use.
+       */
+      mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
+
+      /**
+       * The TTL (in seconds) if you choose override_origin mode.
+       */
+      default?: number;
+    }
+
+    /**
+     * Define which components of the request are included or excluded from the cache
+     * key Cloudflare uses to store the response in cache.
+     */
+    export interface CacheKey {
+      /**
+       * 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
+       */
+      cache_deception_armor?: boolean;
+
+      /**
+       * Customize which components of the request are included or excluded from the
+       * cache key.
+       */
+      custom_key?: CacheKey.CustomKey;
+
+      /**
+       * Treat requests with the same query parameters the same, regardless of the order
+       * those query parameters are in. A value of true ignores the query strings' order.
+       */
+      ignore_query_strings_order?: boolean;
+    }
+
+    export namespace CacheKey {
+      /**
+       * Customize which components of the request are included or excluded from the
+       * cache key.
+       */
+      export interface CustomKey {
+        /**
+         * The cookies to include in building the cache key.
+         */
+        cookie?: CustomKey.Cookie;
+
+        /**
+         * The header names and values to include in building the cache key.
+         */
+        header?: CustomKey.Header;
+
+        /**
+         * Whether to use the original host or the resolved host in the cache key.
+         */
+        host?: CustomKey.Host;
+
+        /**
+         * Use the presence or absence of parameters in the query string to build the cache
+         * key.
+         */
+        query_string?: CustomKey.QueryString;
+
+        /**
+         * Characteristics of the request user agent used in building the cache key.
+         */
+        user?: CustomKey.User;
+      }
+
+      export namespace CustomKey {
+        /**
+         * The cookies to include in building the cache key.
+         */
+        export interface Cookie {
+          /**
+           * Checks for the presence of these cookie names. The presence of these cookies is
+           * used in building the cache key.
+           */
+          check_presence?: Array<string>;
+
+          /**
+           * Include these cookies' names and their values.
+           */
+          include?: Array<string>;
+        }
+
+        /**
+         * The header names and values to include in building the cache key.
+         */
+        export interface Header {
+          /**
+           * Checks for the presence of these header names. The presence of these headers is
+           * used in building the cache key.
+           */
+          check_presence?: Array<string>;
+
+          /**
+           * Whether or not to include the origin header. A value of true will exclude the
+           * origin header in the cache key.
+           */
+          exclude_origin?: boolean;
+
+          /**
+           * Include these headers' names and their values.
+           */
+          include?: Array<string>;
+        }
+
+        /**
+         * Whether to use the original host or the resolved host in the cache key.
+         */
+        export interface Host {
+          /**
+           * Use the resolved host in the cache key. A value of true will use the resolved
+           * host, while a value or false will use the original host.
+           */
+          resolved?: boolean;
+        }
+
+        /**
+         * Use the presence or absence of parameters in the query string to build the cache
+         * key.
+         */
+        export interface QueryString {
+          /**
+           * build the cache key using all query string parameters EXCECPT these excluded
+           * parameters
+           */
+          exclude?: QueryString.Exclude;
+
+          /**
+           * build the cache key using a list of query string parameters that ARE in the
+           * request.
+           */
+          include?: QueryString.Include;
+        }
+
+        export namespace QueryString {
+          /**
+           * build the cache key using all query string parameters EXCECPT these excluded
+           * parameters
+           */
+          export interface Exclude {
+            /**
+             * Exclude all query string parameters from use in building the cache key.
+             */
+            all?: boolean;
+
+            /**
+             * A list of query string parameters NOT used to build the cache key. All
+             * parameters present in the request but missing in this list will be used to build
+             * the cache key.
+             */
+            list?: Array<string>;
+          }
+
+          /**
+           * build the cache key using a list of query string parameters that ARE in the
+           * request.
+           */
+          export interface Include {
+            /**
+             * Use all query string parameters in the cache key.
+             */
+            all?: boolean;
+
+            /**
+             * A list of query string parameters used to build the cache key.
+             */
+            list?: Array<string>;
+          }
+        }
+
+        /**
+         * Characteristics of the request user agent used in building the cache key.
+         */
+        export interface User {
+          /**
+           * Use the user agent's device type in the cache key.
+           */
+          device_type?: boolean;
+
+          /**
+           * Use the user agents's country in the cache key.
+           */
+          geo?: boolean;
+
+          /**
+           * Use the user agent's language in the cache key.
+           */
+          lang?: boolean;
+        }
+      }
+    }
+
+    /**
+     * Mark whether the request's response from origin is eligible for Cache Reserve
+     * (requires a Cache Reserve add-on plan).
+     */
+    export interface CacheReserve {
+      /**
+       * Determines whether cache reserve is enabled. If this is true and a request meets
+       * eligibility criteria, Cloudflare will write the resource to cache reserve.
+       */
+      eligible: boolean;
+
+      /**
+       * The minimum file size eligible for store in cache reserve.
+       */
+      min_file_size: number;
+    }
+
+    /**
+     * TTL (Time to Live) specifies the maximum time to cache a resource in the
+     * Cloudflare edge network.
+     */
+    export interface EdgeTTL {
+      /**
+       * The TTL (in seconds) if you choose override_origin mode.
+       */
+      default: number;
+
+      /**
+       * 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
+       */
+      status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
+    }
+
+    export 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
+       */
+      export interface StatusCodeTTL {
+        /**
+         * Time to cache a response (in seconds). A value of 0 is equivalent to setting the
+         * Cache-Control header with the value "no-cache". A value of -1 is equivalent to
+         * setting Cache-Control header with the value of "no-store".
+         */
+        value: number;
+
+        /**
+         * The range of status codes used to apply the selected mode.
+         */
+        status_code_range?: StatusCodeTTL.StatusCodeRange;
+
+        /**
+         * Set the ttl for responses with this specific status code
+         */
+        status_code_value?: number;
+      }
+
+      export namespace StatusCodeTTL {
+        /**
+         * The range of status codes used to apply the selected mode.
+         */
+        export interface StatusCodeRange {
+          /**
+           * response status code lower bound
+           */
+          from: number;
+
+          /**
+           * response status code upper bound
+           */
+          to: number;
+        }
+      }
+    }
 
     /**
-     * The status code to use for the error.
+     * Define if Cloudflare should serve stale content while getting the latest content
+     * from the origin. If on, Cloudflare will not serve stale content while getting
+     * the latest content from the origin.
      */
-    status_code?: number;
+    export interface ServeStale {
+      /**
+       * Defines whether Cloudflare should serve stale content while updating. If true,
+       * Cloudflare will not serve stale content while getting the latest content from
+       * the origin.
+       */
+      disable_stale_while_updating: boolean;
+    }
   }
 }
 
-export interface SetCacheSettingsRule {
-  /**
-   * The timestamp of when the rule was last modified.
-   */
-  last_updated: string;
-
-  /**
-   * The version of the rule.
-   */
-  version: string;
-
+export interface SetCacheSettingsRuleParam {
   /**
    * The unique ID of the rule.
    */
@@ -1322,12 +2685,7 @@ export interface SetCacheSettingsRule {
   /**
    * The parameters configuring the rule's action.
    */
-  action_parameters?: SetCacheSettingsRule.ActionParameters;
-
-  /**
-   * The categories of the rule.
-   */
-  categories?: Array<string>;
+  action_parameters?: SetCacheSettingsRuleParam.ActionParameters;
 
   /**
    * An informative description of the rule.
@@ -1347,7 +2705,7 @@ export interface SetCacheSettingsRule {
   /**
    * An object configuring the rule's logging behavior.
    */
-  logging?: Logging;
+  logging?: LoggingParam;
 
   /**
    * The reference of the rule (the rule ID by default).
@@ -1355,7 +2713,7 @@ export interface SetCacheSettingsRule {
   ref?: string;
 }
 
-export namespace SetCacheSettingsRule {
+export namespace SetCacheSettingsRuleParam {
   /**
    * The parameters configuring the rule's action.
    */
@@ -1894,6 +3252,152 @@ export namespace SetConfigRule {
   }
 }
 
+export interface SetConfigRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'set_config';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: SetConfigRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace SetConfigRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * Turn on or off Automatic HTTPS Rewrites.
+     */
+    automatic_https_rewrites?: boolean;
+
+    /**
+     * Select which file extensions to minify automatically.
+     */
+    autominify?: ActionParameters.Autominify;
+
+    /**
+     * Turn on or off Browser Integrity Check.
+     */
+    bic?: boolean;
+
+    /**
+     * Turn off all active Cloudflare Apps.
+     */
+    disable_apps?: boolean;
+
+    /**
+     * Turn off Zaraz.
+     */
+    disable_zaraz?: boolean;
+
+    /**
+     * Turn on or off Email Obfuscation.
+     */
+    email_obfuscation?: boolean;
+
+    /**
+     * Turn on or off the Hotlink Protection.
+     */
+    hotlink_protection?: boolean;
+
+    /**
+     * Turn on or off Mirage.
+     */
+    mirage?: boolean;
+
+    /**
+     * Turn on or off Opportunistic Encryption.
+     */
+    opportunistic_encryption?: boolean;
+
+    /**
+     * Configure the Polish level.
+     */
+    polish?: 'off' | 'lossless' | 'lossy';
+
+    /**
+     * Turn on or off Rocket Loader
+     */
+    rocket_loader?: boolean;
+
+    /**
+     * Configure the Security Level.
+     */
+    security_level?: 'off' | 'essentially_off' | 'low' | 'medium' | 'high' | 'under_attack';
+
+    /**
+     * Turn on or off Server Side Excludes.
+     */
+    server_side_excludes?: boolean;
+
+    /**
+     * Configure the SSL level.
+     */
+    ssl?: 'off' | 'flexible' | 'full' | 'strict' | 'origin_pull';
+
+    /**
+     * Turn on or off Signed Exchanges (SXG).
+     */
+    sxg?: boolean;
+  }
+
+  export namespace ActionParameters {
+    /**
+     * Select which file extensions to minify automatically.
+     */
+    export interface Autominify {
+      /**
+       * Minify CSS files.
+       */
+      css?: boolean;
+
+      /**
+       * Minify HTML files.
+       */
+      html?: boolean;
+
+      /**
+       * Minify JS files.
+       */
+      js?: boolean;
+    }
+  }
+}
+
 export interface SkipRule {
   /**
    * The timestamp of when the rule was last modified.
@@ -1960,31 +3464,85 @@ export namespace SkipRule {
      * A list of phases to skip the execution of. This option is incompatible with the
      * ruleset and rulesets options.
      */
-    phases?: Array<
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed'
-    >;
+    phases?: Array<RulesetsAPI.Phase>;
+
+    /**
+     * A list of legacy security products to skip the execution of.
+     */
+    products?: Array<'bic' | 'hot' | 'rateLimit' | 'securityLevel' | 'uaBlock' | 'waf' | 'zoneLockdown'>;
+
+    /**
+     * A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the
+     * execution of. This option is incompatible with the ruleset option.
+     */
+    rules?: Record<string, Array<string>>;
+
+    /**
+     * A ruleset to skip the execution of. This option is incompatible with the
+     * rulesets, rules and phases options.
+     */
+    ruleset?: 'current';
+
+    /**
+     * A list of ruleset IDs to skip the execution of. This option is incompatible with
+     * the ruleset and phases options.
+     */
+    rulesets?: Array<string>;
+  }
+}
+
+export interface SkipRuleParam {
+  /**
+   * The unique ID of the rule.
+   */
+  id?: string;
+
+  /**
+   * The action to perform when the rule matches.
+   */
+  action?: 'skip';
+
+  /**
+   * The parameters configuring the rule's action.
+   */
+  action_parameters?: SkipRuleParam.ActionParameters;
+
+  /**
+   * An informative description of the rule.
+   */
+  description?: string;
+
+  /**
+   * Whether the rule should be executed.
+   */
+  enabled?: boolean;
+
+  /**
+   * The expression defining which traffic will match the rule.
+   */
+  expression?: string;
+
+  /**
+   * An object configuring the rule's logging behavior.
+   */
+  logging?: LoggingParam;
+
+  /**
+   * The reference of the rule (the rule ID by default).
+   */
+  ref?: string;
+}
+
+export namespace SkipRuleParam {
+  /**
+   * The parameters configuring the rule's action.
+   */
+  export interface ActionParameters {
+    /**
+     * A list of phases to skip the execution of. This option is incompatible with the
+     * ruleset and rulesets options.
+     */
+    phases?: Array<RulesetsAPI.PhaseParam>;
 
     /**
      * A list of legacy security products to skip the execution of.
@@ -2023,7 +3581,7 @@ export interface RuleCreateResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -2038,30 +3596,7 @@ export interface RuleCreateResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.
@@ -2107,7 +3642,7 @@ export interface RuleDeleteResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -2122,30 +3657,7 @@ export interface RuleDeleteResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.
@@ -2191,7 +3703,7 @@ export interface RuleEditResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -2206,30 +3718,7 @@ export interface RuleEditResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.
@@ -2327,7 +3816,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2415,7 +3904,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2469,7 +3958,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2547,7 +4036,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2726,7 +4215,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2780,7 +4269,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2834,7 +4323,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -2888,7 +4377,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3012,7 +4501,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3078,12 +4567,12 @@ export namespace RuleCreateParams {
         /**
          * Path portion rewrite.
          */
-        path?: RulesAPI.RewriteURIPart;
+        path?: RulesAPI.RewriteURIPartParam;
 
         /**
          * Query portion rewrite.
          */
-        query?: RulesAPI.RewriteURIPart;
+        query?: RulesAPI.RewriteURIPartParam;
       }
     }
   }
@@ -3134,7 +4623,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3160,7 +4649,7 @@ export namespace RuleCreateParams {
       /**
        * Override the Server Name Indication (SNI).
        */
-      sni?: ActionParameters.Sni;
+      sni?: ActionParameters.SNI;
     }
 
     export namespace ActionParameters {
@@ -3182,7 +4671,7 @@ export namespace RuleCreateParams {
       /**
        * Override the Server Name Indication (SNI).
        */
-      export interface Sni {
+      export interface SNI {
         /**
          * The SNI override.
          */
@@ -3237,7 +4726,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3304,7 +4793,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3380,7 +4869,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3538,7 +5027,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -3555,31 +5044,7 @@ export namespace RuleCreateParams {
        * A list of phases to skip the execution of. This option is incompatible with the
        * ruleset and rulesets options.
        */
-      phases?: Array<
-        | 'ddos_l4'
-        | 'ddos_l7'
-        | 'http_config_settings'
-        | 'http_custom_errors'
-        | 'http_log_custom_fields'
-        | 'http_ratelimit'
-        | 'http_request_cache_settings'
-        | 'http_request_dynamic_redirect'
-        | 'http_request_firewall_custom'
-        | 'http_request_firewall_managed'
-        | 'http_request_late_transform'
-        | 'http_request_origin'
-        | 'http_request_redirect'
-        | 'http_request_sanitize'
-        | 'http_request_sbfm'
-        | 'http_request_select_configuration'
-        | 'http_request_transform'
-        | 'http_response_compression'
-        | 'http_response_firewall_managed'
-        | 'http_response_headers_transform'
-        | 'magic_transit'
-        | 'magic_transit_ids_managed'
-        | 'magic_transit_managed'
-      >;
+      phases?: Array<RulesetsAPI.PhaseParam>;
 
       /**
        * A list of legacy security products to skip the execution of.
@@ -3652,7 +5117,7 @@ export namespace RuleCreateParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4115,7 +5580,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4203,7 +5668,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4257,7 +5722,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4335,7 +5800,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4514,7 +5979,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4568,7 +6033,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4622,7 +6087,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4676,7 +6141,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4800,7 +6265,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4866,12 +6331,12 @@ export namespace RuleEditParams {
         /**
          * Path portion rewrite.
          */
-        path?: RulesAPI.RewriteURIPart;
+        path?: RulesAPI.RewriteURIPartParam;
 
         /**
          * Query portion rewrite.
          */
-        query?: RulesAPI.RewriteURIPart;
+        query?: RulesAPI.RewriteURIPartParam;
       }
     }
   }
@@ -4922,7 +6387,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -4948,7 +6413,7 @@ export namespace RuleEditParams {
       /**
        * Override the Server Name Indication (SNI).
        */
-      sni?: ActionParameters.Sni;
+      sni?: ActionParameters.SNI;
     }
 
     export namespace ActionParameters {
@@ -4970,7 +6435,7 @@ export namespace RuleEditParams {
       /**
        * Override the Server Name Indication (SNI).
        */
-      export interface Sni {
+      export interface SNI {
         /**
          * The SNI override.
          */
@@ -5025,7 +6490,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -5092,7 +6557,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -5168,7 +6633,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -5326,7 +6791,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).
@@ -5343,31 +6808,7 @@ export namespace RuleEditParams {
        * A list of phases to skip the execution of. This option is incompatible with the
        * ruleset and rulesets options.
        */
-      phases?: Array<
-        | 'ddos_l4'
-        | 'ddos_l7'
-        | 'http_config_settings'
-        | 'http_custom_errors'
-        | 'http_log_custom_fields'
-        | 'http_ratelimit'
-        | 'http_request_cache_settings'
-        | 'http_request_dynamic_redirect'
-        | 'http_request_firewall_custom'
-        | 'http_request_firewall_managed'
-        | 'http_request_late_transform'
-        | 'http_request_origin'
-        | 'http_request_redirect'
-        | 'http_request_sanitize'
-        | 'http_request_sbfm'
-        | 'http_request_select_configuration'
-        | 'http_request_transform'
-        | 'http_response_compression'
-        | 'http_response_firewall_managed'
-        | 'http_response_headers_transform'
-        | 'magic_transit'
-        | 'magic_transit_ids_managed'
-        | 'magic_transit_managed'
-      >;
+      phases?: Array<RulesetsAPI.PhaseParam>;
 
       /**
        * A list of legacy security products to skip the execution of.
@@ -5440,7 +6881,7 @@ export namespace RuleEditParams {
     /**
      * Body param: An object configuring the rule's logging behavior.
      */
-    logging?: Logging;
+    logging?: LoggingParam;
 
     /**
      * Body param: The reference of the rule (the rule ID by default).