Merge pull request #21 from deskbookers/develop

v2.0.0

Author: izolate

README.md

@@ -28,7 +28,7 @@ And every resource returns a [`Promise`](https://developer.mozilla.org/en/docs/W
 
 ```js
 
-const workplaces = await deskbookers.workplaces.list(params)
+const workplaces = await deskbookers.workplaces.retrieve(params)
 for (let workplace of workplaces) {
   // Use workplace data
 }
@@ -47,4 +47,6 @@ for (let workplace of workplaces) {
   * [`urgency(id, params)`](docs/workplaces.md#urgencyid-params)
 * events
   * [`unread()`](docs/events.md#unread)
-  * [`list(tabId, limit)`](docs/events.md##listtabid-limit)
+  * [`retrieve(tabId, limit)`](docs/events.md##retrievetabid-limit)
+  * [`list(limit, offset, tags)`](docs/events.md##list)
+  * [`markAllAsRead(tags)`](docs/events.md##mark-all-as-read)

docs/events.md

@@ -20,13 +20,13 @@ const unread = await deskbookers.events.unread()
 }
 ```
 
-## `list(tabId, limit)`
+## `retrieve(tabId, limit)`
 Lists the events for a given tab `id`. Returns an [async generator](https://github.com/tc39/proposal-async-iteration), or throws and `Error` if no events are returned.
 
 ```js
 const tabId = 1
 const eventsLimit = 10
-const eventsIterator = deskbookers.events.list(tabId, eventsLimit)
+const eventsIterator = deskbookers.events.retrieve(tabId, eventsLimit)
 
 
 // Use async generator directly
@@ -44,3 +44,31 @@ Name | Type | Description | Required
 --- | --- | --- | ---
 tabId | Number | Tab id | Yes
 eventsLimit | Number | Amount of events to return | Yes
+
+## `list(limit, offset, tags)`
+Gets all the events for a specific user, if only events of certain type where to be required you can specify them in the tags array.
+
+```js
+// gets the first page of results of all the events with the tag 'booking'
+const res = await deskbookers.events.getAllEvents(30, 0, ['booking'])
+```
+
+### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+limit | Number | Tab id | Yes
+offset | Number | Tab id | Yes
+tags | Array | Tags to filter the results | No
+
+## `markAllAsRead(tags)`
+Gets all the events for a specific user, if only events of certain type where to be required you can specify them in the tags array.
+
+```js
+// mark all events with the tag 'booking' as read
+const res = await deskbookers.events.markAllAsRead(['booking'])
+```
+
+### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+tags | Array | Tags to filter the results | No

src/resources/Events.js

@@ -12,7 +12,7 @@ export default class Events extends Resource {
     })
   }
 
-  async list (tabId = null, limit = 10) {
+  async retrieve (tabId = null, limit = 10) {
     if (!tabId) {
       throw new Error('No tab id')
     }
@@ -44,6 +44,28 @@ export default class Events extends Resource {
     }
   }
 
+  async list (limit, offset, tags = []) {
+    return await this.request({
+      method: 'GET',
+      path: 'event',
+      params: {
+        limit,
+        offset,
+        tags
+      }
+    })
+  }
+
+  async markAllAsRead (tags = []) {
+    return await this.request({
+      method: 'POST',
+      path: 'event/read',
+      params: {
+        tags
+      }
+    })
+  }
+
   async getEvents (tabId, startId, limit, offset) {
     return await this.request({
       method: 'GET',

test/events.js

@@ -29,8 +29,31 @@ test('Events', async t => {
   const unread = await deskbookers.events.unread()
   const tabId = unread.tabs[0].id
 
-  // List events
-  const events = await deskbookers.events.list(tabId)
+  // Retrieve events
+  const events = await deskbookers.events.retrieve(tabId)
   const firstBatch = await events.next()
   t.truthy(firstBatch.value.length)
 })
+
+test('Can retrieve first page containing all events', async t => {
+  await deskbookers.account.login(
+    process.env.LOGIN_EMAIL,
+    process.env.LOGIN_PASSWORD
+  )
+
+  const res = await deskbookers.events.list(30, 0)
+
+  t.truthy(Array.isArray(res))
+})
+
+test('Can mark all events as read', async t => {
+  await deskbookers.account.login(
+    process.env.LOGIN_EMAIL,
+    process.env.LOGIN_PASSWORD
+  )
+
+  const res = await deskbookers.events.markAllAsRead()
+
+  t.truthy(res)
+})
+