seatsio 64.0.0 → 65.0.0

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,12 +241,29 @@ 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).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "64.0.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.32.0",
     "eslint-config-standard": "16.0.3",
-    "eslint-plugin-import": "2.24.2",
+    "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": "27.1.0",
-    "jest-cli": "27.1.0",
+    "jest": "27.4.3",
+    "jest-cli": "27.4.3",
     "uuid": "8.3.2"
   }
 }

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/Events/Events.js

@@ -277,7 +277,7 @@ class Events {
         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))
     }
 

package/src/Reports/EventReports.js

@@ -170,8 +170,8 @@ class EventReports {
      * @param {?string} selectability
      * @returns {Object.<string, ObjectInfo[]>}
      */
-    bySelectability (eventKey, selectability = null) {
-        return this.client.get(EventReports.reportUrl('bySelectability', eventKey, selectability))
+    byAvailability (eventKey, selectability = null) {
+        return this.client.get(EventReports.reportUrl('byAvailability', eventKey, selectability))
             .then((res) => utilities.createEventReport(res.data))
     }
 
@@ -179,8 +179,8 @@ class EventReports {
      * @param {string} eventKey
      * @returns {Object} JSON response from the server
      */
-    summaryBySelectability (eventKey) {
-        return this.client.get(EventReports.summaryReportUrl('bySelectability', eventKey))
+    summaryByAvailability (eventKey) {
+        return this.client.get(EventReports.summaryReportUrl('byAvailability', eventKey))
             .then((res) => res.data)
     }
 
@@ -188,8 +188,8 @@ class EventReports {
      * @param {string} eventKey
      * @returns {Object} JSON response from the server
      */
-    deepSummaryBySelectability (eventKey) {
-        return this.client.get(EventReports.deepSummaryReportUrl('bySelectability', eventKey))
+    deepSummaryByAvailability (eventKey) {
+        return this.client.get(EventReports.deepSummaryReportUrl('byAvailability', eventKey))
             .then((res) => res.data)
     }
 

package/src/errorInterceptor.js

@@ -4,10 +4,9 @@ function errorResponseHandler (error) {
             if (typeof error.response.data !== 'undefined' && error.response.data) {
                 reject(error.response.data)
             } else if (typeof error.response.statusText !== 'undefined' && error.response.statusText) {
-        reject(`${error.config.method} ${error.config.url} resulted in ${error.response.status}  ${error.response.statusText}  error`) // eslint-disable-line
+        reject(`${error.config.method} ${error.config.url} resulted in ${error.response.status} ${error.response.statusText} error`) // eslint-disable-line
             }
         } else {
-            console.log(error)
             reject(error)
         }
     })

package/tests/charts/listAllCharts.test.js

@@ -2,7 +2,7 @@ const ChartListParams = require('../../src/Charts/ChartListParams.js')
 const testUtils = require('../testUtils.js')
 
 test('listAll when there are many charts', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const charts = await testUtils.createArray(15, () => client.charts.create())
 
     const retrievedKeys = []
@@ -14,7 +14,7 @@ test('listAll when there are many charts', async () => {
 })
 
 test('listAll when there are no charts', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const retrievedKeys = []
 
     for await (const chart of client.charts.listAll()) {
@@ -25,7 +25,7 @@ test('listAll when there are no charts', async () => {
 })
 
 test('listAll Charts with filter', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const fooCharts = await testUtils.createArray(3, () => client.charts.create('foo'))
     await client.charts.create('bar')
     const params = new ChartListParams().withFilter('foo')
@@ -39,7 +39,7 @@ test('listAll Charts with filter', async () => {
 })
 
 test('listAll Charts with tag', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const fooCharts = await testUtils.createArray(3, async () => {
         const chart = await client.charts.create()
         await client.charts.addTag(chart.key, 'foo')
@@ -58,7 +58,7 @@ test('listAll Charts with tag', async () => {
 })
 
 test('listAll Charts with tag and filter parameters', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const chart1 = await client.charts.create('bar')
     const chart2 = await client.charts.create()
     const chart3 = await client.charts.create('bar')
@@ -77,7 +77,7 @@ test('listAll Charts with tag and filter parameters', async () => {
 })
 
 test('listAll Charts with expandEvents parameters', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const chart1 = await client.charts.create()
     const chart2 = await client.charts.create()
     const promises = [
@@ -100,8 +100,30 @@ test('listAll Charts with expandEvents parameters', async () => {
     expect(retrievedKeys.sort()).toEqual(generatedEventKeys.sort())
 })
 
+test('listAll Charts with expandEvents parameters and eventsLimit', async () => {
+    const { client } = await testUtils.createTestUserAndClient()
+    const chart1 = await client.charts.create()
+    const promises = [
+        client.events.create(chart1.key),
+        client.events.create(chart1.key),
+        client.events.create(chart1.key)
+    ]
+    const events = await Promise.all(promises)
+    const expectedEventKeys = [events[0].key, events[1].key]
+    const retrievedKeys = []
+    const params = new ChartListParams().withExpandEvents(true).withEventsLimit(2)
+
+    for await (const chart of client.charts.listAll(params)) {
+        for (const event of chart.events) {
+            retrievedKeys.push(event.key)
+        }
+    }
+
+    expect(retrievedKeys.sort()).toEqual(expectedEventKeys.sort())
+})
+
 test('list all charts with validation', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     await testUtils.createArray(3, () => client.charts.create())
     const params = new ChartListParams(...Array(3), true)
 
@@ -111,7 +133,7 @@ test('list all charts with validation', async () => {
 })
 
 test('list all charts without validation', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     await testUtils.createArray(3, () => client.charts.create())
     const params = new ChartListParams()
 

package/tests/eventReports/eventReport.test.js

@@ -252,7 +252,7 @@ test('report by object type', async () => {
     expect(report.booth.length).toBe(0)
 })
 
-test('report by selectability', async () => {
+test('report by availability', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
@@ -261,13 +261,13 @@ test('report by selectability', async () => {
     await client.events.book(event.key, 'A-2', null, 'order1')
     await client.events.book(event.key, 'A-3', null, 'order2')
 
-    const report = await client.eventReports.bySelectability(event.key)
+    const report = await client.eventReports.byAvailability(event.key)
 
-    expect(report.selectable.length).toBe(31)
-    expect(report.not_selectable.length).toBe(3)
+    expect(report.available.length).toBe(31)
+    expect(report.not_available.length).toBe(3)
 })
 
-test('report by specific selectability', async () => {
+test('report by specific availability', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
@@ -276,9 +276,9 @@ test('report by specific selectability', async () => {
     await client.events.book(event.key, 'A-2', null, 'order1')
     await client.events.book(event.key, 'A-3', null, 'order2')
 
-    const report = await client.eventReports.bySelectability(event.key, 'selectable')
+    const report = await client.eventReports.byAvailability(event.key, 'available')
 
-    expect(report.selectable.length).toBe(31)
+    expect(report.available.length).toBe(31)
 })
 
 test('report by channel', async () => {

package/tests/eventReports/eventReportDeepSummary.test.js

@@ -70,18 +70,18 @@ test('deepSummaryBySection', async () => {
     expect(report.NO_SECTION.byCategoryLabel.Cat1.bySelectability.not_selectable).toEqual(1)
 })
 
-test('deepSummaryBySelectability', async () => {
+test('deepSummaryByAvailability', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
     await client.events.book(event.key, (new ObjectProperties('A-1')))
 
-    const report = await client.eventReports.deepSummaryBySelectability(event.key)
+    const report = await client.eventReports.deepSummaryByAvailability(event.key)
 
-    expect(report.not_selectable.count).toEqual(1)
-    expect(report.not_selectable.byCategoryLabel.Cat1.count).toEqual(1)
-    expect(report.not_selectable.byCategoryLabel.Cat1.bySection.NO_SECTION).toEqual(1)
+    expect(report.not_available.count).toEqual(1)
+    expect(report.not_available.byCategoryLabel.Cat1.count).toEqual(1)
+    expect(report.not_available.byCategoryLabel.Cat1.bySection.NO_SECTION).toEqual(1)
 })
 
 test('deepSummaryByChannel', async () => {

package/tests/eventReports/eventReportSummary.test.js

@@ -17,6 +17,7 @@ test('summaryByStatus', async () => {
             count: 1,
             byCategoryKey: { 9: 1 },
             bySelectability: { not_selectable: 1 },
+            byAvailability: { not_available: 1 },
             byCategoryLabel: { Cat1: 1 },
             byChannel: { NO_CHANNEL: 1 }
         },
@@ -26,6 +27,7 @@ test('summaryByStatus', async () => {
             count: 231,
             byCategoryKey: { 9: 115, 10: 116 },
             bySelectability: { selectable: 231 },
+            byAvailability: { available: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 115 },
             byChannel: { NO_CHANNEL: 231 }
         }
@@ -47,6 +49,7 @@ test('summaryByObjectType', async () => {
             count: 32,
             byCategoryKey: { 9: 16, 10: 16 },
             bySelectability: { selectable: 32 },
+            byAvailability: { available: 32 },
             byCategoryLabel: { Cat1: 16, Cat2: 16 },
             byChannel: { NO_CHANNEL: 32 }
         },
@@ -56,6 +59,7 @@ test('summaryByObjectType', async () => {
             byStatus: { free: 200 },
             byCategoryKey: { 9: 100, 10: 100 },
             bySelectability: { selectable: 200 },
+            byAvailability: { available: 200 },
             byCategoryLabel: { Cat2: 100, Cat1: 100 },
             byChannel: { NO_CHANNEL: 200 }
         },
@@ -65,6 +69,7 @@ test('summaryByObjectType', async () => {
             byStatus: {},
             byCategoryKey: {},
             bySelectability: { },
+            byAvailability: { },
             byCategoryLabel: {},
             byChannel: { }
         },
@@ -74,6 +79,7 @@ test('summaryByObjectType', async () => {
             byStatus: {},
             byCategoryKey: {},
             bySelectability: { },
+            byAvailability: { },
             byCategoryLabel: {},
             byChannel: { }
         }
@@ -94,6 +100,7 @@ test('summaryByCategoryKey', async () => {
             count: 116,
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 115, not_selectable: 1 },
+            byAvailability: { available: 115, not_available: 1 },
             byStatus: { booked: 1, free: 115 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -105,6 +112,7 @@ test('summaryByCategoryKey', async () => {
             count: 116,
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 116 },
+            byAvailability: { available: 116 },
             byStatus: { free: 116 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -116,6 +124,7 @@ test('summaryByCategoryKey', async () => {
             count: 0,
             bySection: {},
             bySelectability: {},
+            byAvailability: { },
             byStatus: {},
             byChannel: {},
             byObjectType: {}
@@ -137,6 +146,7 @@ test('summaryByCategoryLabel', async () => {
             count: 116,
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 116 },
+            byAvailability: { available: 116 },
             byStatus: { free: 116 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -148,6 +158,7 @@ test('summaryByCategoryLabel', async () => {
             count: 116,
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 115, not_selectable: 1 },
+            byAvailability: { available: 115, not_available: 1 },
             byStatus: { booked: 1, free: 115 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -159,6 +170,7 @@ test('summaryByCategoryLabel', async () => {
             count: 0,
             bySection: {},
             bySelectability: {},
+            byAvailability: {},
             byStatus: {},
             byChannel: {},
             byObjectType: {}
@@ -179,6 +191,7 @@ test('summaryBySection', async () => {
             count: 232,
             byCategoryKey: { 9: 116, 10: 116 },
             bySelectability: { selectable: 231, not_selectable: 1 },
+            byAvailability: { available: 231, not_available: 1 },
             byStatus: { booked: 1, free: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 116 },
             byChannel: { NO_CHANNEL: 232 },
@@ -190,20 +203,21 @@ test('summaryBySection', async () => {
     })
 })
 
-test('summaryBySelectability', async () => {
+test('summaryByAvailability', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
     await client.events.book(event.key, (new ObjectProperties('A-1')))
 
-    const report = await client.eventReports.summaryBySelectability(event.key)
+    const report = await client.eventReports.summaryByAvailability(event.key)
 
     expect(report).toEqual({
-        selectable: {
+        available: {
             bySection: { NO_SECTION: 231 },
             count: 231,
             byCategoryKey: { 9: 115, 10: 116 },
+            bySelectability: { selectable: 231 },
             byStatus: { free: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 115 },
             byChannel: { NO_CHANNEL: 231 },
@@ -212,10 +226,11 @@ test('summaryBySelectability', async () => {
                 seat: 31
             }
         },
-        not_selectable: {
+        not_available: {
             bySection: { NO_SECTION: 1 },
             count: 1,
             byCategoryKey: { 9: 1 },
+            bySelectability: { not_selectable: 1 },
             byStatus: { booked: 1 },
             byCategoryLabel: { Cat1: 1 },
             byChannel: { NO_CHANNEL: 1 },
@@ -246,6 +261,7 @@ test('summaryByChannel', async () => {
             byStatus: { free: 230 },
             byCategoryLabel: { Cat2: 116, Cat1: 114 },
             bySelectability: { selectable: 230 },
+            byAvailability: { available: 230 },
             byObjectType: {
                 generalAdmission: 200,
                 seat: 30
@@ -258,6 +274,7 @@ test('summaryByChannel', async () => {
             byStatus: { free: 2 },
             byCategoryLabel: { Cat1: 2 },
             bySelectability: { selectable: 2 },
+            byAvailability: { available: 2 },
             byObjectType: {
                 seat: 2
             }

package/tests/exponentialBackoff.test.js

@@ -2,13 +2,13 @@ const Region = require('../src/Region')
 const { SeatsioClient } = require('../index.js')
 
 test('aborts eventually if server keeps returning 429', async () => {
-    const client = new SeatsioClient(new Region('https://httpbin.org'))
+    const client = new SeatsioClient(new Region('https://mockbin.org'))
     const start = new Date()
     try {
-        await client.client.get('/status/429')
+        await client.client.get('/bin/0381d6f4-0155-4b8c-937b-73d3d88b2a3f')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toBe('get /status/429 resulted in 429  TOO MANY REQUESTS  error')
+        expect(e).toEqual({ errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }], messages: [], requestId: '123456', status: 429 })
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeGreaterThan(10000)
         expect(waitTime).toBeLessThan(20000)
@@ -16,26 +16,26 @@ test('aborts eventually if server keeps returning 429', async () => {
 })
 
 test('aborts directly if server returns error other than 429', async () => {
-    const client = new SeatsioClient(new Region('https://httpbin.org'))
+    const client = new SeatsioClient(new Region('https://mockbin.org'))
     const start = new Date()
     try {
-        await client.client.get('/status/400')
+        await client.client.get('/bin/1eea3aab-2bb2-4f92-99c2-50d942fb6294')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toBe('get /status/400 resulted in 400  BAD REQUEST  error')
+        expect(e).toBe('get /bin/1eea3aab-2bb2-4f92-99c2-50d942fb6294 resulted in 400 Bad Request error')
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeLessThan(2000)
     }
 })
 
 test('aborts directly if server returns 429 but max retries 0', async () => {
-    const client = new SeatsioClient(new Region('https://httpbin.org')).setMaxRetries(0)
+    const client = new SeatsioClient(new Region('https://mockbin.org')).setMaxRetries(0)
     const start = new Date()
     try {
-        await client.client.get('/status/429')
+        await client.client.get('/bin/0381d6f4-0155-4b8c-937b-73d3d88b2a3f')
         throw new Error('Should have failed')
     } catch (e) {
-        expect(e).toBe('get /status/429 resulted in 429  TOO MANY REQUESTS  error')
+        expect(e).toEqual({ errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }], messages: [], requestId: '123456', status: 429 })
         const waitTime = new Date().getTime() - start.getTime()
         expect(waitTime).toBeLessThan(2000)
     }