import * as S from "@distilled.cloud/core/schema"; import * as API from "@distilled.cloud/core/api"; import { type CloudflareOpError, type CloudflareOpContext } from "../protocol.ts"; import { ResultInfo } from "../pagination.ts"; export type { CloudflareOpError, CloudflareOpContext }; declare const Forbidden_base: S.Class, import("effect/Cause").YieldableError>; export declare class Forbidden extends /*@__PURE__*/ Forbidden_base { } declare const WaitingRoomNotFound_base: S.Class, import("effect/Cause").YieldableError>; export declare class WaitingRoomNotFound extends /*@__PURE__*/ WaitingRoomNotFound_base { } declare const ZoneNotEntitled_base: S.Class, import("effect/Cause").YieldableError>; export declare class ZoneNotEntitled extends /*@__PURE__*/ ZoneNotEntitled_base { } export type EventsCreateRequestTurnstileAction = "log" | "infinite_queue"; export declare const EventsCreateRequestTurnstileAction: any; export type EventsCreateRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsCreateRequestTurnstileMode: any; export interface CreateEventRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime: string; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime: string; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string; /** A note that you can use to add more details about the event. */ description?: string; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsCreateRequestTurnstileAction | (string & {}); /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsCreateRequestTurnstileMode | (string & {}); } export declare const CreateEventRequest: S.Schema; export type EventsCreateResponseTurnstileAction = "log" | "infinite_queue"; export declare const EventsCreateResponseTurnstileAction: any; export type EventsCreateResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsCreateResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateEventResponse { id?: string | null; createdOn?: string | null; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string | null; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number | null; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsCreateResponseTurnstileAction | null; /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsCreateResponseTurnstileMode | null; } export declare const CreateEventResponse: S.Schema; export type RulesCreateRequestRulesAction = "bypass_waiting_room"; export declare const RulesCreateRequestRulesAction: any; export interface RulesCreateRequestRules { /** The action to take when the expression matches. */ action: RulesCreateRequestRulesAction | (string & {}); /** Criteria defining when there is a match for the current rule. */ expression: string; /** The description of the rule. */ description?: string; /** When set to true, the rule is enabled. */ enabled?: boolean; } export declare const RulesCreateRequestRules: S.Schema; export interface CreateRuleRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; rules: RulesCreateRequestRules; } export declare const CreateRuleRequest: S.Schema; export type RulesCreateResultItemAction = "bypass_waiting_room"; export declare const RulesCreateResultItemAction: any; export interface RulesCreateResultItem { /** The ID of the rule. */ id?: string | null; /** The action to take when the expression matches. */ action?: RulesCreateResultItemAction | null; /** The description of the rule. */ description?: string | null; /** When set to true, the rule is enabled. */ enabled?: boolean | null; /** Criteria defining when there is a match for the current rule. */ expression?: string | null; lastUpdated?: string | null; /** The version of the rule. */ version?: string | null; } export declare const RulesCreateResultItem: S.Schema; export type RulesCreateResultList = Array; export declare const RulesCreateResultList: S.Schema; export interface CreateRuleResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: RulesCreateResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const CreateRuleResponse: S.Schema; export interface CreateRequestAdditionalRoutesItem { /** The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://). */ host?: string; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string; } export declare const CreateRequestAdditionalRoutesItem: S.Schema; export type CreateRequestAdditionalRoutesList = Array; export declare const CreateRequestAdditionalRoutesList: S.Schema; export type CreateRequestCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const CreateRequestCookieAttributesSamesite: any; export type CreateRequestCookieAttributesSecure = "auto" | "always" | "never"; export declare const CreateRequestCookieAttributesSecure: any; export interface CreateRequestCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: CreateRequestCookieAttributesSamesite | (string & {}); /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: CreateRequestCookieAttributesSecure | (string & {}); } export declare const CreateRequestCookieAttributes: S.Schema; export type CreateRequestDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const CreateRequestDefaultTemplateLanguage: any; export type CreateRequestEnabledOriginCommandsItem = "revoke"; export declare const CreateRequestEnabledOriginCommandsItem: any; export type CreateRequestEnabledOriginCommandsList = Array; export declare const CreateRequestEnabledOriginCommandsList: S.Schema; export type CreateRequestQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const CreateRequestQueueingMethod: any; export type CreateRequestQueueingStatusCode = 200 | 202 | 429; export declare const CreateRequestQueueingStatusCode: any; export type CreateRequestTurnstileAction = "log" | "infinite_queue"; export declare const CreateRequestTurnstileAction: any; export type CreateRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const CreateRequestTurnstileMode: any; export interface CreateWaitingRoomRequest { /** Identifier. */ zoneId: string; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host: string; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute: number; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers: number; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: CreateRequestAdditionalRoutesList; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: CreateRequestCookieAttributes; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: CreateRequestDefaultTemplateLanguage | (string & {}); /** A note that you can use to add more details about the waiting room. */ description?: string; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean; /** A list of enabled origin commands. */ enabledOriginCommands?: CreateRequestEnabledOriginCommandsList; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: CreateRequestQueueingMethod | (string & {}); /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: CreateRequestQueueingStatusCode | (number & {}); /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: CreateRequestTurnstileAction | (string & {}); /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: CreateRequestTurnstileMode | (string & {}); } export declare const CreateWaitingRoomRequest: S.Schema; export interface CreateResponseAdditionalRoutesItem { /** The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://). */ host?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; } export declare const CreateResponseAdditionalRoutesItem: S.Schema; export type CreateResponseAdditionalRoutesList = Array; export declare const CreateResponseAdditionalRoutesList: S.Schema; export type CreateResponseCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const CreateResponseCookieAttributesSamesite: any; export type CreateResponseCookieAttributesSecure = "auto" | "always" | "never"; export declare const CreateResponseCookieAttributesSecure: any; export interface CreateResponseCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: CreateResponseCookieAttributesSamesite | null; /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: CreateResponseCookieAttributesSecure | null; } export declare const CreateResponseCookieAttributes: S.Schema; export type CreateResponseDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const CreateResponseDefaultTemplateLanguage: any; export type CreateResponseEnabledOriginCommandsItem = "revoke"; export declare const CreateResponseEnabledOriginCommandsItem: any; export type CreateResponseEnabledOriginCommandsList = Array; export declare const CreateResponseEnabledOriginCommandsList: S.Schema; export type CreateResponseQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const CreateResponseQueueingMethod: any; export type CreateResponseQueueingStatusCode = 200 | 202 | 429; export declare const CreateResponseQueueingStatusCode: any; export type CreateResponseTurnstileAction = "log" | "infinite_queue"; export declare const CreateResponseTurnstileAction: any; export type CreateResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const CreateResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface CreateWaitingRoomResponse { id?: string | null; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: CreateResponseAdditionalRoutesList | null; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: CreateResponseCookieAttributes | null; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string | null; createdOn?: string | null; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string | null; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: CreateResponseDefaultTemplateLanguage | null; /** A note that you can use to add more details about the waiting room. */ description?: string | null; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean | null; /** A list of enabled origin commands. */ enabledOriginCommands?: CreateResponseEnabledOriginCommandsList | null; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host?: string | null; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean | null; modifiedOn?: string | null; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when the next event will begin queueing. */ nextEventPrequeueStartTime?: string | null; /** An ISO 8601 timestamp that marks when the next event will start. */ nextEventStartTime?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean | null; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: CreateResponseQueueingMethod | null; /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: CreateResponseQueueingStatusCode | null; /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number | null; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean | null; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers?: number | null; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: CreateResponseTurnstileAction | null; /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: CreateResponseTurnstileMode | null; } export declare const CreateWaitingRoomResponse: S.Schema; export interface DeleteEventRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; eventId: string; } export declare const DeleteEventRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteEventResponse { id?: string | null; } export declare const DeleteEventResponse: S.Schema; export interface DeleteRuleRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** The ID of the rule. */ ruleId: string; } export declare const DeleteRuleRequest: S.Schema; export type RulesDeleteResultItemAction = "bypass_waiting_room"; export declare const RulesDeleteResultItemAction: any; export interface RulesDeleteResultItem { /** The ID of the rule. */ id?: string | null; /** The action to take when the expression matches. */ action?: RulesDeleteResultItemAction | null; /** The description of the rule. */ description?: string | null; /** When set to true, the rule is enabled. */ enabled?: boolean | null; /** Criteria defining when there is a match for the current rule. */ expression?: string | null; lastUpdated?: string | null; /** The version of the rule. */ version?: string | null; } export declare const RulesDeleteResultItem: S.Schema; export type RulesDeleteResultList = Array; export declare const RulesDeleteResultList: S.Schema; export interface DeleteRuleResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: RulesDeleteResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const DeleteRuleResponse: S.Schema; export interface DeleteWaitingRoomRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; } export declare const DeleteWaitingRoomRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface DeleteWaitingRoomResponse { id?: string | null; } export declare const DeleteWaitingRoomResponse: S.Schema; export interface GetEventRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; eventId: string; } export declare const GetEventRequest: S.Schema; export type EventsGetResponseTurnstileAction = "log" | "infinite_queue"; export declare const EventsGetResponseTurnstileAction: any; export type EventsGetResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsGetResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetEventResponse { id?: string | null; createdOn?: string | null; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string | null; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number | null; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsGetResponseTurnstileAction | null; /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsGetResponseTurnstileMode | null; } export declare const GetEventResponse: S.Schema; export interface GetEventDetailRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; eventId: string; } export declare const GetEventDetailRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetEventDetailResponse { id?: string | null; createdOn?: string | null; customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; queueingMethod?: string | null; sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; totalActiveUsers?: number | null; } export declare const GetEventDetailResponse: S.Schema; export interface GetRuleRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; } export declare const GetRuleRequest: S.Schema; export type RulesGetResultItemAction = "bypass_waiting_room"; export declare const RulesGetResultItemAction: any; export interface RulesGetResultItem { /** The ID of the rule. */ id?: string | null; /** The action to take when the expression matches. */ action?: RulesGetResultItemAction | null; /** The description of the rule. */ description?: string | null; /** When set to true, the rule is enabled. */ enabled?: boolean | null; /** Criteria defining when there is a match for the current rule. */ expression?: string | null; lastUpdated?: string | null; /** The version of the rule. */ version?: string | null; } export declare const RulesGetResultItem: S.Schema; export type RulesGetResultList = Array; export declare const RulesGetResultList: S.Schema; export interface GetRuleResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: RulesGetResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const GetRuleResponse: S.Schema; export interface GetSettingRequest { /** Identifier. */ zoneId: string; } export declare const GetSettingRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetSettingResponse { /** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. */ searchEngineCrawlerBypass: boolean; } export declare const GetSettingResponse: S.Schema; export interface GetStatusRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; } export declare const GetStatusRequest: S.Schema; export type StatusesGetResponseStatus = "event_prequeueing" | "not_queueing" | "queueing" | "suspended"; export declare const StatusesGetResponseStatus: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetStatusResponse { estimatedQueuedUsers?: number | null; estimatedTotalActiveUsers?: number | null; eventId?: string | null; maxEstimatedTimeMinutes?: number | null; status?: StatusesGetResponseStatus | null; } export declare const GetStatusResponse: S.Schema; export interface GetWaitingRoomRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; } export declare const GetWaitingRoomRequest: S.Schema; export type GetResponseAdditionalRoutesItem = CreateResponseAdditionalRoutesItem; export declare const GetResponseAdditionalRoutesItem: S.Schema; export type GetResponseAdditionalRoutesList = Array; export declare const GetResponseAdditionalRoutesList: S.Schema; export type GetResponseCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const GetResponseCookieAttributesSamesite: any; export type GetResponseCookieAttributesSecure = "auto" | "always" | "never"; export declare const GetResponseCookieAttributesSecure: any; export interface GetResponseCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: GetResponseCookieAttributesSamesite | null; /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: GetResponseCookieAttributesSecure | null; } export declare const GetResponseCookieAttributes: S.Schema; export type GetResponseDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const GetResponseDefaultTemplateLanguage: any; export type GetResponseEnabledOriginCommandsItem = "revoke"; export declare const GetResponseEnabledOriginCommandsItem: any; export type GetResponseEnabledOriginCommandsList = Array; export declare const GetResponseEnabledOriginCommandsList: S.Schema; export type GetResponseQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const GetResponseQueueingMethod: any; export type GetResponseQueueingStatusCode = 200 | 202 | 429; export declare const GetResponseQueueingStatusCode: any; export type GetResponseTurnstileAction = "log" | "infinite_queue"; export declare const GetResponseTurnstileAction: any; export type GetResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const GetResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface GetWaitingRoomResponse { id?: string | null; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: GetResponseAdditionalRoutesList | null; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: GetResponseCookieAttributes | null; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string | null; createdOn?: string | null; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string | null; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: GetResponseDefaultTemplateLanguage | null; /** A note that you can use to add more details about the waiting room. */ description?: string | null; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean | null; /** A list of enabled origin commands. */ enabledOriginCommands?: GetResponseEnabledOriginCommandsList | null; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host?: string | null; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean | null; modifiedOn?: string | null; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when the next event will begin queueing. */ nextEventPrequeueStartTime?: string | null; /** An ISO 8601 timestamp that marks when the next event will start. */ nextEventStartTime?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean | null; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: GetResponseQueueingMethod | null; /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: GetResponseQueueingStatusCode | null; /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number | null; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean | null; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers?: number | null; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: GetResponseTurnstileAction | null; /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: GetResponseTurnstileMode | null; } export declare const GetWaitingRoomResponse: S.Schema; export interface ListEventsRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** Page number of paginated results. */ page?: number; /** Maximum number of results per page. Must be a multiple of 5. */ perPage?: number; } export declare const ListEventsRequest: S.Schema; export type EventsListResultItemTurnstileAction = "log" | "infinite_queue"; export declare const EventsListResultItemTurnstileAction: any; export type EventsListResultItemTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsListResultItemTurnstileMode: any; export interface EventsListResultItem { id?: string | null; createdOn?: string | null; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string | null; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number | null; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsListResultItemTurnstileAction | null; /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsListResultItemTurnstileMode | null; } export declare const EventsListResultItem: S.Schema; export type EventsListResultList = Array; export declare const EventsListResultList: S.Schema; export interface ListEventsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: EventsListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListEventsResponse: S.Schema; export interface ListWaitingRoomsForAccountRequest { /** The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. */ accountId: string; /** Page number of paginated results. */ page?: number; /** Maximum number of results per page. Must be a multiple of 5. */ perPage?: number; } export declare const ListWaitingRoomsForAccountRequest: S.Schema; export type ListResultItemAdditionalRoutesItem = CreateResponseAdditionalRoutesItem; export declare const ListResultItemAdditionalRoutesItem: S.Schema; export type ListResultItemAdditionalRoutesList = Array; export declare const ListResultItemAdditionalRoutesList: S.Schema; export type ListResultItemCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const ListResultItemCookieAttributesSamesite: any; export type ListResultItemCookieAttributesSecure = "auto" | "always" | "never"; export declare const ListResultItemCookieAttributesSecure: any; export interface ListResultItemCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: ListResultItemCookieAttributesSamesite | null; /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: ListResultItemCookieAttributesSecure | null; } export declare const ListResultItemCookieAttributes: S.Schema; export type ListResultItemDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const ListResultItemDefaultTemplateLanguage: any; export type ListResultItemEnabledOriginCommandsItem = "revoke"; export declare const ListResultItemEnabledOriginCommandsItem: any; export type ListResultItemEnabledOriginCommandsList = Array; export declare const ListResultItemEnabledOriginCommandsList: S.Schema; export type ListResultItemQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const ListResultItemQueueingMethod: any; export type ListResultItemQueueingStatusCode = 200 | 202 | 429; export declare const ListResultItemQueueingStatusCode: any; export type ListResultItemTurnstileAction = "log" | "infinite_queue"; export declare const ListResultItemTurnstileAction: any; export type ListResultItemTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const ListResultItemTurnstileMode: any; export interface ListResultItem { id?: string | null; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: ListResultItemAdditionalRoutesList | null; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: ListResultItemCookieAttributes | null; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string | null; createdOn?: string | null; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string | null; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: ListResultItemDefaultTemplateLanguage | null; /** A note that you can use to add more details about the waiting room. */ description?: string | null; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean | null; /** A list of enabled origin commands. */ enabledOriginCommands?: ListResultItemEnabledOriginCommandsList | null; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host?: string | null; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean | null; modifiedOn?: string | null; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when the next event will begin queueing. */ nextEventPrequeueStartTime?: string | null; /** An ISO 8601 timestamp that marks when the next event will start. */ nextEventStartTime?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean | null; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: ListResultItemQueueingMethod | null; /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: ListResultItemQueueingStatusCode | null; /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number | null; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean | null; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers?: number | null; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: ListResultItemTurnstileAction | null; /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: ListResultItemTurnstileMode | null; } export declare const ListResultItem: S.Schema; export type ListResultList = Array; export declare const ListResultList: S.Schema; export interface ListWaitingRoomsResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: ListResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const ListWaitingRoomsResponse: S.Schema; export interface ListWaitingRoomsForZoneRequest { /** The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. */ zoneId: string; /** Page number of paginated results. */ page?: number; /** Maximum number of results per page. Must be a multiple of 5. */ perPage?: number; } export declare const ListWaitingRoomsForZoneRequest: S.Schema; export type EventsEditRequestTurnstileAction = "log" | "infinite_queue"; export declare const EventsEditRequestTurnstileAction: any; export type EventsEditRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsEditRequestTurnstileMode: any; export interface PatchEventRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; eventId: string; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime: string; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime: string; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string; /** A note that you can use to add more details about the event. */ description?: string; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsEditRequestTurnstileAction | (string & {}); /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsEditRequestTurnstileMode | (string & {}); } export declare const PatchEventRequest: S.Schema; export type EventsEditResponseTurnstileAction = "log" | "infinite_queue"; export declare const EventsEditResponseTurnstileAction: any; export type EventsEditResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsEditResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchEventResponse { id?: string | null; createdOn?: string | null; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string | null; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number | null; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsEditResponseTurnstileAction | null; /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsEditResponseTurnstileMode | null; } export declare const PatchEventResponse: S.Schema; export type RulesEditRequestAction = "bypass_waiting_room"; export declare const RulesEditRequestAction: any; export interface RulesEditRequestPositionIndex { /** Places the rule in the exact position specified by the integer number . Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten). */ index?: number; } export declare const RulesEditRequestPositionIndex: S.Schema; export interface RulesEditRequestPositionBefore { /** Places the rule before rule . Use this argument with an empty rule ID value ("") to set the rule as the first rule in the ruleset. */ before?: string; } export declare const RulesEditRequestPositionBefore: S.Schema; export interface RulesEditRequestPositionAfter { /** Places the rule after rule . Use this argument with an empty rule ID value ("") to set the rule as the last rule in the ruleset. */ after?: string; } export declare const RulesEditRequestPositionAfter: S.Schema; export type RulesEditRequestPosition = RulesEditRequestPositionIndex | RulesEditRequestPositionBefore | RulesEditRequestPositionAfter; export declare const RulesEditRequestPosition: any; export interface PatchRuleRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** The ID of the rule. */ ruleId: string; /** The action to take when the expression matches. */ action: RulesEditRequestAction | (string & {}); /** Criteria defining when there is a match for the current rule. */ expression: string; /** The description of the rule. */ description?: string; /** When set to true, the rule is enabled. */ enabled?: boolean; /** Reorder the position of a rule */ position?: RulesEditRequestPosition; } export declare const PatchRuleRequest: S.Schema; export type RulesEditResultItemAction = "bypass_waiting_room"; export declare const RulesEditResultItemAction: any; export interface RulesEditResultItem { /** The ID of the rule. */ id?: string | null; /** The action to take when the expression matches. */ action?: RulesEditResultItemAction | null; /** The description of the rule. */ description?: string | null; /** When set to true, the rule is enabled. */ enabled?: boolean | null; /** Criteria defining when there is a match for the current rule. */ expression?: string | null; lastUpdated?: string | null; /** The version of the rule. */ version?: string | null; } export declare const RulesEditResultItem: S.Schema; export type RulesEditResultList = Array; export declare const RulesEditResultList: S.Schema; export interface PatchRuleResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: RulesEditResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const PatchRuleResponse: S.Schema; export interface PatchSettingRequest { /** Identifier. */ zoneId: string; /** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. */ searchEngineCrawlerBypass?: boolean; } export declare const PatchSettingRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchSettingResponse { /** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. */ searchEngineCrawlerBypass: boolean; } export declare const PatchSettingResponse: S.Schema; export type EditRequestAdditionalRoutesItem = CreateRequestAdditionalRoutesItem; export declare const EditRequestAdditionalRoutesItem: S.Schema; export type EditRequestAdditionalRoutesList = Array; export declare const EditRequestAdditionalRoutesList: S.Schema; export type EditRequestCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const EditRequestCookieAttributesSamesite: any; export type EditRequestCookieAttributesSecure = "auto" | "always" | "never"; export declare const EditRequestCookieAttributesSecure: any; export interface EditRequestCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: EditRequestCookieAttributesSamesite | (string & {}); /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: EditRequestCookieAttributesSecure | (string & {}); } export declare const EditRequestCookieAttributes: S.Schema; export type EditRequestDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const EditRequestDefaultTemplateLanguage: any; export type EditRequestEnabledOriginCommandsItem = "revoke"; export declare const EditRequestEnabledOriginCommandsItem: any; export type EditRequestEnabledOriginCommandsList = Array; export declare const EditRequestEnabledOriginCommandsList: S.Schema; export type EditRequestQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const EditRequestQueueingMethod: any; export type EditRequestQueueingStatusCode = 200 | 202 | 429; export declare const EditRequestQueueingStatusCode: any; export type EditRequestTurnstileAction = "log" | "infinite_queue"; export declare const EditRequestTurnstileAction: any; export type EditRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EditRequestTurnstileMode: any; export interface PatchWaitingRoomRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host: string; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute: number; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers: number; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: EditRequestAdditionalRoutesList; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: EditRequestCookieAttributes; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: EditRequestDefaultTemplateLanguage | (string & {}); /** A note that you can use to add more details about the waiting room. */ description?: string; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean; /** A list of enabled origin commands. */ enabledOriginCommands?: EditRequestEnabledOriginCommandsList; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: EditRequestQueueingMethod | (string & {}); /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: EditRequestQueueingStatusCode | (number & {}); /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: EditRequestTurnstileAction | (string & {}); /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: EditRequestTurnstileMode | (string & {}); } export declare const PatchWaitingRoomRequest: S.Schema; export type EditResponseAdditionalRoutesItem = CreateResponseAdditionalRoutesItem; export declare const EditResponseAdditionalRoutesItem: S.Schema; export type EditResponseAdditionalRoutesList = Array; export declare const EditResponseAdditionalRoutesList: S.Schema; export type EditResponseCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const EditResponseCookieAttributesSamesite: any; export type EditResponseCookieAttributesSecure = "auto" | "always" | "never"; export declare const EditResponseCookieAttributesSecure: any; export interface EditResponseCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: EditResponseCookieAttributesSamesite | null; /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: EditResponseCookieAttributesSecure | null; } export declare const EditResponseCookieAttributes: S.Schema; export type EditResponseDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const EditResponseDefaultTemplateLanguage: any; export type EditResponseEnabledOriginCommandsItem = "revoke"; export declare const EditResponseEnabledOriginCommandsItem: any; export type EditResponseEnabledOriginCommandsList = Array; export declare const EditResponseEnabledOriginCommandsList: S.Schema; export type EditResponseQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const EditResponseQueueingMethod: any; export type EditResponseQueueingStatusCode = 200 | 202 | 429; export declare const EditResponseQueueingStatusCode: any; export type EditResponseTurnstileAction = "log" | "infinite_queue"; export declare const EditResponseTurnstileAction: any; export type EditResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EditResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PatchWaitingRoomResponse { id?: string | null; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: EditResponseAdditionalRoutesList | null; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: EditResponseCookieAttributes | null; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string | null; createdOn?: string | null; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string | null; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: EditResponseDefaultTemplateLanguage | null; /** A note that you can use to add more details about the waiting room. */ description?: string | null; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean | null; /** A list of enabled origin commands. */ enabledOriginCommands?: EditResponseEnabledOriginCommandsList | null; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host?: string | null; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean | null; modifiedOn?: string | null; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when the next event will begin queueing. */ nextEventPrequeueStartTime?: string | null; /** An ISO 8601 timestamp that marks when the next event will start. */ nextEventStartTime?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean | null; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: EditResponseQueueingMethod | null; /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: EditResponseQueueingStatusCode | null; /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number | null; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean | null; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers?: number | null; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: EditResponseTurnstileAction | null; /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: EditResponseTurnstileMode | null; } export declare const PatchWaitingRoomResponse: S.Schema; export interface PreviewPageRequest { /** Identifier. */ zoneId: string; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customHtml: string; } export declare const PreviewPageRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PreviewPageResponse { /** URL where the custom waiting room page can temporarily be previewed. */ previewUrl?: string | null; } export declare const PreviewPageResponse: S.Schema; export interface PutSettingRequest { /** Identifier. */ zoneId: string; /** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. */ searchEngineCrawlerBypass?: boolean; } export declare const PutSettingRequest: S.Schema; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface PutSettingResponse { /** Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone. */ searchEngineCrawlerBypass: boolean; } export declare const PutSettingResponse: S.Schema; export type EventsUpdateRequestTurnstileAction = "log" | "infinite_queue"; export declare const EventsUpdateRequestTurnstileAction: any; export type EventsUpdateRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsUpdateRequestTurnstileMode: any; export interface UpdateEventRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; eventId: string; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime: string; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime: string; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string; /** A note that you can use to add more details about the event. */ description?: string; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsUpdateRequestTurnstileAction | (string & {}); /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsUpdateRequestTurnstileMode | (string & {}); } export declare const UpdateEventRequest: S.Schema; export type EventsUpdateResponseTurnstileAction = "log" | "infinite_queue"; export declare const EventsUpdateResponseTurnstileAction: any; export type EventsUpdateResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const EventsUpdateResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface UpdateEventResponse { id?: string | null; createdOn?: string | null; /** If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it. */ customPageHtml?: string | null; /** A note that you can use to add more details about the event. */ description?: string | null; /** If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it. */ disableSessionRenewal?: boolean | null; /** An ISO 8601 timestamp that marks the end of the event. */ eventEndTime?: string | null; /** An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`. */ eventStartTime?: string | null; modifiedOn?: string | null; /** A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`. */ prequeueStartTime?: string | null; /** If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it. */ queueingMethod?: string | null; /** If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it. */ sessionDuration?: number | null; /** If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary. */ shuffleAtEventStart?: boolean | null; /** Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration. */ suspended?: boolean | null; /** If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set. */ totalActiveUsers?: number | null; /** If set, the event will override the waiting room's `turnstile_action` property while it is active. If null, the event will inherit it. */ turnstileAction?: EventsUpdateResponseTurnstileAction | null; /** If set, the event will override the waiting room's `turnstile_mode` property while it is active. If null, the event will inherit it. */ turnstileMode?: EventsUpdateResponseTurnstileMode | null; } export declare const UpdateEventResponse: S.Schema; export type RulesUpdateRequestRulesItemAction = "bypass_waiting_room"; export declare const RulesUpdateRequestRulesItemAction: any; export interface RulesUpdateRequestRulesItem { /** The action to take when the expression matches. */ action: RulesUpdateRequestRulesItemAction | (string & {}); /** Criteria defining when there is a match for the current rule. */ expression: string; /** The description of the rule. */ description?: string; /** When set to true, the rule is enabled. */ enabled?: boolean; } export declare const RulesUpdateRequestRulesItem: S.Schema; export type RulesUpdateRequestRulesList = Array; export declare const RulesUpdateRequestRulesList: S.Schema; export interface UpdateRuleRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; rules: RulesUpdateRequestRulesList; } export declare const UpdateRuleRequest: S.Schema; export type RulesUpdateResultItemAction = "bypass_waiting_room"; export declare const RulesUpdateResultItemAction: any; export interface RulesUpdateResultItem { /** The ID of the rule. */ id?: string | null; /** The action to take when the expression matches. */ action?: RulesUpdateResultItemAction | null; /** The description of the rule. */ description?: string | null; /** When set to true, the rule is enabled. */ enabled?: boolean | null; /** Criteria defining when there is a match for the current rule. */ expression?: string | null; lastUpdated?: string | null; /** The version of the rule. */ version?: string | null; } export declare const RulesUpdateResultItem: S.Schema; export type RulesUpdateResultList = Array; export declare const RulesUpdateResultList: S.Schema; export interface UpdateRuleResponse { /** The unwrapped `result` payload of the v4 response envelope. */ result: RulesUpdateResultList; /** Pagination info from the envelope's `result_info`. */ resultInfo?: ResultInfo | null; } export declare const UpdateRuleResponse: S.Schema; export type UpdateRequestAdditionalRoutesItem = CreateRequestAdditionalRoutesItem; export declare const UpdateRequestAdditionalRoutesItem: S.Schema; export type UpdateRequestAdditionalRoutesList = Array; export declare const UpdateRequestAdditionalRoutesList: S.Schema; export type UpdateRequestCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const UpdateRequestCookieAttributesSamesite: any; export type UpdateRequestCookieAttributesSecure = "auto" | "always" | "never"; export declare const UpdateRequestCookieAttributesSecure: any; export interface UpdateRequestCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: UpdateRequestCookieAttributesSamesite | (string & {}); /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: UpdateRequestCookieAttributesSecure | (string & {}); } export declare const UpdateRequestCookieAttributes: S.Schema; export type UpdateRequestDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const UpdateRequestDefaultTemplateLanguage: any; export type UpdateRequestEnabledOriginCommandsItem = "revoke"; export declare const UpdateRequestEnabledOriginCommandsItem: any; export type UpdateRequestEnabledOriginCommandsList = Array; export declare const UpdateRequestEnabledOriginCommandsList: S.Schema; export type UpdateRequestQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const UpdateRequestQueueingMethod: any; export type UpdateRequestQueueingStatusCode = 200 | 202 | 429; export declare const UpdateRequestQueueingStatusCode: any; export type UpdateRequestTurnstileAction = "log" | "infinite_queue"; export declare const UpdateRequestTurnstileAction: any; export type UpdateRequestTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const UpdateRequestTurnstileMode: any; export interface UpdateWaitingRoomRequest { /** Identifier. */ zoneId: string; waitingRoomId: string; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host: string; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name: string; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute: number; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers: number; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: UpdateRequestAdditionalRoutesList; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: UpdateRequestCookieAttributes; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: UpdateRequestDefaultTemplateLanguage | (string & {}); /** A note that you can use to add more details about the waiting room. */ description?: string; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean; /** A list of enabled origin commands. */ enabledOriginCommands?: UpdateRequestEnabledOriginCommandsList; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: UpdateRequestQueueingMethod | (string & {}); /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: UpdateRequestQueueingStatusCode | (number & {}); /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: UpdateRequestTurnstileAction | (string & {}); /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: UpdateRequestTurnstileMode | (string & {}); } export declare const UpdateWaitingRoomRequest: S.Schema; export type UpdateResponseAdditionalRoutesItem = CreateResponseAdditionalRoutesItem; export declare const UpdateResponseAdditionalRoutesItem: S.Schema; export type UpdateResponseAdditionalRoutesList = Array; export declare const UpdateResponseAdditionalRoutesList: S.Schema; export type UpdateResponseCookieAttributesSamesite = "auto" | "lax" | "none" | "strict"; export declare const UpdateResponseCookieAttributesSamesite: any; export type UpdateResponseCookieAttributesSecure = "auto" | "always" | "never"; export declare const UpdateResponseCookieAttributesSecure: any; export interface UpdateResponseCookieAttributes { /** Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`. */ samesite?: UpdateResponseCookieAttributesSamesite | null; /** Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled. */ secure?: UpdateResponseCookieAttributesSecure | null; } export declare const UpdateResponseCookieAttributes: S.Schema; export type UpdateResponseDefaultTemplateLanguage = "en-US" | "es-ES" | "de-DE" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW" | "nl-NL" | "pl-PL" | "id-ID" | "tr-TR" | "ar-EG" | "ru-RU" | "fa-IR" | "bg-BG" | "hr-HR" | "cs-CZ" | "da-DK" | "fi-FI" | "lt-LT" | "ms-MY" | "nb-NO" | "ro-RO" | "el-GR" | "he-IL" | "hi-IN" | "hu-HU" | "sr-BA" | "sk-SK" | "sl-SI" | "sv-SE" | "tl-PH" | "th-TH" | "uk-UA" | "vi-VN"; export declare const UpdateResponseDefaultTemplateLanguage: any; export type UpdateResponseEnabledOriginCommandsItem = "revoke"; export declare const UpdateResponseEnabledOriginCommandsItem: any; export type UpdateResponseEnabledOriginCommandsList = Array; export declare const UpdateResponseEnabledOriginCommandsList: S.Schema; export type UpdateResponseQueueingMethod = "fifo" | "random" | "passthrough" | "reject"; export declare const UpdateResponseQueueingMethod: any; export type UpdateResponseQueueingStatusCode = 200 | 202 | 429; export declare const UpdateResponseQueueingStatusCode: any; export type UpdateResponseTurnstileAction = "log" | "infinite_queue"; export declare const UpdateResponseTurnstileAction: any; export type UpdateResponseTurnstileMode = "off" | "invisible" | "visible_non_interactive" | "visible_managed"; export declare const UpdateResponseTurnstileMode: any; /** Unwrapped `result` payload of the Cloudflare v4 response envelope. */ export interface UpdateWaitingRoomResponse { id?: string | null; /** Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. */ additionalRoutes?: UpdateResponseAdditionalRoutesList | null; /** Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position. */ cookieAttributes?: UpdateResponseCookieAttributes | null; /** Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`. */ cookieSuffix?: string | null; createdOn?: string | null; /** Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge: */ customPageHtml?: string | null; /** The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used. */ defaultTemplateLanguage?: UpdateResponseDefaultTemplateLanguage | null; /** A note that you can use to add more details about the waiting room. */ description?: string | null; /** Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request. */ disableSessionRenewal?: boolean | null; /** A list of enabled origin commands. */ enabledOriginCommands?: UpdateResponseEnabledOriginCommandsList | null; /** The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique. */ host?: string | null; /** Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields: */ jsonResponseEnabled?: boolean | null; modifiedOn?: string | null; /** A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed. */ name?: string | null; /** Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world. */ newUsersPerMinute?: number | null; /** An ISO 8601 timestamp that marks when the next event will begin queueing. */ nextEventPrequeueStartTime?: string | null; /** An ISO 8601 timestamp that marks when the next event will start. */ nextEventStartTime?: string | null; /** Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported. */ path?: string | null; /** If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable. */ queueAll?: boolean | null; /** Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are: */ queueingMethod?: UpdateResponseQueueingMethod | null; /** HTTP status code returned to a user while in the queue. */ queueingStatusCode?: UpdateResponseQueueingStatusCode | null; /** Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route. */ sessionDuration?: number | null; /** Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room. */ suspended?: boolean | null; /** Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world. */ totalActiveUsers?: number | null; /** Which action to take when a bot is detected using Turnstile. `log` will */ turnstileAction?: UpdateResponseTurnstileAction | null; /** Which Turnstile widget type to use for detecting bot traffic. See */ turnstileMode?: UpdateResponseTurnstileMode | null; } export declare const UpdateWaitingRoomResponse: S.Schema; export type CreateEventError = CloudflareOpError; /** Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time. */ export declare const createEvent: API.OperationMethod; export type CreateRuleError = CloudflareOpError; /** Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room. */ export declare const createRule: API.PaginatedOperationMethod; export type CreateWaitingRoomError = ZoneNotEntitled | Forbidden | CloudflareOpError; /** Creates a new waiting room. */ export declare const createWaitingRoom: API.OperationMethod; export type DeleteEventError = CloudflareOpError; /** Deletes an event for a waiting room. */ export declare const deleteEvent: API.OperationMethod; export type DeleteRuleError = CloudflareOpError; /** Deletes a rule for a waiting room. */ export declare const deleteRule: API.PaginatedOperationMethod; export type DeleteWaitingRoomError = WaitingRoomNotFound | Forbidden | CloudflareOpError; /** Deletes a waiting room. */ export declare const deleteWaitingRoom: API.OperationMethod; export type GetEventError = CloudflareOpError; /** Fetches a single configured event for a waiting room. */ export declare const getEvent: API.OperationMethod; export type GetEventDetailError = CloudflareOpError; /** Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values. */ export declare const getEventDetail: API.OperationMethod; export type GetRuleError = CloudflareOpError; /** Lists rules for a waiting room. */ export declare const getRule: API.PaginatedOperationMethod; export type GetSettingError = Forbidden | CloudflareOpError; /** Gets the zone-level Waiting Room settings that apply as defaults to all waiting rooms on the zone. */ export declare const getSetting: API.OperationMethod; export type GetStatusError = CloudflareOpError; /** Fetches the status of a configured waiting room. Response fields include: 1. `status`: String indicating the status of the waiting room. The possible status are: - **not\_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin. - **queueing** indicates that the thresholds have been met and some users are held in the waiting room. - **event\_prequeueing** indicates that an event is active and is currently prequeueing users before it starts. - **suspended** indicates that the room is suspended. 1. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string. 1. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue. 1. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin. 1. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users. */ export declare const getStatus: API.OperationMethod; export type GetWaitingRoomError = WaitingRoomNotFound | Forbidden | CloudflareOpError; /** Fetches a single configured waiting room. */ export declare const getWaitingRoom: API.OperationMethod; export type ListEventsError = CloudflareOpError; /** Lists events for a waiting room. */ export declare const listEvents: API.PaginatedOperationMethod; export type ListWaitingRoomsForAccountError = Forbidden | CloudflareOpError; /** Lists waiting rooms for account or zone. */ export declare const listWaitingRoomsForAccount: API.PaginatedOperationMethod; export type ListWaitingRoomsForZoneError = Forbidden | CloudflareOpError; /** Lists waiting rooms for account or zone. */ export declare const listWaitingRoomsForZone: API.PaginatedOperationMethod; export type PatchEventError = CloudflareOpError; /** Patches a configured event for a waiting room. */ export declare const patchEvent: API.OperationMethod; export type PatchRuleError = CloudflareOpError; /** Patches a rule for a waiting room. */ export declare const patchRule: API.PaginatedOperationMethod; export type PatchSettingError = CloudflareOpError; /** Partially updates zone-level Waiting Room settings using PATCH semantics. */ export declare const patchSetting: API.OperationMethod; export type PatchWaitingRoomError = CloudflareOpError; /** Patches a configured waiting room. */ export declare const patchWaitingRoom: API.OperationMethod; export type PreviewPageError = CloudflareOpError; /** Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/`. You can use the following query parameters to change the state of the preview: 1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll). 1. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment. 1. `queueing_method`: The queueing method currently used by the waiting room. - **fifo** indicates a FIFO queue. - **random** indicates a Random queue. - **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning "Welcome". - **reject** indicates a Reject queue. 1. `event`: Used to preview a waiting room event. - **none** indicates no event is occurring. - **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`). - **started** indicates that an event has started (between `event_start_time` and `event_end_time`). 1. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**). For example, you can make a request to `http://waitingrooms.dev/preview/?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true` 6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes. For example, you can make a request to `http://waitingrooms.dev/preview/?waitTime=50` to configure the estimated wait time as 50 minutes. */ export declare const previewPage: API.OperationMethod; export type PutSettingError = ZoneNotEntitled | Forbidden | CloudflareOpError; /** Fully updates zone-level Waiting Room settings, replacing the existing configuration. */ export declare const putSetting: API.OperationMethod; export type UpdateEventError = CloudflareOpError; /** Updates a configured event for a waiting room. */ export declare const updateEvent: API.OperationMethod; export type UpdateRuleError = CloudflareOpError; /** Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room. */ export declare const updateRule: API.PaginatedOperationMethod; export type UpdateWaitingRoomError = WaitingRoomNotFound | ZoneNotEntitled | Forbidden | CloudflareOpError; /** Updates a configured waiting room. */ export declare const updateWaitingRoom: API.OperationMethod; //# sourceMappingURL=waiting_rooms.d.ts.map