cloudflare 3.0.0-beta.8 → 3.0.0

package/src/resources/rulesets/rules.ts

@@ -16,7 +16,7 @@ export class Rules extends APIResource {
     rulesetId: string,
     params: RuleCreateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RulesetsAPI.RulesetsRulesetResponse> {
+  ): Core.APIPromise<RulesetsAPI.Ruleset> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -38,7 +38,7 @@ export class Rules extends APIResource {
       this._client.post(`/${accountOrZone}/${accountOrZoneId}/rulesets/${rulesetId}/rules`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: RulesetsAPI.RulesetsRulesetResponse }>
+      }) as Core.APIPromise<{ result: RulesetsAPI.Ruleset }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -50,18 +50,18 @@ export class Rules extends APIResource {
     ruleId: string,
     params?: RuleDeleteParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RulesetsAPI.RulesetsRulesetResponse>;
+  ): Core.APIPromise<RulesetsAPI.Ruleset>;
   delete(
     rulesetId: string,
     ruleId: string,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RulesetsAPI.RulesetsRulesetResponse>;
+  ): Core.APIPromise<RulesetsAPI.Ruleset>;
   delete(
     rulesetId: string,
     ruleId: string,
     params: RuleDeleteParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RulesetsAPI.RulesetsRulesetResponse> {
+  ): Core.APIPromise<RulesetsAPI.Ruleset> {
     if (isRequestOptions(params)) {
       return this.delete(rulesetId, ruleId, {}, params);
     }
@@ -86,19 +86,19 @@ export class Rules extends APIResource {
       this._client.delete(
         `/${accountOrZone}/${accountOrZoneId}/rulesets/${rulesetId}/rules/${ruleId}`,
         options,
-      ) as Core.APIPromise<{ result: RulesetsAPI.RulesetsRulesetResponse }>
+      ) as Core.APIPromise<{ result: RulesetsAPI.Ruleset }>
     )._thenUnwrap((obj) => obj.result);
   }
 
   /**
-   * Updates an existing rule in an account ruleset.
+   * Updates an existing rule in an account or zone ruleset.
    */
   edit(
     rulesetId: string,
     ruleId: string,
     params: RuleEditParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RulesetsAPI.RulesetsRulesetResponse> {
+  ): Core.APIPromise<RulesetsAPI.Ruleset> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -120,64 +120,493 @@ export class Rules extends APIResource {
       this._client.patch(`/${accountOrZone}/${accountOrZoneId}/rulesets/${rulesetId}/rules/${ruleId}`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: RulesetsAPI.RulesetsRulesetResponse }>
+      }) as Core.APIPromise<{ result: RulesetsAPI.Ruleset }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface RuleCreateParams {
-  /**
-   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
-   * Zone ID.
-   */
-  account_id?: string;
+export type RuleCreateParams =
+  | RuleCreateParams.RulesetsBlockRule
+  | RuleCreateParams.RulesetsExecuteRule
+  | RuleCreateParams.RulesetsLogRule
+  | RuleCreateParams.RulesetsSkipRule;
 
-  /**
-   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
-   * Account ID.
-   */
-  zone_id?: string;
+export namespace RuleCreateParams {
+  export interface RulesetsBlockRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
 
-  /**
-   * Body param: An object configuring where the rule will be placed.
-   */
-  position?:
-    | RuleCreateParams.BeforePosition
-    | RuleCreateParams.AfterPosition
-    | RuleCreateParams.IndexPosition;
-}
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'block';
 
-export namespace RuleCreateParams {
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface BeforePosition {
     /**
-     * The ID of another rule to place the rule before. An empty value causes the rule
-     * to be placed at the top.
+     * Body param: The parameters configuring the rule's action.
      */
-    before?: string;
+    action_parameters?: RuleCreateParams.RulesetsBlockRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleCreateParams.RulesetsBlockRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
   }
 
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface AfterPosition {
+  export namespace RulesetsBlockRule {
+    /**
+     * 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;
+      }
+    }
+
     /**
-     * The ID of another rule to place the rule after. An empty value causes the rule
-     * to be placed at the bottom.
+     * An object configuring the rule's logging behavior.
      */
-    after?: string;
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
   }
 
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface IndexPosition {
+  export interface RulesetsExecuteRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'execute';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: RuleCreateParams.RulesetsExecuteRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
     /**
-     * An index at which to place the rule, where index 1 is the first rule.
+     * Body param: Whether the rule should be executed.
      */
-    index?: number;
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleCreateParams.RulesetsExecuteRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsExecuteRule {
+    /**
+     * The parameters configuring the rule's action.
+     */
+    export interface ActionParameters {
+      /**
+       * The ID of the ruleset to execute.
+       */
+      id: string;
+
+      /**
+       * The configuration to use for matched data logging.
+       */
+      matched_data?: ActionParameters.MatchedData;
+
+      /**
+       * A set of overrides to apply to the target ruleset.
+       */
+      overrides?: ActionParameters.Overrides;
+    }
+
+    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;
+      }
+
+      /**
+       * 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;
+
+        /**
+         * 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';
+        }
+      }
+    }
+
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
+  }
+
+  export interface RulesetsLogRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'log';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: unknown;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleCreateParams.RulesetsLogRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsLogRule {
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
+  }
+
+  export interface RulesetsSkipRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'skip';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: RuleCreateParams.RulesetsSkipRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleCreateParams.RulesetsSkipRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsSkipRule {
+    /**
+     * 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<
+        | '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'
+      >;
+
+      /**
+       * 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>;
+    }
+
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
   }
 }
 
@@ -193,56 +622,488 @@ export interface RuleDeleteParams {
   zone_id?: string;
 }
 
-export interface RuleEditParams {
-  /**
-   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
-   * Zone ID.
-   */
-  account_id?: string;
+export type RuleEditParams =
+  | RuleEditParams.RulesetsBlockRule
+  | RuleEditParams.RulesetsExecuteRule
+  | RuleEditParams.RulesetsLogRule
+  | RuleEditParams.RulesetsSkipRule;
 
-  /**
-   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
-   * Account ID.
-   */
-  zone_id?: string;
+export namespace RuleEditParams {
+  export interface RulesetsBlockRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
 
-  /**
-   * Body param: An object configuring where the rule will be placed.
-   */
-  position?: RuleEditParams.BeforePosition | RuleEditParams.AfterPosition | RuleEditParams.IndexPosition;
-}
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'block';
 
-export namespace RuleEditParams {
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface BeforePosition {
     /**
-     * The ID of another rule to place the rule before. An empty value causes the rule
-     * to be placed at the top.
+     * Body param: The parameters configuring the rule's action.
      */
-    before?: string;
+    action_parameters?: RuleEditParams.RulesetsBlockRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleEditParams.RulesetsBlockRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
   }
 
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface AfterPosition {
+  export namespace RulesetsBlockRule {
+    /**
+     * 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;
+      }
+    }
+
     /**
-     * The ID of another rule to place the rule after. An empty value causes the rule
-     * to be placed at the bottom.
+     * An object configuring the rule's logging behavior.
      */
-    after?: string;
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
   }
 
-  /**
-   * An object configuring where the rule will be placed.
-   */
-  export interface IndexPosition {
+  export interface RulesetsExecuteRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'execute';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: RuleEditParams.RulesetsExecuteRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
     /**
-     * An index at which to place the rule, where index 1 is the first rule.
+     * Body param: Whether the rule should be executed.
      */
-    index?: number;
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleEditParams.RulesetsExecuteRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsExecuteRule {
+    /**
+     * The parameters configuring the rule's action.
+     */
+    export interface ActionParameters {
+      /**
+       * The ID of the ruleset to execute.
+       */
+      id: string;
+
+      /**
+       * The configuration to use for matched data logging.
+       */
+      matched_data?: ActionParameters.MatchedData;
+
+      /**
+       * A set of overrides to apply to the target ruleset.
+       */
+      overrides?: ActionParameters.Overrides;
+    }
+
+    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;
+      }
+
+      /**
+       * 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;
+
+        /**
+         * 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';
+        }
+      }
+    }
+
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
+  }
+
+  export interface RulesetsLogRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'log';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: unknown;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleEditParams.RulesetsLogRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsLogRule {
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
+  }
+
+  export interface RulesetsSkipRule {
+    /**
+     * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+     * Zone ID.
+     */
+    account_id?: string;
+
+    /**
+     * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+     * Account ID.
+     */
+    zone_id?: string;
+
+    /**
+     * Body param: The unique ID of the rule.
+     */
+    id?: string;
+
+    /**
+     * Body param: The action to perform when the rule matches.
+     */
+    action?: 'skip';
+
+    /**
+     * Body param: The parameters configuring the rule's action.
+     */
+    action_parameters?: RuleEditParams.RulesetsSkipRule.ActionParameters;
+
+    /**
+     * Body param: An informative description of the rule.
+     */
+    description?: string;
+
+    /**
+     * Body param: Whether the rule should be executed.
+     */
+    enabled?: boolean;
+
+    /**
+     * Body param: The expression defining which traffic will match the rule.
+     */
+    expression?: string;
+
+    /**
+     * Body param: An object configuring the rule's logging behavior.
+     */
+    logging?: RuleEditParams.RulesetsSkipRule.Logging;
+
+    /**
+     * Body param: The reference of the rule (the rule ID by default).
+     */
+    ref?: string;
+  }
+
+  export namespace RulesetsSkipRule {
+    /**
+     * 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<
+        | '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'
+      >;
+
+      /**
+       * 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>;
+    }
+
+    /**
+     * An object configuring the rule's logging behavior.
+     */
+    export interface Logging {
+      /**
+       * Whether to generate a log when the rule matches.
+       */
+      enabled: boolean;
+    }
   }
 }