LogoLogo
Home
  • Documentation
  • Developers
  • The Venue Developer Documentation
  • Next.js SDK
    • React Components
      • VenueContent
      • VenueImage
    • reference
      • Index
      • functions
        • VenueContent
        • VenueImage
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • interfaces
        • NodeHandlers
        • NodeProps
        • RenderNode
      • type-aliases
        • ContentStyles
        • 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
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • NodeHandler
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • TypeScript SDK
    • reference
      • Index
      • functions
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • type-aliases
        • 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
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • REST API
    • Api
      • V2
        • Public
          • Events
          • Pages
          • Products
          • Site
          • Profiles
            • Events
Powered by GitBook
On this page
  • @venuecms/sdk
  • Configuration
  • Sites
  • Events
  • Pages
  • Profiles
  • Products
  • Utilities
  • Other
Export as PDF
  1. TypeScript SDK
  2. reference

Index

@venuecms/sdk


@venuecms/sdk

Configuration

Function
Description

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

Get the site configured via the siteKey

Get the siteKey and site id from a domain name.

Search a site for all content types

Events

Function
Description

Retrieve data for a single event

-

Pages

Function
Description

Get a single page using the slug

Get a list of all pages

Profiles

Function
Description

Get a profile

Get a listing of events for a profile

Get a list of profiles

Products

Function
Description

Get a product

Get a listing of products

Utilities

Function
Description

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

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

-

Last updated 2 months ago

setConfig
getSite
getSiteKeyByDomain
searchSite
getEvent
getEvents
getPage
getPages
getProfile
getProfileEvents
getProfiles
getProduct
getProducts
getLocalizedContent
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