cloudflare/resources/queues/consumers.mjs

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../core/resource.mjs";
import { SinglePage } from "../../core/pagination.mjs";
import { path } from "../../internal/utils/path.mjs";
export var BaseConsumers = /* @__PURE__ */ (() => {
    class BaseConsumers extends APIResource {
        /**
         * Creates a consumer for a Queue.
         *
         * @example
         * ```ts
         * const consumer = await client.queues.consumers.create(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   {
         *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *     script_name: 'my-consumer-worker',
         *     type: 'worker',
         *   },
         * );
         * ```
         */
        create(queueID, params, options) {
            const { account_id, ...body } = params;
            return this._client.post(path `/accounts/${account_id}/queues/${queueID}/consumers`, {
                body,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Replaces a Queue consumer, or creates it if it does not exist.
         *
         * @example
         * ```ts
         * const consumer = await client.queues.consumers.update(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   {
         *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *     queue_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *     script_name: 'my-consumer-worker',
         *     type: 'worker',
         *   },
         * );
         * ```
         */
        update(consumerID, params, options) {
            const { account_id, queue_id, ...body } = params;
            return this._client.put(path `/accounts/${account_id}/queues/${queue_id}/consumers/${consumerID}`, {
                body,
                ...options,
            })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Returns the consumers configured for a Queue.
         *
         * @example
         * ```ts
         * // Automatically fetches more pages as needed.
         * for await (const consumer of client.queues.consumers.list(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
         * )) {
         *   // ...
         * }
         * ```
         */
        list(queueID, params, options) {
            const { account_id } = params;
            return this._client.getAPIList(path `/accounts/${account_id}/queues/${queueID}/consumers`, (SinglePage), options);
        }
        /**
         * Deletes a consumer from a Queue.
         *
         * @example
         * ```ts
         * const consumer = await client.queues.consumers.delete(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   {
         *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *     queue_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *   },
         * );
         * ```
         */
        delete(consumerID, params, options) {
            const { account_id, queue_id } = params;
            return this._client.delete(path `/accounts/${account_id}/queues/${queue_id}/consumers/${consumerID}`, options);
        }
        /**
         * Returns a Queue consumer by identifier.
         *
         * @example
         * ```ts
         * const consumer = await client.queues.consumers.get(
         *   '023e105f4ecef8ad9ca31a8372d0c353',
         *   {
         *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *     queue_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *   },
         * );
         * ```
         */
        get(consumerID, params, options) {
            const { account_id, queue_id } = params;
            return this._client.get(path `/accounts/${account_id}/queues/${queue_id}/consumers/${consumerID}`, options)._thenUnwrap((obj) => obj.result);
        }
    }
    BaseConsumers._key = Object.freeze([
        'queues',
        'consumers',
    ]);
    return BaseConsumers;
})();
export class Consumers extends BaseConsumers {
}
//# sourceMappingURL=consumers.mjs.map