endpoints/asset-family | akeneo-api.js

Index

Functions

Const get

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

- Defined in endpoints/asset-family.ts:14
see

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

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

Const getAll

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

- Defined in endpoints/asset-family.ts:44
Parameters
- http: AxiosInstance
- __namedParameters: { query?: undefined | AssetFamilyQueryParameters }
  - Optional query?: undefined | AssetFamilyQueryParameters
Returns Promise<ListResponse<AssetFamily>>

Const getAsset

getAsset(http: AxiosInstance, __namedParameters: { assetFamilyCode: string; code: string }): Promise<Asset>

- Defined in endpoints/asset-family.ts:67
see

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

Parameters
- http: AxiosInstance
- __namedParameters: { assetFamilyCode: string; code: string }
  - assetFamilyCode: string
  - code: string
Returns Promise<Asset>

Const getAssets

getAssets(http: AxiosInstance, __namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }): Promise<ListResponse<Asset>>

- Defined in endpoints/asset-family.ts:54
see

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

Parameters
- http: AxiosInstance
- __namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }
  - assetFamilyCode: string
  - Optional query?: undefined | AssetQueryParameters
Returns Promise<ListResponse<Asset>>

Const getAssetsAll

getAssetsAll(http: AxiosInstance, __namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }): Promise<ListResponse<Asset>>

- Defined in endpoints/asset-family.ts:83
Parameters
- http: AxiosInstance
- __namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }
  - assetFamilyCode: string
  - Optional query?: undefined | AssetQueryParameters
Returns Promise<ListResponse<Asset>>

Const getOne

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

- Defined in endpoints/asset-family.ts:27
see

https://api.akeneo.com/api-reference.html#get_asset_family__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<AssetFamily>

Index

Functions

Functions

Const get

Parameters

http: AxiosInstance

params: { query?: undefined | AssetFamilyQueryParameters }

Optional query?: undefined | AssetFamilyQueryParameters

Returns Promise<ListResponse<AssetFamily>>

Const getAll

Parameters

http: AxiosInstance

__namedParameters: { query?: undefined | AssetFamilyQueryParameters }

Optional query?: undefined | AssetFamilyQueryParameters

Returns Promise<ListResponse<AssetFamily>>

Const getAsset

Parameters

http: AxiosInstance

__namedParameters: { assetFamilyCode: string; code: string }

assetFamilyCode: string

code: string

Returns Promise<Asset>

Const getAssets

Parameters

http: AxiosInstance

__namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }

assetFamilyCode: string

Optional query?: undefined | AssetQueryParameters

Returns Promise<ListResponse<Asset>>

Const getAssetsAll

Parameters

http: AxiosInstance

__namedParameters: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }

assetFamilyCode: string

Optional query?: undefined | AssetQueryParameters

Returns Promise<ListResponse<Asset>>

Const getOne

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<AssetFamily>