seatsio 65.0.0 → 65.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "65.0.0",
+  "version": "65.1.0",
   "main": "index.js",
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",

package/src/Events/EventObjectInfo.js

@@ -31,7 +31,8 @@ class EventObjectInfo {
         this.displayedObjectType = report.displayedObjectType
         this.leftNeighbour = report.leftNeighbour
         this.rightNeighbour = report.rightNeighbour
-        this.isSelectable = report.isSelectable
+        this.isAvailable = report.isAvailable
+        this.availabilityReason = report.availabilityReason
         this.isDisabledBySocialDistancing = report.isDisabledBySocialDistancing
         this.channel = report.channel
         this.distanceToFocalPoint = report.distanceToFocalPoint

package/src/Events/Events.js

@@ -272,9 +272,11 @@ class Events {
      * @param {?string[]} channelKeys
      * @param {?boolean} ignoreSocialDistancing
      * @returns {Promise<ChangeObjectStatusResult>}
+     * @param {?string[]} allowedPreviousStatuses
+     * @param {?string[]} rejectedPreviousStatuses
      */
-    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)
+    changeObjectStatus (eventKeyOrKeys, objectOrObjects, status, holdToken = null, orderId = null, keepExtraData = null, ignoreChannels = null, channelKeys = null, ignoreSocialDistancing = null, allowedPreviousStatuses = null, rejectedPreviousStatuses = null) {
+        const request = this.changeObjectStatusRequest(objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing, allowedPreviousStatuses, rejectedPreviousStatuses)
         request.events = Array.isArray(eventKeyOrKeys) ? eventKeyOrKeys : [eventKeyOrKeys]
 
         return this.client.post('/events/groups/actions/change-object-status?expand=objects', request)
@@ -287,7 +289,18 @@ class Events {
      */
     changeObjectStatusInBatch (statusChangeRequests) {
         const requests = statusChangeRequests.map(r => {
-            const json = this.changeObjectStatusRequest(r.objectOrObjects, r.status, r.holdToken, r.orderId, r.keepExtraData, r.ignoreChannels, r.channelKeys)
+            const json = this.changeObjectStatusRequest(
+                r.objectOrObjects,
+                r.status,
+                r.holdToken,
+                r.orderId,
+                r.keepExtraData,
+                r.ignoreChannels,
+                r.channelKeys,
+                null,
+                r.allowedPreviousStatuses,
+                r.rejectedPreviousStatuses
+            )
             json.event = r.eventKey
             return json
         })
@@ -297,7 +310,7 @@ class Events {
             .then((res) => res.data.results.map(r => new ChangeObjectStatusResult(r.objects)))
     }
 
-    changeObjectStatusRequest (objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing) {
+    changeObjectStatusRequest (objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, ignoreSocialDistancing, allowedPreviousStatuses, rejectedPreviousStatuses) {
         const request = {}
         request.objects = this.normalizeObjects(objectOrObjects)
         request.status = status
@@ -319,6 +332,12 @@ class Events {
         if (ignoreSocialDistancing !== null) {
             request.ignoreSocialDistancing = ignoreSocialDistancing
         }
+        if (allowedPreviousStatuses !== null) {
+            request.allowedPreviousStatuses = allowedPreviousStatuses
+        }
+        if (rejectedPreviousStatuses !== null) {
+            request.rejectedPreviousStatuses = rejectedPreviousStatuses
+        }
         return request
     }
 

package/src/Events/StatusChangeRequest.js

@@ -8,8 +8,10 @@ class StatusChangeRequest {
      * @param {?boolean} keepExtraData
      * @param {?boolean} ignoreChannels
      * @param {?string[]} channelKeys
+     * @param {?string[]} allowedPreviousStatuses
+     * @param {?string[]} rejectedPreviousStatuses
      */
-    constructor (eventKey, objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys) {
+    constructor (eventKey, objectOrObjects, status, holdToken, orderId, keepExtraData, ignoreChannels, channelKeys, allowedPreviousStatuses, rejectedPreviousStatuses) {
         this.eventKey = eventKey
         this.objectOrObjects = objectOrObjects
         this.status = status
@@ -18,6 +20,8 @@ class StatusChangeRequest {
         this.keepExtraData = keepExtraData
         this.ignoreChannels = ignoreChannels
         this.channelKeys = channelKeys
+        this.allowedPreviousStatuses = allowedPreviousStatuses
+        this.rejectedPreviousStatuses = rejectedPreviousStatuses
     }
 }
 

package/src/Reports/EventReports.js

@@ -167,11 +167,21 @@ class EventReports {
 
     /**
      * @param {string} eventKey
-     * @param {?string} selectability
+     * @param {?string} availability
      * @returns {Object.<string, ObjectInfo[]>}
      */
-    byAvailability (eventKey, selectability = null) {
-        return this.client.get(EventReports.reportUrl('byAvailability', eventKey, selectability))
+    byAvailability (eventKey, availability = null) {
+        return this.client.get(EventReports.reportUrl('byAvailability', eventKey, availability))
+            .then((res) => utilities.createEventReport(res.data))
+    }
+
+    /**
+     * @param {string} eventKey
+     * @param {?string} availabilityReason
+     * @returns {Object.<string, ObjectInfo[]>}
+     */
+    byAvailabilityReason (eventKey, availabilityReason = null) {
+        return this.client.get(EventReports.reportUrl('byAvailabilityReason', eventKey, availabilityReason))
             .then((res) => utilities.createEventReport(res.data))
     }
 
@@ -184,6 +194,15 @@ class EventReports {
             .then((res) => res.data)
     }
 
+    /**
+     * @param {string} eventKey
+     * @returns {Object} JSON response from the server
+     */
+    summaryByAvailabilityReason (eventKey) {
+        return this.client.get(EventReports.summaryReportUrl('byAvailabilityReason', eventKey))
+            .then((res) => res.data)
+    }
+
     /**
      * @param {string} eventKey
      * @returns {Object} JSON response from the server
@@ -193,6 +212,15 @@ class EventReports {
             .then((res) => res.data)
     }
 
+    /**
+     * @param {string} eventKey
+     * @returns {Object} JSON response from the server
+     */
+    deepSummaryByAvailabilityReason (eventKey) {
+        return this.client.get(EventReports.deepSummaryReportUrl('byAvailabilityReason', eventKey))
+            .then((res) => res.data)
+    }
+
     /**
      * @param {string} eventKey
      * @param {?string} channel

package/tests/charts/listAllCharts.test.js

@@ -103,13 +103,9 @@ test('listAll Charts with expandEvents parameters', async () => {
 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 event1 = await client.events.create(chart1.key)
+    const event2 = await client.events.create(chart1.key)
+    const event3 = await client.events.create(chart1.key)
     const retrievedKeys = []
     const params = new ChartListParams().withExpandEvents(true).withEventsLimit(2)
 
@@ -119,7 +115,7 @@ test('listAll Charts with expandEvents parameters and eventsLimit', async () =>
         }
     }
 
-    expect(retrievedKeys.sort()).toEqual(expectedEventKeys.sort())
+    expect(retrievedKeys).toEqual([event3.key, event2.key])
 })
 
 test('list all charts with validation', async () => {

package/tests/eventReports/eventReport.test.js

@@ -37,7 +37,8 @@ test('report properties', async () => {
     expect(reportItem.displayedObjectType).toBe(undefined)
     expect(reportItem.leftNeighbour).toBe(undefined)
     expect(reportItem.rightNeighbour).toBe('A-2')
-    expect(reportItem.isSelectable).toBe(false)
+    expect(reportItem.isAvailable).toBe(false)
+    expect(reportItem.availabilityReason).toBe('booked')
     expect(reportItem.isDisabledBySocialDistancing).toBe(false)
     expect(reportItem.bookAsAWhole).toBe(undefined)
     expect(reportItem.distanceToFocalPoint).toBeTruthy()
@@ -281,6 +282,35 @@ test('report by specific availability', async () => {
     expect(report.available.length).toBe(31)
 })
 
+test('report by availability reason', 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, 'A-1', null, 'order1')
+    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.byAvailabilityReason(event.key)
+
+    expect(report.available.length).toBe(31)
+    expect(report.booked.length).toBe(3)
+})
+
+test('report by specific availability reason', 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, 'A-1', null, 'order1')
+    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.byAvailabilityReason(event.key, 'booked')
+
+    expect(report.booked.length).toBe(3)
+})
+
 test('report by channel', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()

package/tests/eventReports/eventReportDeepSummary.test.js

@@ -84,6 +84,20 @@ test('deepSummaryByAvailability', async () => {
     expect(report.not_available.byCategoryLabel.Cat1.bySection.NO_SECTION).toEqual(1)
 })
 
+test('deepSummaryByAvailabilityReason', 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.deepSummaryByAvailabilityReason(event.key)
+
+    expect(report.booked.count).toEqual(1)
+    expect(report.booked.byCategoryLabel.Cat1.count).toEqual(1)
+    expect(report.booked.byCategoryLabel.Cat1.bySection.NO_SECTION).toEqual(1)
+})
+
 test('deepSummaryByChannel', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
     const chartKey = testUtils.getChartKey()

package/tests/eventReports/eventReportSummary.test.js

@@ -18,6 +18,7 @@ test('summaryByStatus', async () => {
             byCategoryKey: { 9: 1 },
             bySelectability: { not_selectable: 1 },
             byAvailability: { not_available: 1 },
+            byAvailabilityReason: { booked: 1 },
             byCategoryLabel: { Cat1: 1 },
             byChannel: { NO_CHANNEL: 1 }
         },
@@ -28,6 +29,7 @@ test('summaryByStatus', async () => {
             byCategoryKey: { 9: 115, 10: 116 },
             bySelectability: { selectable: 231 },
             byAvailability: { available: 231 },
+            byAvailabilityReason: { available: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 115 },
             byChannel: { NO_CHANNEL: 231 }
         }
@@ -50,6 +52,7 @@ test('summaryByObjectType', async () => {
             byCategoryKey: { 9: 16, 10: 16 },
             bySelectability: { selectable: 32 },
             byAvailability: { available: 32 },
+            byAvailabilityReason: { available: 32 },
             byCategoryLabel: { Cat1: 16, Cat2: 16 },
             byChannel: { NO_CHANNEL: 32 }
         },
@@ -60,28 +63,31 @@ test('summaryByObjectType', async () => {
             byCategoryKey: { 9: 100, 10: 100 },
             bySelectability: { selectable: 200 },
             byAvailability: { available: 200 },
+            byAvailabilityReason: { available: 200 },
             byCategoryLabel: { Cat2: 100, Cat1: 100 },
             byChannel: { NO_CHANNEL: 200 }
         },
         table: {
             count: 0,
-            bySection: { },
+            bySection: {},
             byStatus: {},
             byCategoryKey: {},
-            bySelectability: { },
-            byAvailability: { },
+            bySelectability: {},
+            byAvailability: {},
+            byAvailabilityReason: {},
             byCategoryLabel: {},
-            byChannel: { }
+            byChannel: {}
         },
         booth: {
             count: 0,
-            bySection: { },
+            bySection: {},
             byStatus: {},
             byCategoryKey: {},
-            bySelectability: { },
-            byAvailability: { },
+            bySelectability: {},
+            byAvailability: {},
+            byAvailabilityReason: {},
             byCategoryLabel: {},
-            byChannel: { }
+            byChannel: {}
         }
     })
 })
@@ -101,6 +107,7 @@ test('summaryByCategoryKey', async () => {
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 115, not_selectable: 1 },
             byAvailability: { available: 115, not_available: 1 },
+            byAvailabilityReason: { available: 115, booked: 1 },
             byStatus: { booked: 1, free: 115 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -113,6 +120,7 @@ test('summaryByCategoryKey', async () => {
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 116 },
             byAvailability: { available: 116 },
+            byAvailabilityReason: { available: 116 },
             byStatus: { free: 116 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -124,7 +132,8 @@ test('summaryByCategoryKey', async () => {
             count: 0,
             bySection: {},
             bySelectability: {},
-            byAvailability: { },
+            byAvailability: {},
+            byAvailabilityReason: { },
             byStatus: {},
             byChannel: {},
             byObjectType: {}
@@ -147,6 +156,7 @@ test('summaryByCategoryLabel', async () => {
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 116 },
             byAvailability: { available: 116 },
+            byAvailabilityReason: { available: 116 },
             byStatus: { free: 116 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -159,6 +169,7 @@ test('summaryByCategoryLabel', async () => {
             bySection: { NO_SECTION: 116 },
             bySelectability: { selectable: 115, not_selectable: 1 },
             byAvailability: { available: 115, not_available: 1 },
+            byAvailabilityReason: { available: 115, booked: 1 },
             byStatus: { booked: 1, free: 115 },
             byChannel: { NO_CHANNEL: 116 },
             byObjectType: {
@@ -171,6 +182,7 @@ test('summaryByCategoryLabel', async () => {
             bySection: {},
             bySelectability: {},
             byAvailability: {},
+            byAvailabilityReason: { },
             byStatus: {},
             byChannel: {},
             byObjectType: {}
@@ -192,6 +204,7 @@ test('summaryBySection', async () => {
             byCategoryKey: { 9: 116, 10: 116 },
             bySelectability: { selectable: 231, not_selectable: 1 },
             byAvailability: { available: 231, not_available: 1 },
+            byAvailabilityReason: { available: 231, booked: 1 },
             byStatus: { booked: 1, free: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 116 },
             byChannel: { NO_CHANNEL: 232 },
@@ -218,6 +231,7 @@ test('summaryByAvailability', async () => {
             count: 231,
             byCategoryKey: { 9: 115, 10: 116 },
             bySelectability: { selectable: 231 },
+            byAvailabilityReason: { available: 231 },
             byStatus: { free: 231 },
             byCategoryLabel: { Cat2: 116, Cat1: 115 },
             byChannel: { NO_CHANNEL: 231 },
@@ -231,12 +245,86 @@ test('summaryByAvailability', async () => {
             count: 1,
             byCategoryKey: { 9: 1 },
             bySelectability: { not_selectable: 1 },
+            byAvailabilityReason: { booked: 1 },
+            byStatus: { booked: 1 },
+            byCategoryLabel: { Cat1: 1 },
+            byChannel: { NO_CHANNEL: 1 },
+            byObjectType: {
+                seat: 1
+            }
+        }
+    })
+})
+
+test('summaryByAvailabilityReason', 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.summaryByAvailabilityReason(event.key)
+
+    expect(report).toEqual({
+        available: {
+            bySection: { NO_SECTION: 231 },
+            count: 231,
+            byCategoryKey: { 9: 115, 10: 116 },
+            bySelectability: { selectable: 231 },
+            byAvailability: { available: 231 },
+            byStatus: { free: 231 },
+            byCategoryLabel: { Cat2: 116, Cat1: 115 },
+            byChannel: { NO_CHANNEL: 231 },
+            byObjectType: {
+                generalAdmission: 200,
+                seat: 31
+            }
+        },
+        booked: {
+            bySection: { NO_SECTION: 1 },
+            count: 1,
+            byCategoryKey: { 9: 1 },
+            bySelectability: { not_selectable: 1 },
+            byAvailability: { not_available: 1 },
             byStatus: { booked: 1 },
             byCategoryLabel: { Cat1: 1 },
             byChannel: { NO_CHANNEL: 1 },
             byObjectType: {
                 seat: 1
             }
+        },
+        disabled_by_social_distancing: {
+            count: 0,
+            bySection: { },
+            byCategoryKey: { },
+            bySelectability: { },
+            byAvailability: { },
+            byStatus: { },
+            byCategoryLabel: { },
+            byChannel: { },
+            byObjectType: {}
+        },
+        not_for_sale: {
+            count: 0,
+            bySection: { },
+            byCategoryKey: { },
+            bySelectability: { },
+            byAvailability: { },
+            byStatus: { },
+            byCategoryLabel: { },
+            byChannel: { },
+            byObjectType: {}
+        },
+        reservedByToken: {
+            count: 0,
+            bySection: { },
+            byCategoryKey: { },
+            bySelectability: { },
+            byAvailability: { },
+            byStatus: { },
+            byCategoryLabel: { },
+            byChannel: { },
+            byObjectType: {}
         }
     })
 })
@@ -261,6 +349,7 @@ test('summaryByChannel', async () => {
             byStatus: { free: 230 },
             byCategoryLabel: { Cat2: 116, Cat1: 114 },
             bySelectability: { selectable: 230 },
+            byAvailabilityReason: { available: 230 },
             byAvailability: { available: 230 },
             byObjectType: {
                 generalAdmission: 200,
@@ -275,6 +364,7 @@ test('summaryByChannel', async () => {
             byCategoryLabel: { Cat1: 2 },
             bySelectability: { selectable: 2 },
             byAvailability: { available: 2 },
+            byAvailabilityReason: { available: 2 },
             byObjectType: {
                 seat: 2
             }

package/tests/events/changeObjectStatus.test.js

@@ -26,7 +26,8 @@ test('should change object status', async () => {
             hasRestrictedView: false,
             isCompanionSeat: false,
             rightNeighbour: 'A-2',
-            isSelectable: false,
+            isAvailable: false,
+            availabilityReason: 'lolzor',
             isDisabledBySocialDistancing: false,
             distanceToFocalPoint: 79.43847425150014
         }
@@ -228,3 +229,33 @@ test('should accept ignoreSocialDistancing', async () => {
     const objectInfo = await client.events.retrieveObjectInfo(event.key, 'A-1')
     expect(objectInfo.status).toBe(EventObjectInfo.BOOKED)
 })
+
+test('should accept allowedPreviousStatuses', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+    const event = await client.events.create(chartKey)
+
+    try {
+        await client.events.changeObjectStatus(event.key, ['A-1'], EventObjectInfo.BOOKED, null, null, null, null, null, true, ['MustBeThisStatus'], null)
+        throw new Error('Should have failed')
+    } catch (e) {
+        expect(e.errors.length).toEqual(1)
+        expect(e.errors[0].code).toBe('ILLEGAL_STATUS_CHANGE')
+    }
+})
+
+test('should accept rejectedPreviousStatuses', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+    const event = await client.events.create(chartKey)
+
+    try {
+        await client.events.changeObjectStatus(event.key, ['A-1'], EventObjectInfo.BOOKED, null, null, null, null, null, true, null, ['free'])
+        throw new Error('Should have failed')
+    } catch (e) {
+        expect(e.errors.length).toEqual(1)
+        expect(e.errors[0].code).toBe('ILLEGAL_STATUS_CHANGE')
+    }
+})

package/tests/events/changeObjectStatusInBatch.test.js

@@ -71,3 +71,37 @@ test('should accept ignoreChannels', async () => {
 
     expect(result[0].objects['A-1'].status).toBe('lolzor')
 })
+
+test('should accept allowedPreviousStatuses', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+    const event = await client.events.create(chartKey)
+
+    try {
+        await client.events.changeObjectStatusInBatch([
+            new StatusChangeRequest(event.key, ['A-1'], 'lolzor', null, null, null, null, null, ['MustBeThisStatus'], null)
+        ])
+        throw new Error('Should have failed')
+    } catch (e) {
+        expect(e.errors.length).toEqual(1)
+        expect(e.errors[0].code).toBe('ILLEGAL_STATUS_CHANGE')
+    }
+})
+
+test('should accept rejectedPreviousStatuses', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+    const event = await client.events.create(chartKey)
+
+    try {
+        await client.events.changeObjectStatusInBatch([
+            new StatusChangeRequest(event.key, ['A-1'], 'lolzor', null, null, null, true, null, null, ['free'])
+        ])
+        throw new Error('Should have failed')
+    } catch (e) {
+        expect(e.errors.length).toEqual(1)
+        expect(e.errors[0].code).toBe('ILLEGAL_STATUS_CHANGE')
+    }
+})