api.md

Queues

Types:

• Queue
• QueueDeleteResponse
• QueueGetMetricsResponse

Methods:

• client.queues.create({ ...params }) -> Queue
• client.queues.update(queueId, { ...params }) -> Queue
• client.queues.list({ ...params }) -> QueuesSinglePage
• client.queues.delete(queueId, { ...params }) -> QueueDeleteResponse
• client.queues.edit(queueId, { ...params }) -> Queue
• client.queues.get(queueId, { ...params }) -> Queue
• client.queues.getMetrics(queueId, { ...params }) -> QueueGetMetricsResponse

Messages

Types:

• MessageAckResponse
• MessageBulkPushResponse
• MessagePullResponse
• MessagePushResponse

Methods:

• client.queues.messages.ack(queueId, { ...params }) -> MessageAckResponse
• client.queues.messages.bulkPush(queueId, { ...params }) -> MessageBulkPushResponse
• client.queues.messages.pull(queueId, { ...params }) -> MessagePullResponse
• client.queues.messages.push(queueId, { ...params }) -> MessagePushResponse

Purge

Types:

• PurgeStatusResponse

Methods:

• client.queues.purge.start(queueId, { ...params }) -> Queue
• client.queues.purge.status(queueId, { ...params }) -> PurgeStatusResponse

Consumers

Types:

• Consumer
• ConsumerDeleteResponse

Methods:

• client.queues.consumers.create(queueId, { ...params }) -> Consumer
• client.queues.consumers.update(queueId, consumerId, { ...params }) -> Consumer
• client.queues.consumers.list(queueId, { ...params }) -> ConsumersSinglePage
• client.queues.consumers.delete(queueId, consumerId, { ...params }) -> ConsumerDeleteResponse
• client.queues.consumers.get(queueId, consumerId, { ...params }) -> Consumer

Subscriptions

Types:

• SubscriptionCreateResponse
• SubscriptionUpdateResponse
• SubscriptionListResponse
• SubscriptionDeleteResponse
• SubscriptionGetResponse

Methods:

• client.queues.subscriptions.create({ ...params }) -> SubscriptionCreateResponse
• client.queues.subscriptions.update(subscriptionId, { ...params }) -> SubscriptionUpdateResponse
• client.queues.subscriptions.list({ ...params }) -> SubscriptionListResponsesV4PagePaginationArray
• client.queues.subscriptions.delete(subscriptionId, { ...params }) -> SubscriptionDeleteResponse
• client.queues.subscriptions.get(subscriptionId, { ...params }) -> SubscriptionGetResponse