api.md

WaitingRooms

Types:

• AdditionalRoutes
• CookieAttributes
• Query
• WaitingRoom
• WaitingRoomDeleteResponse

Methods:

• client.waitingRooms.create({ ...params }) -> WaitingRoom
• client.waitingRooms.update(waitingRoomId, { ...params }) -> WaitingRoom
• client.waitingRooms.list({ ...params }) -> WaitingRoomsV4PagePaginationArray
• client.waitingRooms.delete(waitingRoomId, { ...params }) -> WaitingRoomDeleteResponse
• client.waitingRooms.edit(waitingRoomId, { ...params }) -> WaitingRoom
• client.waitingRooms.get(waitingRoomId, { ...params }) -> WaitingRoom

Page

Types:

• PagePreviewResponse

Methods:

• client.waitingRooms.page.preview({ ...params }) -> PagePreviewResponse

Events

Types:

• Event
• EventDeleteResponse

Methods:

• client.waitingRooms.events.create(waitingRoomId, { ...params }) -> Event
• client.waitingRooms.events.update(waitingRoomId, eventId, { ...params }) -> Event
• client.waitingRooms.events.list(waitingRoomId, { ...params }) -> EventsV4PagePaginationArray
• client.waitingRooms.events.delete(waitingRoomId, eventId, { ...params }) -> EventDeleteResponse
• client.waitingRooms.events.edit(waitingRoomId, eventId, { ...params }) -> Event
• client.waitingRooms.events.get(waitingRoomId, eventId, { ...params }) -> Event

Details

Types:

• EventQuery
• DetailGetResponse

Methods:

• client.waitingRooms.events.details.get(waitingRoomId, eventId, { ...params }) -> DetailGetResponse

Rules

Types:

• WaitingRoomRule

Methods:

• client.waitingRooms.rules.create(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.update(waitingRoomId, [ ...rules ]) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.delete(waitingRoomId, ruleId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.edit(waitingRoomId, ruleId, { ...params }) -> WaitingRoomRulesSinglePage
• client.waitingRooms.rules.get(waitingRoomId, { ...params }) -> WaitingRoomRulesSinglePage

Statuses

Types:

• StatusGetResponse

Methods:

• client.waitingRooms.statuses.get(waitingRoomId, { ...params }) -> StatusGetResponse

Settings

Types:

• Setting
• SettingUpdateResponse
• SettingEditResponse
• SettingGetResponse

Methods:

• client.waitingRooms.settings.update({ ...params }) -> SettingUpdateResponse
• client.waitingRooms.settings.edit({ ...params }) -> SettingEditResponse
• client.waitingRooms.settings.get({ ...params }) -> SettingGetResponse