seatsio 63.5.0 → 65.0.0

package/.github/dependabot.yml

@@ -3,5 +3,5 @@ updates:
 - package-ecosystem: npm
   directory: "/"
   schedule:
-    interval: daily
+    interval: monthly
   open-pull-requests-limit: 10

package/.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: 'Publish'
+name: 'Publish release'
 
 on:
   release:

package/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: 'Create release'
+
+on:
+  workflow_dispatch:
+    inputs:
+      versionType:
+        description: 'minor or major'
+        required: true
+      description:
+        description: 'Release description'
+        required: true
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: oleksiyrudenko/gha-git-credentials@v2-latest
+        with:
+          token: '${{ secrets.GITHUB_TOKEN }}'
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 13
+          registry-url: https://registry.npmjs.org/
+      - run: npm version ${{ github.event.inputs.versionType }}
+      - uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true
+      - id: package-version
+        uses: martinbeentjes/npm-get-version-action@master
+      - uses: ncipollo/release-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: 'v${{ steps.package-version.outputs.current-version}}'
+          body: ${{ github.event.inputs.description }}

package/README.md

@@ -154,6 +154,23 @@ A combination of filter, sorting order and sorting option is also possible.
 let parameter = new StatusChangesParams().withFilter('testFilter').sortByStatus().sortAscending()
 ```
 
+### Retrieving object category and status (and other information)
+
+```js
+import { SeatsioClient, Region } from 'seatsio'
+
+let client = new SeatsioClient(Region.EU(), <WORKSPACE SECRET KEY>)
+let objectInfos = await client.events.retrieveObjectInfos(event.key, ['A-1', 'A-2'])
+
+console.log(objectInfos['A-1'].categoryKey)
+console.log(objectInfos['A-1'].categoryLabel)
+console.log(objectInfos['A-1'].status)
+    
+console.log(objectInfos['A-2'].categoryKey)
+console.log(objectInfos['A-2'].categoryLabel)
+console.log(objectInfos['A-2'].status)
+```
+
 ### Event reports
 
 Want to know which seats of an event are booked, and which ones are free? That’s where reporting comes in handy.
@@ -224,15 +241,42 @@ let client = new SeatsioClient(Region.EU(), <COMPANY ADMIN KEY>)
 await client.workspaces.create('a workspace');
 ```
 
+### Creating a chart and an event with the company admin key
+
+```js
+import { SeatsioClient, Region } from 'seatsio'
+
+let client = new SeatsioClient(Region.EU(), <COMPANY ADMIN KEY>, <WORKSPACE PUBLIC KEY>)
+let chart = await client.charts.create()
+let event = await client.events.create(chart.key)
+console.log(`Created a chart with key ${chart.key} and an event with key: ${event.key}`)
+```
+
 ## Error Handling
-When an API call results in an error, a rejected promise is returned with the response received from the server. This response contains a message string describing what went wrong, and also two other properties:
+When an API call results in an error, a rejected promise is returned with a value that looks like
+
+```json
+{
+  errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }],
+  messages: ['Rate limit exceeded'],
+  requestId: '123456',
+  status: 429
+}
+```
 
-- `messages`: an array of error messages that the server returned. In most cases, this array will contain only one element.
-- `requestId`: the identifier of the request you made. Please mention this to us when you have questions, as it will make debugging easier.
-- 
 ## Rate limiting - exponential backoff
 
 This library supports [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff).
 
 When you send too many concurrent requests, the server returns an error `429 - Too Many Requests`. The client reacts to this by waiting for a while, and then retrying the request.
-If the request still fails with an error `429`, it waits a little longer, and try again. This happens at most 5 times, before giving up (after approximately 15 seconds).
+If the request still fails with an error `429`, it waits a little longer, and try again. By default this happens 5 times, before giving up (after approximately 15 seconds).
+
+To change the maximum number of retries, create the `SeatsioClient` as follows:
+
+```js
+import { SeatsioClient, Region } from 'seatsio'
+
+let client = new SeatsioClient(Region.EU(), <WORKSPACE SECRET KEY>).setMaxRetries(3)
+```
+
+Passing in 0 disables exponential backoff completely. In that case, the client will never retry a failed request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "63.5.0",
+  "version": "65.0.0",
   "main": "index.js",
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",
@@ -14,15 +14,15 @@
     "url": "https://github.com/seatsio/seatsio-js"
   },
   "dependencies": {
-    "axios": "0.21.1"
+    "axios": "0.24.0"
   },
   "devDependencies": {
     "browserify": "latest",
-    "eslint": "7.25.0",
-    "eslint-config-standard": "15.0.1",
-    "eslint-plugin-import": "2.22.1",
+    "eslint": "7.32.0",
+    "eslint-config-standard": "16.0.3",
+    "eslint-plugin-import": "2.25.3",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "5.1.0",
+    "eslint-plugin-promise": "5.2.0",
     "eslint-plugin-standard": "5.0.0",
     "gulp": "latest",
     "gulp-buffer": "latest",
@@ -30,8 +30,8 @@
     "gulp-tap": "latest",
     "gulp-uglify": "latest",
     "gulp-uglify-es": "latest",
-    "jest": "26.6.3",
-    "jest-cli": "26.6.3",
+    "jest": "27.4.3",
+    "jest-cli": "27.4.3",
     "uuid": "8.3.2"
   }
 }

package/releasing.md

@@ -1,4 +1,10 @@
 *Note: this is internal documentation for the seats.io team*
 
+Through GitHub actions (the preferred way):
+
+Run https://github.com/seatsio/seatsio-js/actions/workflows/release.yml
+
+Manually:
+
 1) Set the correct version number in package.json
 2) Create the release in GitHub

package/src/Accounts/Accounts.js

@@ -8,28 +8,28 @@ class Accounts {
     }
 
     /**
-     * @returns {Promise<Account>} Promise that resolves to Account object
+     * @returns {Promise<Account>}
      */
     retrieveMyAccount () {
         return this.client.get(baseUrl).then((res) => new Account(res.data))
     }
 
     /**
-     * @returns {Promise<string>} Promise that resolves to a string
+     * @returns {Promise<string>}
      */
     regenerateSecretKey () {
         return this.client.post(baseUrl + '/secret-key/actions/regenerate').then((res) => res.data.secretKey)
     }
 
     /**
-     * @returns {Promise<string>} Promise that resolves to a string
+     * @returns {Promise<string>}
      */
     regenerateDesignerKey () {
         return this.client.post(baseUrl + '/designer-key/actions/regenerate').then((res) => res.data.designerKey)
     }
 
     /**
-     * @returns {Promise} Promise
+     * @returns {Promise}
      */
     enableDraftChartDrawings () {
         return this.client.post(baseUrl + '/draft-chart-drawings/actions/enable')

package/src/Charts/ChartListParams.js

@@ -4,11 +4,13 @@ class ChartListParams {
      * @param {?string} tag
      * @param {?boolean} expandEvents
      * @param {?boolean} withValidation
+     * @param {?number} eventsLimit
      */
-    constructor (filter = null, tag = null, expandEvents = null, withValidation = false) {
+    constructor (filter = null, tag = null, expandEvents = null, withValidation = false, eventsLimit = null) {
         this.filter = filter
         this.tag = tag
         this.validation = withValidation
+        this.eventsLimit = eventsLimit
         if (expandEvents === true) {
             this.expand = 'events'
         }
@@ -43,6 +45,15 @@ class ChartListParams {
         return this
     }
 
+    /**
+     * @param {number} eventsLimit
+     * @returns {ChartListParams}
+     */
+    withEventsLimit (eventsLimit) {
+        this.eventsLimit = eventsLimit
+        return this
+    }
+
     /**
      *
      * @param {boolean} validation
@@ -58,7 +69,8 @@ class ChartListParams {
             tag: this.tag,
             expand: this.expand,
             filter: this.filter,
-            validation: this.validation
+            validation: this.validation,
+            eventsLimit: this.eventsLimit
         }
     }
 }

package/src/{Reports/ChartReportItem.js → Charts/ChartObjectInfo.js}

@@ -1,12 +1,14 @@
 const helperFunctions = require('../utilities/helperFunctions.js')
+const { IDs } = require('../Common/IDs')
 
-class ChartReportItem {
+class ChartObjectInfo {
     /**
      * @param {object} chartReport
      */
     constructor (chartReport) {
         this.label = chartReport.label
         this.labels = helperFunctions.labelCreator(chartReport)
+        this.ids = new IDs(chartReport.ids.own, chartReport.ids.parent, chartReport.ids.section)
         this.categoryLabel = chartReport.categoryLabel
         this.categoryKey = chartReport.categoryKey
         this.entrance = chartReport.entrance
@@ -20,4 +22,4 @@ class ChartReportItem {
     }
 }
 
-module.exports = ChartReportItem
+module.exports = ChartObjectInfo

package/src/Charts/Charts.js

@@ -19,7 +19,7 @@ class Charts {
      * @param {?string} name
      * @param {?string} venueType
      * @param {?Object[]} categories
-     * @returns {Promise<Chart>} Promise that resolves to Chart object
+     * @returns {Promise<Chart>}
      */
     create (name = null, venueType = null, categories = null) {
         const requestParameters = {}
@@ -80,7 +80,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     retrieve (key) {
         return this.client.get(`charts/${key}`)
@@ -89,7 +89,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     retrieveWithEvents (key) {
         return this.client.get(`charts/${key}?expand=events`)
@@ -98,7 +98,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise} Promise that resolves to JSON
+     * @returns {Promise}
      */
     retrievePublishedVersion (key) {
         return this.client.get(`charts/${key}/version/published`)
@@ -107,7 +107,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise} Promise that resolves to JSON
+     * @returns {Promise}
      */
     retrieveDraftVersion (key) {
         return this.client.get(`charts/${key}/version/draft`)
@@ -148,7 +148,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     copy (key) {
         return this.client.post(`charts/${key}/version/published/actions/copy`)
@@ -157,7 +157,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     copyDraftVersion (key) {
         return this.client.post(`charts/${key}/version/draft/actions/copy`)
@@ -166,7 +166,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     copyToSubaccount (key, subaccountId) {
         return this.client.post(`charts/${key}/version/published/actions/copy-to/${subaccountId}`)
@@ -176,7 +176,7 @@ class Charts {
     /**
      * @param {string} key
      * @params {string} workspaceKey
-     * @returns {Promise<Chart>} Promise that resolves to a Chart object
+     * @returns {Promise<Chart>}
      */
     copyToWorkspace (key, workspaceKey) {
         return this.client.post(`charts/${key}/version/published/actions/copy-to-workspace/${workspaceKey}`)
@@ -193,7 +193,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise} Promise that resolves to an SVG doc
+     * @returns {Promise}
      */
     retrievePublishedVersionThumbnail (key) {
         return this.client.get(`/charts/${key}/version/published/thumbnail`, { responseType: 'arraybuffer' })
@@ -202,7 +202,7 @@ class Charts {
 
     /**
      * @param {string} key
-     * @returns {Promise} Promise that resolves to an SVG doc
+     * @returns {Promise}
      */
     retrieveDraftVersionThumbnail (key) {
         return this.client.get(`/charts/${key}/version/draft/thumbnail`, { responseType: 'arraybuffer' })

package/src/Common/IDs.js

@@ -0,0 +1,11 @@
+class IDs {
+    constructor (own, parent = null, section = null) {
+        this.own = own
+        this.parent = parent
+        this.section = section
+    }
+}
+
+module.exports = {
+    IDs: IDs
+}

package/src/Events/ChangeObjectStatusResult.js

@@ -2,7 +2,7 @@ const utilities = require('../utilities/reportUtility.js')
 
 class ChangeObjectStatusResult {
     /**
-     * @param {Object.<string, {EventReportItem}>} objects
+     * @param {Object.<string, {ObjectInfo}>} objects
      */
     constructor (objects) {
         this.objects = utilities.createChangeObjectStatusDetails(objects)

package/src/{Reports/EventReportItem.js → Events/EventObjectInfo.js}

@@ -1,12 +1,14 @@
 const helperFunctions = require('../utilities/helperFunctions.js')
+const { IDs } = require('../Common/IDs')
 
-class EventReportItem {
+class EventObjectInfo {
     /**
      * @param {object} report
      */
     constructor (report) {
         this.label = report.label
         this.labels = helperFunctions.labelCreator(report)
+        this.ids = new IDs(report.ids.own, report.ids.parent, report.ids.section)
         this.status = report.status
         this.categoryLabel = report.categoryLabel
         this.categoryKey = report.categoryKey
@@ -33,7 +35,12 @@ class EventReportItem {
         this.isDisabledBySocialDistancing = report.isDisabledBySocialDistancing
         this.channel = report.channel
         this.distanceToFocalPoint = report.distanceToFocalPoint
+        this.holds = report.holds
     }
 }
 
-module.exports = EventReportItem
+EventObjectInfo.FREE = 'free'
+EventObjectInfo.BOOKED = 'booked'
+EventObjectInfo.HELD = 'reservedByToken'
+
+module.exports = EventObjectInfo

package/src/Events/Events.js

@@ -1,6 +1,6 @@
 const Page = require('../Page.js')
 const Lister = require('../Lister.js')
-const ObjectStatus = require('./ObjectStatus.js')
+const EventObjectInfo = require('./EventObjectInfo.js')
 const StatusChange = require('./StatusChange.js')
 const BestAvailableObjects = require('./BestAvailableObjects.js')
 const ChangeObjectStatusResult = require('./ChangeObjectStatusResult.js')
@@ -20,7 +20,7 @@ class Events {
      * @param {?string} eventKey
      * @param {?TableBookingConfig} tableBookingConfig
      * @param {?string} socialDistancingRulesetKey
-     * @returns {Promise<Event>} Promise that resolves to Event object
+     * @returns {Promise<Event>}
      */
     create (chartKey, eventKey = null, tableBookingConfig = null, socialDistancingRulesetKey = null) {
         const requestParameters = {}
@@ -45,7 +45,7 @@ class Events {
 
     /**
      * @param {string} eventKey
-     * @returns {Promise<Event>} Promise that resolves to Event object
+     * @returns {Promise<Event>}
      */
     retrieve (eventKey) {
         return this.client.get(`/events/${encodeURIComponent(eventKey)}`)
@@ -233,12 +233,32 @@ class Events {
 
     /**
      * @param {string} eventKey
-     * @param {string} obj
-     * @returns {Promise<ObjectStatus>} Promise that resolves to ObjectStatus object
+     * @param {string} label
+     * @returns {Promise<EventObjectInfo>}
      */
-    retrieveObjectStatus (eventKey, obj) {
-        return this.client.get(`events/${encodeURIComponent(eventKey)}/objects/${encodeURIComponent(obj)}`)
-            .then((res) => new ObjectStatus(res.data))
+    async retrieveObjectInfo (eventKey, label) {
+        const result = await this.retrieveObjectInfos(eventKey, [label])
+        return result[label]
+    }
+
+    /**
+     * @param {string} eventKey
+     * @param {string[]} labels
+     * @returns {Promise<Map<String, EventObjectInfo>>}
+     */
+    retrieveObjectInfos (eventKey, labels) {
+        const params = new URLSearchParams()
+        labels.forEach(label => {
+            params.append('label', label)
+        })
+        return this.client.get(`events/${encodeURIComponent(eventKey)}/objects`, { params })
+            .then((res) => {
+                const objectInfos = res.data
+                for (const key of Object.keys(objectInfos)) {
+                    objectInfos[key] = new EventObjectInfo(objectInfos[key])
+                }
+                return objectInfos
+            })
     }
 
     /**
@@ -251,13 +271,13 @@ class Events {
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
      * @param {?boolean} ignoreSocialDistancing
-     * @returns {Promise<ChangeObjectStatusResult>} Promise that resolves to ChangeObjectStatusResult object
+     * @returns {Promise<ChangeObjectStatusResult>}
      */
     changeObjectStatus (eventKeyOrKeys, objectOrObjects, status, holdToken = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null, ignoreSocialDistancing = null) {
         const request = this.changeObjectStatusRequest(objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing)
         request.events = Array.isArray(eventKeyOrKeys) ? eventKeyOrKeys : [eventKeyOrKeys]
 
-        return this.client.post('/seasons/actions/change-object-status?expand=objects', request)
+        return this.client.post('/events/groups/actions/change-object-status?expand=objects', request)
             .then((res) => new ChangeObjectStatusResult(res.data.objects))
     }
 
@@ -311,10 +331,10 @@ class Events {
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
      * @param {?boolean} ignoreSocialDistancing
-     * @returns {Promise<ChangeObjectStatusResult>} Promise that resolves to ChangeObjectStatusResult object
+     * @returns {Promise<ChangeObjectStatusResult>}
      */
     book (eventKeyOrKeys, objectOrObjects, holdToken = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null, ignoreSocialDistancing = null) {
-        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, ObjectStatus.BOOKED, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing)
+        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, EventObjectInfo.BOOKED, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing)
     }
 
     /**
@@ -328,10 +348,10 @@ class Events {
      * @param {?boolean} keepExtraData
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
-     * @returns {Promise<BestAvailableObjects>} Promise that resolves to BestAvailableObjects object
+     * @returns {Promise<BestAvailableObjects>}
      */
     bookBestAvailable (eventKey, number, categories = null, holdToken = null, extraData = null, ticketTypes = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null) {
-        return this.changeBestAvailableObjectStatus(encodeURIComponent(eventKey), number, ObjectStatus.BOOKED, categories, holdToken, extraData, ticketTypes, orderId, keepExtraData, ignoreChannels, channelKeys)
+        return this.changeBestAvailableObjectStatus(encodeURIComponent(eventKey), number, EventObjectInfo.BOOKED, categories, holdToken, extraData, ticketTypes, orderId, keepExtraData, ignoreChannels, channelKeys)
     }
 
     /**
@@ -342,10 +362,10 @@ class Events {
      * @param {?boolean} keepExtraData
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
-     * @returns {Promise<ChangeObjectStatusResult>} Promise that resolves to ChangeObjectStatusResult object
+     * @returns {Promise<ChangeObjectStatusResult>}
      */
     release (eventKeyOrKeys, objectOrObjects, holdToken = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null) {
-        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, ObjectStatus.FREE, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys)
+        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, EventObjectInfo.FREE, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys)
     }
 
     /**
@@ -357,10 +377,10 @@ class Events {
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
      * @param {?boolean} ignoreSocialDistancing
-     * @returns {Promise<ChangeObjectStatusResult>} Promise that resolves to ChangeObjectStatusResult object
+     * @returns {Promise<ChangeObjectStatusResult>}
      */
     hold (eventKeyOrKeys, objectOrObjects, holdToken, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null, ignoreSocialDistancing = null) {
-        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, ObjectStatus.HELD, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing)
+        return this.changeObjectStatus(eventKeyOrKeys, objectOrObjects, EventObjectInfo.HELD, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing)
     }
 
     /**
@@ -375,10 +395,10 @@ class Events {
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
      * @param {?string[]} ticketTypes
-     * @returns {Promise<BestAvailableObjects>} Promise that resolves to BestAvailableObjects object
+     * @returns {Promise<BestAvailableObjects>}
      */
     holdBestAvailable (eventKey, number, holdToken, categories = null, extraData = null, ticketTypes = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null) {
-        return this.changeBestAvailableObjectStatus(encodeURIComponent(eventKey), number, ObjectStatus.HELD, categories, holdToken, extraData, ticketTypes, orderId, keepExtraData, ignoreChannels, channelKeys)
+        return this.changeBestAvailableObjectStatus(encodeURIComponent(eventKey), number, EventObjectInfo.HELD, categories, holdToken, extraData, ticketTypes, orderId, keepExtraData, ignoreChannels, channelKeys)
     }
 
     /**
@@ -393,7 +413,7 @@ class Events {
      * @param {?boolean} keepExtraData
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
-     * @returns {Promise<BestAvailableObjects>} Promise that resolves to BestAvailableObjects object
+     * @returns {Promise<BestAvailableObjects>}
      */
     changeBestAvailableObjectStatus (eventKey, number, status, categories = null, holdToken = null, extraData = null, ticketTypes = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null) {
         const requestParameters = {}

package/src/Reports/ChartReports.js

@@ -13,7 +13,7 @@ class ChartReports {
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
-     * @returns {Object.<string, ChartReportItem[]>}
+     * @returns {Object.<string, ChartObjectInfo[]>}
      */
     byLabel (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byLabel', chartKey, bookWholeTables)
@@ -22,7 +22,7 @@ class ChartReports {
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
-     * @returns {Object.<string, ChartReportItem[]>}
+     * @returns {Object.<string, ChartObjectInfo[]>}
      */
     byObjectType (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byObjectType', chartKey, bookWholeTables)
@@ -31,7 +31,7 @@ class ChartReports {
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
-     * @returns {Object.<string, ChartReportItem[]>}
+     * @returns {Object.<string, ChartObjectInfo[]>}
      */
     byCategoryLabel (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byCategoryLabel', chartKey, bookWholeTables)
@@ -40,7 +40,7 @@ class ChartReports {
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
-     * @returns {Object.<string, ChartReportItem[]>}
+     * @returns {Object.<string, ChartObjectInfo[]>}
      */
     byCategoryKey (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byCategoryKey', chartKey, bookWholeTables)