import { APIResource } from "../../resource.js"; import * as Core from "../../core.js"; import * as RulesAPI from "./rules.js"; import * as RulesetsAPI from "./rulesets.js"; import { SinglePage } from "../../pagination.js"; export declare class Versions extends APIResource { /** * Fetches the versions of an account or zone ruleset. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const versionListResponse of client.rulesets.versions.list( * '2f2feab2026849078ba485f918791bdc', * { account_id: 'account_id' }, * )) { * // ... * } * ``` */ list(rulesetId: string, params?: VersionListParams, options?: Core.RequestOptions): Core.PagePromise; list(rulesetId: string, options?: Core.RequestOptions): Core.PagePromise; /** * Deletes an existing version of an account or zone ruleset. * * @example * ```ts * await client.rulesets.versions.delete( * '2f2feab2026849078ba485f918791bdc', * '1', * { account_id: 'account_id' }, * ); * ``` */ delete(rulesetId: string, rulesetVersion: string, params?: VersionDeleteParams, options?: Core.RequestOptions): Core.APIPromise; delete(rulesetId: string, rulesetVersion: string, options?: Core.RequestOptions): Core.APIPromise; /** * Fetches a specific version of an account or zone ruleset. * * @example * ```ts * const version = await client.rulesets.versions.get( * '2f2feab2026849078ba485f918791bdc', * '1', * { account_id: 'account_id' }, * ); * ``` */ get(rulesetId: string, rulesetVersion: string, params?: VersionGetParams, options?: Core.RequestOptions): Core.APIPromise; get(rulesetId: string, rulesetVersion: string, options?: Core.RequestOptions): Core.APIPromise; } export declare class VersionListResponsesSinglePage extends SinglePage { } /** * A ruleset object. */ export interface VersionListResponse { /** * The unique ID of the ruleset. */ id: string; /** * The kind of the ruleset. */ kind: RulesetsAPI.Kind; /** * The timestamp of when the ruleset was last modified. */ last_updated: string; /** * The human-readable name of the ruleset. */ name: string; /** * The phase of the ruleset. */ phase: RulesetsAPI.Phase; /** * The version of the ruleset. */ version: string; /** * An informative description of the ruleset. */ description?: string; } /** * A ruleset object. */ export interface VersionGetResponse { /** * The unique ID of the ruleset. */ id: string; /** * The kind of the ruleset. */ kind: RulesetsAPI.Kind; /** * The timestamp of when the ruleset was last modified. */ last_updated: string; /** * The human-readable name of the ruleset. */ name: string; /** * The phase of the ruleset. */ phase: RulesetsAPI.Phase; /** * The list of rules in the ruleset. */ rules: Array; /** * The version of the ruleset. */ version: string; /** * An informative description of the ruleset. */ description?: string; } export declare namespace VersionGetResponse { interface RulesetsChallengeRule { /** * The timestamp of when the rule was last modified. */ last_updated: string; /** * The version of the rule. */ version: string; /** * The unique ID of the rule. */ id?: string; /** * The action to perform when the rule matches. */ action?: 'challenge'; /** * The parameters configuring the rule's action. */ action_parameters?: unknown; /** * The categories of the rule. */ categories?: Array; /** * An informative description of the rule. */ description?: string; /** * Whether the rule should be executed. */ enabled?: boolean; /** * Configuration for exposed credential checking. */ exposed_credential_check?: RulesetsChallengeRule.ExposedCredentialCheck; /** * The expression defining which traffic will match the rule. */ expression?: string; /** * An object configuring the rule's logging behavior. */ logging?: RulesAPI.Logging; /** * An object configuring the rule's rate limit behavior. */ ratelimit?: RulesetsChallengeRule.Ratelimit; /** * The reference of the rule (the rule's ID by default). */ ref?: string; } namespace RulesetsChallengeRule { /** * Configuration for exposed credential checking. */ interface ExposedCredentialCheck { /** * An expression that selects the password used in the credentials check. */ password_expression: string; /** * An expression that selects the user ID used in the credentials check. */ username_expression: string; } /** * An object configuring the rule's rate limit behavior. */ interface Ratelimit { /** * Characteristics of the request on which the rate limit counter will be * incremented. */ characteristics: Array; /** * Period in seconds over which the counter is being incremented. */ period: number; /** * An expression that defines when the rate limit counter should be incremented. It * defaults to the same as the rule's expression. */ counting_expression?: string; /** * Period of time in seconds after which the action will be disabled following its * first execution. */ mitigation_timeout?: number; /** * The threshold of requests per period after which the action will be executed for * the first time. */ requests_per_period?: number; /** * Whether counting is only performed when an origin is reached. */ requests_to_origin?: boolean; /** * The score threshold per period for which the action will be executed the first * time. */ score_per_period?: number; /** * A response header name provided by the origin, which contains the score to * increment rate limit counter with. */ score_response_header_name?: string; } } interface RulesetsJSChallengeRule { /** * The timestamp of when the rule was last modified. */ last_updated: string; /** * The version of the rule. */ version: string; /** * The unique ID of the rule. */ id?: string; /** * The action to perform when the rule matches. */ action?: 'js_challenge'; /** * The parameters configuring the rule's action. */ action_parameters?: unknown; /** * The categories of the rule. */ categories?: Array; /** * An informative description of the rule. */ description?: string; /** * Whether the rule should be executed. */ enabled?: boolean; /** * Configuration for exposed credential checking. */ exposed_credential_check?: RulesetsJSChallengeRule.ExposedCredentialCheck; /** * The expression defining which traffic will match the rule. */ expression?: string; /** * An object configuring the rule's logging behavior. */ logging?: RulesAPI.Logging; /** * An object configuring the rule's rate limit behavior. */ ratelimit?: RulesetsJSChallengeRule.Ratelimit; /** * The reference of the rule (the rule's ID by default). */ ref?: string; } namespace RulesetsJSChallengeRule { /** * Configuration for exposed credential checking. */ interface ExposedCredentialCheck { /** * An expression that selects the password used in the credentials check. */ password_expression: string; /** * An expression that selects the user ID used in the credentials check. */ username_expression: string; } /** * An object configuring the rule's rate limit behavior. */ interface Ratelimit { /** * Characteristics of the request on which the rate limit counter will be * incremented. */ characteristics: Array; /** * Period in seconds over which the counter is being incremented. */ period: number; /** * An expression that defines when the rate limit counter should be incremented. It * defaults to the same as the rule's expression. */ counting_expression?: string; /** * Period of time in seconds after which the action will be disabled following its * first execution. */ mitigation_timeout?: number; /** * The threshold of requests per period after which the action will be executed for * the first time. */ requests_per_period?: number; /** * Whether counting is only performed when an origin is reached. */ requests_to_origin?: boolean; /** * The score threshold per period for which the action will be executed the first * time. */ score_per_period?: number; /** * A response header name provided by the origin, which contains the score to * increment rate limit counter with. */ score_response_header_name?: string; } } interface RulesetsSetCacheControlRule { /** * The timestamp of when the rule was last modified. */ last_updated: string; /** * The version of the rule. */ version: string; /** * The unique ID of the rule. */ id?: string; /** * The action to perform when the rule matches. */ action?: 'set_cache_control'; /** * The parameters configuring the rule's action. */ action_parameters?: RulesetsSetCacheControlRule.ActionParameters; /** * The categories of the rule. */ categories?: Array; /** * An informative description of the rule. */ description?: string; /** * Whether the rule should be executed. */ enabled?: boolean; /** * Configuration for exposed credential checking. */ exposed_credential_check?: RulesetsSetCacheControlRule.ExposedCredentialCheck; /** * The expression defining which traffic will match the rule. */ expression?: string; /** * An object configuring the rule's logging behavior. */ logging?: RulesAPI.Logging; /** * An object configuring the rule's rate limit behavior. */ ratelimit?: RulesetsSetCacheControlRule.Ratelimit; /** * The reference of the rule (the rule's ID by default). */ ref?: string; } namespace RulesetsSetCacheControlRule { /** * The parameters configuring the rule's action. */ interface ActionParameters { /** * A cache-control directive configuration. */ immutable?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts a duration value in * seconds. */ 'max-age'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ 'must-revalidate'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ 'must-understand'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts optional qualifiers (header * names). */ 'no-cache'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ 'no-store'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ 'no-transform'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts optional qualifiers (header * names). */ private?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ 'proxy-revalidate'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration. */ public?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts a duration value in * seconds. */ 's-maxage'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts a duration value in * seconds. */ 'stale-if-error'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; /** * A cache-control directive configuration that accepts a duration value in * seconds. */ 'stale-while-revalidate'?: ActionParameters.SetDirective | ActionParameters.RemoveDirective; } namespace ActionParameters { /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with a duration value in seconds. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * The duration value in seconds for the directive. */ value: number; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with optional qualifiers. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; /** * Optional list of header names to qualify the directive (e.g., for "private" or * "no-cache" directives). */ qualifiers?: Array; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with optional qualifiers. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; /** * Optional list of header names to qualify the directive (e.g., for "private" or * "no-cache" directives). */ qualifiers?: Array; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with a duration value in seconds. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * The duration value in seconds for the directive. */ value: number; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with a duration value in seconds. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * The duration value in seconds for the directive. */ value: number; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Set the directive with a duration value in seconds. */ interface SetDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * The duration value in seconds for the directive. */ value: number; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } /** * Remove the directive. */ interface RemoveDirective { /** * The operation to perform on the cache-control directive. */ operation: 'set' | 'remove'; /** * Whether the directive should only be applied to the Cloudflare CDN cache. */ cloudflare_only?: boolean; } } /** * Configuration for exposed credential checking. */ interface ExposedCredentialCheck { /** * An expression that selects the password used in the credentials check. */ password_expression: string; /** * An expression that selects the user ID used in the credentials check. */ username_expression: string; } /** * An object configuring the rule's rate limit behavior. */ interface Ratelimit { /** * Characteristics of the request on which the rate limit counter will be * incremented. */ characteristics: Array; /** * Period in seconds over which the counter is being incremented. */ period: number; /** * An expression that defines when the rate limit counter should be incremented. It * defaults to the same as the rule's expression. */ counting_expression?: string; /** * Period of time in seconds after which the action will be disabled following its * first execution. */ mitigation_timeout?: number; /** * The threshold of requests per period after which the action will be executed for * the first time. */ requests_per_period?: number; /** * Whether counting is only performed when an origin is reached. */ requests_to_origin?: boolean; /** * The score threshold per period for which the action will be executed the first * time. */ score_per_period?: number; /** * A response header name provided by the origin, which contains the score to * increment rate limit counter with. */ score_response_header_name?: string; } } interface RulesetsSetCacheTagsRule { /** * The timestamp of when the rule was last modified. */ last_updated: string; /** * The version of the rule. */ version: string; /** * The unique ID of the rule. */ id?: string; /** * The action to perform when the rule matches. */ action?: 'set_cache_tags'; /** * The parameters configuring the rule's action. */ action_parameters?: RulesetsSetCacheTagsRule.AddCacheTagsValues | RulesetsSetCacheTagsRule.AddCacheTagsExpression | RulesetsSetCacheTagsRule.RemoveCacheTagsValues | RulesetsSetCacheTagsRule.RemoveCacheTagsExpression | RulesetsSetCacheTagsRule.SetCacheTagsValues | RulesetsSetCacheTagsRule.SetCacheTagsExpression; /** * The categories of the rule. */ categories?: Array; /** * An informative description of the rule. */ description?: string; /** * Whether the rule should be executed. */ enabled?: boolean; /** * Configuration for exposed credential checking. */ exposed_credential_check?: RulesetsSetCacheTagsRule.ExposedCredentialCheck; /** * The expression defining which traffic will match the rule. */ expression?: string; /** * An object configuring the rule's logging behavior. */ logging?: RulesAPI.Logging; /** * An object configuring the rule's rate limit behavior. */ ratelimit?: RulesetsSetCacheTagsRule.Ratelimit; /** * The reference of the rule (the rule's ID by default). */ ref?: string; } namespace RulesetsSetCacheTagsRule { /** * Add cache tags using a list of values. */ interface AddCacheTagsValues { /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; /** * A list of cache tag values. */ values: Array; } /** * Add cache tags using an expression. */ interface AddCacheTagsExpression { /** * An expression that evaluates to an array of cache tag values. */ expression: string; /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; } /** * Remove cache tags using a list of values. */ interface RemoveCacheTagsValues { /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; /** * A list of cache tag values. */ values: Array; } /** * Remove cache tags using an expression. */ interface RemoveCacheTagsExpression { /** * An expression that evaluates to an array of cache tag values. */ expression: string; /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; } /** * Set cache tags using a list of values. */ interface SetCacheTagsValues { /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; /** * A list of cache tag values. */ values: Array; } /** * Set cache tags using an expression. */ interface SetCacheTagsExpression { /** * An expression that evaluates to an array of cache tag values. */ expression: string; /** * The operation to perform on the cache tags. */ operation: 'add' | 'remove' | 'set'; } /** * Configuration for exposed credential checking. */ interface ExposedCredentialCheck { /** * An expression that selects the password used in the credentials check. */ password_expression: string; /** * An expression that selects the user ID used in the credentials check. */ username_expression: string; } /** * An object configuring the rule's rate limit behavior. */ interface Ratelimit { /** * Characteristics of the request on which the rate limit counter will be * incremented. */ characteristics: Array; /** * Period in seconds over which the counter is being incremented. */ period: number; /** * An expression that defines when the rate limit counter should be incremented. It * defaults to the same as the rule's expression. */ counting_expression?: string; /** * Period of time in seconds after which the action will be disabled following its * first execution. */ mitigation_timeout?: number; /** * The threshold of requests per period after which the action will be executed for * the first time. */ requests_per_period?: number; /** * Whether counting is only performed when an origin is reached. */ requests_to_origin?: boolean; /** * The score threshold per period for which the action will be executed the first * time. */ score_per_period?: number; /** * A response header name provided by the origin, which contains the score to * increment rate limit counter with. */ score_response_header_name?: string; } } } export interface VersionListParams { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ account_id?: string; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zone_id?: string; } export interface VersionDeleteParams { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ account_id?: string; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zone_id?: string; } export interface VersionGetParams { /** * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ account_id?: string; /** * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zone_id?: string; } export declare namespace Versions { export { type VersionListResponse as VersionListResponse, type VersionGetResponse as VersionGetResponse, VersionListResponsesSinglePage as VersionListResponsesSinglePage, type VersionListParams as VersionListParams, type VersionDeleteParams as VersionDeleteParams, type VersionGetParams as VersionGetParams, }; } //# sourceMappingURL=versions.d.ts.map