Alokai

ComponentsApiFactory

ComponentsApi - factory interface

Signature

ComponentsApiFactory: (
	configuration?: Configuration,
	basePath?: string,
	axios?: AxiosInstance
) => {
    getComponentById(baseSiteId: string,
	componentId: string,
	catalogCode?: string,
	categoryCode?: string,
	fields?: GetComponentByIdFieldsEnum,
	productCode?: string,
	options?: any): AxiosPromise<ComponentAdaptedData>;
    getComponentByIdAndUser(baseSiteId: string,
	componentId: string,
	userId: string,
	catalogCode?: string,
	categoryCode?: string,
	fields?: GetComponentByIdAndUserFieldsEnum,
	productCode?: string,
	options?: any): AxiosPromise<ComponentAdaptedData>;
    getComponentsByIds(baseSiteId: string,
	catalogCode?: string,
	categoryCode?: string,
	componentIds?: Array<string>,
	currentPage?: number,
	fields?: GetComponentsByIdsFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: any): AxiosPromise<ListAdaptedComponents>;
    getComponentsByIdsAndUser(baseSiteId: string,
	userId: string,
	catalogCode?: string,
	categoryCode?: string,
	componentIds?: Array<string>,
	currentPage?: number,
	fields?: GetComponentsByIdsAndUserFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: any): AxiosPromise<ListAdaptedComponents>;
    searchComponentsByIds(baseSiteId: string,
	componentIDList: ComponentIDList,
	catalogCode?: string,
	categoryCode?: string,
	currentPage?: number,
	fields?: SearchComponentsByIdsFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: any): AxiosPromise<ListAdaptedComponents>;
}

Parameters

NameRequiredTypeDescription
configurationOptionalConfiguration
basePathOptionalstring
axiosOptionalAxiosInstance

Referenced Types

On this page