Alokai

ComponentsApiAxiosParamCreator

ComponentsApi - axios parameter creator

Signature

ComponentsApiAxiosParamCreator: (
	configuration?: Configuration
) => {
    getComponentById: (baseSiteId: string,
	componentId: string,
	catalogCode?: string,
	categoryCode?: string,
	fields?: GetComponentByIdFieldsEnum,
	productCode?: string,
	options?: AxiosRequestConfig) => Promise<RequestArgs>;
    getComponentByIdAndUser: (baseSiteId: string,
	componentId: string,
	userId: string,
	catalogCode?: string,
	categoryCode?: string,
	fields?: GetComponentByIdAndUserFieldsEnum,
	productCode?: string,
	options?: AxiosRequestConfig) => Promise<RequestArgs>;
    getComponentsByIds: (baseSiteId: string,
	catalogCode?: string,
	categoryCode?: string,
	componentIds?: Array<string>,
	currentPage?: number,
	fields?: GetComponentsByIdsFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: AxiosRequestConfig) => Promise<RequestArgs>;
    getComponentsByIdsAndUser: (baseSiteId: string,
	userId: string,
	catalogCode?: string,
	categoryCode?: string,
	componentIds?: Array<string>,
	currentPage?: number,
	fields?: GetComponentsByIdsAndUserFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: AxiosRequestConfig) => Promise<RequestArgs>;
    searchComponentsByIds: (baseSiteId: string,
	componentIDList: ComponentIDList,
	catalogCode?: string,
	categoryCode?: string,
	currentPage?: number,
	fields?: SearchComponentsByIdsFieldsEnum,
	pageSize?: number,
	productCode?: string,
	sort?: string,
	options?: AxiosRequestConfig) => Promise<RequestArgs>;
}

Parameters

NameRequiredTypeDescription
configurationOptionalConfiguration

Referenced Types

On this page