Merge pull request #57 from deskbookers/ft-DSK-1323-availability-api-fullcalendar

Ft dsk 1323 availability api fullcalendar

Author: vdvleon

README.md

@@ -53,6 +53,7 @@ for (let workplace of workplaces) {
   * [`report(params)`](docs/actions.md#reportparams)
 * availability
   * [`retrieve(params)`](docs/availability.md#retrieveparams)
+  * [`retrieveForFullCalendar(params)`](docs/availability.md#retrieveforfullcalendarparams)
 * spaces
   * [`retrieve(id)`](docs/spaces.md#retrieveid)
   * [`urgency(id, params)`](docs/spaces.md#urgencyid-params)

docs/availability.md

@@ -11,15 +11,15 @@ await deskbookers.availability.retrieve({
 })
 ```
 
-#### Arguments
+### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 venueId | Number | Venue ID | Yes
 start | String | Start date (YYYY-MM-DD) | Yes
 end | String | End date (YYYY-MM-DD), exclusive | Yes
 noCache | Bool | Ignore cache | No
 
-#### Example response
+### Example response
 
 ```json
 {
@@ -53,3 +53,44 @@ noCache | Bool | Ignore cache | No
   ]
 }
 ```
+
+## `retrieveForFullCalendar(params)`
+Retrieve fullcalendar availability for a given space and date range.
+
+```js
+await deskbookers.availability.retrieveForFullCalendar({
+  spaceId: 12345,
+  start: '2017-05-01',
+  end: '2017-05-08'
+})
+```
+
+### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+spaceId | Number | Space ID | Yes
+start | String | Start date (YYYY-MM-DD) | Yes
+end | String | End date (YYYY-MM-DD), exclusive | Yes
+noCache | Bool | Ignore cache | No
+
+### Example response
+
+```json
+[
+  {
+    "type": "closed",
+    "start": 1508709600,
+    "end": 1508742000
+  },
+  {
+    "type": "onRequest",
+    "start": 1508824800,
+    "end": 1508828400
+  },
+  {
+    "type": "occupied",
+    "start": 1508868000,
+    "end": 1508882400
+  }
+]
+```

src/resources/Availability.js

@@ -18,4 +18,20 @@ export default class Availability extends Resource {
       }
     })
   }
+
+  async retrieveForFullCalendar({
+    start,
+    end,
+    spaceId,
+    noCache = false
+  }) {
+    return await this.request({
+      path: `spaces/${spaceId}/fullCalendar`,
+      params: {
+        noCache,
+        start,
+        end
+      }
+    })
+  }
 }