@distilled.cloud/cloudflare 0.22.3 → 0.22.4

package/lib/services/rulesets.d.ts

@@ -3380,7 +3380,7 @@ interface CreateRuleBaseRequest {
     /** Body param: The unique ID of the rule. */
     id?: string;
     /** Body param: The action to perform when the rule matches. */
-    action?: "block";
+    action?: "block" | "challenge" | "compress_response" | "ddos_dynamic" | "execute" | "force_connection_close" | "js_challenge" | "log" | "log_custom_field" | "managed_challenge" | "redirect" | "rewrite" | "route" | "score" | "serve_error" | "set_cache_control" | "set_cache_settings" | "set_cache_tags" | "set_config" | "skip" | (string & {});
     /** Body param: The parameters configuring the rule's action. */
     actionParameters?: {
         response?: {
@@ -3388,6 +3388,260 @@ interface CreateRuleBaseRequest {
             contentType: string;
             statusCode: number;
         };
+    } | {
+        algorithms: {
+            name?: "none" | "auto" | "default" | "gzip" | "brotli" | "zstd" | (string & {});
+        }[];
+    } | {
+        id: string;
+        matchedData?: {
+            publicKey: string;
+        };
+        overrides?: {
+            action?: string;
+            categories?: {
+                category: string;
+                action?: string;
+                enabled?: boolean;
+                sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+            }[];
+            enabled?: boolean;
+            rules?: {
+                id: string;
+                action?: string;
+                enabled?: boolean;
+                scoreThreshold?: number;
+                sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+            }[];
+            sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+        };
+    } | {
+        cookieFields?: {
+            name: string;
+        }[];
+        rawResponseFields?: {
+            name: string;
+            preserveDuplicates?: boolean;
+        }[];
+        requestFields?: {
+            name: string;
+        }[];
+        responseFields?: {
+            name: string;
+            preserveDuplicates?: boolean;
+        }[];
+        transformedRequestFields?: {
+            name: string;
+        }[];
+    } | {
+        fromList?: {
+            key: string;
+            name: string;
+        };
+        fromValue?: {
+            targetUrl: {
+                expression?: string;
+                value?: string;
+            };
+            preserveQueryString?: boolean;
+            statusCode?: "301" | "302" | "303" | "307" | "308" | (string & {});
+        };
+    } | {
+        headers?: Record<string, unknown>;
+        uri?: {
+            path: {
+                expression?: string;
+                value?: string;
+            };
+        } | {
+            query: {
+                expression?: string;
+                value?: string;
+            };
+        };
+    } | {
+        hostHeader?: string;
+        origin?: {
+            host?: string;
+            port?: number;
+        };
+        sni?: {
+            value: string;
+        };
+    } | {
+        increment: number;
+    } | {
+        content: string;
+        contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | (string & {});
+        statusCode?: number;
+    } | {
+        assetName: string;
+        contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | (string & {});
+        statusCode?: number;
+    } | {
+        immutable?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        maxAge?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        mustRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        mustUnderstand?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noCache?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noStore?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noTransform?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        private?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        proxyRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        public?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        sMaxage?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        staleIfError?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        staleWhileRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+    } | {
+        additionalCacheablePorts?: number[];
+        browserTtl?: {
+            mode: "respect_origin" | "bypass_by_default" | "override_origin" | "bypass" | (string & {});
+            default?: number;
+        };
+        cache?: boolean;
+        cacheKey?: {
+            cacheByDeviceType?: boolean;
+            cacheDeceptionArmor?: boolean;
+            customKey?: {
+                cookie?: {
+                    checkPresence?: string[];
+                    include?: string[];
+                };
+                header?: {
+                    checkPresence?: string[];
+                    contains?: Record<string, unknown>;
+                    excludeOrigin?: boolean;
+                    include?: string[];
+                };
+                host?: {
+                    resolved?: boolean;
+                };
+                queryString?: {
+                    exclude?: {
+                        all?: true;
+                        list?: string[];
+                    };
+                    include?: {
+                        all?: true;
+                        list?: string[];
+                    };
+                };
+                user?: {
+                    deviceType?: boolean;
+                    geo?: boolean;
+                    lang?: boolean;
+                };
+            };
+            ignoreQueryStringsOrder?: boolean;
+        };
+        cacheReserve?: {
+            eligible: boolean;
+            minimumFileSize?: number;
+        };
+        edgeTtl?: {
+            mode: "respect_origin" | "bypass_by_default" | "override_origin" | (string & {});
+            default?: number;
+            statusCodeTtl?: {
+                value: number;
+                statusCode?: number;
+                statusCodeRange?: {
+                    from?: number;
+                    to?: number;
+                };
+            }[];
+        };
+        originCacheControl?: boolean;
+        originErrorPagePassthru?: boolean;
+        readTimeout?: number;
+        respectStrongEtags?: boolean;
+        serveStale?: {
+            disableStaleWhileUpdating?: boolean;
+        };
+        sharedDictionary?: {
+            matchPattern: string;
+        };
+        stripEtags?: boolean;
+        stripLastModified?: boolean;
+        stripSetCookie?: boolean;
+    } | {
+        operation: "add" | "remove" | "set" | (string & {});
+        values: string[];
+    } | {
+        expression: string;
+        operation: "add" | "remove" | "set" | (string & {});
+    } | {
+        automaticHttpsRewrites?: boolean;
+        autominify?: {
+            css?: boolean;
+            html?: boolean;
+            js?: boolean;
+        };
+        bic?: boolean;
+        contentConverter?: boolean;
+        disableApps?: true;
+        disablePayPerCrawl?: true;
+        disableRum?: true;
+        disableZaraz?: true;
+        emailObfuscation?: boolean;
+        fonts?: boolean;
+        hotlinkProtection?: boolean;
+        mirage?: boolean;
+        opportunisticEncryption?: boolean;
+        polish?: "off" | "lossless" | "lossy" | "webp" | (string & {});
+        redirectsForAiTraining?: boolean;
+        requestBodyBuffering?: "none" | "standard" | "full" | (string & {});
+        responseBodyBuffering?: "none" | "standard" | (string & {});
+        rocketLoader?: boolean;
+        securityLevel?: "off" | "essentially_off" | "low" | "medium" | "high" | "under_attack" | (string & {});
+        serverSideExcludes?: boolean;
+        ssl?: "off" | "flexible" | "full" | "strict" | "origin_pull" | (string & {});
+        sxg?: boolean;
+    } | {
+        phase?: "current";
+        phases?: ("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_transform" | "http_response_cache_settings" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit" | (string & {}))[];
+        products?: ("bic" | "hot" | "rateLimit" | "securityLevel" | "uaBlock" | "waf" | "zoneLockdown" | (string & {}))[];
+        rules?: Record<string, unknown>;
+        ruleset?: "current";
+        rulesets?: string[];
     };
     /** Body param: An informative description of the rule. */
     description?: string;
@@ -3407,9 +3661,7 @@ interface CreateRuleBaseRequest {
     /** Body param: An object configuring where the rule will be placed. */
     position?: {
         before?: string;
-    } | {
         after?: string;
-    } | {
         index?: number;
     };
     /** Body param: An object configuring the rule's rate limit behavior. */
@@ -4286,7 +4538,7 @@ interface PatchRuleBaseRequest {
     /** Body param: The unique ID of the rule. */
     id?: string;
     /** Body param: The action to perform when the rule matches. */
-    action?: "block";
+    action?: "block" | "challenge" | "compress_response" | "ddos_dynamic" | "execute" | "force_connection_close" | "js_challenge" | "log" | "log_custom_field" | "managed_challenge" | "redirect" | "rewrite" | "route" | "score" | "serve_error" | "set_cache_control" | "set_cache_settings" | "set_cache_tags" | "set_config" | "skip" | (string & {});
     /** Body param: The parameters configuring the rule's action. */
     actionParameters?: {
         response?: {
@@ -4294,6 +4546,260 @@ interface PatchRuleBaseRequest {
             contentType: string;
             statusCode: number;
         };
+    } | {
+        algorithms: {
+            name?: "none" | "auto" | "default" | "gzip" | "brotli" | "zstd" | (string & {});
+        }[];
+    } | {
+        id: string;
+        matchedData?: {
+            publicKey: string;
+        };
+        overrides?: {
+            action?: string;
+            categories?: {
+                category: string;
+                action?: string;
+                enabled?: boolean;
+                sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+            }[];
+            enabled?: boolean;
+            rules?: {
+                id: string;
+                action?: string;
+                enabled?: boolean;
+                scoreThreshold?: number;
+                sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+            }[];
+            sensitivityLevel?: "default" | "medium" | "low" | "eoff" | (string & {});
+        };
+    } | {
+        cookieFields?: {
+            name: string;
+        }[];
+        rawResponseFields?: {
+            name: string;
+            preserveDuplicates?: boolean;
+        }[];
+        requestFields?: {
+            name: string;
+        }[];
+        responseFields?: {
+            name: string;
+            preserveDuplicates?: boolean;
+        }[];
+        transformedRequestFields?: {
+            name: string;
+        }[];
+    } | {
+        fromList?: {
+            key: string;
+            name: string;
+        };
+        fromValue?: {
+            targetUrl: {
+                expression?: string;
+                value?: string;
+            };
+            preserveQueryString?: boolean;
+            statusCode?: "301" | "302" | "303" | "307" | "308" | (string & {});
+        };
+    } | {
+        headers?: Record<string, unknown>;
+        uri?: {
+            path: {
+                expression?: string;
+                value?: string;
+            };
+        } | {
+            query: {
+                expression?: string;
+                value?: string;
+            };
+        };
+    } | {
+        hostHeader?: string;
+        origin?: {
+            host?: string;
+            port?: number;
+        };
+        sni?: {
+            value: string;
+        };
+    } | {
+        increment: number;
+    } | {
+        content: string;
+        contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | (string & {});
+        statusCode?: number;
+    } | {
+        assetName: string;
+        contentType?: "application/json" | "text/html" | "text/plain" | "text/xml" | (string & {});
+        statusCode?: number;
+    } | {
+        immutable?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        maxAge?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        mustRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        mustUnderstand?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noCache?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noStore?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        noTransform?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        private?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        proxyRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        public?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        sMaxage?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        staleIfError?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+        staleWhileRevalidate?: {
+            operation: "set" | "remove" | (string & {});
+            cloudflareOnly?: boolean;
+        };
+    } | {
+        additionalCacheablePorts?: number[];
+        browserTtl?: {
+            mode: "respect_origin" | "bypass_by_default" | "override_origin" | "bypass" | (string & {});
+            default?: number;
+        };
+        cache?: boolean;
+        cacheKey?: {
+            cacheByDeviceType?: boolean;
+            cacheDeceptionArmor?: boolean;
+            customKey?: {
+                cookie?: {
+                    checkPresence?: string[];
+                    include?: string[];
+                };
+                header?: {
+                    checkPresence?: string[];
+                    contains?: Record<string, unknown>;
+                    excludeOrigin?: boolean;
+                    include?: string[];
+                };
+                host?: {
+                    resolved?: boolean;
+                };
+                queryString?: {
+                    exclude?: {
+                        all?: true;
+                        list?: string[];
+                    };
+                    include?: {
+                        all?: true;
+                        list?: string[];
+                    };
+                };
+                user?: {
+                    deviceType?: boolean;
+                    geo?: boolean;
+                    lang?: boolean;
+                };
+            };
+            ignoreQueryStringsOrder?: boolean;
+        };
+        cacheReserve?: {
+            eligible: boolean;
+            minimumFileSize?: number;
+        };
+        edgeTtl?: {
+            mode: "respect_origin" | "bypass_by_default" | "override_origin" | (string & {});
+            default?: number;
+            statusCodeTtl?: {
+                value: number;
+                statusCode?: number;
+                statusCodeRange?: {
+                    from?: number;
+                    to?: number;
+                };
+            }[];
+        };
+        originCacheControl?: boolean;
+        originErrorPagePassthru?: boolean;
+        readTimeout?: number;
+        respectStrongEtags?: boolean;
+        serveStale?: {
+            disableStaleWhileUpdating?: boolean;
+        };
+        sharedDictionary?: {
+            matchPattern: string;
+        };
+        stripEtags?: boolean;
+        stripLastModified?: boolean;
+        stripSetCookie?: boolean;
+    } | {
+        operation: "add" | "remove" | "set" | (string & {});
+        values: string[];
+    } | {
+        expression: string;
+        operation: "add" | "remove" | "set" | (string & {});
+    } | {
+        automaticHttpsRewrites?: boolean;
+        autominify?: {
+            css?: boolean;
+            html?: boolean;
+            js?: boolean;
+        };
+        bic?: boolean;
+        contentConverter?: boolean;
+        disableApps?: true;
+        disablePayPerCrawl?: true;
+        disableRum?: true;
+        disableZaraz?: true;
+        emailObfuscation?: boolean;
+        fonts?: boolean;
+        hotlinkProtection?: boolean;
+        mirage?: boolean;
+        opportunisticEncryption?: boolean;
+        polish?: "off" | "lossless" | "lossy" | "webp" | (string & {});
+        redirectsForAiTraining?: boolean;
+        requestBodyBuffering?: "none" | "standard" | "full" | (string & {});
+        responseBodyBuffering?: "none" | "standard" | (string & {});
+        rocketLoader?: boolean;
+        securityLevel?: "off" | "essentially_off" | "low" | "medium" | "high" | "under_attack" | (string & {});
+        serverSideExcludes?: boolean;
+        ssl?: "off" | "flexible" | "full" | "strict" | "origin_pull" | (string & {});
+        sxg?: boolean;
+    } | {
+        phase?: "current";
+        phases?: ("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_transform" | "http_response_cache_settings" | "http_response_compression" | "http_response_firewall_managed" | "http_response_headers_transform" | "magic_transit" | "magic_transit_ids_managed" | "magic_transit_managed" | "magic_transit_ratelimit" | (string & {}))[];
+        products?: ("bic" | "hot" | "rateLimit" | "securityLevel" | "uaBlock" | "waf" | "zoneLockdown" | (string & {}))[];
+        rules?: Record<string, unknown>;
+        ruleset?: "current";
+        rulesets?: string[];
     };
     /** Body param: An informative description of the rule. */
     description?: string;
@@ -4313,9 +4819,7 @@ interface PatchRuleBaseRequest {
     /** Body param: An object configuring where the rule will be placed. */
     position?: {
         before?: string;
-    } | {
         after?: string;
-    } | {
         index?: number;
     };
     /** Body param: An object configuring the rule's rate limit behavior. */