cloudflare 3.0.0 → 3.1.0

package/src/resources/firewall/waf/packages/rules.ts

@@ -16,11 +16,11 @@ export class Rules extends APIResource {
     packageId: string,
     params: RuleListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<WAFManagedRulesRulesV4PagePaginationArray, WAFManagedRulesRule> {
+  ): Core.PagePromise<RuleListResponsesV4PagePaginationArray, RuleListResponse> {
     const { zone_id, ...query } = params;
     return this._client.getAPIList(
       `/zones/${zone_id}/firewall/waf/packages/${packageId}/rules`,
-      WAFManagedRulesRulesV4PagePaginationArray,
+      RuleListResponsesV4PagePaginationArray,
       { query, ...options },
     );
   }
@@ -68,7 +68,28 @@ export class Rules extends APIResource {
   }
 }
 
-export class WAFManagedRulesRulesV4PagePaginationArray extends V4PagePaginationArray<WAFManagedRulesRule> {}
+export class RuleListResponsesV4PagePaginationArray extends V4PagePaginationArray<RuleListResponse> {}
+
+/**
+ * When set to `on`, the current WAF rule will be used when evaluating the request.
+ * Applies to anomaly detection WAF rules.
+ */
+export type AllowedModesAnomaly = 'on' | 'off';
+
+/**
+ * The rule group to which the current WAF rule belongs.
+ */
+export interface WAFRuleGroup {
+  /**
+   * The unique identifier of the rule group.
+   */
+  id?: string;
+
+  /**
+   * The name of the rule group.
+   */
+  name?: string;
+}
 
 /**
  * When triggered, anomaly detection WAF rules contribute to an overall threat
@@ -76,12 +97,12 @@ export class WAFManagedRulesRulesV4PagePaginationArray extends V4PagePaginationA
  * configure the total scoring threshold through the 'sensitivity' property of the
  * WAF package.
  */
-export type WAFManagedRulesRule =
-  | WAFManagedRulesRule.WAFManagedRulesAnomalyRule
-  | WAFManagedRulesRule.WAFManagedRulesTraditionalDenyRule
-  | WAFManagedRulesRule.WAFManagedRulesTraditionalAllowRule;
+export type RuleListResponse =
+  | RuleListResponse.WAFManagedRulesAnomalyRule
+  | RuleListResponse.WAFManagedRulesTraditionalDenyRule
+  | RuleListResponse.WAFManagedRulesTraditionalAllowRule;
 
-export namespace WAFManagedRulesRule {
+export namespace RuleListResponse {
   /**
    * When triggered, anomaly detection WAF rules contribute to an overall threat
    * score that will determine if a request is considered malicious. You can
@@ -98,7 +119,7 @@ export namespace WAFManagedRulesRule {
      * Defines the available modes for the current WAF rule. Applies to anomaly
      * detection WAF rules.
      */
-    allowed_modes: Array<'on' | 'off'>;
+    allowed_modes: Array<RulesAPI.AllowedModesAnomaly>;
 
     /**
      * The public description of the WAF rule.
@@ -108,13 +129,13 @@ export namespace WAFManagedRulesRule {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesAnomalyRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * When set to `on`, the current WAF rule will be used when evaluating the request.
      * Applies to anomaly detection WAF rules.
      */
-    mode: 'on' | 'off';
+    mode: RulesAPI.AllowedModesAnomaly;
 
     /**
      * The unique identifier of a WAF package.
@@ -127,23 +148,6 @@ export namespace WAFManagedRulesRule {
     priority: string;
   }
 
-  export namespace WAFManagedRulesAnomalyRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
-
   /**
    * When triggered, traditional WAF rules cause the firewall to immediately act upon
    * the request based on the configuration of the rule. A 'deny' rule will
@@ -174,7 +178,7 @@ export namespace WAFManagedRulesRule {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesTraditionalDenyRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * The action that the current WAF rule will perform when triggered. Applies to
@@ -193,23 +197,6 @@ export namespace WAFManagedRulesRule {
     priority: string;
   }
 
-  export namespace WAFManagedRulesTraditionalDenyRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
-
   /**
    * When triggered, traditional WAF rules cause the firewall to immediately act on
    * the request based on the rule configuration. An 'allow' rule will immediately
@@ -226,6 +213,8 @@ export namespace WAFManagedRulesRule {
      */
     allowed_modes: Array<'on' | 'off'>;
 
+    default_mode: unknown;
+
     /**
      * The public description of the WAF rule.
      */
@@ -234,7 +223,7 @@ export namespace WAFManagedRulesRule {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesTraditionalAllowRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * When set to `on`, the current rule will be used when evaluating the request.
@@ -252,23 +241,6 @@ export namespace WAFManagedRulesRule {
      */
     priority: string;
   }
-
-  export namespace WAFManagedRulesTraditionalAllowRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
 }
 
 /**
@@ -299,7 +271,7 @@ export namespace RuleEditResponse {
      * Defines the available modes for the current WAF rule. Applies to anomaly
      * detection WAF rules.
      */
-    allowed_modes: Array<'on' | 'off'>;
+    allowed_modes: Array<RulesAPI.AllowedModesAnomaly>;
 
     /**
      * The public description of the WAF rule.
@@ -309,13 +281,13 @@ export namespace RuleEditResponse {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesAnomalyRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * When set to `on`, the current WAF rule will be used when evaluating the request.
      * Applies to anomaly detection WAF rules.
      */
-    mode: 'on' | 'off';
+    mode: RulesAPI.AllowedModesAnomaly;
 
     /**
      * The unique identifier of a WAF package.
@@ -328,23 +300,6 @@ export namespace RuleEditResponse {
     priority: string;
   }
 
-  export namespace WAFManagedRulesAnomalyRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
-
   /**
    * When triggered, traditional WAF rules cause the firewall to immediately act upon
    * the request based on the configuration of the rule. A 'deny' rule will
@@ -375,7 +330,7 @@ export namespace RuleEditResponse {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesTraditionalDenyRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * The action that the current WAF rule will perform when triggered. Applies to
@@ -394,23 +349,6 @@ export namespace RuleEditResponse {
     priority: string;
   }
 
-  export namespace WAFManagedRulesTraditionalDenyRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
-
   /**
    * When triggered, traditional WAF rules cause the firewall to immediately act on
    * the request based on the rule configuration. An 'allow' rule will immediately
@@ -427,6 +365,8 @@ export namespace RuleEditResponse {
      */
     allowed_modes: Array<'on' | 'off'>;
 
+    default_mode: unknown;
+
     /**
      * The public description of the WAF rule.
      */
@@ -435,7 +375,7 @@ export namespace RuleEditResponse {
     /**
      * The rule group to which the current WAF rule belongs.
      */
-    group: WAFManagedRulesTraditionalAllowRule.Group;
+    group: RulesAPI.WAFRuleGroup;
 
     /**
      * When set to `on`, the current rule will be used when evaluating the request.
@@ -453,26 +393,9 @@ export namespace RuleEditResponse {
      */
     priority: string;
   }
-
-  export namespace WAFManagedRulesTraditionalAllowRule {
-    /**
-     * The rule group to which the current WAF rule belongs.
-     */
-    export interface Group {
-      /**
-       * The unique identifier of the rule group.
-       */
-      id?: string;
-
-      /**
-       * The name of the rule group.
-       */
-      name?: string;
-    }
-  }
 }
 
-export type RuleGetResponse = unknown | Array<unknown> | string;
+export type RuleGetResponse = unknown | string | null;
 
 export interface RuleListParams extends V4PagePaginationArrayParams {
   /**
@@ -480,11 +403,21 @@ export interface RuleListParams extends V4PagePaginationArrayParams {
    */
   zone_id: string;
 
+  /**
+   * Query param: The public description of the WAF rule.
+   */
+  description?: string;
+
   /**
    * Query param: The direction used to sort returned rules.
    */
   direction?: 'asc' | 'desc';
 
+  /**
+   * Query param: The unique identifier of the rule group.
+   */
+  group_id?: string;
+
   /**
    * Query param: When set to `all`, all the search requirements must match. When set
    * to `any`, only one of the search requirements has to match.
@@ -500,6 +433,12 @@ export interface RuleListParams extends V4PagePaginationArrayParams {
    * Query param: The field used to sort returned rules.
    */
   order?: 'priority' | 'group_id' | 'description';
+
+  /**
+   * Query param: The order in which the individual WAF rule is executed within its
+   * rule group.
+   */
+  priority?: string;
 }
 
 export interface RuleEditParams {
@@ -523,10 +462,12 @@ export interface RuleGetParams {
 }
 
 export namespace Rules {
-  export import WAFManagedRulesRule = RulesAPI.WAFManagedRulesRule;
+  export import AllowedModesAnomaly = RulesAPI.AllowedModesAnomaly;
+  export import WAFRuleGroup = RulesAPI.WAFRuleGroup;
+  export import RuleListResponse = RulesAPI.RuleListResponse;
   export import RuleEditResponse = RulesAPI.RuleEditResponse;
   export import RuleGetResponse = RulesAPI.RuleGetResponse;
-  export import WAFManagedRulesRulesV4PagePaginationArray = RulesAPI.WAFManagedRulesRulesV4PagePaginationArray;
+  export import RuleListResponsesV4PagePaginationArray = RulesAPI.RuleListResponsesV4PagePaginationArray;
   export import RuleListParams = RulesAPI.RuleListParams;
   export import RuleEditParams = RulesAPI.RuleEditParams;
   export import RuleGetParams = RulesAPI.RuleGetParams;

package/src/resources/firewall/waf/waf.ts

@@ -11,12 +11,16 @@ export class WAF extends APIResource {
 
 export namespace WAF {
   export import Overrides = OverridesAPI.Overrides;
-  export import WAFOverride = OverridesAPI.WAFOverride;
+  export import Override = OverridesAPI.Override;
+  export import OverrideURL = OverridesAPI.OverrideURL;
+  export import RewriteAction = OverridesAPI.RewriteAction;
+  export import WAFRule = OverridesAPI.WAFRule;
   export import OverrideDeleteResponse = OverridesAPI.OverrideDeleteResponse;
-  export import WAFOverridesV4PagePaginationArray = OverridesAPI.WAFOverridesV4PagePaginationArray;
+  export import OverridesV4PagePaginationArray = OverridesAPI.OverridesV4PagePaginationArray;
   export import OverrideCreateParams = OverridesAPI.OverrideCreateParams;
   export import OverrideUpdateParams = OverridesAPI.OverrideUpdateParams;
   export import OverrideListParams = OverridesAPI.OverrideListParams;
+  export import OverrideDeleteParams = OverridesAPI.OverrideDeleteParams;
   export import Packages = PackagesAPI.Packages;
   export import PackageListResponse = PackagesAPI.PackageListResponse;
   export import PackageGetResponse = PackagesAPI.PackageGetResponse;