liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
48 lines (47 loc) • 4.17 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetSiteDisplayPageTemplateData, GetSiteDisplayPageTemplateResponses, GetSiteDisplayPageTemplatesPageData, GetSiteDisplayPageTemplatesPageResponses, PostSitePageDefinitionPreviewData, PostSitePageDefinitionPreviewResponses, DeleteStructuredContentByVersionData, DeleteStructuredContentByVersionResponses, GetStructuredContentByVersionData, GetStructuredContentByVersionResponses, GetSiteStructuredContentsPageData, GetSiteStructuredContentsPageResponses, GetStructuredContentsVersionsPageData, GetStructuredContentsVersionsPageResponses, PostSiteStructuredContentDraftData, PostSiteStructuredContentDraftResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
/**
* Retrieves a display page template of a site
*/
export declare const getSiteDisplayPageTemplate: <ThrowOnError extends boolean = false>(options: Options<GetSiteDisplayPageTemplateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteDisplayPageTemplateResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the display page templates of a site
*/
export declare const getSiteDisplayPageTemplatesPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteDisplayPageTemplatesPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteDisplayPageTemplatesPageResponses, unknown, ThrowOnError, "fields">;
/**
* Renders and retrieves HTML for the page definition using the theme of specified site.
*/
export declare const postSitePageDefinitionPreview: <ThrowOnError extends boolean = false>(options: Options<PostSitePageDefinitionPreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSitePageDefinitionPreviewResponses, unknown, ThrowOnError, "fields">;
/**
* Deletes a version of a structured content via its ID.
*/
export declare const deleteStructuredContentByVersion: <ThrowOnError extends boolean = false>(options: Options<DeleteStructuredContentByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<DeleteStructuredContentByVersionResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves a version of a structured content
*/
export declare const getStructuredContentByVersion: <ThrowOnError extends boolean = false>(options: Options<GetStructuredContentByVersionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetStructuredContentByVersionResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves the site's structured contents latest version. Results can be paginated, filtered, searched, flattened, and sorted.
*/
export declare const getSiteStructuredContentsPage: <ThrowOnError extends boolean = false>(options: Options<GetSiteStructuredContentsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSiteStructuredContentsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Retrieves all versions of a structured content via its ID.
*/
export declare const getStructuredContentsVersionsPage: <ThrowOnError extends boolean = false>(options: Options<GetStructuredContentsVersionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetStructuredContentsVersionsPageResponses, unknown, ThrowOnError, "fields">;
/**
* Creates a draft of a structured content
*/
export declare const postSiteStructuredContentDraft: <ThrowOnError extends boolean = false>(options: Options<PostSiteStructuredContentDraftData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSiteStructuredContentDraftResponses, unknown, ThrowOnError, "fields">;