cloudflare 4.3.0 → 4.4.0

package/resources/rulesets/rules.d.ts

@@ -889,7 +889,7 @@ export declare namespace ExecuteRule {
         }
         namespace Overrides {
             /**
-             * A category-level override
+             * A category-level override.
              */
             interface Category {
                 /**
@@ -910,7 +910,7 @@ export declare namespace ExecuteRule {
                 sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
             }
             /**
-             * A rule-level override
+             * A rule-level override.
              */
             interface Rule {
                 /**
@@ -1094,7 +1094,7 @@ export declare namespace ExecuteRuleParam {
         }
         namespace Overrides {
             /**
-             * A category-level override
+             * A category-level override.
              */
             interface Category {
                 /**
@@ -1115,7 +1115,7 @@ export declare namespace ExecuteRuleParam {
                 sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
             }
             /**
-             * A rule-level override
+             * A rule-level override.
              */
             interface Rule {
                 /**
@@ -3924,7 +3924,7 @@ export declare namespace SetCacheSettingsRule {
         origin_cache_control?: boolean;
         /**
          * Generate Cloudflare error pages from issues sent from the origin server. When
-         * on, error pages will trigger for issues from the origin
+         * on, error pages will trigger for issues from the origin.
          */
         origin_error_page_passthru?: boolean;
         /**
@@ -3969,12 +3969,12 @@ export declare namespace SetCacheSettingsRule {
          */
         interface CacheKey {
             /**
-             * Separate cached content based on the visitor’s device type
+             * Separate cached content based on the visitor’s device type.
              */
             cache_by_device_type?: boolean;
             /**
              * Protect from web cache deception attacks while allowing static assets to be
-             * cached
+             * cached.
              */
             cache_deception_armor?: boolean;
             /**
@@ -4167,18 +4167,18 @@ export declare namespace SetCacheSettingsRule {
              */
             default: number;
             /**
-             * edge ttl options
+             * Edge TTL options.
              */
             mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
             /**
-             * List of single status codes, or status code ranges to apply the selected mode
+             * List of single status codes, or status code ranges to apply the selected mode.
              */
             status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
         }
         namespace EdgeTTL {
             /**
              * Specify how long Cloudflare should cache the response based on the status code
-             * from the origin. Can be a single status code or a range or status codes
+             * from the origin. Can be a single status code or a range or status codes.
              */
             interface StatusCodeTTL {
                 /**
@@ -4192,7 +4192,7 @@ export declare namespace SetCacheSettingsRule {
                  */
                 status_code_range?: StatusCodeTTL.StatusCodeRange;
                 /**
-                 * Set the ttl for responses with this specific status code
+                 * Set the TTL for responses with this specific status code.
                  */
                 status_code_value?: number;
             }
@@ -4202,11 +4202,11 @@ export declare namespace SetCacheSettingsRule {
                  */
                 interface StatusCodeRange {
                     /**
-                     * response status code lower bound
+                     * Response status code lower bound.
                      */
                     from: number;
                     /**
-                     * response status code upper bound
+                     * Response status code upper bound.
                      */
                     to: number;
                 }
@@ -4367,7 +4367,7 @@ export declare namespace SetCacheSettingsRuleParam {
         origin_cache_control?: boolean;
         /**
          * Generate Cloudflare error pages from issues sent from the origin server. When
-         * on, error pages will trigger for issues from the origin
+         * on, error pages will trigger for issues from the origin.
          */
         origin_error_page_passthru?: boolean;
         /**
@@ -4412,12 +4412,12 @@ export declare namespace SetCacheSettingsRuleParam {
          */
         interface CacheKey {
             /**
-             * Separate cached content based on the visitor’s device type
+             * Separate cached content based on the visitor’s device type.
              */
             cache_by_device_type?: boolean;
             /**
              * Protect from web cache deception attacks while allowing static assets to be
-             * cached
+             * cached.
              */
             cache_deception_armor?: boolean;
             /**
@@ -4610,18 +4610,18 @@ export declare namespace SetCacheSettingsRuleParam {
              */
             default: number;
             /**
-             * edge ttl options
+             * Edge TTL options.
              */
             mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
             /**
-             * List of single status codes, or status code ranges to apply the selected mode
+             * List of single status codes, or status code ranges to apply the selected mode.
              */
             status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
         }
         namespace EdgeTTL {
             /**
              * Specify how long Cloudflare should cache the response based on the status code
-             * from the origin. Can be a single status code or a range or status codes
+             * from the origin. Can be a single status code or a range or status codes.
              */
             interface StatusCodeTTL {
                 /**
@@ -4635,7 +4635,7 @@ export declare namespace SetCacheSettingsRuleParam {
                  */
                 status_code_range?: StatusCodeTTL.StatusCodeRange;
                 /**
-                 * Set the ttl for responses with this specific status code
+                 * Set the TTL for responses with this specific status code.
                  */
                 status_code_value?: number;
             }
@@ -4645,11 +4645,11 @@ export declare namespace SetCacheSettingsRuleParam {
                  */
                 interface StatusCodeRange {
                     /**
-                     * response status code lower bound
+                     * Response status code lower bound.
                      */
                     from: number;
                     /**
-                     * response status code upper bound
+                     * Response status code upper bound.
                      */
                     to: number;
                 }
@@ -4832,9 +4832,9 @@ export declare namespace SetConfigRule {
         /**
          * Configure the Polish level.
          */
-        polish?: 'off' | 'lossless' | 'lossy';
+        polish?: 'off' | 'lossless' | 'lossy' | 'webp';
         /**
-         * Turn on or off Rocket Loader
+         * Turn on or off Rocket Loader.
          */
         rocket_loader?: boolean;
         /**
@@ -5024,9 +5024,9 @@ export declare namespace SetConfigRuleParam {
         /**
          * Configure the Polish level.
          */
-        polish?: 'off' | 'lossless' | 'lossy';
+        polish?: 'off' | 'lossless' | 'lossy' | 'webp';
         /**
-         * Turn on or off Rocket Loader
+         * Turn on or off Rocket Loader.
          */
         rocket_loader?: boolean;
         /**
@@ -6775,7 +6775,7 @@ export declare namespace RuleCreateParams {
             }
             namespace Overrides {
                 /**
-                 * A category-level override
+                 * A category-level override.
                  */
                 interface Category {
                     /**
@@ -6796,7 +6796,7 @@ export declare namespace RuleCreateParams {
                     sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
                 }
                 /**
-                 * A rule-level override
+                 * A rule-level override.
                  */
                 interface Rule {
                     /**
@@ -8361,9 +8361,9 @@ export declare namespace RuleCreateParams {
             /**
              * Configure the Polish level.
              */
-            polish?: 'off' | 'lossless' | 'lossy';
+            polish?: 'off' | 'lossless' | 'lossy' | 'webp';
             /**
-             * Turn on or off Rocket Loader
+             * Turn on or off Rocket Loader.
              */
             rocket_loader?: boolean;
             /**
@@ -8758,7 +8758,7 @@ export declare namespace RuleCreateParams {
             origin_cache_control?: boolean;
             /**
              * Generate Cloudflare error pages from issues sent from the origin server. When
-             * on, error pages will trigger for issues from the origin
+             * on, error pages will trigger for issues from the origin.
              */
             origin_error_page_passthru?: boolean;
             /**
@@ -8803,12 +8803,12 @@ export declare namespace RuleCreateParams {
              */
             interface CacheKey {
                 /**
-                 * Separate cached content based on the visitor’s device type
+                 * Separate cached content based on the visitor’s device type.
                  */
                 cache_by_device_type?: boolean;
                 /**
                  * Protect from web cache deception attacks while allowing static assets to be
-                 * cached
+                 * cached.
                  */
                 cache_deception_armor?: boolean;
                 /**
@@ -9001,18 +9001,18 @@ export declare namespace RuleCreateParams {
                  */
                 default: number;
                 /**
-                 * edge ttl options
+                 * Edge TTL options.
                  */
                 mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
                 /**
-                 * List of single status codes, or status code ranges to apply the selected mode
+                 * List of single status codes, or status code ranges to apply the selected mode.
                  */
                 status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
             }
             namespace EdgeTTL {
                 /**
                  * Specify how long Cloudflare should cache the response based on the status code
-                 * from the origin. Can be a single status code or a range or status codes
+                 * from the origin. Can be a single status code or a range or status codes.
                  */
                 interface StatusCodeTTL {
                     /**
@@ -9026,7 +9026,7 @@ export declare namespace RuleCreateParams {
                      */
                     status_code_range?: StatusCodeTTL.StatusCodeRange;
                     /**
-                     * Set the ttl for responses with this specific status code
+                     * Set the TTL for responses with this specific status code.
                      */
                     status_code_value?: number;
                 }
@@ -9036,11 +9036,11 @@ export declare namespace RuleCreateParams {
                      */
                     interface StatusCodeRange {
                         /**
-                         * response status code lower bound
+                         * Response status code lower bound.
                          */
                         from: number;
                         /**
-                         * response status code upper bound
+                         * Response status code upper bound.
                          */
                         to: number;
                     }
@@ -10260,7 +10260,7 @@ export declare namespace RuleEditParams {
             }
             namespace Overrides {
                 /**
-                 * A category-level override
+                 * A category-level override.
                  */
                 interface Category {
                     /**
@@ -10281,7 +10281,7 @@ export declare namespace RuleEditParams {
                     sensitivity_level?: 'default' | 'medium' | 'low' | 'eoff';
                 }
                 /**
-                 * A rule-level override
+                 * A rule-level override.
                  */
                 interface Rule {
                     /**
@@ -11846,9 +11846,9 @@ export declare namespace RuleEditParams {
             /**
              * Configure the Polish level.
              */
-            polish?: 'off' | 'lossless' | 'lossy';
+            polish?: 'off' | 'lossless' | 'lossy' | 'webp';
             /**
-             * Turn on or off Rocket Loader
+             * Turn on or off Rocket Loader.
              */
             rocket_loader?: boolean;
             /**
@@ -12243,7 +12243,7 @@ export declare namespace RuleEditParams {
             origin_cache_control?: boolean;
             /**
              * Generate Cloudflare error pages from issues sent from the origin server. When
-             * on, error pages will trigger for issues from the origin
+             * on, error pages will trigger for issues from the origin.
              */
             origin_error_page_passthru?: boolean;
             /**
@@ -12288,12 +12288,12 @@ export declare namespace RuleEditParams {
              */
             interface CacheKey {
                 /**
-                 * Separate cached content based on the visitor’s device type
+                 * Separate cached content based on the visitor’s device type.
                  */
                 cache_by_device_type?: boolean;
                 /**
                  * Protect from web cache deception attacks while allowing static assets to be
-                 * cached
+                 * cached.
                  */
                 cache_deception_armor?: boolean;
                 /**
@@ -12486,18 +12486,18 @@ export declare namespace RuleEditParams {
                  */
                 default: number;
                 /**
-                 * edge ttl options
+                 * Edge TTL options.
                  */
                 mode: 'respect_origin' | 'bypass_by_default' | 'override_origin';
                 /**
-                 * List of single status codes, or status code ranges to apply the selected mode
+                 * List of single status codes, or status code ranges to apply the selected mode.
                  */
                 status_code_ttl: Array<EdgeTTL.StatusCodeTTL>;
             }
             namespace EdgeTTL {
                 /**
                  * Specify how long Cloudflare should cache the response based on the status code
-                 * from the origin. Can be a single status code or a range or status codes
+                 * from the origin. Can be a single status code or a range or status codes.
                  */
                 interface StatusCodeTTL {
                     /**
@@ -12511,7 +12511,7 @@ export declare namespace RuleEditParams {
                      */
                     status_code_range?: StatusCodeTTL.StatusCodeRange;
                     /**
-                     * Set the ttl for responses with this specific status code
+                     * Set the TTL for responses with this specific status code.
                      */
                     status_code_value?: number;
                 }
@@ -12521,11 +12521,11 @@ export declare namespace RuleEditParams {
                      */
                     interface StatusCodeRange {
                         /**
-                         * response status code lower bound
+                         * Response status code lower bound.
                          */
                         from: number;
                         /**
-                         * response status code upper bound
+                         * Response status code upper bound.
                          */
                         to: number;
                     }