Index

@venuecms/sdk

---

@venuecms/sdk

Configuration

Function	Description
setConfig	Allows you to pass in the siteKey and API key manually in case you want it to be dynamically set. If you don't use this function, the SDK will default to using process.env.VENUE_SITE_KEY and process.env.VENUE_API_KEY instead.

Sites

Function	Description
getSite	Get the site configured via the siteKey
getSiteKeyByDomain	Get the siteKey and site id from a domain name.
searchSite	Search a site for all content types

Events

Function	Description
getEvent	Retrieve data for a single event
getEvents	-

Pages

Function	Description
getPage	Get a single page using the slug
getPages	Get a list of all pages

Profiles

Function	Description
getProfile	Get a profile
getProfileEvents	Get a listing of events for a profile
getProfiles	Get a list of profiles

Products

Function	Description
getProduct	Get a product
getProducts	Get a listing of products

Utilities

Function	Description
getLocalizedContent	This function will properly resolve content blocks that are localized. It takes in the array of localized content and returns the proper content to be used in your page.

Other

Type alias	Description
CustomSchemaData	-
Event	-
GetEventData	-
GetEventError	-
GetEventResponse	-
GetEventsData	-
GetEventsError	-
GetEventsResponse	-
GetPageData	-
GetPageError	-
GetPageResponse	-
GetPagesData	-
GetPagesError	-
GetPagesResponse	-
GetProductData	-
GetProductError	-
GetProductResponse	-
GetProductsData	-
GetProductsError	-
GetProductsResponse	-
GetProfileData	-
GetProfileError	-
GetProfileEventsData	-
GetProfileEventsError	-
GetProfileEventsResponse	-
GetProfileResponse	-
GetProfilesData	-
GetProfilesError	-
GetProfilesResponse	-
GetSiteByDomainData	-
GetSiteByDomainError	-
GetSiteByDomainResponse	-
GetSiteData	-
GetSiteError	-
GetSiteResponse	-
LocalizedContent	-
Location	-
MediaItem	-
Page	-
Product	-
ProductVariant	-
Profile	-
publishState	-
recordType	-
SearchSiteData	-
SearchSiteError	-
SearchSiteResponse	-
SearchSiteResults	-
Site	-
SiteSettings	-
TicketOnEvent	-
WebSite	-