Module endpoints/attribute

Index

Functions

Functions

Const get

get(http: AxiosInstance, params: { query?: undefined | AttributeQueryParameters }): Promise<ListResponse<Attribute>>

- Defined in endpoints/attribute.ts:15
see

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

Parameters
- http: AxiosInstance
- params: { query?: undefined | AttributeQueryParameters }
  - Optional query?: undefined | AttributeQueryParameters
Returns Promise<ListResponse<Attribute>>

Const getAll

getAll(http: AxiosInstance, __namedParameters: { query?: undefined | AttributeQueryParameters }): Promise<ListResponse<Attribute>>

- Defined in endpoints/attribute.ts:37
Parameters
- http: AxiosInstance
- __namedParameters: { query?: undefined | AttributeQueryParameters }
  - Optional query?: undefined | AttributeQueryParameters
Returns Promise<ListResponse<Attribute>>

Const getOne

getOne(http: AxiosInstance, __namedParameters: { code: string }): Promise<Attribute>

- Defined in endpoints/attribute.ts:28
see

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

Parameters
- http: AxiosInstance
- __namedParameters: { code: string }
  - code: string
Returns Promise<Attribute>

Const getOptions

getOptions(http: AxiosInstance, __namedParameters: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }): Promise<ListResponse<AttributeOption>>

- Defined in endpoints/attribute.ts:48
see

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

Parameters
- http: AxiosInstance
- __namedParameters: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }
  - attributeCode: string
  - Optional query?: undefined | AttributeOptionQueryParameters
Returns Promise<ListResponse<AttributeOption>>