> For the complete documentation index, see [llms.txt](https://docs.venuecms.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.venuecms.com/developers/sdk/reference/index.md).

# Index

**@venuecms/sdk**

***

## @venuecms/sdk

### Configuration

| Function                                                      | Description                                                                                                                                                                                                                           |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [setConfig](/developers/sdk/reference/functions/setconfig.md) | 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](/developers/sdk/reference/functions/getsite.md)                                                                   | Get the site configured via the siteKey         |
| [getSiteKeyByDomain](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getSiteKeyByDomain.md) | Get the siteKey and site id from a domain name. |
| [listSiteDomains](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/listSiteDomains.md)       | -                                               |
| [searchSite](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/searchSite.md)                 | Search a site for all content types             |

### Events

| Function                                                      | Description                      |
| ------------------------------------------------------------- | -------------------------------- |
| [getEvent](/developers/sdk/reference/functions/getevent.md)   | Retrieve data for a single event |
| [getEvents](/developers/sdk/reference/functions/getevents.md) | -                                |

### Pages

| Function                                                    | Description                      |
| ----------------------------------------------------------- | -------------------------------- |
| [getPage](/developers/sdk/reference/functions/getpage.md)   | Get a single page using the slug |
| [getPages](/developers/sdk/reference/functions/getpages.md) | Get a list of all pages          |

### Profiles

| Function                                                                                                                    | Description                             |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [getProfile](/developers/sdk/reference/functions/getprofile.md)                                                             | Get a profile                           |
| [getProfileEvents](/developers/sdk/reference/functions/getprofileevents.md)                                                 | Get a listing of events for a profile   |
| [getProfileProducts](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getProfileProducts.md) | Get a listing of products for a profile |
| [getProfiles](/developers/sdk/reference/functions/getprofiles.md)                                                           | Get a list of profiles                  |

### Products

| Function                                                          | Description               |
| ----------------------------------------------------------------- | ------------------------- |
| [getProduct](/developers/sdk/reference/functions/getproduct.md)   | Get a product             |
| [getProducts](/developers/sdk/reference/functions/getproducts.md) | Get a listing of products |

### Utilities

| Function                                                                          | Description                                                                                                                                                               |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [getLocalizedContent](/developers/sdk/reference/functions/getlocalizedcontent.md) | 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](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddCustomDomainData.md)                         | -           |
| [AddCustomDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddCustomDomainError.md)                       | -           |
| [AddCustomDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddCustomDomainResponse.md)                 | -           |
| [AddDomainInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddDomainInput.md)                                   | -           |
| [AddDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddDomainResponse.md)                             | -           |
| [AddRoleToMediaItemData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddRoleToMediaItemData.md)                   | -           |
| [AddRoleToMediaItemError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddRoleToMediaItemError.md)                 | -           |
| [AddRoleToMediaItemInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddRoleToMediaItemInput.md)                 | -           |
| [AddRoleToMediaItemResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/AddRoleToMediaItemResponse.md)           | -           |
| [BatchEmail](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/BatchEmail.md)                                           | -           |
| [BatchPagination](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/BatchPagination.md)                                 | -           |
| [BatchSendResult](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/BatchSendResult.md)                                 | -           |
| [CreateAndSendBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateAndSendBatchData.md)                   | -           |
| [CreateAndSendBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateAndSendBatchError.md)                 | -           |
| [CreateAndSendBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateAndSendBatchResponse.md)           | -           |
| [CreateDraftBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateDraftBatchData.md)                       | -           |
| [CreateDraftBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateDraftBatchError.md)                     | -           |
| [CreateDraftBatchInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateDraftBatchInput.md)                     | -           |
| [CreateDraftBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CreateDraftBatchResponse.md)               | -           |
| [CustomSchemaData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/CustomSchemaData.md)                               | -           |
| [DeleteBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DeleteBatchData.md)                                 | -           |
| [DeleteBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DeleteBatchError.md)                               | -           |
| [DeleteBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DeleteBatchResponse.md)                         | -           |
| [DnsRecord](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DnsRecord.md)                                             | -           |
| [DomainStatus](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DomainStatus.md)                                       | -           |
| [DraftBatchResult](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/DraftBatchResult.md)                               | -           |
| [Email](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/Email.md)                                                     | -           |
| [EmailBatch](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailBatch.md)                                           | -           |
| [EmailBatchDetail](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailBatchDetail.md)                               | -           |
| [EmailBatchesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailBatchesResponse.md)                       | -           |
| [EmailConfig](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailConfig.md)                                         | -           |
| [EmailConfigInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailConfigInput.md)                               | -           |
| [EmailsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailsResponse.md)                                   | -           |
| [EmailStats](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EmailStats.md)                                           | -           |
| [Event](/developers/sdk/reference/type-aliases/event.md)                                                                                                 | -           |
| [EventDates](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EventDates.md)                                           | -           |
| [EventReference](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EventReference.md)                                   | -           |
| [EventRelations](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/EventRelations.md)                                   | -           |
| [GetDomainStatusData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetDomainStatusData.md)                         | -           |
| [GetDomainStatusError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetDomainStatusError.md)                       | -           |
| [GetDomainStatusResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetDomainStatusResponse.md)                 | -           |
| [GetEmailBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchData.md)                             | -           |
| [GetEmailBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchError.md)                           | -           |
| [GetEmailBatchesData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchesData.md)                         | -           |
| [GetEmailBatchesError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchesError.md)                       | -           |
| [GetEmailBatchesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchesResponse.md)                 | -           |
| [GetEmailBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailBatchResponse.md)                     | -           |
| [GetEmailByIdData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailByIdData.md)                               | -           |
| [GetEmailByIdError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailByIdError.md)                             | -           |
| [GetEmailByIdResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailByIdResponse.md)                       | -           |
| [GetEmailConfigData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailConfigData.md)                           | -           |
| [GetEmailConfigError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailConfigError.md)                         | -           |
| [GetEmailConfigResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailConfigResponse.md)                   | -           |
| [GetEmailsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailsData.md)                                     | -           |
| [GetEmailsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailsError.md)                                   | -           |
| [GetEmailsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailsResponse.md)                             | -           |
| [GetEmailStatsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailStatsData.md)                             | -           |
| [GetEmailStatsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailStatsError.md)                           | -           |
| [GetEmailStatsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEmailStatsResponse.md)                     | -           |
| [GetEventData](/developers/sdk/reference/type-aliases/geteventdata.md)                                                                                   | -           |
| [GetEventDatesData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEventDatesData.md)                             | -           |
| [GetEventDatesError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEventDatesError.md)                           | -           |
| [GetEventDatesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetEventDatesResponse.md)                     | -           |
| [GetEventError](/developers/sdk/reference/type-aliases/geteventerror.md)                                                                                 | -           |
| [GetEventResponse](/developers/sdk/reference/type-aliases/geteventresponse.md)                                                                           | -           |
| [GetEventsData](/developers/sdk/reference/type-aliases/geteventsdata.md)                                                                                 | -           |
| [GetEventsError](/developers/sdk/reference/type-aliases/geteventserror.md)                                                                               | -           |
| [GetEventsResponse](/developers/sdk/reference/type-aliases/geteventsresponse.md)                                                                         | -           |
| [GetNewsArticleData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsArticleData.md)                           | -           |
| [GetNewsArticleError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsArticleError.md)                         | -           |
| [GetNewsArticleResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsArticleResponse.md)                   | -           |
| [GetNewsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsData.md)                                         | -           |
| [GetNewsDatesData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsDatesData.md)                               | -           |
| [GetNewsDatesError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsDatesError.md)                             | -           |
| [GetNewsDatesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsDatesResponse.md)                       | -           |
| [GetNewsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsError.md)                                       | -           |
| [GetNewsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetNewsResponse.md)                                 | -           |
| [GetPageData](/developers/sdk/reference/type-aliases/getpagedata.md)                                                                                     | -           |
| [GetPageError](/developers/sdk/reference/type-aliases/getpageerror.md)                                                                                   | -           |
| [GetPageResponse](/developers/sdk/reference/type-aliases/getpageresponse.md)                                                                             | -           |
| [GetPagesData](/developers/sdk/reference/type-aliases/getpagesdata.md)                                                                                   | -           |
| [GetPagesError](/developers/sdk/reference/type-aliases/getpageserror.md)                                                                                 | -           |
| [GetPagesResponse](/developers/sdk/reference/type-aliases/getpagesresponse.md)                                                                           | -           |
| [GetProductData](/developers/sdk/reference/type-aliases/getproductdata.md)                                                                               | -           |
| [GetProductError](/developers/sdk/reference/type-aliases/getproducterror.md)                                                                             | -           |
| [GetProductResponse](/developers/sdk/reference/type-aliases/getproductresponse.md)                                                                       | -           |
| [GetProductsData](/developers/sdk/reference/type-aliases/getproductsdata.md)                                                                             | -           |
| [GetProductsError](/developers/sdk/reference/type-aliases/getproductserror.md)                                                                           | -           |
| [GetProductsResponse](/developers/sdk/reference/type-aliases/getproductsresponse.md)                                                                     | -           |
| [GetProfileData](/developers/sdk/reference/type-aliases/getprofiledata.md)                                                                               | -           |
| [GetProfileError](/developers/sdk/reference/type-aliases/getprofileerror.md)                                                                             | -           |
| [GetProfileEventsData](/developers/sdk/reference/type-aliases/getprofileeventsdata.md)                                                                   | -           |
| [GetProfileEventsError](/developers/sdk/reference/type-aliases/getprofileeventserror.md)                                                                 | -           |
| [GetProfileEventsResponse](/developers/sdk/reference/type-aliases/getprofileeventsresponse.md)                                                           | -           |
| [GetProfileProductsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetProfileProductsData.md)                   | -           |
| [GetProfileProductsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetProfileProductsError.md)                 | -           |
| [GetProfileProductsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetProfileProductsResponse.md)           | -           |
| [GetProfileResponse](/developers/sdk/reference/type-aliases/getprofileresponse.md)                                                                       | -           |
| [GetProfilesData](/developers/sdk/reference/type-aliases/getprofilesdata.md)                                                                             | -           |
| [GetProfilesError](/developers/sdk/reference/type-aliases/getprofileserror.md)                                                                           | -           |
| [GetProfilesResponse](/developers/sdk/reference/type-aliases/getprofilesresponse.md)                                                                     | -           |
| [GetSiteByDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetSiteByDomainData.md)                         | -           |
| [GetSiteByDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetSiteByDomainError.md)                       | -           |
| [GetSiteByDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetSiteByDomainResponse.md)                 | -           |
| [GetSiteData](/developers/sdk/reference/type-aliases/getsitedata.md)                                                                                     | -           |
| [GetSiteError](/developers/sdk/reference/type-aliases/getsiteerror.md)                                                                                   | -           |
| [GetSiteResponse](/developers/sdk/reference/type-aliases/getsiteresponse.md)                                                                             | -           |
| [GetTagsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetTagsData.md)                                         | -           |
| [GetTagsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetTagsError.md)                                       | -           |
| [GetTagsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/GetTagsResponse.md)                                 | -           |
| [ListMediaItemRolesData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListMediaItemRolesData.md)                   | -           |
| [ListMediaItemRolesError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListMediaItemRolesError.md)                 | -           |
| [ListMediaItemRolesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListMediaItemRolesResponse.md)           | -           |
| [ListSiteDomainsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListSiteDomainsData.md)                         | -           |
| [ListSiteDomainsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListSiteDomainsError.md)                       | -           |
| [ListSiteDomainsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ListSiteDomainsResponse.md)                 | -           |
| [LocalizedContent](/developers/sdk/reference/type-aliases/localizedcontent.md)                                                                           | -           |
| [LocationSlim](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/LocationSlim.md)                                       | -           |
| [MediaItem](/developers/sdk/reference/type-aliases/mediaitem.md)                                                                                         | -           |
| [MediaItemRole](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/MediaItemRole.md)                                     | -           |
| [NewsDates](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/NewsDates.md)                                             | -           |
| [Page](/developers/sdk/reference/type-aliases/page.md)                                                                                                   | -           |
| [Pagination](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/Pagination.md)                                           | -           |
| [Product](/developers/sdk/reference/type-aliases/product.md)                                                                                             | -           |
| [ProductVariant](/developers/sdk/reference/type-aliases/productvariant.md)                                                                               | -           |
| [Profile](/developers/sdk/reference/type-aliases/profile.md)                                                                                             | -           |
| [ProfileSlim](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/ProfileSlim.md)                                         | -           |
| [PublicSignInData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignInData.md)                               | -           |
| [PublicSignInError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignInError.md)                             | -           |
| [PublicSignInResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignInResponse.md)                       | -           |
| [PublicSignOutData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignOutData.md)                             | -           |
| [PublicSignOutError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignOutError.md)                           | -           |
| [PublicSignOutResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignOutResponse.md)                     | -           |
| [PublicSignUpData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignUpData.md)                               | -           |
| [PublicSignUpError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignUpError.md)                             | -           |
| [PublicSignUpResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/PublicSignUpResponse.md)                       | -           |
| [publishState](/developers/sdk/reference/type-aliases/publishstate.md)                                                                                   | -           |
| [Recipient](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/Recipient.md)                                             | -           |
| [recordType](/developers/sdk/reference/type-aliases/recordtype.md)                                                                                       | -           |
| [RemoveCustomDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveCustomDomainData.md)                   | -           |
| [RemoveCustomDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveCustomDomainError.md)                 | -           |
| [RemoveCustomDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveCustomDomainResponse.md)           | -           |
| [RemoveRoleFromMediaItemData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveRoleFromMediaItemData.md)         | -           |
| [RemoveRoleFromMediaItemError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveRoleFromMediaItemError.md)       | -           |
| [RemoveRoleFromMediaItemResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/RemoveRoleFromMediaItemResponse.md) | -           |
| [SearchAllData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchAllData.md)                                     | -           |
| [SearchAllError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchAllError.md)                                   | -           |
| [SearchAllResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchAllResponse.md)                             | -           |
| [SearchAllSiteResults](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchAllSiteResults.md)                       | -           |
| [SearchSiteData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchSiteData.md)                                   | -           |
| [SearchSiteError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchSiteError.md)                                 | -           |
| [SearchSiteResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchSiteResponse.md)                           | -           |
| [SearchSiteResults](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SearchSiteResults.md)                             | -           |
| [SendBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SendBatchData.md)                                     | -           |
| [SendBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SendBatchError.md)                                   | -           |
| [SendBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/SendBatchResponse.md)                             | -           |
| [Site](/developers/sdk/reference/type-aliases/site.md)                                                                                                   | -           |
| [SiteSettings](/developers/sdk/reference/type-aliases/sitesettings.md)                                                                                   | -           |
| [status](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/status.md)                                                   | -           |
| [status2](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/status2.md)                                                 | -           |
| [status3](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/status3.md)                                                 | -           |
| [status4](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/status4.md)                                                 | -           |
| [Tag](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/Tag.md)                                                         | -           |
| [TagListItem](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/TagListItem.md)                                         | -           |
| [TicketOnEvent](/developers/sdk/reference/type-aliases/ticketonevent.md)                                                                                 | -           |
| [type](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/type.md)                                                       | -           |
| [UpdateDraftBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateDraftBatchData.md)                       | -           |
| [UpdateDraftBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateDraftBatchError.md)                     | -           |
| [UpdateDraftBatchInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateDraftBatchInput.md)                     | -           |
| [UpdateDraftBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateDraftBatchResponse.md)               | -           |
| [UpdateEmailConfigData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateEmailConfigData.md)                     | -           |
| [UpdateEmailConfigError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateEmailConfigError.md)                   | -           |
| [UpdateEmailConfigResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/UpdateEmailConfigResponse.md)             | -           |
| [VerifyDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/VerifyDomainData.md)                               | -           |
| [VerifyDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/VerifyDomainError.md)                             | -           |
| [VerifyDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/VerifyDomainResponse.md)                       | -           |
| [WebSite](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/type-aliases/WebSite.md)                                                 | -           |
| [cache](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/cache.md)                                                        | -           |
| [getEventDates](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getEventDates.md)                                        | -           |

### News

| Function                                                                                                            | Description                           |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| [getNews](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getNews.md)               | Get a list of all news items          |
| [getNewsArticle](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getNewsArticle.md) | Get a single news item using the slug |
| [getNewsDates](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getNewsDates.md)     | -                                     |

### Tags

| Function                                                                                              | Description                  |
| ----------------------------------------------------------------------------------------------------- | ---------------------------- |
| [getTags](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk/reference/functions/getTags.md) | Get a listing of tags in use |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.venuecms.com/developers/sdk/reference/index.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.