Module endpoints/category

Index

Functions

Functions

Const get

get(http: AxiosInstance, params: { query?: undefined | CategoryQueryParameters }): Promise<ListResponse<Category<Record<string, any>>>>

- Defined in endpoints/category.ts:8
see

https://api.akeneo.com/api-reference.html#Category

Parameters
- http: AxiosInstance
- params: { query?: undefined | CategoryQueryParameters }
  - Optional query?: undefined | CategoryQueryParameters
Returns Promise<ListResponse<Category<Record<string, any>>>>

Const getAll

getAll(http: AxiosInstance, params: { query?: undefined | CategoryQueryParameters }): Promise<ListResponse<Category<Record<string, any>>>>

- Defined in endpoints/category.ts:38
Parameters
- http: AxiosInstance
- params: { query?: undefined | CategoryQueryParameters }
  - Optional query?: undefined | CategoryQueryParameters
Returns Promise<ListResponse<Category<Record<string, any>>>>

Const getOne

getOne(http: AxiosInstance, __namedParameters: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }): Promise<Category<Record<string, any>>>

- Defined in endpoints/category.ts:21
see

https://api.akeneo.com/api-reference.html#get_categories__code_

Parameters
- http: AxiosInstance
- __namedParameters: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }
  - code: string
  - Optional query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean }
Returns Promise<Category<Record<string, any>>>