cloudflare/resources/queues/queues.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Queues = exports.BaseQueues = void 0;
const tslib_1 = require("../../internal/tslib.js");
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../core/resource.js");
const ConsumersAPI = tslib_1.__importStar(require("./consumers.js"));
const consumers_1 = require("./consumers.js");
const MessagesAPI = tslib_1.__importStar(require("./messages.js"));
const messages_1 = require("./messages.js");
const PurgeAPI = tslib_1.__importStar(require("./purge.js"));
const purge_1 = require("./purge.js");
const SubscriptionsAPI = tslib_1.__importStar(require("./subscriptions.js"));
const subscriptions_1 = require("./subscriptions.js");
const pagination_1 = require("../../core/pagination.js");
const path_1 = require("../../internal/utils/path.js");
var BaseQueues = /* @__PURE__ */ (() => {
    class BaseQueues extends resource_1.APIResource {
        /**
         * Creates a Queue in the account.
         *
         * @example
         * ```ts
         * const queue = await client.queues.create({
         *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *   queue_name: 'example-queue',
         * });
         * ```
         */
        create(params, options) {
            const { account_id, ...body } = params;
            return this._client.post((0, path_1.path) `/accounts/${account_id}/queues`, { body, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Replaces a Queue's configuration with the supplied configuration. This endpoint
         * does not support partial updates.
         *
         * @example
         * ```ts
         * const queue = await client.queues.update(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        update(queueID, params, options) {
            const { account_id, ...body } = params;
            return this._client.put((0, path_1.path) `/accounts/${account_id}/queues/${queueID}`, { body, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Returns the queues owned by an account.
         *
         * @example
         * ```ts
         * // Automatically fetches more pages as needed.
         * for await (const queue of client.queues.list({
         *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         * })) {
         *   // ...
         * }
         * ```
         */
        list(params, options) {
            const { account_id } = params;
            return this._client.getAPIList((0, path_1.path) `/accounts/${account_id}/queues`, (pagination_1.SinglePage), options);
        }
        /**
         * Deletes a Queue.
         *
         * @example
         * ```ts
         * const queue = await client.queues.delete(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        delete(queueID, params, options) {
            const { account_id } = params;
            return this._client.delete((0, path_1.path) `/accounts/${account_id}/queues/${queueID}`, options);
        }
        /**
         * Updates part of a Queue's configuration.
         *
         * @example
         * ```ts
         * const queue = await client.queues.edit(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        edit(queueID, params, options) {
            const { account_id, ...body } = params;
            return this._client.patch((0, path_1.path) `/accounts/${account_id}/queues/${queueID}`, {
                body,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Returns details about a specific Queue.
         *
         * @example
         * ```ts
         * const queue = await client.queues.get(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        get(queueID, params, options) {
            const { account_id } = params;
            return this._client.get((0, path_1.path) `/accounts/${account_id}/queues/${queueID}`, options)._thenUnwrap((obj) => obj.result);
        }
        /**
         * Returns best-effort metrics for a Queue. Values may be approximate due to the
         * distributed nature of Queues.
         *
         * @example
         * ```ts
         * const response = await client.queues.getMetrics(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * );
         * ```
         */
        getMetrics(queueID, params, options) {
            const { account_id } = params;
            return this._client.get((0, path_1.path) `/accounts/${account_id}/queues/${queueID}/metrics`, options)._thenUnwrap((obj) => obj.result);
        }
    }
    BaseQueues._key = Object.freeze(['queues']);
    return BaseQueues;
})();
exports.BaseQueues = BaseQueues;
var Queues = /* @__PURE__ */ (() => {
    class Queues extends BaseQueues {
        constructor() {
            super(...arguments);
            this.messages = new MessagesAPI.Messages(this._client);
            this.purge = new PurgeAPI.Purge(this._client);
            this.consumers = new ConsumersAPI.Consumers(this._client);
            this.subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
        }
    }
    Queues.Messages = messages_1.Messages;
    Queues.BaseMessages = messages_1.BaseMessages;
    Queues.Purge = purge_1.Purge;
    Queues.BasePurge = purge_1.BasePurge;
    Queues.Consumers = consumers_1.Consumers;
    Queues.BaseConsumers = consumers_1.BaseConsumers;
    Queues.Subscriptions = subscriptions_1.Subscriptions;
    Queues.BaseSubscriptions = subscriptions_1.BaseSubscriptions;
    return Queues;
})();
exports.Queues = Queues;
//# sourceMappingURL=queues.js.map