cloudflare 4.5.0 → 5.1.0

package/resources/rulesets/rulesets.d.ts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../resource.js";
 import * as Core from "../../core.js";
 import * as RulesAPI from "./rules.js";
-import { BlockRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, LogCustomFieldRule, LogRule, Logging, ManagedChallengeRule, RedirectRule, RewriteRule, RewriteURIPart, RouteRule, RuleCreateParams, RuleCreateResponse, RuleDeleteParams, RuleDeleteResponse, RuleEditParams, RuleEditResponse, Rules, RulesetRule, ScoreRule, ServeErrorRule, SetCacheSettingsRule, SetConfigRule, SkipRule } from "./rules.js";
+import { BlockRule, CompressResponseRule, DDoSDynamicRule, ExecuteRule, ForceConnectionCloseRule, LogCustomFieldRule, LogRule, Logging, ManagedChallengeRule, RedirectRule, RewriteRule, RouteRule, RuleCreateParams, RuleCreateResponse, RuleDeleteParams, RuleDeleteResponse, RuleEditParams, RuleEditResponse, Rules, RulesetRule, ScoreRule, ServeErrorRule, SetCacheSettingsRule, SetConfigRule, SkipRule } from "./rules.js";
 import * as VersionsAPI from "./versions.js";
 import { VersionDeleteParams, VersionGetParams, VersionGetResponse, VersionListParams, VersionListResponse, VersionListResponsesSinglePage, Versions } from "./versions.js";
 import * as PhasesAPI from "./phases/phases.js";
@@ -149,7 +149,7 @@ export interface RulesetCreateResponse {
     /**
      * The list of rules in the ruleset.
      */
-    rules: Array<RulesAPI.BlockRule | RulesetCreateResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.ExecuteRule | RulesetCreateResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule | RulesAPI.SetCacheSettingsRule | RulesAPI.LogCustomFieldRule | RulesAPI.DDoSDynamicRule | RulesAPI.ForceConnectionCloseRule>;
+    rules: Array<RulesAPI.BlockRule | RulesetCreateResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.DDoSDynamicRule | RulesAPI.ExecuteRule | RulesAPI.ForceConnectionCloseRule | RulesetCreateResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.LogCustomFieldRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetCacheSettingsRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule>;
     /**
      * The version of the ruleset.
      */
@@ -194,7 +194,7 @@ export declare namespace RulesetCreateResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
         /**
@@ -206,34 +206,34 @@ export declare namespace RulesetCreateResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -242,7 +242,7 @@ export declare namespace RulesetCreateResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -257,7 +257,7 @@ export declare namespace RulesetCreateResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -266,8 +266,8 @@ export declare namespace RulesetCreateResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -306,7 +306,7 @@ export declare namespace RulesetCreateResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
         /**
@@ -318,34 +318,34 @@ export declare namespace RulesetCreateResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsJSChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsJSChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -354,7 +354,7 @@ export declare namespace RulesetCreateResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -369,7 +369,7 @@ export declare namespace RulesetCreateResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -378,8 +378,8 @@ export declare namespace RulesetCreateResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -412,7 +412,7 @@ export interface RulesetUpdateResponse {
     /**
      * The list of rules in the ruleset.
      */
-    rules: Array<RulesAPI.BlockRule | RulesetUpdateResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.ExecuteRule | RulesetUpdateResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule | RulesAPI.SetCacheSettingsRule | RulesAPI.LogCustomFieldRule | RulesAPI.DDoSDynamicRule | RulesAPI.ForceConnectionCloseRule>;
+    rules: Array<RulesAPI.BlockRule | RulesetUpdateResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.DDoSDynamicRule | RulesAPI.ExecuteRule | RulesAPI.ForceConnectionCloseRule | RulesetUpdateResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.LogCustomFieldRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetCacheSettingsRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule>;
     /**
      * The version of the ruleset.
      */
@@ -457,7 +457,7 @@ export declare namespace RulesetUpdateResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
         /**
@@ -469,34 +469,34 @@ export declare namespace RulesetUpdateResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -505,7 +505,7 @@ export declare namespace RulesetUpdateResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -520,7 +520,7 @@ export declare namespace RulesetUpdateResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -529,8 +529,8 @@ export declare namespace RulesetUpdateResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -569,7 +569,7 @@ export declare namespace RulesetUpdateResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
         /**
@@ -581,34 +581,34 @@ export declare namespace RulesetUpdateResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsJSChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsJSChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -617,7 +617,7 @@ export declare namespace RulesetUpdateResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -632,7 +632,7 @@ export declare namespace RulesetUpdateResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -641,8 +641,8 @@ export declare namespace RulesetUpdateResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -708,7 +708,7 @@ export interface RulesetGetResponse {
     /**
      * The list of rules in the ruleset.
      */
-    rules: Array<RulesAPI.BlockRule | RulesetGetResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.ExecuteRule | RulesetGetResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule | RulesAPI.SetCacheSettingsRule | RulesAPI.LogCustomFieldRule | RulesAPI.DDoSDynamicRule | RulesAPI.ForceConnectionCloseRule>;
+    rules: Array<RulesAPI.BlockRule | RulesetGetResponse.RulesetsChallengeRule | RulesAPI.CompressResponseRule | RulesAPI.DDoSDynamicRule | RulesAPI.ExecuteRule | RulesAPI.ForceConnectionCloseRule | RulesetGetResponse.RulesetsJSChallengeRule | RulesAPI.LogRule | RulesAPI.LogCustomFieldRule | RulesAPI.ManagedChallengeRule | RulesAPI.RedirectRule | RulesAPI.RewriteRule | RulesAPI.RouteRule | RulesAPI.ScoreRule | RulesAPI.ServeErrorRule | RulesAPI.SetCacheSettingsRule | RulesAPI.SetConfigRule | RulesAPI.SkipRule>;
     /**
      * The version of the ruleset.
      */
@@ -753,7 +753,7 @@ export declare namespace RulesetGetResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
         /**
@@ -765,34 +765,34 @@ export declare namespace RulesetGetResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -801,7 +801,7 @@ export declare namespace RulesetGetResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -816,7 +816,7 @@ export declare namespace RulesetGetResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -825,8 +825,8 @@ export declare namespace RulesetGetResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -865,7 +865,7 @@ export declare namespace RulesetGetResponse {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
         /**
@@ -877,34 +877,34 @@ export declare namespace RulesetGetResponse {
          */
         logging?: RulesAPI.Logging;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsJSChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsJSChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -913,7 +913,7 @@ export declare namespace RulesetGetResponse {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -928,7 +928,7 @@ export declare namespace RulesetGetResponse {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -937,8 +937,8 @@ export declare namespace RulesetGetResponse {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -974,7 +974,7 @@ export interface RulesetCreateParams {
     /**
      * Body param: The list of rules in the ruleset.
      */
-    rules?: Array<RulesAPI.BlockRuleParam | RulesetCreateParams.RulesetsChallengeRule | RulesAPI.CompressResponseRuleParam | RulesAPI.ExecuteRuleParam | RulesetCreateParams.RulesetsJSChallengeRule | RulesAPI.LogRuleParam | RulesAPI.ManagedChallengeRuleParam | RulesAPI.RedirectRuleParam | RulesAPI.RewriteRuleParam | RulesAPI.RouteRuleParam | RulesAPI.ScoreRuleParam | RulesAPI.ServeErrorRuleParam | RulesAPI.SetConfigRuleParam | RulesAPI.SkipRuleParam | RulesAPI.SetCacheSettingsRuleParam | RulesAPI.LogCustomFieldRuleParam | RulesAPI.DDoSDynamicRuleParam | RulesAPI.ForceConnectionCloseRuleParam>;
+    rules?: Array<RulesAPI.BlockRuleParam | RulesetCreateParams.RulesetsChallengeRule | RulesAPI.CompressResponseRuleParam | RulesAPI.DDoSDynamicRuleParam | RulesAPI.ExecuteRuleParam | RulesAPI.ForceConnectionCloseRuleParam | RulesetCreateParams.RulesetsJSChallengeRule | RulesAPI.LogRuleParam | RulesAPI.LogCustomFieldRuleParam | RulesAPI.ManagedChallengeRuleParam | RulesAPI.RedirectRuleParam | RulesAPI.RewriteRuleParam | RulesAPI.RouteRuleParam | RulesAPI.ScoreRuleParam | RulesAPI.ServeErrorRuleParam | RulesAPI.SetCacheSettingsRuleParam | RulesAPI.SetConfigRuleParam | RulesAPI.SkipRuleParam>;
 }
 export declare namespace RulesetCreateParams {
     interface RulesetsChallengeRule {
@@ -999,7 +999,7 @@ export declare namespace RulesetCreateParams {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
         /**
@@ -1011,34 +1011,34 @@ export declare namespace RulesetCreateParams {
          */
         logging?: RulesAPI.LoggingParam;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -1047,7 +1047,7 @@ export declare namespace RulesetCreateParams {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -1062,7 +1062,7 @@ export declare namespace RulesetCreateParams {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -1071,8 +1071,8 @@ export declare namespace RulesetCreateParams {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -1099,7 +1099,7 @@ export declare namespace RulesetCreateParams {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
         /**
@@ -1111,34 +1111,34 @@ export declare namespace RulesetCreateParams {
          */
         logging?: RulesAPI.LoggingParam;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsJSChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsJSChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -1147,7 +1147,7 @@ export declare namespace RulesetCreateParams {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -1162,7 +1162,7 @@ export declare namespace RulesetCreateParams {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -1171,8 +1171,8 @@ export declare namespace RulesetCreateParams {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -1208,7 +1208,7 @@ export interface RulesetUpdateParams {
     /**
      * Body param: The list of rules in the ruleset.
      */
-    rules?: Array<RulesAPI.BlockRuleParam | RulesetUpdateParams.RulesetsChallengeRule | RulesAPI.CompressResponseRuleParam | RulesAPI.ExecuteRuleParam | RulesetUpdateParams.RulesetsJSChallengeRule | RulesAPI.LogRuleParam | RulesAPI.ManagedChallengeRuleParam | RulesAPI.RedirectRuleParam | RulesAPI.RewriteRuleParam | RulesAPI.RouteRuleParam | RulesAPI.ScoreRuleParam | RulesAPI.ServeErrorRuleParam | RulesAPI.SetConfigRuleParam | RulesAPI.SkipRuleParam | RulesAPI.SetCacheSettingsRuleParam | RulesAPI.LogCustomFieldRuleParam | RulesAPI.DDoSDynamicRuleParam | RulesAPI.ForceConnectionCloseRuleParam>;
+    rules?: Array<RulesAPI.BlockRuleParam | RulesetUpdateParams.RulesetsChallengeRule | RulesAPI.CompressResponseRuleParam | RulesAPI.DDoSDynamicRuleParam | RulesAPI.ExecuteRuleParam | RulesAPI.ForceConnectionCloseRuleParam | RulesetUpdateParams.RulesetsJSChallengeRule | RulesAPI.LogRuleParam | RulesAPI.LogCustomFieldRuleParam | RulesAPI.ManagedChallengeRuleParam | RulesAPI.RedirectRuleParam | RulesAPI.RewriteRuleParam | RulesAPI.RouteRuleParam | RulesAPI.ScoreRuleParam | RulesAPI.ServeErrorRuleParam | RulesAPI.SetCacheSettingsRuleParam | RulesAPI.SetConfigRuleParam | RulesAPI.SkipRuleParam>;
 }
 export declare namespace RulesetUpdateParams {
     interface RulesetsChallengeRule {
@@ -1233,7 +1233,7 @@ export declare namespace RulesetUpdateParams {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
         /**
@@ -1245,34 +1245,34 @@ export declare namespace RulesetUpdateParams {
          */
         logging?: RulesAPI.LoggingParam;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -1281,7 +1281,7 @@ export declare namespace RulesetUpdateParams {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -1296,7 +1296,7 @@ export declare namespace RulesetUpdateParams {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -1305,8 +1305,8 @@ export declare namespace RulesetUpdateParams {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -1333,7 +1333,7 @@ export declare namespace RulesetUpdateParams {
          */
         enabled?: boolean;
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
         /**
@@ -1345,34 +1345,34 @@ export declare namespace RulesetUpdateParams {
          */
         logging?: RulesAPI.LoggingParam;
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         ratelimit?: RulesetsJSChallengeRule.Ratelimit;
         /**
-         * The reference of the rule (the rule ID by default).
+         * The reference of the rule (the rule's ID by default).
          */
         ref?: string;
     }
     namespace RulesetsJSChallengeRule {
         /**
-         * Configure checks for exposed credentials.
+         * Configuration for exposed credential checking.
          */
         interface ExposedCredentialCheck {
             /**
-             * Expression that selects the password used in the credentials check.
+             * An expression that selects the password used in the credentials check.
              */
             password_expression: string;
             /**
-             * Expression that selects the user ID used in the credentials check.
+             * An expression that selects the user ID used in the credentials check.
              */
             username_expression: string;
         }
         /**
-         * An object configuring the rule's ratelimit behavior.
+         * An object configuring the rule's rate limit behavior.
          */
         interface Ratelimit {
             /**
-             * Characteristics of the request on which the ratelimiter counter will be
+             * Characteristics of the request on which the rate limit counter will be
              * incremented.
              */
             characteristics: Array<string>;
@@ -1381,7 +1381,7 @@ export declare namespace RulesetUpdateParams {
              */
             period: number;
             /**
-             * Defines when the ratelimit counter should be incremented. It is optional and
+             * An expression that defines when the rate limit counter should be incremented. It
              * defaults to the same as the rule's expression.
              */
             counting_expression?: string;
@@ -1396,7 +1396,7 @@ export declare namespace RulesetUpdateParams {
              */
             requests_per_period?: number;
             /**
-             * Defines if ratelimit counting is only done when an origin is reached.
+             * Whether counting is only performed when an origin is reached.
              */
             requests_to_origin?: boolean;
             /**
@@ -1405,8 +1405,8 @@ export declare namespace RulesetUpdateParams {
              */
             score_per_period?: number;
             /**
-             * The response header name provided by the origin which should contain the score
-             * to increment ratelimit counter on.
+             * A response header name provided by the origin, which contains the score to
+             * increment rate limit counter with.
              */
             score_response_header_name?: string;
         }
@@ -1447,7 +1447,7 @@ export interface RulesetGetParams {
 export declare namespace Rulesets {
     export { type Kind as Kind, type Phase as Phase, type Ruleset as Ruleset, type RulesetCreateResponse as RulesetCreateResponse, type RulesetUpdateResponse as RulesetUpdateResponse, type RulesetListResponse as RulesetListResponse, type RulesetGetResponse as RulesetGetResponse, RulesetListResponsesCursorPagination as RulesetListResponsesCursorPagination, type RulesetCreateParams as RulesetCreateParams, type RulesetUpdateParams as RulesetUpdateParams, type RulesetListParams as RulesetListParams, type RulesetDeleteParams as RulesetDeleteParams, type RulesetGetParams as RulesetGetParams, };
     export { Phases as Phases, type PhaseUpdateResponse as PhaseUpdateResponse, type PhaseGetResponse as PhaseGetResponse, type PhaseUpdateParams as PhaseUpdateParams, type PhaseGetParams as PhaseGetParams, };
-    export { Rules as Rules, type BlockRule as BlockRule, type CompressResponseRule as CompressResponseRule, type DDoSDynamicRule as DDoSDynamicRule, type ExecuteRule as ExecuteRule, type ForceConnectionCloseRule as ForceConnectionCloseRule, type LogCustomFieldRule as LogCustomFieldRule, type LogRule as LogRule, type Logging as Logging, type ManagedChallengeRule as ManagedChallengeRule, type RedirectRule as RedirectRule, type RewriteRule as RewriteRule, type RewriteURIPart as RewriteURIPart, type RouteRule as RouteRule, type RulesetRule as RulesetRule, type ScoreRule as ScoreRule, type ServeErrorRule as ServeErrorRule, type SetCacheSettingsRule as SetCacheSettingsRule, type SetConfigRule as SetConfigRule, type SkipRule as SkipRule, type RuleCreateResponse as RuleCreateResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleEditResponse as RuleEditResponse, type RuleCreateParams as RuleCreateParams, type RuleDeleteParams as RuleDeleteParams, type RuleEditParams as RuleEditParams, };
+    export { Rules as Rules, type BlockRule as BlockRule, type CompressResponseRule as CompressResponseRule, type DDoSDynamicRule as DDoSDynamicRule, type ExecuteRule as ExecuteRule, type ForceConnectionCloseRule as ForceConnectionCloseRule, type LogCustomFieldRule as LogCustomFieldRule, type LogRule as LogRule, type Logging as Logging, type ManagedChallengeRule as ManagedChallengeRule, type RedirectRule as RedirectRule, type RewriteRule as RewriteRule, type RouteRule as RouteRule, type RulesetRule as RulesetRule, type ScoreRule as ScoreRule, type ServeErrorRule as ServeErrorRule, type SetCacheSettingsRule as SetCacheSettingsRule, type SetConfigRule as SetConfigRule, type SkipRule as SkipRule, type RuleCreateResponse as RuleCreateResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleEditResponse as RuleEditResponse, type RuleCreateParams as RuleCreateParams, type RuleDeleteParams as RuleDeleteParams, type RuleEditParams as RuleEditParams, };
     export { Versions as Versions, type VersionListResponse as VersionListResponse, type VersionGetResponse as VersionGetResponse, VersionListResponsesSinglePage as VersionListResponsesSinglePage, type VersionListParams as VersionListParams, type VersionDeleteParams as VersionDeleteParams, type VersionGetParams as VersionGetParams, };
 }
 //# sourceMappingURL=rulesets.d.ts.map