ComponentsApiFp
ComponentsApi - functional programming interface
Signature
ComponentsApiFp: (
configuration?: Configuration
) => {
getComponentById(baseSiteId: string,
componentId: string,
catalogCode?: string,
categoryCode?: string,
fields?: GetComponentByIdFieldsEnum,
productCode?: string,
options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance,
basePath?: string) => AxiosPromise<ComponentAdaptedData>>;
getComponentByIdAndUser(baseSiteId: string,
componentId: string,
userId: string,
catalogCode?: string,
categoryCode?: string,
fields?: GetComponentByIdAndUserFieldsEnum,
productCode?: string,
options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance,
basePath?: string) => AxiosPromise<ComponentAdaptedData>>;
getComponentsByIds(baseSiteId: string,
catalogCode?: string,
categoryCode?: string,
componentIds?: Array<string>,
currentPage?: number,
fields?: GetComponentsByIdsFieldsEnum,
pageSize?: number,
productCode?: string,
sort?: string,
options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance,
basePath?: string) => 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance,
basePath?: string) => AxiosPromise<ListAdaptedComponents>>;
searchComponentsByIds(baseSiteId: string,
componentIDList: ComponentIDList,
catalogCode?: string,
categoryCode?: string,
currentPage?: number,
fields?: SearchComponentsByIdsFieldsEnum,
pageSize?: number,
productCode?: string,
sort?: string,
options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance,
basePath?: string) => AxiosPromise<ListAdaptedComponents>>;
}Parameters
| Name | Required | Type | Description |
|---|---|---|---|
configuration | Optional | Configuration |
Referenced Types
- GetComponentByIdFieldsEnum
AxiosRequestConfigAxiosInstanceAxiosPromise- GetComponentByIdAndUserFieldsEnum
- GetComponentsByIdsFieldsEnum
- ListAdaptedComponents
- GetComponentsByIdsAndUserFieldsEnum
- ComponentIDList
- SearchComponentsByIdsFieldsEnum