@appwrite.io/console 15.6.0 → 15.7.0

package/types/services/waf.d.ts

@@ -31,7 +31,7 @@ export declare class Waf {
      */
     listRules(queries?: string[], search?: string, total?: boolean): Promise<Models.WafRuleList>;
     /**
-     * Create a bypass WAF rule.
+     * Create a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -56,7 +56,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleBypass>;
     /**
-     * Create a bypass WAF rule.
+     * Create a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -73,7 +73,7 @@ export declare class Waf {
      */
     createBypassRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleBypass>;
     /**
-     * Update a bypass WAF rule.
+     * Update a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID.
@@ -98,7 +98,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleBypass>;
     /**
-     * Update a bypass WAF rule.
+     * Update a bypass WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID.
@@ -115,7 +115,97 @@ export declare class Waf {
      */
     updateBypassRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleBypass>;
     /**
-     * Create a deny WAF rule.
+     * Create a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
+     *
+     *
+     * @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
+     * @param {string} params.resourceType - Resource type the rule applies to.
+     * @param {string} params.name - Rule name.
+     * @param {string} params.resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} params.description - Optional description for the rule.
+     * @param {string} params.challengeType - Challenge type enforced by the rule.
+     * @param {number} params.priority - Evaluation priority. Lower numbers run earlier.
+     * @param {boolean} params.enabled - Set to false to create the rule in a disabled state.
+     * @param {string} params.conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleChallenge>}
+     */
+    createChallengeRule(params: {
+        ruleId: string;
+        resourceType: string;
+        name: string;
+        resourceId?: string;
+        description?: string;
+        challengeType?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleChallenge>;
+    /**
+     * Create a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
+     *
+     *
+     * @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
+     * @param {string} resourceType - Resource type the rule applies to.
+     * @param {string} name - Rule name.
+     * @param {string} resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} description - Optional description for the rule.
+     * @param {string} challengeType - Challenge type enforced by the rule.
+     * @param {number} priority - Evaluation priority. Lower numbers run earlier.
+     * @param {boolean} enabled - Set to false to create the rule in a disabled state.
+     * @param {string} conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleChallenge>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createChallengeRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, challengeType?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleChallenge>;
+    /**
+     * Update a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
+     *
+     *
+     * @param {string} params.ruleId - Rule ID.
+     * @param {string} params.resourceType - Resource type the rule applies to.
+     * @param {string} params.resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} params.name - Rule name.
+     * @param {string} params.description - Optional description for the rule.
+     * @param {string} params.challengeType - Challenge type enforced by the rule.
+     * @param {number} params.priority - Evaluation priority. Lower numbers run earlier.
+     * @param {boolean} params.enabled - Set to false to disable the rule.
+     * @param {string} params.conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleChallenge>}
+     */
+    updateChallengeRule(params: {
+        ruleId: string;
+        resourceType?: string;
+        resourceId?: string;
+        name?: string;
+        description?: string;
+        challengeType?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleChallenge>;
+    /**
+     * Update a challenge WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
+     *
+     *
+     * @param {string} ruleId - Rule ID.
+     * @param {string} resourceType - Resource type the rule applies to.
+     * @param {string} resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} name - Rule name.
+     * @param {string} description - Optional description for the rule.
+     * @param {string} challengeType - Challenge type enforced by the rule.
+     * @param {number} priority - Evaluation priority. Lower numbers run earlier.
+     * @param {boolean} enabled - Set to false to disable the rule.
+     * @param {string} conditions - Array of condition strings generated using the WAF Condition builder. Maximum of 100 conditions are allowed, each 4096 characters long.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleChallenge>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateChallengeRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, challengeType?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleChallenge>;
+    /**
+     * Create a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -140,7 +230,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleDeny>;
     /**
-     * Create a deny WAF rule.
+     * Create a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -157,7 +247,7 @@ export declare class Waf {
      */
     createDenyRule(ruleId: string, resourceType: string, name: string, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleDeny>;
     /**
-     * Update a deny WAF rule.
+     * Update a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID.
@@ -182,7 +272,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleDeny>;
     /**
-     * Update a deny WAF rule.
+     * Update a deny WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID.
@@ -199,7 +289,7 @@ export declare class Waf {
      */
     updateDenyRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleDeny>;
     /**
-     * Create a rate limit WAF rule.
+     * Create a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -228,7 +318,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleRateLimit>;
     /**
-     * Create a rate limit WAF rule.
+     * Create a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -247,7 +337,7 @@ export declare class Waf {
      */
     createRateLimitRule(ruleId: string, resourceType: string, name: string, limit: number, interval: number, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRateLimit>;
     /**
-     * Update a rate limit WAF rule.
+     * Update a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID.
@@ -276,7 +366,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleRateLimit>;
     /**
-     * Update a rate limit WAF rule.
+     * Update a rate limit WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID.
@@ -295,7 +385,7 @@ export declare class Waf {
      */
     updateRateLimitRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, limit?: number, interval?: number, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRateLimit>;
     /**
-     * Create a redirect WAF rule.
+     * Create a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -324,7 +414,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleRedirect>;
     /**
-     * Create a redirect WAF rule.
+     * Create a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID. Choose a custom ID or pass `ID.unique()` to generate a unique one.
@@ -343,7 +433,7 @@ export declare class Waf {
      */
     createRedirectRule(ruleId: string, resourceType: string, name: string, location: string, statusCode: number, resourceId?: string, description?: string, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRedirect>;
     /**
-     * Update a redirect WAF rule.
+     * Update a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} params.ruleId - Rule ID.
@@ -372,7 +462,7 @@ export declare class Waf {
         conditions?: string;
     }): Promise<Models.WafRuleRedirect>;
     /**
-     * Update a redirect WAF rule.
+     * Update a redirect WAF rule. Conditions can match request attributes including `ip` (plain IPs or CIDR blocks like `10.0.0.0/8`), `method`, `path`, `host`, `country`, `continent`, `headers.<name>`, `query.<key>`, `queryKeys`, `userAgent`, `os`, `osVersion`, `browser`, and `browserVersion`. Conditions on `city` and `state` require the premium Geo DB addon.
      *
      *
      * @param {string} ruleId - Rule ID.