Merge pull request #29 from deskbookers/develop

v2.1

Author: izolate

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.1.0 - 2017-05-23
+### Added
+- `setTimezone`, `setLanguage` and `preferences` methods to `Account` resource
+- `Actions` resource with `report` method
+
 ## 2.0.1 - 2017-05-12
 ### Added
 - `createdAt` attribute to `Account` retrieval method

README.md

@@ -43,6 +43,14 @@ for (let workplace of workplaces) {
   * [`retrieve()`](docs/account.md#retrieve)
   * [`contexts(params)`](docs/account.md#contextsparams)
   * [`menu(context)`](docs/account.md#menucontext)
+  * [`setLanguage(language)`](docs/account.md#setlanguagelanguage)
+  * [`setTimezone(timezone)`](docs/account.md#settimezonetimezone)
+  * [`preferences`](docs/account.md#preferences)
+    * [`list(keys)`](docs/account.md#listkeys)
+    * [`retrieve(key)`](docs/account.md#retrievekey)
+    * [`update(params)`](docs/account.md#updateparams)
+* actions
+  * [`report(params)`](docs/actions.md#reportparams)
 * workplaces
   * [`urgency(id, params)`](docs/workplaces.md#urgencyid-params)
 * events

docs/account.md

@@ -9,13 +9,13 @@ const password = 'm4c1nt0sh'
 const user = await deskbookers.account.login(email, password)
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 email | String | User account email address | Yes
 password | String | User account password | Yes
 
-### Example response
+#### Example response
 
 ```json
 {
@@ -39,15 +39,15 @@ const user = await deskbookers.account.signup({
 })
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 firstName | String | User first name | Yes
 lastName | String |User last name | Yes
 email | String | User account email address | Yes
 password | String | User account password | Yes
 
-### Example response
+#### Example response
 
 ```json
 {
@@ -68,7 +68,7 @@ const email = '[email protected]'
 const res = await deskbookers.account.forgot(email)
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 email | String | Email address | Yes
@@ -81,7 +81,7 @@ Retrieves the current logged in user information.
 const user = await deskbookers.account.retrieve()
 ```
 
-### Example response
+#### Example response
 
 ```json
 {
@@ -105,14 +105,14 @@ const contexts = await deskbookers.account.contexts({
 })
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 query | String | Autocomplete value | No
 page | Number | Pagination number (1 indexed) | No
 supported | Array | Context type returned: 'provider' or 'venue'  | No
 
-### Example response
+#### Example response
 
 ```json
 [{
@@ -134,12 +134,12 @@ const context = contexts[0].context
 const menu = await deskbookers.account.menu(context)
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 context | String | Context code | Yes
 
-### Example response
+#### Example response
 ```json
 {
   "top": [{
@@ -204,3 +204,106 @@ context | String | Context code | Yes
   }]
 }
 ```
+
+## `setLanguage(language)`
+Store user language.
+
+```js
+await deskbookers.account.setLanguage('en-gb')
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+language | String | Language code | Yes
+
+#### Example response
+```json
+true
+```
+
+## `setTimezone(timezone)`
+Store user timezone.
+
+```js
+await deskbookers.account.setTimezone('Europe/Amsterdam')
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+timezone | String | Timezone | Yes
+
+#### Example response
+```json
+true
+```
+
+## `preferences`
+This sub-resource handles user account preferences.
+
+### `list(keys)`
+
+Returns a `Map` of account preferences. Specify an array of keys to return, or omit to return all.
+
+```js
+// Get subset of keys
+const keys = ['city', 'country', 'language', 'timezone']
+await deskbookers.account.preferences.list(...keys)
+
+// Get all
+await deskbookers.account.preferences.list()
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+keys | Array | List of keys to retrieve | No
+
+
+#### Example response
+
+```js
+Map {
+  'city' => 'Amsterdam',
+  'country' => 'Netherlands',
+  'language' => 'nl-nl',
+  'timezone' => 'Europe/Amsterdam'
+}
+```
+
+### `retrieve(key)`
+
+Retrieves the account preference value for the supplied key.
+
+```js
+const city = await deskbookers.account.preferences.retrieve('city')
+console.log(city) // 'Amsterdam'
+```
+
+### `update(params)`
+
+Accepts an object of key/values to update. Returns a `Map` of all preferences.
+
+```js
+const preferences = deskbookers.account.preferences
+
+const prefs = await preferences.update({
+  city: 'London',
+  country: 'United Kingdom',
+  timezone: 'Europe/London',
+  language: 'en-gb'
+})
+
+prefs.get('country') // 'United Kingdom'
+```
+
+#### Example response
+```js
+Map {
+  "city": "London",
+  "country": "United Kingdom",
+  "language": "en-gb",
+  "timezone": "Europe/London"
+}
+```

docs/actions.md

@@ -0,0 +1,34 @@
+# Actions
+
+## `report(params)`
+Reports a problem to Deskbookers.
+
+```js
+await deskbookers.actions.report({
+  message: `This button ain't working!`,
+  category: 'Bugs',
+  browser: 'IE6',
+  page: '/home',
+  context: 'Provider mode',
+  extras: [
+    'day' => 'It was on a sunday',
+    'weather' => 'It was rainy'
+  ]
+})
+```
+
+#### Arguments
+Name | Type | Description | Required
+--- | --- | --- | ---
+message | String | Problem message | Yes
+category | String | Problem category | Yes
+browser | String | Browser the problem occured in | Yes
+page | String | Page the problem occured | Yes
+context | String | Context in which problem occured | Yes
+extras | Array | Extra information about problem | No
+
+#### Example response
+
+```json
+true
+```

docs/events.md

@@ -7,7 +7,7 @@ Retrieves the unread count of the events, and returns a breakdown of unread coun
 const unread = await deskbookers.events.unread()
 ```
 
-### Example response
+#### Example response
 
 ```json
 {
@@ -39,7 +39,7 @@ for await (let currentBatch of eventsIterator) {
 }
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 tabId | Number | Tab id | Yes
@@ -53,7 +53,7 @@ Gets all the events for a specific user, if only events of certain type where to
 const res = await deskbookers.events.getAllEvents(30, 0, ['booking'])
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 limit | Number | Tab id | Yes
@@ -68,7 +68,7 @@ Gets all the events for a specific user, if only events of certain type where to
 const res = await deskbookers.events.markAllAsRead(['booking'])
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 tags | Array | Tags to filter the results | No

docs/workplaces.md

@@ -14,7 +14,7 @@ const urgency = await deskbookers.workplaces.urgency(12345, {
 })
 ```
 
-### Arguments
+#### Arguments
 Name | Type | Description | Required
 --- | --- | --- | ---
 id | Number | Workplace ID | Yes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deskbookers",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Deskbookers API JavaScript SDK",
   "main": "dist/index.js",
   "scripts": {
@@ -30,6 +30,7 @@
     "moment": "^2.17.1",
     "phpurlencode": "^1.0.0",
     "qs": "^6.3.0",
+    "ramda": "^0.23.0",
     "rndm": "^1.2.0",
     "url": "^0.11.0"
   },

src/Error.js renamed to src/DeskbookersError.js

@@ -1,7 +1,6 @@
 export default class DeskbookersError extends Error {
   constructor (message) {
-    super()
-    this.type = 'DeskbookersError'
-    this.message = message
+    super(message)
+    this.name = 'DeskbookersError'
   }
 }

src/InvalidResponseError.js

@@ -0,0 +1,16 @@
+import DeskbookersError from './DeskbookersError'
+
+const MAX_ERROR_LENGTH = 100
+
+export default class InvalidResponseError extends DeskbookersError {
+  constructor (text) {
+    // Prepare text
+    text = `${text || ''}`
+    if (text.length > MAX_ERROR_LENGTH) {
+      text = `${text.substr(0, MAX_ERROR_LENGTH)}...`
+    }
+
+    super(`Invalid API response received: ${text}`)
+    this.name = 'InvalidResponseError'
+  }
+}

src/index.js

@@ -1,4 +1,4 @@
-import Account from './resources/Account'
+import Account from './resources/account'
 import Cart from './resources/Cart'
 import Events from './resources/Events'
 import Workplaces from './resources/Workplaces'