seatsio 68.0.0 → 69.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "68.0.0",
+  "version": "69.0.0",
   "main": "index.js",
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",
@@ -30,8 +30,8 @@
     "gulp-tap": "latest",
     "gulp-uglify": "latest",
     "gulp-uglify-es": "latest",
-    "jest": "28.0.3",
-    "jest-cli": "28.0.3",
+    "jest": "28.1.0",
+    "jest-cli": "28.1.0",
     "uuid": "8.3.2"
   }
 }

package/src/Events/Channels.js

@@ -0,0 +1,52 @@
+class Channels {
+    /**
+     * @param {Axios} client
+     */
+    constructor (client) {
+        this.client = client
+    }
+
+    add (eventKey, channelKey, name, color, index, objects) {
+        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels`, {
+            key: channelKey,
+            name: name,
+            color: color,
+            index: index,
+            objects: objects
+        })
+    }
+
+    remove (eventKey, channelKey) {
+        return this.client.delete(`/events/${encodeURIComponent(eventKey)}/channels/${encodeURIComponent(channelKey)}`)
+    }
+
+    update (eventKey, channelKey, newChannelName, newColor, newObjects) {
+        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/${encodeURIComponent(channelKey)}`, {
+            name: newChannelName,
+            color: newColor,
+            objects: newObjects
+        })
+    }
+
+    addObjects (eventKey, channelKey, objects) {
+        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/${encodeURIComponent(channelKey)}/objects`, {
+            objects: objects
+        })
+    }
+
+    removeObjects (eventKey, channelKey, objects) {
+        return this.client.delete(`/events/${encodeURIComponent(eventKey)}/channels/${encodeURIComponent(channelKey)}/objects`, {
+            data: { objects: objects }
+        })
+    }
+
+    replace (eventKey, channels) {
+        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/update`, { channels: channels })
+    }
+
+    setObjects (eventKey, channelConfig) {
+        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/assign-objects`, { channelConfig: channelConfig })
+    }
+}
+
+module.exports = Channels

package/src/Events/Events.js

@@ -1,6 +1,7 @@
 const Page = require('../Page.js')
 const Lister = require('../Lister.js')
 const EventObjectInfo = require('./EventObjectInfo.js')
+const Channels = require('./Channels.js')
 const StatusChange = require('./StatusChange.js')
 const BestAvailableObjects = require('./BestAvailableObjects.js')
 const ChangeObjectStatusResult = require('./ChangeObjectStatusResult.js')
@@ -12,6 +13,7 @@ class Events {
      */
     constructor (client) {
         this.client = client
+        this.channels = new Channels(this.client)
     }
 
     /* @return Event */
@@ -57,14 +59,6 @@ class Events {
             .then((res) => new EventDeserializer().fromJson(res.data))
     }
 
-    updateChannels (eventKey, channels) {
-        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/update`, { channels: channels })
-    }
-
-    assignObjectsToChannel (eventKey, channelConfig) {
-        return this.client.post(`/events/${encodeURIComponent(eventKey)}/channels/assign-objects`, { channelConfig: channelConfig })
-    }
-
     /**
      * @param {string} eventKey
      * @param {?string} chartKey

package/tests/eventReports/eventReport.test.js

@@ -10,10 +10,10 @@ test('report properties', async () => {
     const event = await client.events.create(chartKey)
     const extraData = { foo: 'bar' }
     await client.events.book(event.key, (new ObjectProperties('A-1')).setTicketType('ticketType1').setExtraData(extraData), null, 'order1')
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channel1: { name: 'channel 1', color: 'blue', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channel1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channel1: ['A-1'] })
 
     const report = await client.eventReports.byLabel(event.key)
 
@@ -316,10 +316,10 @@ test('report by channel', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channel1: { name: 'channel 1', color: 'blue', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channel1: ['A-1', 'A-2'] })
+    await client.events.channels.setObjects(event.key, { channel1: ['A-1', 'A-2'] })
 
     const report = await client.eventReports.byChannel(event.key)
 
@@ -332,10 +332,10 @@ test('report by specific channel', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channel1: { name: 'channel 1', color: 'blue', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channel1: ['A-1', 'A-2'] })
+    await client.events.channels.setObjects(event.key, { channel1: ['A-1', 'A-2'] })
 
     const report = await client.eventReports.byChannel(event.key, 'channel1')
 

package/tests/eventReports/eventReportSummary.test.js

@@ -354,10 +354,10 @@ test('summaryByChannel', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channel1: { name: 'channel 1', color: 'blue', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channel1: ['A-1', 'A-2'] })
+    await client.events.channels.setObjects(event.key, { channel1: ['A-1', 'A-2'] })
 
     const report = await client.eventReports.summaryByChannel(event.key)
 

package/tests/events/bookObject.test.js

@@ -100,10 +100,10 @@ test('should accept channel keys', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['A-1'] })
 
     await client.events.book(event.key, ['A-1'], null, null, null, null, ['channelKey1'])
 
@@ -116,10 +116,10 @@ test('should accept ignoreChannels', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['A-1'] })
 
     await client.events.book(event.key, ['A-1'], null, null, null, true)
 

package/tests/events/changeBestAvailableObjectStatus.test.js

@@ -178,10 +178,10 @@ test('should accept channel keys', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['B-6'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['B-6'] })
 
     const bestAvailableObjs = await client.events.changeBestAvailableObjectStatus(event.key, 1, 'lolzor', null, null, null, null, null, null, null, ['channelKey1'])
 
@@ -193,10 +193,10 @@ test('should accept ignoreChannels', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['A-1'] })
 
     const bestAvailableObjs = await client.events.changeBestAvailableObjectStatus(event.key, 1, 'lolzor', null, null, null, null, null, null, true)
 

package/tests/events/changeObjectStatus.test.js

@@ -178,14 +178,14 @@ test('should accept channel keys', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: {
             name: 'channel 1',
             color: '#FFAABB',
             index: 1
         }
     })
-    await client.events.assignObjectsToChannel(event.key, {
+    await client.events.channels.setObjects(event.key, {
         channelKey1: ['A-1', 'A-2']
     })
     await client.events.changeObjectStatus(event.key, ['A-1'], 'someStatus', null, null, null, null, ['channelKey1'])
@@ -199,14 +199,14 @@ test('should accept ignoreChannels', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: {
             name: 'channel 1',
             color: '#FFAABB',
             index: 1
         }
     })
-    await client.events.assignObjectsToChannel(event.key, {
+    await client.events.channels.setObjects(event.key, {
         channelKey1: ['A-1', 'A-2']
     })
     await client.events.changeObjectStatus(event.key, ['A-1'], 'someStatus', null, null, null, true)

package/tests/events/changeObjectStatusInBatch.test.js

@@ -31,14 +31,14 @@ test('should accept channel keys', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: {
             name: 'channel 1',
             color: '#FFAABB',
             index: 1
         }
     })
-    await client.events.assignObjectsToChannel(event.key, {
+    await client.events.channels.setObjects(event.key, {
         channelKey1: ['A-1']
     })
 
@@ -54,14 +54,14 @@ test('should accept ignoreChannels', async () => {
     const chartKey = testUtils.getChartKey()
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: {
             name: 'channel 1',
             color: '#FFAABB',
             index: 1
         }
     })
-    await client.events.assignObjectsToChannel(event.key, {
+    await client.events.channels.setObjects(event.key, {
         channelKey1: ['A-1', 'A-2']
     })
 

package/tests/events/channels/addChannel.test.js

@@ -0,0 +1,77 @@
+const testUtils = require('../../testUtils')
+const Channel = require('../../../src/Events/Channel')
+test('can add a channel', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+    await client.events.channels.add(event.key, 'channelKey2', 'channel 2', '#FFFF99', 2, ['A-3'])
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['A-1', 'A-2']
+        }),
+        new Channel({
+            key: 'channelKey2',
+            name: 'channel 2',
+            color: '#FFFF99',
+            index: 2,
+            objects: ['A-3']
+        })
+    ])
+})
+
+test('index is optional', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', undefined, ['A-1', 'A-2'])
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            objects: ['A-1', 'A-2']
+        })
+    ])
+})
+
+test('objects are optional', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, undefined)
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: []
+        })
+    ])
+})

package/tests/events/channels/addObjectToChannel.test.js

@@ -0,0 +1,34 @@
+const testUtils = require('../../testUtils')
+const Channel = require('../../../src/Events/Channel')
+
+test('can add objects, moving them from one channel to another', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+    await client.events.channels.add(event.key, 'channelKey2', 'channel 2', '#FFFF99', 2, ['A-3', 'A-4'])
+
+    await client.events.channels.addObjects(event.key, 'channelKey1', ['A-3', 'A-4'])
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['A-1', 'A-2', 'A-3', 'A-4']
+        }),
+        new Channel({
+            key: 'channelKey2',
+            name: 'channel 2',
+            color: '#FFFF99',
+            index: 2,
+            objects: []
+        })
+    ])
+})

package/tests/events/channels/removeChannel.test.js

@@ -0,0 +1,26 @@
+const testUtils = require('../../testUtils')
+const Channel = require('../../../src/Events/Channel')
+test('can remove a channel', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+    await client.events.channels.add(event.key, 'channelKey2', 'channel 2', '#FFFF99', 2, ['A-3', 'A-4'])
+
+    await client.events.channels.remove(event.key, 'channelKey2')
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['A-1', 'A-2']
+        })
+    ])
+})

package/tests/events/channels/removeObjectsFromChannel.test.js

@@ -0,0 +1,25 @@
+const testUtils = require('../../testUtils')
+const Channel = require('../../../src/Events/Channel')
+test('can remove objects from channels', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2', 'A-3', 'A-4'])
+
+    await client.events.channels.removeObjects(event.key, 'channelKey1', ['A-3', 'A-4'])
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['A-1', 'A-2']
+        })
+    ])
+})

package/tests/events/{assignObjectsToChannels.test.js → channels/replaceChannels.test.js}

@@ -1,17 +1,17 @@
-const testUtils = require('../testUtils.js')
-const Channel = require('../../src/Events/Channel.js')
+const testUtils = require('../../testUtils.js')
+const Channel = require('../../../src/Events/Channel.js')
 
 test('should assign objects to channels', 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.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         "channelKey1": {name: "channel 1", color: "blue", index: 1},
         "channelKey2": {name: "channel 2", color: "red", index: 2}
     })
 
-    await client.events.assignObjectsToChannel(event.key, {
+    await client.events.channels.setObjects(event.key, {
         "channelKey1": ["A-1", "A-2"],
         "channelKey2": ["A-3"]
     })

package/tests/events/{updateChannels.test.js → channels/setObjectsForChannelsTest.js}

@@ -1,12 +1,12 @@
-const testUtils = require('../testUtils.js')
-const Channel = require('../../src/Events/Channel.js')
+const testUtils = require('../../testUtils.js')
+const Channel = require('../../../src/Events/Channel.js')
 
 test('should update channels', async () => {
     const {client} = await testUtils.createTestUserAndClient()
     const chart = await client.charts.create()
     const event = await client.events.create(chart.key)
 
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         "channelKey1": {
             "name": "channel 1",
             "color": "#FFAABB",

package/tests/events/channels/updateChannel.test.js

@@ -0,0 +1,65 @@
+const testUtils = require('../../testUtils')
+const Channel = require('../../../src/Events/Channel')
+
+test('update name', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+
+    await client.events.channels.update(event.key, 'channelKey1', 'new channel name', undefined, undefined)
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'new channel name',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['A-1', 'A-2']
+        })
+    ])
+})
+
+test('update color', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+
+    await client.events.channels.update(event.key, 'channelKey1', undefined, 'red', undefined)
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: 'red',
+            index: 1,
+            objects: ['A-1', 'A-2']
+        })
+    ])
+})
+
+test('update objects', 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.channels.add(event.key, 'channelKey1', 'channel 1', '#FFFF98', 1, ['A-1', 'A-2'])
+
+    await client.events.channels.update(event.key, 'channelKey1', undefined, undefined, ['B-1'])
+
+    const retrievedEvent = await client.events.retrieve(event.key)
+    expect(retrievedEvent.channels).toEqual([
+        new Channel({
+            key: 'channelKey1',
+            name: 'channel 1',
+            color: '#FFFF98',
+            index: 1,
+            objects: ['B-1']
+        })
+    ])
+})

package/tests/events/holdObjects.test.js

@@ -41,10 +41,10 @@ test('should accept channel keys', async () => {
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
     const holdToken = await client.holdTokens.create()
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['A-1'] })
     await client.events.hold(event.key, ['A-1'], holdToken.holdToken, null, null, null, ['channelKey1'])
 
     const objectInfo = await client.events.retrieveObjectInfo(event.key, 'A-1')
@@ -57,10 +57,10 @@ test('should accept ignoreChannels', async () => {
     await testUtils.createTestChart(chartKey, user.secretKey)
     const event = await client.events.create(chartKey)
     const holdToken = await client.holdTokens.create()
-    await client.events.updateChannels(event.key, {
+    await client.events.channels.replace(event.key, {
         channelKey1: { name: 'channel 1', color: '#FFAABB', index: 1 }
     })
-    await client.events.assignObjectsToChannel(event.key, { channelKey1: ['A-1'] })
+    await client.events.channels.setObjects(event.key, { channelKey1: ['A-1'] })
 
     await client.events.hold(event.key, ['A-1'], holdToken.holdToken, null, null, true)