Alokai

PagesApiFactory

PagesApi - factory interface

Signature

PagesApiFactory: (
	configuration?: Configuration,
	basePath?: string,
	axios?: AxiosInstance
) => {
    getAllPages(baseSiteId: string,
	currentPage?: number,
	fields?: GetAllPagesFieldsEnum,
	pageSize?: number,
	pageType?: GetAllPagesPageTypeEnum,
	sort?: string,
	options?: any): AxiosPromise<ListAdaptedPages>;
    getAllPagesWithUser(baseSiteId: string,
	userId: string,
	currentPage?: number,
	fields?: GetAllPagesWithUserFieldsEnum,
	pageSize?: number,
	pageType?: GetAllPagesWithUserPageTypeEnum,
	sort?: string,
	options?: any): AxiosPromise<ListAdaptedPages>;
    getPage(baseSiteId: string,
	code?: string,
	fields?: GetPageFieldsEnum,
	pageLabelOrId?: string,
	pageType?: GetPagePageTypeEnum,
	options?: any): AxiosPromise<PageAdaptedData>;
    getPageById(baseSiteId: string,
	pageId: string,
	fields?: GetPageByIdFieldsEnum,
	options?: any): AxiosPromise<PageAdaptedData>;
    getPageByIdAndUser(baseSiteId: string,
	pageId: string,
	userId: string,
	fields?: GetPageByIdAndUserFieldsEnum,
	options?: any): AxiosPromise<PageAdaptedData>;
    getPageWithUser(baseSiteId: string,
	userId: string,
	code?: string,
	fields?: GetPageWithUserFieldsEnum,
	pageLabelOrId?: string,
	pageType?: GetPageWithUserPageTypeEnum,
	options?: any): AxiosPromise<PageAdaptedData>;
}

Parameters

NameRequiredTypeDescription
configurationOptionalConfiguration
basePathOptionalstring
axiosOptionalAxiosInstance

Referenced Types

On this page