@venuecms/sdk-next/dist/lib/api/index.d.ts

This is a work in progress and is heavily in flux until we launch 1.0 in February.

import * as _venuecms_sdk from '@venuecms/sdk';
import { GetEventsData, GetEventData, GetPagesData, GetPageData, GetNewsData, GetNewsArticleData, GetProfilesData, GetProfileData, GetProfileEventsData, GetProfileProductsData, GetProductsData, GetProductData, SearchSiteData } from '@venuecms/sdk';

/**
 * Get the site configured via the siteKey (cached)
 * @category Sites
 */
declare const getSite: () => Promise<({
    data: _venuecms_sdk.Site;
    error: undefined;
} | {
    data: undefined;
    error: unknown;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a list of events (cached)
 * @category Events
 */
declare const getEvents: (params?: GetEventsData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetEventsResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Retrieve data for a single event (cached)
 * @category Events
 */
declare const getEvent: (params: Omit<GetEventData["path"], "siteKey">) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.Event;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a list of all pages (cached)
 * @category Pages
 */
declare const getPages: (params?: GetPagesData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetPagesResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a single page using the slug (cached)
 * @category Pages
 */
declare const getPage: (params: Omit<GetPageData["path"], "siteKey">) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetPageResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a list of all news items (cached)
 * @category News
 */
declare const getNews: (params?: GetNewsData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetNewsResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a single news item using the slug (cached)
 * @category News
 */
declare const getNewsArticle: (params: Omit<GetNewsArticleData["path"], "siteKey">) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetNewsArticleResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a list of profiles (cached)
 * @category Profiles
 */
declare const getProfiles: (params?: GetProfilesData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetProfilesResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a profile (cached)
 * @category Profiles
 */
declare const getProfile: (params: Omit<GetProfileData["path"], "siteKey">) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.Profile;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a listing of events for a profile (cached)
 * @category Profiles
 */
declare const getProfileEvents: (params: Omit<GetProfileEventsData["path"], "siteKey"> & GetProfileEventsData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetProfileEventsResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a listing of products for a profile (cached)
 * @category Profiles
 */
declare const getProfileProducts: (params: Omit<GetProfileProductsData["path"], "siteKey"> & GetProfileProductsData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetProfileProductsResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a listing of products (cached)
 * @category Products
 */
declare const getProducts: (params: GetProductsData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.GetProductsResponse;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Get a product (cached)
 * @category Products
 */
declare const getProduct: (params: Omit<GetProductData["path"], "siteKey">) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.Product;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;
/**
 * Search a site for all content types (cached)
 * @category Sites
 */
declare const searchSite: (params: SearchSiteData["query"]) => Promise<({
    data: undefined;
    error: unknown;
} | {
    data: _venuecms_sdk.SearchSiteResults;
    error: undefined;
}) & {
    request: Request;
    response: Response;
}>;

export { getEvent, getEvents, getNews, getNewsArticle, getPage, getPages, getProduct, getProducts, getProfile, getProfileEvents, getProfileProducts, getProfiles, getSite, searchSite };