@collectivtech/alana-sdk-js

---

@collectivtech/alana-sdk-js / resources/venue / Venue

Class: Venue

Defined in: src/resources/venue.ts:77

A venue is a location where an experience or event can take place.

Extends

• ApiResource

Constructors

Constructor

new Venue(apiResponse, context): Venue

Defined in: src/resources/venue.ts:186

Create a new venue resource object from an ALANA API response.

Parameters

apiResponse

any

A raw JSON response

context

ApiContext

An API context

Returns

Venue

Overrides

ApiResource.constructor

Properties

_context

protected _context: ApiContext

Defined in: src/resource.ts:148

The API context for this resource.

Inherited from

ApiResource._context

---

address?

optional address?: string

Defined in: src/resources/venue.ts:96

The street part of the venue's address.

---

address2?

optional address2?: string

Defined in: src/resources/venue.ts:101

Any additional "line 2" address data, such as a suite number.

---

availabilities?

optional availabilities?: any[]

Defined in: src/resources/venue.ts:173

A list of "blocks" of availability. These are periods of time on specific days, with the times relative to the venue's timezone.

---

available

available: boolean

Defined in: src/resources/venue.ts:123

Whether this venue is available for booking.

---

blackoutTimes?

optional blackoutTimes?: ExperienceBlackoutPeriod[]

Defined in: src/resources/venue.ts:178

A list of blackout days and times. The venue is unavailabile during these periods.

---

capacity?

optional capacity?: number

Defined in: src/resources/venue.ts:144

The total capacity of this venue. Experiences must have a maximum occupancy no greater than this value for this venue to be available.

---

city?

optional city?: string

Defined in: src/resources/venue.ts:106

The city part of the venue's address.

---

created

created: Date

Defined in: src/resources/venue.ts:128

The date this venue was created on the ALANA Platform.

---

id

id: number

Defined in: src/resources/venue.ts:81

The venue ID for this venue.

---

licensed?

optional licensed?: boolean

Defined in: src/resources/venue.ts:155

Whether this venue is licensed for use in certain types of experiences. Examples include fireworks or serving alcohol.

---

licenseText?

optional licenseText?: string

Defined in: src/resources/venue.ts:161

If the venue is marked as licensed, then text describing the license and its extent, including what is allowed under the license and what is not.

---

minimumTier?

optional minimumTier?: number

Defined in: src/resources/venue.ts:138

The minimum subscription tier for events or experiences using this venue.

---

name

name: string

Defined in: src/resources/venue.ts:86

The name of the venue.

---

parking?

optional parking?: boolean

Defined in: src/resources/venue.ts:149

Whether this venue provides parking on-site.

---

postalCode?

optional postalCode?: string

Defined in: src/resources/venue.ts:118

The ZIP or postal code of the venue's address. NOTE: The ALANA Platform is currently US-only.

---

provider

provider: VenueProvider

Defined in: src/resources/venue.ts:91

The business providing this venue.

---

state?

optional state?: string

Defined in: src/resources/venue.ts:112

The state part of the venue's address. NOTE: The ALANA Platform is currently US-only.

---

themes

themes: ExperienceThemeTag[]

Defined in: src/resources/venue.ts:133

An array of theme tags for this venue.

---

timezone

timezone: string

Defined in: src/resources/venue.ts:167

The timezone this venue is located in. Mostly used internally, but exposed for use cases which may need it.

Methods

addTag()

addTag(tag): Promise<Venue>

Defined in: src/resources/venue.ts:311

Add a theme tag to this venue. Themes can include a tag and a category for hierarchy-style navigation.

Note: If the theme tag object that is passed has an ID set to anything other than null or undefined, the theme tag with that ID will be used regardless of the values entered in the tag and category properties.

Parameters

tag

VenueTag

A venue theme tag object

Returns

Promise<Venue>

The updated Venue resource object

---

delete()

delete(): Promise<boolean>

Defined in: src/resources/venue.ts:285

Delete this venue. This operation is only permitted for the business which provided the venue.

Returns

Promise<boolean>

true if the operation succeeded

---

update()

update(): Promise<Venue>

Defined in: src/resources/venue.ts:232

Update this venue with new location and availability information.

Returns

Promise<Venue>

An updated Venue resource object