@distilled.cloud/cloudflare 0.6.1 → 0.7.0

package/lib/services/firewall.d.ts

@@ -286,7 +286,13 @@ export interface GetLockdownResponse {
     /** The unique identifier of the Zone Lockdown rule. */
     id: string;
     /** A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. */
-    configurations: unknown;
+    configurations: ({
+        target?: "ip" | null;
+        value?: string | null;
+    } | {
+        target?: "ip_range" | null;
+        value?: string | null;
+    })[];
     /** The timestamp of when the rule was created. */
     createdOn: string;
     /** An informative summary of the rule. */
@@ -327,7 +333,13 @@ export declare const ListLockdownsRequest: Schema.Schema<ListLockdownsRequest>;
 export interface ListLockdownsResponse {
     result: {
         id: string;
-        configurations: unknown;
+        configurations: ({
+            target?: "ip" | null;
+            value?: string | null;
+        } | {
+            target?: "ip_range" | null;
+            value?: string | null;
+        })[];
         createdOn: string;
         description: string;
         modifiedOn: string;
@@ -347,7 +359,13 @@ export declare const listLockdowns: API.PaginatedOperationMethod<ListLockdownsRe
     pages: (input: ListLockdownsRequest) => stream.Stream<ListLockdownsResponse, ListLockdownsError, Credentials | HttpClient.HttpClient>;
     items: (input: ListLockdownsRequest) => stream.Stream<{
         id: string;
-        configurations: unknown;
+        configurations: ({
+            target?: "ip" | null;
+            value?: string | null;
+        } | {
+            target?: "ip_range" | null;
+            value?: string | null;
+        })[];
         createdOn: string;
         description: string;
         modifiedOn: string;
@@ -359,7 +377,13 @@ export interface CreateLockdownRequest {
     /** Path param: Defines an identifier. */
     zoneId: string;
     /** Body param: A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. */
-    configurations: unknown;
+    configurations: ({
+        target?: "ip";
+        value?: string;
+    } | {
+        target?: "ip_range";
+        value?: string;
+    })[];
     /** Body param: The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls: string[];
     /** Body param: An informative summary of the rule. This value is sanitized and any tags will be removed. */
@@ -374,7 +398,13 @@ export interface CreateLockdownResponse {
     /** The unique identifier of the Zone Lockdown rule. */
     id: string;
     /** A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. */
-    configurations: unknown;
+    configurations: ({
+        target?: "ip" | null;
+        value?: string | null;
+    } | {
+        target?: "ip_range" | null;
+        value?: string | null;
+    })[];
     /** The timestamp of when the rule was created. */
     createdOn: string;
     /** An informative summary of the rule. */
@@ -394,7 +424,13 @@ export interface UpdateLockdownRequest {
     /** Path param: Defines an identifier. */
     zoneId: string;
     /** Body param: A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. */
-    configurations: unknown;
+    configurations: ({
+        target?: "ip";
+        value?: string;
+    } | {
+        target?: "ip_range";
+        value?: string;
+    })[];
     /** Body param: The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls: string[];
 }
@@ -403,7 +439,13 @@ export interface UpdateLockdownResponse {
     /** The unique identifier of the Zone Lockdown rule. */
     id: string;
     /** A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations. */
-    configurations: unknown;
+    configurations: ({
+        target?: "ip" | null;
+        value?: string | null;
+    } | {
+        target?: "ip_range" | null;
+        value?: string | null;
+    })[];
     /** The timestamp of when the rule was created. */
     createdOn: string;
     /** An informative summary of the rule. */
@@ -443,7 +485,13 @@ export interface BulkPutRulesResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -461,7 +509,13 @@ export declare const bulkPutRules: API.PaginatedOperationMethod<BulkPutRulesRequ
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -484,7 +538,13 @@ export interface GetRuleResponse {
     action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
     /** An informative summary of the firewall rule. */
     description?: string | null;
-    filter?: unknown | {
+    filter?: {
+        id?: string | null;
+        description?: string | null;
+        expression?: string | null;
+        paused?: boolean | null;
+        ref?: string | null;
+    } | {
         id: string;
         deleted: boolean;
     } | null;
@@ -517,7 +577,13 @@ export interface ListRulesResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -541,7 +607,13 @@ export declare const listRules: API.PaginatedOperationMethod<ListRulesRequest, L
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -564,7 +636,12 @@ export interface CreateRuleRequest {
         timeout?: number;
     };
     /** Body param: */
-    filter: unknown;
+    filter: {
+        description?: string;
+        expression?: string;
+        paused?: boolean;
+        ref?: string;
+    };
 }
 export declare const CreateRuleRequest: Schema.Schema<CreateRuleRequest>;
 export interface CreateRuleResponse {
@@ -572,7 +649,13 @@ export interface CreateRuleResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -590,7 +673,13 @@ export declare const createRule: API.PaginatedOperationMethod<CreateRuleRequest,
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -614,7 +703,12 @@ export interface UpdateRuleRequest {
         timeout?: number;
     };
     /** Body param: */
-    filter: unknown;
+    filter: {
+        description?: string;
+        expression?: string;
+        paused?: boolean;
+        ref?: string;
+    };
 }
 export declare const UpdateRuleRequest: Schema.Schema<UpdateRuleRequest>;
 export interface UpdateRuleResponse {
@@ -624,7 +718,13 @@ export interface UpdateRuleResponse {
     action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
     /** An informative summary of the firewall rule. */
     description?: string | null;
-    filter?: unknown | {
+    filter?: {
+        id?: string | null;
+        description?: string | null;
+        expression?: string | null;
+        paused?: boolean | null;
+        ref?: string | null;
+    } | {
         id: string;
         deleted: boolean;
     } | null;
@@ -650,7 +750,13 @@ export interface PatchRuleResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -668,7 +774,13 @@ export declare const patchRule: API.PaginatedOperationMethod<PatchRuleRequest, P
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -691,7 +803,13 @@ export interface DeleteRuleResponse {
     action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
     /** An informative summary of the firewall rule. */
     description?: string | null;
-    filter?: unknown | {
+    filter?: {
+        id?: string | null;
+        description?: string | null;
+        expression?: string | null;
+        paused?: boolean | null;
+        ref?: string | null;
+    } | {
         id: string;
         deleted: boolean;
     } | null;
@@ -718,7 +836,13 @@ export interface BulkPatchRulesResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -736,7 +860,13 @@ export declare const bulkPatchRules: API.PaginatedOperationMethod<BulkPatchRules
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -756,7 +886,13 @@ export interface BulkDeleteRulesResponse {
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -774,7 +910,13 @@ export declare const bulkDeleteRules: API.PaginatedOperationMethod<BulkDeleteRul
         id?: string | null;
         action?: "block" | "challenge" | "js_challenge" | "managed_challenge" | "allow" | "log" | "bypass" | null;
         description?: string | null;
-        filter?: unknown | {
+        filter?: {
+            id?: string | null;
+            description?: string | null;
+            expression?: string | null;
+            paused?: boolean | null;
+            ref?: string | null;
+        } | {
             id: string;
             deleted: boolean;
         } | null;
@@ -891,7 +1033,22 @@ export interface UpdateUaRuleRequest {
     /** Path param: Defines an identifier. */
     zoneId: string;
     /** Body param: The rule configuration. */
-    configuration: unknown;
+    configuration: {
+        target?: "ip";
+        value?: string;
+    } | {
+        target?: "ip6";
+        value?: string;
+    } | {
+        target?: "ip_range";
+        value?: string;
+    } | {
+        target?: "asn";
+        value?: string;
+    } | {
+        target?: "country";
+        value?: string;
+    };
     /** Body param: The action to apply to a matched request. */
     mode: "block" | "challenge" | "whitelist" | "js_challenge" | "managed_challenge";
     /** Body param: An informative summary of the rule. This value is sanitized and any tags will be removed. */
@@ -968,7 +1125,7 @@ export interface GetWafOverrideResponse {
         simulate?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
     } | null;
     /** An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule */
-    rules?: unknown | null;
+    rules?: Record<string, unknown> | null;
     /** The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls?: string[] | null;
 }
@@ -994,7 +1151,7 @@ export interface ListWafOverridesResponse {
             disable?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
             simulate?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
         } | null;
-        rules?: unknown | null;
+        rules?: Record<string, unknown> | null;
         urls?: string[] | null;
     }[];
     resultInfo: {
@@ -1021,7 +1178,7 @@ export declare const listWafOverrides: API.PaginatedOperationMethod<ListWafOverr
             disable?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
             simulate?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
         } | null;
-        rules?: unknown | null;
+        rules?: Record<string, unknown> | null;
         urls?: string[] | null;
     }, ListWafOverridesError, Credentials | HttpClient.HttpClient>;
 };
@@ -1052,7 +1209,7 @@ export interface CreateWafOverrideResponse {
         simulate?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
     } | null;
     /** An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule */
-    rules?: unknown | null;
+    rules?: Record<string, unknown> | null;
     /** The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls?: string[] | null;
 }
@@ -1074,7 +1231,7 @@ export interface UpdateWafOverrideRequest {
         simulate?: "challenge" | "block" | "simulate" | "disable" | "default";
     };
     /** Body param: An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disa */
-    rules: unknown;
+    rules: Record<string, unknown>;
     /** Body param: The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls: string[];
 }
@@ -1099,7 +1256,7 @@ export interface UpdateWafOverrideResponse {
         simulate?: "challenge" | "block" | "simulate" | "disable" | "default" | null;
     } | null;
     /** An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule */
-    rules?: unknown | null;
+    rules?: Record<string, unknown> | null;
     /** The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. */
     urls?: string[] | null;
 }
@@ -1126,8 +1283,22 @@ export interface GetWafPackageRequest {
 }
 export declare const GetWafPackageRequest: Schema.Schema<GetWafPackageRequest>;
 export type GetWafPackageResponse = {
-    errors: unknown[];
-    messages: unknown[];
+    errors: {
+        code: number;
+        message: string;
+        documentationUrl?: string | null;
+        source?: {
+            pointer?: string | null;
+        } | null;
+    }[];
+    messages: {
+        code: number;
+        message: string;
+        documentationUrl?: string | null;
+        source?: {
+            pointer?: string | null;
+        } | null;
+    }[];
     result: string | null;
     success: true;
 } | {
@@ -1275,7 +1446,10 @@ export interface ListWafPackageRulesResponse {
         id: string;
         allowedModes: ("on" | "off")[];
         description: string;
-        group: unknown;
+        group: {
+            id?: string | null;
+            name?: string | null;
+        };
         mode: "on" | "off";
         packageId: string;
         priority: string;
@@ -1284,7 +1458,10 @@ export interface ListWafPackageRulesResponse {
         allowedModes: ("default" | "disable" | "simulate" | "block" | "challenge")[];
         defaultMode: "disable" | "simulate" | "block" | "challenge";
         description: string;
-        group: unknown;
+        group: {
+            id?: string | null;
+            name?: string | null;
+        };
         mode: "default" | "disable" | "simulate" | "block" | "challenge";
         packageId: string;
         priority: string;
@@ -1304,7 +1481,10 @@ export declare const listWafPackageRules: API.PaginatedOperationMethod<ListWafPa
         id: string;
         allowedModes: ("on" | "off")[];
         description: string;
-        group: unknown;
+        group: {
+            id?: string | null;
+            name?: string | null;
+        };
         mode: "on" | "off";
         packageId: string;
         priority: string;
@@ -1313,7 +1493,10 @@ export declare const listWafPackageRules: API.PaginatedOperationMethod<ListWafPa
         allowedModes: ("default" | "disable" | "simulate" | "block" | "challenge")[];
         defaultMode: "disable" | "simulate" | "block" | "challenge";
         description: string;
-        group: unknown;
+        group: {
+            id?: string | null;
+            name?: string | null;
+        };
         mode: "default" | "disable" | "simulate" | "block" | "challenge";
         packageId: string;
         priority: string;
@@ -1332,7 +1515,10 @@ export type PatchWafPackageRuleResponse = {
     id: string;
     allowedModes: ("on" | "off")[];
     description: string;
-    group: unknown;
+    group: {
+        id?: string | null;
+        name?: string | null;
+    };
     mode: "on" | "off";
     packageId: string;
     priority: string;
@@ -1341,7 +1527,10 @@ export type PatchWafPackageRuleResponse = {
     allowedModes: ("default" | "disable" | "simulate" | "block" | "challenge")[];
     defaultMode: "disable" | "simulate" | "block" | "challenge";
     description: string;
-    group: unknown;
+    group: {
+        id?: string | null;
+        name?: string | null;
+    };
     mode: "default" | "disable" | "simulate" | "block" | "challenge";
     packageId: string;
     priority: string;