seatsio 65.0.0 → 66.0.0

package/README.md

@@ -38,10 +38,31 @@ seatsio-js follows semver since v54.4.0.
 
 Please note that any version below v2 is not production ready.
 
-## Examples
+## Usage
+
+### General instructions
+
+To use this library, you'll need to create a `SeatsioClient`:
+
+```js
+import { SeatsioClient, Region } from 'seatsio'
+
+let client = new SeatsioClient(Region.EU(), <WORKSPACE SECRET KEY>)
+...
+```
+
+You can find your _workspace secret key_ in the [settings section of the workspace](https://app.seats.io/workspace-settings). It is important that you keep your _secret key_ private and not expose it in-browser calls unless it is password protected.
+
+The region should correspond to the region of your account:
+
+- `Region.EU()`: Europe
+- `Region.NA()`: North-America
+- `Region.SA()`: South-America
+- `Region.OC()`: Oceania
+
+If you're unsure about your region, have a look at your [company settings page](https://app.seats.io/company-settings).
 
 ### Creating a chart and an event
-Once you create a new `SeatsioClient` using your _secret key_, you can create _charts_ and then _events_. You can find your _secret key_ in the Settings section of your workspace: https://app.seats.io/workspace-settings. It is important that you keep your _secret key_ private and not expose it in-browser calls unless it is password protected.
 
 ```js
 import { SeatsioClient, Region } from 'seatsio'
@@ -257,10 +278,10 @@ When an API call results in an error, a rejected promise is returned with a valu
 
 ```json
 {
-  errors: [{ code: 'RATE_LIMIT_EXCEEDED', message: 'Rate limit exceeded' }],
-  messages: ['Rate limit exceeded'],
-  requestId: '123456',
-  status: 429
+  "errors": [{ "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded" }],
+  "messages": ["Rate limit exceeded"],
+  "requestId": "123456",
+  "status": 429
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "65.0.0",
+  "version": "66.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.24.0"
+    "axios": "0.25.0"
   },
   "devDependencies": {
     "browserify": "latest",
     "eslint": "7.32.0",
     "eslint-config-standard": "16.0.3",
-    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-import": "2.25.4",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "5.2.0",
+    "eslint-plugin-promise": "6.0.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.4.3",
-    "jest-cli": "27.4.3",
+    "jest": "27.4.7",
+    "jest-cli": "27.4.7",
     "uuid": "8.3.2"
   }
 }

package/src/AsyncIterator.js

@@ -5,6 +5,7 @@ const Event = require('./Events/Event.js')
 const User = require('./Users/User.js')
 const Subaccount = require('./Subaccounts/Subaccount.js')
 const Workspace = require('./Workspaces/Workspace.js')
+const Season = require('./Seasons/Season')
 
 class AsyncIterator {
     /**
@@ -45,6 +46,16 @@ class AsyncIterator {
         this.pages.push(new Page(events, data.next_page_starts_after, data.previous_page_ends_before))
     }
 
+    seasons (data) {
+        const seasons = []
+        data.items.forEach(seasonData => {
+            const season = new Season(seasonData)
+            this.items.push(season)
+            seasons.push(season)
+        })
+        this.pages.push(new Page(seasons, data.next_page_starts_after, data.previous_page_ends_before))
+    }
+
     statusChanges (data) {
         const statusChanges = []
         data.items.forEach((statusData) => {
@@ -102,6 +113,9 @@ class AsyncIterator {
                 case 'events':
                     this.events(res.data)
                     break
+                case 'seasons':
+                    this.seasons(res.data)
+                    break
                 case 'statusChanges':
                     this.statusChanges(res.data)
                     break

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

@@ -13,6 +13,8 @@ class StatusChange {
         this.extraData = statusChange.extraData ? statusChange.extraData : null
         this.holdToken = statusChange.holdToken ? statusChange.holdToken : null
         this.origin = statusChange.origin
+        this.isPresentOnChart = statusChange.isPresentOnChart
+        this.displayedLabel = statusChange.displayedLabel ? statusChange.displayedLabel : null
     }
 }
 

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

@@ -5,11 +5,6 @@ class ChartReports {
         this.client = client
     }
 
-    fetchReport (reportType, eventKey, bookWholeTables) {
-        return this.client.get(`/reports/charts/${encodeURIComponent(eventKey)}/${reportType}`, { params: { bookWholeTables } })
-            .then((res) => utilities.createChartReport(res.data))
-    }
-
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -28,6 +23,15 @@ class ChartReports {
         return this.fetchReport('byObjectType', chartKey, bookWholeTables)
     }
 
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object} JSON response from the server
+     */
+    summaryByObjectType (chartKey, bookWholeTables = undefined) {
+        return this.fetchSummaryReport('byObjectType', chartKey, bookWholeTables)
+    }
+
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -37,6 +41,15 @@ class ChartReports {
         return this.fetchReport('byCategoryLabel', chartKey, bookWholeTables)
     }
 
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object} JSON response from the server
+     */
+    summaryByCategoryLabel (chartKey, bookWholeTables = undefined) {
+        return this.fetchSummaryReport('byCategoryLabel', chartKey, bookWholeTables)
+    }
+
     /**
      * @param {string} chartKey
      * @param {string} bookWholeTables
@@ -45,6 +58,43 @@ class ChartReports {
     byCategoryKey (chartKey, bookWholeTables = undefined) {
         return this.fetchReport('byCategoryKey', chartKey, bookWholeTables)
     }
+
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object} JSON response from the server
+     */
+    summaryByCategoryKey (chartKey, bookWholeTables = undefined) {
+        return this.fetchSummaryReport('byCategoryKey', chartKey, bookWholeTables)
+    }
+
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object.<string, ChartObjectInfo[]>}
+     */
+    bySection (chartKey, bookWholeTables = undefined) {
+        return this.fetchReport('bySection', chartKey, bookWholeTables)
+    }
+
+    /**
+     * @param {string} chartKey
+     * @param {string} bookWholeTables
+     * @returns {Object} JSON response from the server
+     */
+    summaryBySection (chartKey, bookWholeTables = undefined) {
+        return this.fetchSummaryReport('bySection', chartKey, bookWholeTables)
+    }
+
+    fetchReport (reportType, chartKey, bookWholeTables) {
+        return this.client.get(`/reports/charts/${encodeURIComponent(chartKey)}/${reportType}`, { params: { bookWholeTables } })
+            .then((res) => utilities.createChartReport(res.data))
+    }
+
+    fetchSummaryReport (reportType, chartKey, bookWholeTables) {
+        return this.client.get(`/reports/charts/${encodeURIComponent(chartKey)}/${reportType}/summary`, { params: { bookWholeTables } })
+            .then((res) => res.data)
+    }
 }
 
 module.exports = ChartReports

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/src/Seasons/Season.js

@@ -0,0 +1,16 @@
+const Event = require('../Events/Event.js')
+
+class Season {
+    /**
+     * @param {object} season
+     */
+    constructor (season) {
+        this.id = season.id
+        this.key = season.key
+        this.seasonEvent = new Event(season.seasonEvent)
+        this.partialSeasonKeys = season.partialSeasonKeys
+        this.events = season.events.map(e => new Event(e))
+    }
+}
+
+module.exports = Season

package/src/Seasons/SeasonParams.js

@@ -0,0 +1,28 @@
+class SeasonParams {
+    key (key) {
+        this._key = key
+        return this
+    }
+
+    numberOfEvents (numberOfEvents) {
+        this._numberOfEvents = numberOfEvents
+        return this
+    }
+
+    eventKeys (eventKeys) {
+        this._eventKeys = eventKeys
+        return this
+    }
+
+    tableBookingConfig (tableBookingConfig) {
+        this._tableBookingConfig = tableBookingConfig
+        return this
+    }
+
+    socialDistancingRulesetKey (socialDistancingRulesetKey) {
+        this._socialDistancingRulesetKey = socialDistancingRulesetKey
+        return this
+    }
+}
+
+module.exports = SeasonParams

package/src/Seasons/Seasons.js

@@ -0,0 +1,194 @@
+const Page = require('../Page.js')
+const Lister = require('../Lister.js')
+const Season = require('./Season')
+
+class Seasons {
+    /**
+     * @param {SeatsioClient} client
+     */
+    constructor (client) {
+        this.client = client
+    }
+
+    /**
+     * @param {string} chartKey
+     * @param {?seasonParams} SeasonParams
+     * @returns {Promise<Season>}
+     */
+    create (chartKey, seasonParams = null) {
+        const requestParameters = {}
+
+        requestParameters.chartKey = chartKey
+
+        if (seasonParams !== null) {
+            if (seasonParams._key !== null) {
+                requestParameters.key = seasonParams._key
+            }
+
+            if (seasonParams._numberOfEvents !== null) {
+                requestParameters.numberOfEvents = seasonParams._numberOfEvents
+            }
+
+            if (seasonParams._eventKeys !== null) {
+                requestParameters.eventKeys = seasonParams._eventKeys
+            }
+
+            if (seasonParams._tableBookingConfig !== null) {
+                requestParameters.tableBookingConfig = seasonParams._tableBookingConfig
+            }
+
+            if (seasonParams._socialDistancingRulesetKey !== null) {
+                requestParameters.socialDistancingRulesetKey = seasonParams._socialDistancingRulesetKey
+            }
+        }
+
+        return this.client.post('/seasons', requestParameters)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} topLevelSeasonKey
+     * @param {?string} partialSeasonKey
+     * @param {?string[]} eventKeys
+     * @returns {Promise<Season>}
+     */
+    createPartialSeason (topLevelSeasonKey, partialSeasonKey = null, eventKeys = null) {
+        const requestParameters = {}
+
+        if (partialSeasonKey !== null) {
+            requestParameters.key = partialSeasonKey
+        }
+
+        if (eventKeys !== null) {
+            requestParameters.eventKeys = eventKeys
+        }
+        return this.client.post(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons`, requestParameters)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} key
+     * @returns {Promise<Season>}
+     */
+    retrieve (key) {
+        return this.client.get(`/seasons/${encodeURIComponent(key)}`)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} topLevelSeasonKey
+     * @param {?string} partialSeasonKey
+     * @returns {Promise<Season>}
+     */
+    retrievePartialSeason (topLevelSeasonKey, partialSeasonKey) {
+        return this.client.get(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}`)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} key
+     * @param {?number} numberOfEvents
+     * @param {?string[]} eventKeys
+     * @returns {Promise<Season>}
+     */
+    createEvents (key, numberOfEvents = null, eventKeys = null) {
+        const requestParameters = { }
+
+        if (numberOfEvents !== null) {
+            requestParameters.numberOfEvents = numberOfEvents
+        }
+
+        if (eventKeys !== null) {
+            requestParameters.eventKeys = eventKeys
+        }
+
+        return this.client.post(`/seasons/${encodeURIComponent(key)}/actions/create-events`, requestParameters)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} topLevelSeasonKey
+     * @param {string} partialSeasonKey
+     * @param {string[]} eventKeys
+     * @returns {Promise<Season>}
+     */
+    addEventsToPartialSeason (topLevelSeasonKey, partialSeasonKey, eventKeys) {
+        const requestParameters = { eventKeys }
+        return this.client.post(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}/actions/add-events`, requestParameters)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {string} key
+     * @returns {Promise}
+     */
+    delete (key) {
+        return this.client.delete(`/seasons/${encodeURIComponent(key)}`)
+    }
+
+    /**
+     * @param {string} topLevelSeasonKey
+     * @param {string} partialSeasonKey
+     * @returns {Promise<void>}
+     */
+    deletePartialSeason (topLevelSeasonKey, partialSeasonKey) {
+        return this.client.delete(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}`)
+    }
+
+    /**
+     * @param {string} topLevelSeasonKey
+     * @param {string} partialSeasonKey
+     * @param {string} eventKey
+     * @returns {Promise<Season>}
+     */
+    async removeEventFromPartialSeason (topLevelSeasonKey, partialSeasonKey, eventKey) {
+        return this.client.delete(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}/events/${encodeURIComponent(eventKey)}`)
+            .then((res) => new Season(res.data))
+    }
+
+    /**
+     * @param {?object} requestParameters
+     * @returns {AsyncIterator<Season>}
+     */
+    listAll (requestParameters = {}) {
+        return this.iterator().all(requestParameters)
+    }
+
+    /**
+     * @param {?number} pageSize
+     * @returns {Page<Season>}
+     */
+    listFirstPage (pageSize = null) {
+        return this.iterator().firstPage(null, pageSize)
+    }
+
+    /**
+     * @param {?string} afterId
+     * @param {?number} pageSize
+     * @returns {Page<Season>}
+     */
+    listPageAfter (afterId, pageSize = null) {
+        return this.iterator().pageAfter(afterId, null, pageSize)
+    }
+
+    /**
+     * @param {?string} beforeId
+     * @param {?number} pageSize
+     * @returns {Page<Season>}
+     */
+    listPageBefore (beforeId, pageSize = null) {
+        return this.iterator().pageBefore(beforeId, null, pageSize)
+    }
+
+    /**
+     * @returns {Lister}
+     */
+    iterator () {
+        return new Lister('/seasons', this.client, 'seasons', (data) => {
+            const seasons = data.items.map(seasonData => new Season(seasonData))
+            return new Page(seasons, data.next_page_starts_after, data.previous_page_ends_before)
+        })
+    }
+}
+
+module.exports = Seasons

package/src/SeatsioClient.js

@@ -11,6 +11,7 @@ const EventReports = require('./Reports/EventReports.js')
 const UsageReports = require('./Reports/UsageReports.js')
 const errorResponseHandler = require('./errorInterceptor.js')
 const Axios = require('axios')
+const Seasons = require('./Seasons/Seasons')
 
 class SeatsioClient {
     constructor (region, secretKey, workspaceKey = null, extraHeaders = {}) {
@@ -32,6 +33,7 @@ class SeatsioClient {
         this.chartReports = new ChartReports(this.client)
         this.eventReports = new EventReports(this.client)
         this.usageReports = new UsageReports(this.client)
+        this.seasons = new Seasons(this.client)
     }
 
     _axiosConfig (baseUrl, secretKey, workspaceKey, extraHeaders) {

package/tests/chartReports/chartReport.test.js

@@ -119,3 +119,14 @@ test('get report byCategoryLabel', async () => {
     expect(report.Cat1.length).toBe(17)
     expect(report.Cat2.length).toBe(17)
 })
+
+test('get report bySection', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChartWithSections(chartKey, user.secretKey)
+
+    const report = await client.chartReports.bySection(chartKey)
+
+    expect(report['Section A'].length).toBe(36)
+    expect(report['Section B'].length).toBe(35)
+})