Interface: QueuesApi

The methods of Talkline.queues.

Methods

addMember()

addMember(id, body): Promise<QueueMember>;

POST /v1/queues/{id}/members.

Parameters

Parameter	Type
id	string
body	AddQueueMemberRequest

Returns

Promise<QueueMember>

---

create()

create(body): Promise<Queue>;

POST /v1/queues.

Parameters

Parameter	Type
body	CreateQueueRequest

Returns

Promise<Queue>

---

entries()

entries(id, query?): Promise<Page<QueueEntry>>;

GET /v1/queues/{id}/entries: one page of the line, oldest first, and what became of each entry.

Parameters

Parameter	Type
id	string
query?	ListQueueEntriesQuery

Returns

Promise<Page<QueueEntry>>

---

explain()

explain(id, query): Promise<QueueExplanation>;

GET /v1/queues/{id}/explain: why one member scored what it did for a caller.

Parameters

Parameter	Type
id	string
query	ExplainQueueQuery

Returns

Promise<QueueExplanation>

---

get()

get(id): Promise<Queue>;

GET /v1/queues/{id}.

Parameters

Parameter	Type
id	string

Returns

Promise<Queue>

---

iterate()

iterate(query?): AsyncIterable<Queue>;

GET /v1/queues, every page in turn.

Parameters

Parameter	Type
query?	Pageless<PageQuery>

Returns

AsyncIterable<Queue>

---

iterateEntries()

iterateEntries(id, query?): AsyncIterable<QueueEntry>;

GET /v1/queues/{id}/entries, every page in turn.

Parameters

Parameter	Type
id	string
query?	Pageless<ListQueueEntriesQuery>

Returns

AsyncIterable<QueueEntry>

---

iterateMembers()

iterateMembers(id, query?): AsyncIterable<QueueMember>;

GET /v1/queues/{id}/members, every page in turn.

Parameters

Parameter	Type
id	string
query?	Pageless<PageQuery>

Returns

AsyncIterable<QueueMember>

---

list()

list(query?): Promise<Page<Queue>>;

GET /v1/queues, one page.

Parameters

Parameter	Type
query?	PageQuery

Returns

Promise<Page<Queue>>

---

listMembers()

listMembers(id, query?): Promise<Page<QueueMember>>;

GET /v1/queues/{id}/members, one page.

Parameters

Parameter	Type
id	string
query?	PageQuery

Returns

Promise<Page<QueueMember>>

---

remove()

remove(id): Promise<void>;

DELETE /v1/queues/{id}: with its members and its line.

Parameters

Parameter	Type
id	string

Returns

Promise<void>

---

removeMember()

removeMember(id, identity): Promise<void>;

DELETE /v1/queues/{id}/members/{identity}.

Parameters

Parameter	Type
id	string
identity	string

Returns

Promise<void>

---

simulate()

simulate(id, query): Promise<QueueSimulation>;

GET /v1/queues/{id}/simulate: ranks the members for a caller now, offering nothing. skills is comma-separated.

Parameters

Parameter	Type
id	string
query	SimulateQueueQuery

Returns

Promise<QueueSimulation>

---

stats()

stats(id): Promise<QueueStats>;

GET /v1/queues/{id}/stats: the line now, and how today's entries ended (UTC).

Parameters

Parameter	Type
id	string

Returns

Promise<QueueStats>

---

update()

update(id, body): Promise<Queue>;

PATCH /v1/queues/{id}: from each entry's next attempt, waiting ones included; settings, when given, replaces them whole.

Parameters

Parameter	Type
id	string
body	UpdateQueueRequest

Returns

Promise<Queue>

---

updateMember()

updateMember(
   id, 
   identity, 
   body
): Promise<QueueMember>;

PATCH /v1/queues/{id}/members/{identity}: pausedUntil pauses until then, and null resumes.

Parameters

Parameter	Type
id	string
identity	string
body	UpdateQueueMemberRequest

Returns

Promise<QueueMember>