index

References

default

Functions

createClient

References

default

Renames and exports createClient

Type aliases

AkeneoClientAPI

AkeneoClientAPI: ReturnType<typeof createClient>

Asset

Asset: { code: string; values: Record<string, ValuesRecord[]> }

Type declaration

code: string
values: Record<string, ValuesRecord[]>

AssetFamily

AssetFamily: { attribute_as_main_media: string; code: string; labels: Record<string, string>; naming_convention: { abort_asset_creation_on_error: boolean; pattern: string; source: { channel: any; locale: any; property: string } }; product_link_rules: Record<string, Record<string, string>>[]; transformations: any[] }

Type declaration

attribute_as_main_media: string
code: string
labels: Record<string, string>
naming_convention: { abort_asset_creation_on_error: boolean; pattern: string; source: { channel: any; locale: any; property: string } }
- abort_asset_creation_on_error: boolean
- pattern: string
- source: { channel: any; locale: any; property: string }
  - channel: any
  - locale: any
  - property: string
product_link_rules: Record<string, Record<string, string>>[]
transformations: any[]

AssetFamilyQueryParameters

AssetFamilyQueryParameters: { search_after?: string }

Type declaration

Optional search_after?: string

AssetQueryParameters

AssetQueryParameters: { channel?: string; locales?: string; search?: string; search_after?: string }

Type declaration

Optional channel?: string
Optional locales?: string
Optional search?: string
Optional search_after?: string

Attribute

Attribute: { allowed_extensions: string[]; available_locales: string[]; code: string; date_max: string; date_min: string; decimals_allowed: boolean; default_metric_unit: string; default_value: boolean; group: string; group_labels: Record<string, string>; labels: Record<string, string>; localizable: boolean; max_characters: number; max_file_size: string; metric_family: string; negative_allowed: boolean; number_max: string; number_min: string; reference_data_name: string; scopable: boolean; sort_order: number; type: string; unique: boolean; useable_as_grid_filter: boolean; validation_regexp: string; validation_rule: string; wysiwyg_enabled: boolean }

Type declaration

allowed_extensions: string[]
available_locales: string[]
code: string
date_max: string
date_min: string
decimals_allowed: boolean
default_metric_unit: string
default_value: boolean
group: string
group_labels: Record<string, string>
labels: Record<string, string>
localizable: boolean
max_characters: number
max_file_size: string
metric_family: string
negative_allowed: boolean
number_max: string
number_min: string
reference_data_name: string
scopable: boolean
sort_order: number
type: string
unique: boolean
useable_as_grid_filter: boolean
validation_regexp: string
validation_rule: string
wysiwyg_enabled: boolean

AttributeOption

AttributeOption: { attribute: string; code: string; labels: Record<string, string>; sort_order: number }

Type declaration

attribute: string
code: string
labels: Record<string, string>
sort_order: number

AttributeOptionQueryParameters

AttributeOptionQueryParameters: { limit?: number; page?: number; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional with_count?: boolean

AttributeQueryParameters

AttributeQueryParameters: { limit?: number; page?: number; search?: string; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional search?: string
Optional with_count?: boolean

CategoryQueryParameters

CategoryQueryParameters: { limit?: number; page?: number; search?: string; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional search?: string
Optional with_count?: boolean

ClientParams

ClientParams: { axiosOptions?: AxiosRequestConfig; clientId: string; password: string; secret: string; url: string; username: string }

Type declaration

Optional axiosOptions?: AxiosRequestConfig

Optional: axiosOptions (https://github.com/axios/axios#request-config)
clientId: string

clientId of your app
password: string

password
secret: string

matching secret
url: string

API host
username: string

username

Entity

Entity: { code: string; labels: KeyValueMap }

Type declaration

code: string
labels: KeyValueMap

EntityRecord

EntityRecord: { code: string; values: Record<string, ValuesRecord[]> }

Type declaration

code: string
values: Record<string, ValuesRecord[]>

Family

Family: { attribute_as_image: string; attribute_as_label: string; attribute_requirements: Record<string, any>; attributes: string[]; code: string; labels: Record<string, any> }

Type declaration

attribute_as_image: string
attribute_as_label: string
attribute_requirements: Record<string, any>
attributes: string[]
code: string
labels: Record<string, any>

FamilyQueryParameters

FamilyQueryParameters: { limit?: number; page?: number; search?: string; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional search?: string
Optional with_count?: boolean

FamilyVariantQueryParameters

FamilyVariantQueryParameters: { limit?: number; page?: number; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional with_count?: boolean

KeyValueMap

KeyValueMap: Record<string, any>

ListResponse

ListResponse<T>: { current_page?: number; items: T[]; items_count?: number }

Type parameters

Type declaration

Optional current_page?: number
items: T[]
Optional items_count?: number

PaginationType

PaginationType: "page" | "search_after"

Product

Product: { associations: Record<string, Association>; categories: string[]; created: string; enabled: boolean; family: string; groups: string[]; identifier: string; metadata: Record<string, any>; parent: string; quantified_associations: Record<string, Association>; updated: string; uuid?: string; values: Record<string, any> }

Type declaration

associations: Record<string, Association>
categories: string[]
created: string
enabled: boolean
family: string
groups: string[]
identifier: string
metadata: Record<string, any>
parent: string
quantified_associations: Record<string, Association>
updated: string
Optional uuid?: string
values: Record<string, any>

ProductModel

ProductModel: { associations: Record<string, Association>; categories: string[]; code: string; created: string; family: string; family_variant: string; metadata: Record<string, any>; parent?: string; quantified_associations: Record<string, Association>; updated: string; values: Record<string, any> }

Type declaration

associations: Record<string, Association>
categories: string[]
code: string
created: string
family: string
family_variant: string
metadata: Record<string, any>
Optional parent?: string
quantified_associations: Record<string, Association>
updated: string
values: Record<string, any>

ProductModelQueryParameters

ProductModelQueryParameters: { attributes?: string; limit?: number; locales?: string; page?: number; pagination_type?: PaginationType; scope?: string; search?: string; search_after?: string; with_count?: boolean }

Type declaration

Optional attributes?: string
Optional limit?: number
Optional locales?: string
Optional page?: number
Optional pagination_type?: PaginationType
Optional scope?: string
Optional search?: string
Optional search_after?: string
Optional with_count?: boolean

ProductQueryParameters

ProductQueryParameters: { attributes?: string; limit?: number; locales?: string; page?: number; pagination_type?: PaginationType; scope?: string; search?: string; search_after?: string; with_attribute_options?: boolean; with_count?: boolean; with_quality_scores?: boolean }

Type declaration

Optional attributes?: string
Optional limit?: number
Optional locales?: string
Optional page?: number
Optional pagination_type?: PaginationType
Optional scope?: string
Optional search?: string
Optional search_after?: string
Optional with_attribute_options?: boolean
Optional with_count?: boolean
Optional with_quality_scores?: boolean

ReferenceEntityQueryParameters

ReferenceEntityQueryParameters: { limit?: number; page?: number; search?: string; with_count?: boolean }

Type declaration

Optional limit?: number
Optional page?: number
Optional search?: string
Optional with_count?: boolean

ReferenceEntityRecordQueryParameters

ReferenceEntityRecordQueryParameters: { search_after?: string }

Type declaration

Optional search_after?: string

Variant

Variant: { code: string; labels: Record<string, any>; variant_attribute_sets: VariantAttributeSet[] }

Type declaration

code: string
labels: Record<string, any>
variant_attribute_sets: VariantAttributeSet[]

Functions

Const createClient

createClient(params: ClientParams): { assetFamily: { get: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAll: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAsset: (params: { assetFamilyCode: string; code: string }) => Promise<Asset>; getAssets: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getAssetsAll: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<AssetFamily> }; assetMediaFile: { get: (code: string) => Promise<AxiosResponse<any>> }; attribute: { add: (__namedParameters: { attribute: any; code: string }) => Promise<AxiosResponse<any>>; addOption: (__namedParameters: { attributeCode: string; code: string; option: any }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getAll: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getOne: (params: { code: string }) => Promise<Attribute>; getOptions: (params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }) => Promise<ListResponse<AttributeOption>> }; category: { get: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getAll: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Category<Record<string, any>>> }; family: { get: (params: { query?: undefined | FamilyQueryParameters }) => Promise<ListResponse<Family>>; getVariants: (params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }) => Promise<ListResponse<Variant>> }; product: { get: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getAll: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Product> }; productModel: { get: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getAll: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getOne: (params: { code: string }) => Promise<ProductModel> }; raw: { http: AxiosInstance }; referenceEntitiesMediaFile: { get: (code: string) => Promise<any> }; referenceEntity: { add: (__namedParameters: { body: any; code: string }) => Promise<AxiosResponse<any>>; addAttribute: (__namedParameters: { attribute: any; code: string; referenceEntityCode: string }) => Promise<void>; addAttributeOption: (__namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; addRecords: (__namedParameters: { records: any[]; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | ReferenceEntityQueryParameters }) => Promise<ListResponse<Entity>>; getRecords: (params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }) => Promise<ListResponse<EntityRecord>> } }

- Defined in index.ts:42
Create a client instance

Parameters
- params: ClientParams
  Client initialization parameters
```
const client = akeneo({
  url: AKENEO_API_URL,
  username: AKENEO_USERNAME,
  password: AKENEO_PASSWORD,
  clientId: AKENEO_CLIENT_ID,
  secret: AKENEO_SECRET,
});
```
Returns { assetFamily: { get: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAll: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAsset: (params: { assetFamilyCode: string; code: string }) => Promise<Asset>; getAssets: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getAssetsAll: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<AssetFamily> }; assetMediaFile: { get: (code: string) => Promise<AxiosResponse<any>> }; attribute: { add: (__namedParameters: { attribute: any; code: string }) => Promise<AxiosResponse<any>>; addOption: (__namedParameters: { attributeCode: string; code: string; option: any }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getAll: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getOne: (params: { code: string }) => Promise<Attribute>; getOptions: (params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }) => Promise<ListResponse<AttributeOption>> }; category: { get: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getAll: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Category<Record<string, any>>> }; family: { get: (params: { query?: undefined | FamilyQueryParameters }) => Promise<ListResponse<Family>>; getVariants: (params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }) => Promise<ListResponse<Variant>> }; product: { get: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getAll: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Product> }; productModel: { get: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getAll: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getOne: (params: { code: string }) => Promise<ProductModel> }; raw: { http: AxiosInstance }; referenceEntitiesMediaFile: { get: (code: string) => Promise<any> }; referenceEntity: { add: (__namedParameters: { body: any; code: string }) => Promise<AxiosResponse<any>>; addAttribute: (__namedParameters: { attribute: any; code: string; referenceEntityCode: string }) => Promise<void>; addAttributeOption: (__namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; addRecords: (__namedParameters: { records: any[]; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | ReferenceEntityQueryParameters }) => Promise<ListResponse<Entity>>; getRecords: (params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }) => Promise<ListResponse<EntityRecord>> } }
- assetFamily: { get: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAll: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>; getAsset: (params: { assetFamilyCode: string; code: string }) => Promise<Asset>; getAssets: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getAssetsAll: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<AssetFamily> }
  - get: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>
    - - (params: { query?: undefined | AssetFamilyQueryParameters }): Promise<ListResponse<AssetFamily>>
      - Parameters
        
        params: { query?: undefined | AssetFamilyQueryParameters }
        
        Optional query?: undefined | AssetFamilyQueryParameters
        
        Returns Promise<ListResponse<AssetFamily>>
  - getAll: (params: { query?: undefined | AssetFamilyQueryParameters }) => Promise<ListResponse<AssetFamily>>
    - - (params: { query?: undefined | AssetFamilyQueryParameters }): Promise<ListResponse<AssetFamily>>
      - Parameters
        
        params: { query?: undefined | AssetFamilyQueryParameters }
        
        Optional query?: undefined | AssetFamilyQueryParameters
        
        Returns Promise<ListResponse<AssetFamily>>
  - getAsset: (params: { assetFamilyCode: string; code: string }) => Promise<Asset>
    - - (params: { assetFamilyCode: string; code: string }): Promise<Asset>
      - Parameters
        
        params: { assetFamilyCode: string; code: string }
        
        assetFamilyCode: string
        
        code: string
        
        Returns Promise<Asset>
  - getAssets: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>
    - - (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }): Promise<ListResponse<Asset>>
      - Parameters
        
        params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }
        
        assetFamilyCode: string
        
        Optional query?: undefined | AssetQueryParameters
        
        Returns Promise<ListResponse<Asset>>
  - getAssetsAll: (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }) => Promise<ListResponse<Asset>>
    - - (params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }): Promise<ListResponse<Asset>>
      - Parameters
        
        params: { assetFamilyCode: string; query?: undefined | AssetQueryParameters }
        
        assetFamilyCode: string
        
        Optional query?: undefined | AssetQueryParameters
        
        Returns Promise<ListResponse<Asset>>
  - getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<AssetFamily>
    - - (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }): Promise<AssetFamily>
      - Parameters
        
        params: { 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>
- assetMediaFile: { get: (code: string) => Promise<AxiosResponse<any>> }
  - get: (code: string) => Promise<AxiosResponse<any>>
    - - (code: string): Promise<AxiosResponse<any>>
      - see
        
        https://api.akeneo.com/api-reference.html#get_asset_media_files__code
        
        Parameters
        
        code: string
        
        Returns Promise<AxiosResponse<any>>
- attribute: { add: (__namedParameters: { attribute: any; code: string }) => Promise<AxiosResponse<any>>; addOption: (__namedParameters: { attributeCode: string; code: string; option: any }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getAll: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>; getOne: (params: { code: string }) => Promise<Attribute>; getOptions: (params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }) => Promise<ListResponse<AttributeOption>> }
  - add: (__namedParameters: { attribute: any; code: string }) => Promise<AxiosResponse<any>>
    - - (__namedParameters: { attribute: any; code: string }): Promise<AxiosResponse<any>>
      - Parameters
        
        __namedParameters: { attribute: any; code: string }
        
        attribute: any
        
        code: string
        
        Returns Promise<AxiosResponse<any>>
  - addOption: (__namedParameters: { attributeCode: string; code: string; option: any }) => Promise<AxiosResponse<any>>
    - - (__namedParameters: { attributeCode: string; code: string; option: any }): Promise<AxiosResponse<any>>
      - Parameters
        
        __namedParameters: { attributeCode: string; code: string; option: any }
        
        attributeCode: string
        
        code: string
        
        option: any
        
        Returns Promise<AxiosResponse<any>>
  - get: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>
    - - (params: { query?: undefined | AttributeQueryParameters }): Promise<ListResponse<Attribute>>
      - Parameters
        
        params: { query?: undefined | AttributeQueryParameters }
        
        Optional query?: undefined | AttributeQueryParameters
        
        Returns Promise<ListResponse<Attribute>>
  - getAll: (params: { query?: undefined | AttributeQueryParameters }) => Promise<ListResponse<Attribute>>
    - - (params: { query?: undefined | AttributeQueryParameters }): Promise<ListResponse<Attribute>>
      - Parameters
        
        params: { query?: undefined | AttributeQueryParameters }
        
        Optional query?: undefined | AttributeQueryParameters
        
        Returns Promise<ListResponse<Attribute>>
  - getOne: (params: { code: string }) => Promise<Attribute>
    - - (params: { code: string }): Promise<Attribute>
      - Parameters
        
        params: { code: string }
        
        code: string
        
        Returns Promise<Attribute>
  - getOptions: (params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }) => Promise<ListResponse<AttributeOption>>
    - - (params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }): Promise<ListResponse<AttributeOption>>
      - Parameters
        
        params: { attributeCode: string; query?: undefined | AttributeOptionQueryParameters }
        
        attributeCode: string
        
        Optional query?: undefined | AttributeOptionQueryParameters
        
        Returns Promise<ListResponse<AttributeOption>>
- category: { get: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getAll: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Category<Record<string, any>>> }
  - get: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>
    - - (params: { query?: undefined | CategoryQueryParameters }): Promise<ListResponse<Category<Record<string, any>>>>
      - Parameters
        
        params: { query?: undefined | CategoryQueryParameters }
        
        Optional query?: undefined | CategoryQueryParameters
        
        Returns Promise<ListResponse<Category<Record<string, any>>>>
  - getAll: (params: { query?: undefined | CategoryQueryParameters }) => Promise<ListResponse<Category<Record<string, any>>>>
    - - (params: { query?: undefined | CategoryQueryParameters }): Promise<ListResponse<Category<Record<string, any>>>>
      - Parameters
        
        params: { query?: undefined | CategoryQueryParameters }
        
        Optional query?: undefined | CategoryQueryParameters
        
        Returns Promise<ListResponse<Category<Record<string, any>>>>
  - getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Category<Record<string, any>>>
    - - (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }): Promise<Category<Record<string, any>>>
      - Parameters
        
        params: { 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>>>
- family: { get: (params: { query?: undefined | FamilyQueryParameters }) => Promise<ListResponse<Family>>; getVariants: (params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }) => Promise<ListResponse<Variant>> }
  - get: (params: { query?: undefined | FamilyQueryParameters }) => Promise<ListResponse<Family>>
    - - (params: { query?: undefined | FamilyQueryParameters }): Promise<ListResponse<Family>>
      - Parameters
        
        params: { query?: undefined | FamilyQueryParameters }
        
        Optional query?: undefined | FamilyQueryParameters
        
        Returns Promise<ListResponse<Family>>
  - getVariants: (params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }) => Promise<ListResponse<Variant>>
    - - (params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }): Promise<ListResponse<Variant>>
      - Parameters
        
        params: { familyCode: string; query?: undefined | FamilyVariantQueryParameters }
        
        familyCode: string
        
        Optional query?: undefined | FamilyVariantQueryParameters
        
        Returns Promise<ListResponse<Variant>>
- product: { get: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getAll: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>; getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Product> }
  - get: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>
    - - (params: { query?: undefined | ProductQueryParameters }): Promise<ListResponse<Product>>
      - Parameters
        
        params: { query?: undefined | ProductQueryParameters }
        
        Optional query?: undefined | ProductQueryParameters
        
        Returns Promise<ListResponse<Product>>
  - getAll: (params: { query?: undefined | ProductQueryParameters }) => Promise<ListResponse<Product>>
    - - (params: { query?: undefined | ProductQueryParameters }): Promise<ListResponse<Product>>
      - Parameters
        
        params: { query?: undefined | ProductQueryParameters }
        
        Optional query?: undefined | ProductQueryParameters
        
        Returns Promise<ListResponse<Product>>
  - getOne: (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }) => Promise<Product>
    - - (params: { code: string; query?: undefined | { with_attribute_options?: undefined | boolean; with_quality_scores?: undefined | boolean } }): Promise<Product>
      - Parameters
        
        params: { 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<Product>
- productModel: { get: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getAll: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>; getOne: (params: { code: string }) => Promise<ProductModel> }
  - get: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>
    - - (params: { query?: undefined | ProductModelQueryParameters }): Promise<ListResponse<ProductModel>>
      - Parameters
        
        params: { query?: undefined | ProductModelQueryParameters }
        
        Optional query?: undefined | ProductModelQueryParameters
        
        Returns Promise<ListResponse<ProductModel>>
  - getAll: (params: { query?: undefined | ProductModelQueryParameters }) => Promise<ListResponse<ProductModel>>
    - - (params: { query?: undefined | ProductModelQueryParameters }): Promise<ListResponse<ProductModel>>
      - Parameters
        
        params: { query?: undefined | ProductModelQueryParameters }
        
        Optional query?: undefined | ProductModelQueryParameters
        
        Returns Promise<ListResponse<ProductModel>>
  - getOne: (params: { code: string }) => Promise<ProductModel>
    - - (params: { code: string }): Promise<ProductModel>
      - Parameters
        
        params: { code: string }
        
        code: string
        
        Returns Promise<ProductModel>
- raw: { http: AxiosInstance }
  - http: AxiosInstance
- referenceEntitiesMediaFile: { get: (code: string) => Promise<any> }
  - get: (code: string) => Promise<any>
    - - (code: string): Promise<any>
      - see
        
        https://api.akeneo.com/api-reference.html#get_reference_entity_media_files__code
        
        Parameters
        
        code: string
        
        Returns Promise<any>
- referenceEntity: { add: (__namedParameters: { body: any; code: string }) => Promise<AxiosResponse<any>>; addAttribute: (__namedParameters: { attribute: any; code: string; referenceEntityCode: string }) => Promise<void>; addAttributeOption: (__namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; addRecords: (__namedParameters: { records: any[]; referenceEntityCode: string }) => Promise<AxiosResponse<any>>; get: (params: { query?: undefined | ReferenceEntityQueryParameters }) => Promise<ListResponse<Entity>>; getRecords: (params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }) => Promise<ListResponse<EntityRecord>> }
  - add: (__namedParameters: { body: any; code: string }) => Promise<AxiosResponse<any>>
    - - (__namedParameters: { body: any; code: string }): Promise<AxiosResponse<any>>
      - see
        
        https://api.akeneo.com/api-reference.html#patch_reference_entity__code_
        
        Parameters
        
        __namedParameters: { body: any; code: string }
        
        body: any
        
        code: string
        
        Returns Promise<AxiosResponse<any>>
  - addAttribute: (__namedParameters: { attribute: any; code: string; referenceEntityCode: string }) => Promise<void>
    - - (__namedParameters: { attribute: any; code: string; referenceEntityCode: string }): Promise<void>
      - see
        
        https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__code_
        
        Parameters
        
        __namedParameters: { attribute: any; code: string; referenceEntityCode: string }
        
        attribute: any
        
        code: string
        
        referenceEntityCode: string
        
        Returns Promise<void>
  - addAttributeOption: (__namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }) => Promise<AxiosResponse<any>>
    - - (__namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }): Promise<AxiosResponse<any>>
      - see
        
        https://api.akeneo.com/api-reference.html#patch_reference_entity_attributes__attribute_code__options__code_
        
        Parameters
        
        __namedParameters: { attributeCode: string; code: string; option: any; referenceEntityCode: string }
        
        attributeCode: string
        
        code: string
        
        option: any
        
        referenceEntityCode: string
        
        Returns Promise<AxiosResponse<any>>
  - addRecords: (__namedParameters: { records: any[]; referenceEntityCode: string }) => Promise<AxiosResponse<any>>
    - - (__namedParameters: { records: any[]; referenceEntityCode: string }): Promise<AxiosResponse<any>>
      - see
        
        https://api.akeneo.com/api-reference.html#patch_reference_entity_records
        
        Parameters
        
        __namedParameters: { records: any[]; referenceEntityCode: string }
        
        records: any[]
        
        referenceEntityCode: string
        
        Returns Promise<AxiosResponse<any>>
  - get: (params: { query?: undefined | ReferenceEntityQueryParameters }) => Promise<ListResponse<Entity>>
    - - (params: { query?: undefined | ReferenceEntityQueryParameters }): Promise<ListResponse<Entity>>
      - Parameters
        
        params: { query?: undefined | ReferenceEntityQueryParameters }
        
        Optional query?: undefined | ReferenceEntityQueryParameters
        
        Returns Promise<ListResponse<Entity>>
  - getRecords: (params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }) => Promise<ListResponse<EntityRecord>>
    - - (params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }): Promise<ListResponse<EntityRecord>>
      - Parameters
        
        params: { query?: undefined | ReferenceEntityRecordQueryParameters; referenceEntityCode: string }
        
        Optional query?: undefined | ReferenceEntityRecordQueryParameters
        
        referenceEntityCode: string
        
        Returns Promise<ListResponse<EntityRecord>>

Index

References

Type aliases

Functions

References

default

Type aliases

AkeneoClientAPI

Asset

Type declaration

code: string

values: Record<string, ValuesRecord[]>

AssetFamily

Type declaration

attribute_as_main_media: string

code: string

labels: Record<string, string>

naming_convention: { abort_asset_creation_on_error: boolean; pattern: string; source: { channel: any; locale: any; property: string } }

abort_asset_creation_on_error: boolean

pattern: string

source: { channel: any; locale: any; property: string }

channel: any

locale: any

property: string

product_link_rules: Record<string, Record<string, string>>[]

transformations: any[]

AssetFamilyQueryParameters

Type declaration

Optional search_after?: string

AssetQueryParameters

Type declaration

Optional channel?: string

Optional locales?: string

Optional search?: string

Optional search_after?: string

Attribute

Type declaration

allowed_extensions: string[]

available_locales: string[]

code: string

date_max: string

date_min: string

decimals_allowed: boolean

default_metric_unit: string

default_value: boolean

group: string

group_labels: Record<string, string>

labels: Record<string, string>

localizable: boolean

max_characters: number

max_file_size: string

metric_family: string

negative_allowed: boolean

number_max: string

number_min: string

reference_data_name: string

scopable: boolean

sort_order: number

type: string

unique: boolean

useable_as_grid_filter: boolean

validation_regexp: string

validation_rule: string

wysiwyg_enabled: boolean

AttributeOption

Type declaration

attribute: string

code: string

labels: Record<string, string>

sort_order: number

AttributeOptionQueryParameters

Type declaration

Optional limit?: number

Optional page?: number

Optional with_count?: boolean

AttributeQueryParameters

Type declaration

Optional limit?: number

Optional page?: number

Optional search?: string