Index

@venuecms/sdk-next

@venuecms/sdk-next

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 (cached)

getSiteKeyByDomain

Get the siteKey and site id from a domain name.

listSiteDomains

-

Search a site for all content types (cached)

Events

Function

Description

Retrieve data for a single event (cached)

Get a list of events (cached)

Pages

Function

Description

Get a single page using the slug (cached)

Get a list of all pages (cached)

Profiles

Function

Description

Get a profile (cached)

getProfileEvents

Get a listing of events for a profile (cached)

getProfileProducts

Get a listing of products for a profile (cached)

Get a list of profiles (cached)

Products

Function

Description

Get a product (cached)

Get a listing of products (cached)

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

Name

Description

-

-

-

AddCustomDomainData

-

AddCustomDomainError

-

AddCustomDomainResponse

-

-

AddDomainResponse

-

AddItemToMediaCollectionData

-

AddItemToMediaCollectionError

-

AddItemToMediaCollectionResponse

-

AddMediaItemToCollectionInput

-

AddRoleToMediaCollectionData

-

AddRoleToMediaCollectionError

-

AddRoleToMediaCollectionInput

-

AddRoleToMediaCollectionResponse

-

AddRoleToMediaItemData

-

AddRoleToMediaItemError

-

AddRoleToMediaItemInput

-

AddRoleToMediaItemResponse

-

AtprotoOauthDisconnectData

-

AtprotoOauthDisconnectError

-

AtprotoOauthDisconnectResponse

-

AtprotoOauthDisconnectResponse2

-

AtprotoOauthStartData

-

AtprotoOauthStartError

-

AtprotoOauthStartInput

-

AtprotoOauthStartResponse

-

AtprotoOauthStartResponse2

-

AtprotoOauthStatusData

-

AtprotoOauthStatusError

-

AtprotoOauthStatusResponse

-

AtprotoOauthStatusResponse2

-

-

BatchPagination

-

BatchSendResult

-

-

CreateAndSendBatchData

-

CreateAndSendBatchError

-

CreateAndSendBatchResponse

-

CreateDraftBatchData

-

CreateDraftBatchError

-

CreateDraftBatchInput

-

CreateDraftBatchResponse

-

CreateEventLivestreamData

-

CreateEventLivestreamError

-

CreateEventLivestreamResponse

-

CreateLivestreamInput

-

CreateMediaCollectionData

-

CreateMediaCollectionError

-

CreateMediaCollectionInput

-

CreateMediaCollectionResponse

-

CustomSchemaData

-

DeleteBatchData

-

DeleteBatchError

-

DeleteBatchResponse

-

DeleteEventLivestreamData

-

DeleteEventLivestreamError

-

DeleteEventLivestreamResponse

-

DeleteMediaCollectionData

-

DeleteMediaCollectionError

-

DeleteMediaCollectionResponse

-

DeleteMediaItemData

-

DeleteMediaItemError

-

DeleteMediaItemResponse

-

-

-

DraftBatchResult

-

-

-

EmailBatchDetail

-

EmailBatchesResponse

-

-

EmailConfigInput

-

-

-

EntityMediaCount

-

-

-

-

-

-

GetBackendLinkPreviewData

-

GetBackendLinkPreviewError

-

GetBackendLinkPreviewResponse

-

GetDomainStatusData

-

GetDomainStatusError

-

GetDomainStatusResponse

-

GetEmailBatchData

-

GetEmailBatchError

-

GetEmailBatchesData

-

GetEmailBatchesError

-

GetEmailBatchesResponse

-

GetEmailBatchResponse

-

GetEmailByIdData

-

GetEmailByIdError

-

GetEmailByIdResponse

-

GetEmailConfigData

-

GetEmailConfigError

-

GetEmailConfigResponse

-

-

-

GetEmailsResponse

-

GetEmailStatsData

-

GetEmailStatsError

-

GetEmailStatsResponse

-

GetEntityMediaCountData

-

GetEntityMediaCountError

-

GetEntityMediaCountResponse

-

-

GetEventDatesData

-

GetEventDatesError

-

GetEventDatesResponse

-

-

GetEventLivestreamData

-

GetEventLivestreamError

-

GetEventLivestreamResponse

-

GetEventResponse

-

-

-

GetEventsResponse

-

GetMediaCollectionData

-

GetMediaCollectionError

-

GetMediaCollectionResponse

-

GetNewsArticleData

-

GetNewsArticleError

-

GetNewsArticleResponse

-

-

GetNewsDatesData

-

GetNewsDatesError

-

GetNewsDatesResponse

-

-

GetNewsResponse

-

-

-

GetPageResponse

-

-

-

GetPagesResponse

-

GetPlaybackTokenData

-

GetPlaybackTokenError

-

GetPlaybackTokenResponse

-

-

GetProductError

-

GetProductResponse

-

GetProductsData

-

GetProductsError

-

GetProductsResponse

-

-

GetProfileError

-

GetProfileEventsData

-

GetProfileEventsError

-

GetProfileEventsResponse

-

GetProfileProductsData

-

GetProfileProductsError

-

GetProfileProductsResponse

-

GetProfileResponse

-

GetProfilesData

-

GetProfilesError

-

GetProfilesResponse

-

GetPublicLinkPreviewData

-

GetPublicLinkPreviewError

-

GetPublicLinkPreviewResponse

-

GetSiteByDomainData

-

GetSiteByDomainError

-

GetSiteByDomainResponse

-

-

-

GetSiteResponse

-

GetStripeKeyStatusData

-

GetStripeKeyStatusError

-

GetStripeKeyStatusResponse

-

-

-

GetTagsResponse

-

-

-

ListMediaCollectionRolesData

-

ListMediaCollectionRolesError

-

ListMediaCollectionRolesResponse

-

ListMediaCollectionsData

-

ListMediaCollectionsError

-

ListMediaCollectionsResponse

-

ListMediaItemRolesData

-

ListMediaItemRolesError

-

ListMediaItemRolesResponse

-

ListSiteDomainsData

-

ListSiteDomainsError

-

ListSiteDomainsResponse

-

-

-

LivestreamResponse

-

LocalizedContent

-

-

MediaCollection

-

MediaCollectionRole

-

-

-

-

-

-

-

-

-

-

-

-

-

PublicLinkPreview

-

PublicSignInData

-

PublicSignInError

-

PublicSignInResponse

-

PublicSignOutData

-

PublicSignOutError

-

PublicSignOutResponse

-

PublicSignUpData

-

PublicSignUpError

-

PublicSignUpResponse

-

-

-

-

RemoveCustomDomainData

-

RemoveCustomDomainError

-

RemoveCustomDomainResponse

-

RemoveItemFromMediaCollectionData

-

RemoveItemFromMediaCollectionError

-

RemoveItemFromMediaCollectionResponse

-

RemoveRoleFromMediaCollectionData

-

RemoveRoleFromMediaCollectionError

-

RemoveRoleFromMediaCollectionResponse

-

RemoveRoleFromMediaItemData

-

RemoveRoleFromMediaItemError

-

RemoveRoleFromMediaItemResponse

-

RemoveStripeKeyData

-

RemoveStripeKeyError

-

RemoveStripeKeyResponse

-

ReorderMediaCollectionItemData

-

ReorderMediaCollectionItemError

-

ReorderMediaCollectionItemInput

-

ReorderMediaCollectionItemResponse

-

-

-

SearchAllResponse

-

SearchAllSiteResults

-

-

SearchSiteError

-

SearchSiteResponse

-

SearchSiteResults

-

-

-

SendBatchResponse

-

-

-

-

-

-

-

StopEventLivestreamData

-

StopEventLivestreamError

-

StopEventLivestreamResponse

-

StopLivestreamResponse

-

StripeKeyStatus

-

StripeKeySuccess

-

StripeKeyUpdateInput

-

-

-

-

-

UpdatedMediaItem

-

UpdateDraftBatchData

-

UpdateDraftBatchError

-

UpdateDraftBatchInput

-

UpdateDraftBatchResponse

-

UpdateEmailConfigData

-

UpdateEmailConfigError

-

UpdateEmailConfigResponse

-

UpdateMediaCollectionData

-

UpdateMediaCollectionError

-

UpdateMediaCollectionInput

-

UpdateMediaCollectionResponse

-

UpdateMediaItemData

-

UpdateMediaItemError

-

UpdateMediaItemInput

-

UpdateMediaItemOrderData

-

UpdateMediaItemOrderError

-

UpdateMediaItemOrderInput

-

UpdateMediaItemOrderResponse

-

UpdateMediaItemOrderResponse2

-

UpdateMediaItemResponse

-

UpdateStripeKeyData

-

UpdateStripeKeyError

-

UpdateStripeKeyResponse

-

VerifyDomainData

-

VerifyDomainError

-

VerifyDomainResponse

-

-

-

Component form of useEmbedResize. Renders nothing. Mounted once by VenueContent; can also be placed in a layout if rendering embeds elsewhere.

getEventDates

-

useEmbedResize

-

VenueContent

-

-

-

-

News

Function

Description

Get a list of all news items (cached)

getNewsArticle

Get a single news item using the slug (cached)

getNewsDates

-

Tags

Function

Description

Get a listing of tags in use

Last updated 2 months ago