@appwrite.io/console 15.3.0-rc.1 → 15.4.0

package/types/services/waf.d.ts

@@ -0,0 +1,435 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Waf {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * List WAF rules for the current project.
+     *
+     *
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleList>}
+     */
+    listRules(params?: {
+        queries?: string[];
+        search?: string;
+        total?: boolean;
+    }): Promise<Models.WafRuleList>;
+    /**
+     * List WAF rules for the current project.
+     *
+     *
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRuleList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listRules(queries?: string[], search?: string, total?: boolean): Promise<Models.WafRuleList>;
+    /**
+     * Create a bypass WAF rule.
+     *
+     *
+     * @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. Leave empty for the API resource type.
+     * @param {string} params.description - Optional description for 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.WafRuleBypass>}
+     */
+    createBypassRule(params: {
+        ruleId: string;
+        resourceType: string;
+        name: string;
+        resourceId?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleBypass>;
+    /**
+     * Create a bypass WAF rule.
+     *
+     *
+     * @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. Leave empty for the API resource type.
+     * @param {string} description - Optional description for 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.WafRuleBypass>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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 {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.WafRuleBypass>}
+     */
+    updateBypassRule(params: {
+        ruleId: string;
+        resourceType?: string;
+        resourceId?: string;
+        name?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleBypass>;
+    /**
+     * Update a bypass WAF rule.
+     *
+     *
+     * @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 {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.WafRuleBypass>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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 {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.WafRuleDeny>}
+     */
+    createDenyRule(params: {
+        ruleId: string;
+        resourceType: string;
+        name: string;
+        resourceId?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleDeny>;
+    /**
+     * Create a deny WAF rule.
+     *
+     *
+     * @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 {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.WafRuleDeny>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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 {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.WafRuleDeny>}
+     */
+    updateDenyRule(params: {
+        ruleId: string;
+        resourceType?: string;
+        resourceId?: string;
+        name?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleDeny>;
+    /**
+     * Update a deny WAF rule.
+     *
+     *
+     * @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 {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.WafRuleDeny>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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 {number} params.limit - Maximum number of matching requests allowed in the configured interval.
+     * @param {number} params.interval - Interval in seconds used for rate limiting.
+     * @param {string} params.resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} params.description - Optional description for 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.WafRuleRateLimit>}
+     */
+    createRateLimitRule(params: {
+        ruleId: string;
+        resourceType: string;
+        name: string;
+        limit: number;
+        interval: number;
+        resourceId?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleRateLimit>;
+    /**
+     * Create a rate limit WAF rule.
+     *
+     *
+     * @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 {number} limit - Maximum number of matching requests allowed in the configured interval.
+     * @param {number} interval - Interval in seconds used for rate limiting.
+     * @param {string} resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} description - Optional description for 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.WafRuleRateLimit>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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 {number} params.limit - Maximum number of matching requests allowed in the configured interval.
+     * @param {number} params.interval - Interval in seconds used for rate limiting.
+     * @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.WafRuleRateLimit>}
+     */
+    updateRateLimitRule(params: {
+        ruleId: string;
+        resourceType?: string;
+        resourceId?: string;
+        name?: string;
+        description?: string;
+        limit?: number;
+        interval?: number;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleRateLimit>;
+    /**
+     * Update a rate limit WAF rule.
+     *
+     *
+     * @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 {number} limit - Maximum number of matching requests allowed in the configured interval.
+     * @param {number} interval - Interval in seconds used for rate limiting.
+     * @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.WafRuleRateLimit>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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.location - Location used for redirect responses.
+     * @param {number} params.statusCode - Integer status code used for redirect responses.
+     * @param {string} params.resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} params.description - Optional description for 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.WafRuleRedirect>}
+     */
+    createRedirectRule(params: {
+        ruleId: string;
+        resourceType: string;
+        name: string;
+        location: string;
+        statusCode: number;
+        resourceId?: string;
+        description?: string;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleRedirect>;
+    /**
+     * Create a redirect WAF rule.
+     *
+     *
+     * @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} location - Location used for redirect responses.
+     * @param {number} statusCode - Integer status code used for redirect responses.
+     * @param {string} resourceId - Resource identifier. Required for functions and sites.
+     * @param {string} description - Optional description for 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.WafRuleRedirect>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    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.
+     *
+     *
+     * @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.location - Location used for redirect responses.
+     * @param {number} params.statusCode - Integer status code used for redirect responses.
+     * @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.WafRuleRedirect>}
+     */
+    updateRedirectRule(params: {
+        ruleId: string;
+        resourceType?: string;
+        resourceId?: string;
+        name?: string;
+        description?: string;
+        location?: string;
+        statusCode?: number;
+        priority?: number;
+        enabled?: boolean;
+        conditions?: string;
+    }): Promise<Models.WafRuleRedirect>;
+    /**
+     * Update a redirect WAF rule.
+     *
+     *
+     * @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} location - Location used for redirect responses.
+     * @param {number} statusCode - Integer status code used for redirect responses.
+     * @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.WafRuleRedirect>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateRedirectRule(ruleId: string, resourceType?: string, resourceId?: string, name?: string, description?: string, location?: string, statusCode?: number, priority?: number, enabled?: boolean, conditions?: string): Promise<Models.WafRuleRedirect>;
+    /**
+     * Get a WAF rule by its ID.
+     *
+     *
+     * @param {string} params.ruleId - Rule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRule>}
+     */
+    getRule(params: {
+        ruleId: string;
+    }): Promise<Models.WafRule>;
+    /**
+     * Get a WAF rule by its ID.
+     *
+     *
+     * @param {string} ruleId - Rule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WafRule>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getRule(ruleId: string): Promise<Models.WafRule>;
+    /**
+     * Delete a WAF rule.
+     *
+     *
+     * @param {string} params.ruleId - Rule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteRule(params: {
+        ruleId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a WAF rule.
+     *
+     *
+     * @param {string} ruleId - Rule ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteRule(ruleId: string): Promise<{}>;
+}

package/types/enums/health-antivirus-status.d.ts

@@ -1,5 +0,0 @@
-export declare enum HealthAntivirusStatus {
-    Disabled = "disabled",
-    Offline = "offline",
-    Online = "online"
-}

package/types/enums/health-check-status.d.ts

@@ -1,4 +0,0 @@
-export declare enum HealthCheckStatus {
-    Pass = "pass",
-    Fail = "fail"
-}

package/types/enums/health-queue-name.d.ts

@@ -1,16 +0,0 @@
-export declare enum HealthQueueName {
-    V1database = "v1-database",
-    V1deletes = "v1-deletes",
-    V1audits = "v1-audits",
-    V1mails = "v1-mails",
-    V1functions = "v1-functions",
-    V1statsresources = "v1-stats-resources",
-    V1statsusage = "v1-stats-usage",
-    V1webhooks = "v1-webhooks",
-    V1certificates = "v1-certificates",
-    V1builds = "v1-builds",
-    V1screenshots = "v1-screenshots",
-    V1messaging = "v1-messaging",
-    V1migrations = "v1-migrations",
-    V1notifications = "v1-notifications"
-}