cloudflare/resources/waiting-rooms/statuses.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Statuses = exports.BaseStatuses = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../core/resource.js");
const path_1 = require("../../internal/utils/path.js");
var BaseStatuses = /* @__PURE__ */ (() => {
    class BaseStatuses 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.
         *    - **suspended** indicates that the room is suspended.
         * 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.
         *
         * @example
         * ```ts
         * const status = await client.waitingRooms.statuses.get(
         *   '699d98642c564d2e855e9661899b7252',
         *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        get(waitingRoomID, params, options) {
            const { zone_id } = params;
            return this._client.get((0, path_1.path) `/zones/${zone_id}/waiting_rooms/${waitingRoomID}/status`, options)._thenUnwrap((obj) => obj.result);
        }
    }
    BaseStatuses._key = Object.freeze([
        'waitingRooms',
        'statuses',
    ]);
    return BaseStatuses;
})();
exports.BaseStatuses = BaseStatuses;
class Statuses extends BaseStatuses {
}
exports.Statuses = Statuses;
//# sourceMappingURL=statuses.js.map