cloudflare
Version:
The official TypeScript library for the Cloudflare API
35 lines • 1.76 kB
JavaScript
;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
Object.defineProperty(exports, "__esModule", { value: true });
exports.Statuses = void 0;
const resource_1 = require("cloudflare/resource");
class Statuses extends resource_1.APIResource {
/**
* 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.
* 2. `event_id`: String of the current event's `id` if an event is active,
* otherwise an empty string.
* 3. `estimated_queued_users`: Integer of the estimated number of users currently
* waiting in the queue.
* 4. `estimated_total_active_users`: Integer of the estimated number of users
* currently active on the origin.
* 5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently
* presented to the users.
*/
get(waitingRoomId, params, options) {
const { zone_id } = params;
return this._client.get(`/zones/${zone_id}/waiting_rooms/${waitingRoomId}/status`, options)._thenUnwrap((obj) => obj.result);
}
}
exports.Statuses = Statuses;
(function (Statuses) {
})(Statuses = exports.Statuses || (exports.Statuses = {}));
//# sourceMappingURL=statuses.js.map