Class: ReservedSeating

ReservedSeating()

An Library for Reserved Seating Venues have Seats, Events are at Venues Reservations are Seats at Events

Constructor

new ReservedSeating()

Source:

Methods

AddSeatToOrder(orderId, seatId)

Place a hold on a seat and add it to an order
Parameters:
Name Type Description
orderId string Order ID
seatId string Seat ID
Source:

AutoSelect(numSeats, seatClassPreference)

Automatically select some seats and add them to the order
Parameters:
Name Type Description
numSeats number Number of seats to select
seatClassPreference array Which seat classes to prefer in order
Source:

CancelEvent(eventId)

Cancel an event and all reservations for that event
Parameters:
Name Type Description
eventId string Event ID
Source:

CancelReservation(orderId, seatId)

Cancel a reservation and release the seats
Parameters:
Name Type Description
orderId string Order ID
seatId string Seat ID
Source:

CompleteOrder(orderId)

Complete order and convert holds into reservations
Parameters:
Name Type Description
orderId string Order ID
Source:

ContinueOrder(orderId, expires)

Keep an order from expiring and becoming abondoned
Parameters:
Name Type Description
orderId string Order ID
expires number New timestamp when order will expire
Source:

CreateEvent(ownerId, venueConfigId, maxPeople) → {Promise}

Create a new Event
Parameters:
Name Type Description
ownerId string Who is responsible for this event
venueConfigId string Venue Configuration to use for this event
maxPeople number Maximum people permitted in venue
Source:
Returns:
the id of the new Event Promise will resolve to type string.
Type
Promise

CreateOrder(userId, eventId, expires) → {Promise}

Create a new Order
Parameters:
Name Type Description
userId string The user who is placing the reservation
eventId string The event that the order is for
expires number Timestamp when order expires and is considered abondoned
Source:
Returns:
the id of the new Order Promise will resolve to type string.
Type
Promise

CreateSeat(name, seatClass, venueConfigId, nextTo, tableId, geometry) → {Promise}

Create a new seat
Parameters:
Name Type Description
name string The seat name
seatClass string The class of seat
venueConfigId string the Venue Configuration the seat belongs to
nextTo array the seats that are next to this one
tableId string the table this seat is at
geometry object Information about where the Seat is
Source:
Returns:
the id of the new seat Promise will resolve to type string.
Type
Promise

CreateTable(venueConfigId, minSeats, maxSeats, geometry) → {Promise}

Create a new Table
Parameters:
Name Type Description
venueConfigId string Venue Configuration to use for this event
minSeats number Minimum number of people in a party to reserve the table
maxSeats number Maximum number of people that can sit at this table
geometry object Information about where the Table is
Source:
Returns:
the id of the new Table Promise will resolve to type string.
Type
Promise

CreateVenue(ownerId, name, maxPeople) → {Promise}

Create a new venue
Parameters:
Name Type Description
ownerId string Who is responsible for this venue
name string Name of Venue
maxPeople number Maximum people permitted in venue
Source:
Returns:
the id of the new venue Promise will resolve to type string.
Type
Promise

CreateVenueConfiguration(venueId, name, maxPeople) → {Promise}

Create a new Venue Congiguration
Parameters:
Name Type Description
venueId string Venue
name string Name of Venue Configuration
maxPeople number Maximum number of people permitted in this Venue Configuration
Source:
Returns:
the id of the new Venue Configuration Promise will resolve to type string.
Type
Promise

DeleteEvent(id)

Delete an Event Events on sale must be cancelled before being deleted.
Parameters:
Name Type Description
id string Event ID
Source:

DeleteOrder(id)

Delete an Order Reservations must be cancelled first
Parameters:
Name Type Description
id string Order ID
Source:

DeleteSeat(id)

Delete a Seat Venue Configuration must be unavailable first
Parameters:
Name Type Description
id string Seat ID
Source:

DeleteTable(id)

Delete a Table Venue Configuration must be unavailable first
Parameters:
Name Type Description
id string Table ID
Source:

DeleteVenue(id)

Delete a Venue
Parameters:
Name Type Description
id string Venue ID
Source:

DeleteVenueConfiguration(id)

Delete a Venue Configuration Must be unavailable first
Parameters:
Name Type Description
id string Venue Configuration ID
Source:

FindAbandonedOrders(page, perpage) → {Promise}

Get any abondoned (expired) orders
Parameters:
Name Type Description
page number page number
perpage number per page
Source:
Returns:
abondoned orders Promise will resolve to type array.
Type
Promise

GetAllEventsOnSale(page, perpage) → {Promise}

Get all Events marked on sale
Parameters:
Name Type Description
page number page number
perpage number per page
Source:
Returns:
events on sale Promise will resolve to type array.
Type
Promise

GetAllVenuesByOwner(ownerId) → {Promise}

Get all Venues for an owner
Parameters:
Name Type Description
ownerId string owner id
Source:
Returns:
List of venues Promise will resolve to type array.
Type
Promise

GetEvent(id) → {Promise}

Get an Event
Parameters:
Name Type Description
id string Event ID
Source:
Returns:
the Event data as an object Promise will resolve to type object.
Type
Promise

GetOrdersForUser(userId, page, perpage) → {Promise}

Get a users orders
Parameters:
Name Type Description
userId string User ID
page number page number
perpage number per page
Source:
Returns:
orders for user Promise will resolve to type array.
Type
Promise

GetOrderSummary(orderId) → {Promise}

Get a summary of an Order
Parameters:
Name Type Description
orderId string Order ID
Source:
Returns:
the summary for the specified Order Promise will resolve to type array.
Type
Promise

GetSeat(id) → {Promise}

Get a Seat
Parameters:
Name Type Description
id string Seat ID
Source:
Returns:
the Seat data as an object Promise will resolve to type object.
Type
Promise

GetSeatsAndTablesForEvent(eventId, page, perpage)

Get all Seats and Tables for an Event
Parameters:
Name Type Description
eventId string Event ID
page number page number
perpage number per page
Source:

GetTable(id) → {Promise}

Get a Table
Parameters:
Name Type Description
id string Table ID
Source:
Returns:
the Table data as an object Promise will resolve to type object.
Type
Promise

GetVenue(id) → {Promise}

Get a Venue
Parameters:
Name Type Description
id string Venue ID
Source:
Returns:
the Venue data as an object Promise will resolve to type object.
Type
Promise

GetVenueConfiguration(id) → {Promise}

Get a Venue Configuration
Parameters:
Name Type Description
id string Venue Configuration ID
Source:
Returns:
the VenueConfiguration data as an object Promise will resolve to type object.
Type
Promise

GetVenueConfigurations(venueId) → {Promise}

Get Venue Configurations for a Venue
Parameters:
Name Type Description
venueId string Venue ID
Source:
Returns:
the Venue Configurations for the specified Venue Promise will resolve to type array.
Type
Promise

UpdateEvent(data, complete)

Update an Event
Parameters:
Name Type Description
data object Event data to update
complete boolean if set to true, missing fields should be deleted
Source:

UpdateSeat(data, complete)

Update a Seat
Parameters:
Name Type Description
data object Seat data to update
complete boolean if set to true, missing fields should be deleted
Source:

UpdateTable(data, complete)

Update a Table
Parameters:
Name Type Description
data object Table data to update
complete boolean if set to true, missing fields should be deleted
Source:

UpdateVenue(data, complete)

Update a Venue
Parameters:
Name Type Description
data object Venue data to update
complete boolean if set to true, missing fields should be deleted
Source:

UpdateVenueConfiguration(data, complete)

Update a Venue Configuration
Parameters:
Name Type Description
data object Venue Configuration data to update
complete boolean if set to true, missing fields should be deleted
Source:

UpdateVenueConfigurationAvailability(venueConfigurationId, available)

Make a venue configuration available or unavailable. Must not have any events for sale using this venute configuration.
Parameters:
Name Type Description
venueConfigurationId string Venue Configuration ID
available boolean availability
Source: