cloudflare 4.5.0 → 5.1.0

package/src/resources/rulesets/phases/phases.ts

@@ -148,21 +148,21 @@ export interface PhaseUpdateResponse {
     | RulesAPI.BlockRule
     | PhaseUpdateResponse.RulesetsChallengeRule
     | RulesAPI.CompressResponseRule
+    | RulesAPI.DDoSDynamicRule
     | RulesAPI.ExecuteRule
+    | RulesAPI.ForceConnectionCloseRule
     | PhaseUpdateResponse.RulesetsJSChallengeRule
     | RulesAPI.LogRule
+    | RulesAPI.LogCustomFieldRule
     | RulesAPI.ManagedChallengeRule
     | RulesAPI.RedirectRule
     | RulesAPI.RewriteRule
     | RulesAPI.RouteRule
     | RulesAPI.ScoreRule
     | RulesAPI.ServeErrorRule
+    | RulesAPI.SetCacheSettingsRule
     | RulesAPI.SetConfigRule
     | RulesAPI.SkipRule
-    | RulesAPI.SetCacheSettingsRule
-    | RulesAPI.LogCustomFieldRule
-    | RulesAPI.DDoSDynamicRule
-    | RulesAPI.ForceConnectionCloseRule
   >;
 
   /**
@@ -219,7 +219,7 @@ export namespace PhaseUpdateResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
 
@@ -234,38 +234,38 @@ export namespace PhaseUpdateResponse {
     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;
   }
 
   export namespace RulesetsChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -276,7 +276,7 @@ export namespace PhaseUpdateResponse {
       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;
@@ -294,7 +294,7 @@ export namespace PhaseUpdateResponse {
       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;
 
@@ -305,8 +305,8 @@ export namespace PhaseUpdateResponse {
       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;
     }
@@ -354,7 +354,7 @@ export namespace PhaseUpdateResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
 
@@ -369,38 +369,38 @@ export namespace PhaseUpdateResponse {
     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;
   }
 
   export namespace RulesetsJSChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -411,7 +411,7 @@ export namespace PhaseUpdateResponse {
       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;
@@ -429,7 +429,7 @@ export namespace PhaseUpdateResponse {
       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;
 
@@ -440,8 +440,8 @@ export namespace PhaseUpdateResponse {
       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;
     }
@@ -484,21 +484,21 @@ export interface PhaseGetResponse {
     | RulesAPI.BlockRule
     | PhaseGetResponse.RulesetsChallengeRule
     | RulesAPI.CompressResponseRule
+    | RulesAPI.DDoSDynamicRule
     | RulesAPI.ExecuteRule
+    | RulesAPI.ForceConnectionCloseRule
     | PhaseGetResponse.RulesetsJSChallengeRule
     | RulesAPI.LogRule
+    | RulesAPI.LogCustomFieldRule
     | RulesAPI.ManagedChallengeRule
     | RulesAPI.RedirectRule
     | RulesAPI.RewriteRule
     | RulesAPI.RouteRule
     | RulesAPI.ScoreRule
     | RulesAPI.ServeErrorRule
+    | RulesAPI.SetCacheSettingsRule
     | RulesAPI.SetConfigRule
     | RulesAPI.SkipRule
-    | RulesAPI.SetCacheSettingsRule
-    | RulesAPI.LogCustomFieldRule
-    | RulesAPI.DDoSDynamicRule
-    | RulesAPI.ForceConnectionCloseRule
   >;
 
   /**
@@ -555,7 +555,7 @@ export namespace PhaseGetResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
 
@@ -570,38 +570,38 @@ export namespace PhaseGetResponse {
     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;
   }
 
   export namespace RulesetsChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -612,7 +612,7 @@ export namespace PhaseGetResponse {
       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;
@@ -630,7 +630,7 @@ export namespace PhaseGetResponse {
       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 namespace PhaseGetResponse {
       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;
     }
@@ -690,7 +690,7 @@ export namespace PhaseGetResponse {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
 
@@ -705,38 +705,38 @@ export namespace PhaseGetResponse {
     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;
   }
 
   export namespace RulesetsJSChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -747,7 +747,7 @@ export namespace PhaseGetResponse {
       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;
@@ -765,7 +765,7 @@ export namespace PhaseGetResponse {
       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;
 
@@ -776,8 +776,8 @@ export namespace PhaseGetResponse {
       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;
     }
@@ -814,21 +814,21 @@ export interface PhaseUpdateParams {
     | RulesAPI.BlockRuleParam
     | PhaseUpdateParams.RulesetsChallengeRule
     | RulesAPI.CompressResponseRuleParam
+    | RulesAPI.DDoSDynamicRuleParam
     | RulesAPI.ExecuteRuleParam
+    | RulesAPI.ForceConnectionCloseRuleParam
     | PhaseUpdateParams.RulesetsJSChallengeRule
     | RulesAPI.LogRuleParam
+    | RulesAPI.LogCustomFieldRuleParam
     | RulesAPI.ManagedChallengeRuleParam
     | RulesAPI.RedirectRuleParam
     | RulesAPI.RewriteRuleParam
     | RulesAPI.RouteRuleParam
     | RulesAPI.ScoreRuleParam
     | RulesAPI.ServeErrorRuleParam
+    | RulesAPI.SetCacheSettingsRuleParam
     | RulesAPI.SetConfigRuleParam
     | RulesAPI.SkipRuleParam
-    | RulesAPI.SetCacheSettingsRuleParam
-    | RulesAPI.LogCustomFieldRuleParam
-    | RulesAPI.DDoSDynamicRuleParam
-    | RulesAPI.ForceConnectionCloseRuleParam
   >;
 }
 
@@ -860,7 +860,7 @@ export namespace PhaseUpdateParams {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck;
 
@@ -875,38 +875,38 @@ export namespace PhaseUpdateParams {
     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;
   }
 
   export namespace RulesetsChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -917,7 +917,7 @@ export namespace PhaseUpdateParams {
       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;
@@ -935,7 +935,7 @@ export namespace PhaseUpdateParams {
       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;
 
@@ -946,8 +946,8 @@ export namespace PhaseUpdateParams {
       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;
     }
@@ -980,7 +980,7 @@ export namespace PhaseUpdateParams {
     enabled?: boolean;
 
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck;
 
@@ -995,38 +995,38 @@ export namespace PhaseUpdateParams {
     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;
   }
 
   export namespace RulesetsJSChallengeRule {
     /**
-     * Configure checks for exposed credentials.
+     * Configuration for exposed credential checking.
      */
     export 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.
      */
     export 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>;
@@ -1037,7 +1037,7 @@ export namespace PhaseUpdateParams {
       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;
@@ -1055,7 +1055,7 @@ export namespace PhaseUpdateParams {
       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;
 
@@ -1066,8 +1066,8 @@ export namespace PhaseUpdateParams {
       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;
     }