Skip to main content

akeneo

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen

Requirements.

Python 3.11+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/labd/akeneo-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/labd/akeneo-python-sdk.git)

Then import the package:

import akeneo

Development

The project uses uv:

uv sync
uv run pytest

The client is generated with make generate (openapi-generator python-nextgen 6.4.0); packaging lives in pyproject.toml and is not touched by the generator.

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function

import time
import akeneo
from akeneo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://demo.akeneo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = akeneo.Configuration(
    host = "http://demo.akeneo.com"
)



# Enter a context with an instance of the API client
with akeneo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = akeneo.AssetApi(api_client)
    asset_family_code = 'asset_family_code_example' # str | Code of the asset family
    code = 'code_example' # str | Code of the resource

    try:
        # Delete an asset
        api_instance.delete_assets_code(asset_family_code, code)
    except ApiException as e:
        print("Exception when calling AssetApi->delete_assets_code: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://demo.akeneo.com

Class Method HTTP request Description
AssetApi delete_assets_code DELETE /api/rest/v1/asset-families/{asset_family_code}/assets/{code} Delete an asset
AssetApi get_assets GET /api/rest/v1/asset-families/{asset_family_code}/assets Get the list of the assets of a given asset family
AssetApi get_assets_code GET /api/rest/v1/asset-families/{asset_family_code}/assets/{code} Get an asset of a given asset family
AssetApi patch_asset_code PATCH /api/rest/v1/asset-families/{asset_family_code}/assets/{code} Update/create an asset
AssetApi patch_assets PATCH /api/rest/v1/asset-families/{asset_family_code}/assets Update/create several assets
AssetAttributeApi get_asset_families_code_attributes GET /api/rest/v1/asset-families/{asset_family_code}/attributes Get the list of attributes of a given asset family
AssetAttributeApi get_asset_family_attributes_code GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{code} Get an attribute of a given asset family
AssetAttributeApi patch_asset_family_attributes_code PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{code} Update/create an attribute of a given asset family
AssetAttributeOptionApi get_asset_attributes_attribute_code_options_code GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code} Get an attribute option for a given attribute of a given asset family
AssetAttributeOptionApi get_asset_family_attributes_attribute_code_options GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options Get a list of attribute options of a given attribute for a given asset family
AssetAttributeOptionApi patch_asset_attributes_attribute_code_options_code PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code} Update/create an asset attribute option for a given asset family
AssetFamilyApi get_asset_families GET /api/rest/v1/asset-families Get list of asset families
AssetFamilyApi get_asset_family_code GET /api/rest/v1/asset-families/{code} Get an asset family
AssetFamilyApi patch_asset_family_code PATCH /api/rest/v1/asset-families/{code} Update/create an asset family
AssetMediaFileApi get_asset_media_files_code GET /api/rest/v1/asset-media-files/{code} Download the media file associated to an asset
AssetMediaFileApi post_asset_media_files POST /api/rest/v1/asset-media-files Create a new media file for an asset
AssociationTypeApi association_types_get GET /api/rest/v1/association-types/{code} Get an association type
AssociationTypeApi association_types_get_list GET /api/rest/v1/association-types Get a list of association types
AssociationTypeApi association_types_patch PATCH /api/rest/v1/association-types/{code} Update/create an association type
AssociationTypeApi association_types_post POST /api/rest/v1/association-types Create a new association type
AssociationTypeApi several_association_types_patch PATCH /api/rest/v1/association-types Update/create several association types
AttributeApi get_attributes GET /api/rest/v1/attributes Get list of attributes
AttributeApi get_attributes_code GET /api/rest/v1/attributes/{code} Get an attribute
AttributeApi patch_attributes PATCH /api/rest/v1/attributes Update/create several attributes
AttributeApi patch_attributes_code PATCH /api/rest/v1/attributes/{code} Update/create an attribute
AttributeApi post_attributes POST /api/rest/v1/attributes Create a new attribute
AttributeGroupApi attribute_groups_get GET /api/rest/v1/attribute-groups/{code} Get an attribute group
AttributeGroupApi attribute_groups_get_list GET /api/rest/v1/attribute-groups Get list of attribute groups
AttributeGroupApi attribute_groups_patch PATCH /api/rest/v1/attribute-groups/{code} Update/create an attribute group
AttributeGroupApi attribute_groups_post POST /api/rest/v1/attribute-groups Create a new attribute group
AttributeGroupApi several_attribute_groups_patch PATCH /api/rest/v1/attribute-groups Update/create several attribute groups
AttributeOptionApi get_attributes_attribute_code_options GET /api/rest/v1/attributes/{attribute_code}/options Get list of attribute options
AttributeOptionApi get_attributes_attribute_code_options_code GET /api/rest/v1/attributes/{attribute_code}/options/{code} Get an attribute option
AttributeOptionApi patch_attributes_attribute_code_options PATCH /api/rest/v1/attributes/{attribute_code}/options Update/create several attribute options
AttributeOptionApi patch_attributes_attribute_code_options_code PATCH /api/rest/v1/attributes/{attribute_code}/options/{code} Update/create an attribute option
AttributeOptionApi post_attributes_attribute_code_options POST /api/rest/v1/attributes/{attribute_code}/options Create a new attribute option
AuthenticationApi post_token POST /api/oauth/v1/token Get authentication token
CatalogProductsApi get_app_catalog_product_uuids GET /api/rest/v1/catalogs/{id}/product-uuids Get the list of product uuids
CatalogProductsApi get_app_catalog_products GET /api/rest/v1/catalogs/{id}/products Get the list of products related to a catalog
CatalogProductsApi get_app_catalog_products_uuid GET /api/rest/v1/catalogs/{id}/products/{uuid} Get a product related to a catalog
CatalogsApi delete_app_catalog DELETE /api/rest/v1/catalogs/{id} Delete a catalog
CatalogsApi get_app_catalog GET /api/rest/v1/catalogs/{id} Get a catalog
CatalogsApi get_app_catalogs GET /api/rest/v1/catalogs Get the list of owned catalogs
CatalogsApi patch_app_catalog PATCH /api/rest/v1/catalogs/{id} Update a catalog
CatalogsApi post_app_catalog POST /api/rest/v1/catalogs Create a new catalog
CategoryApi get_categories GET /api/rest/v1/categories Get list of categories
CategoryApi get_categories_code GET /api/rest/v1/categories/{code} Get a category
CategoryApi get_category_media_files_code_download GET /api/rest/v1/category-media-files/{code}/download Download a category media file [COMING SOON]
CategoryApi patch_categories PATCH /api/rest/v1/categories Update/create several categories
CategoryApi patch_categories_code PATCH /api/rest/v1/categories/{code} Update/create a category
CategoryApi post_categories POST /api/rest/v1/categories Create a new category
ChannelApi channels_patch PATCH /api/rest/v1/channels/{code} Update/create a channel
ChannelApi channels_post POST /api/rest/v1/channels Create a new channel
ChannelApi get_channels GET /api/rest/v1/channels Get a list of channels
ChannelApi get_channels_code GET /api/rest/v1/channels/{code} Get a channel
ChannelApi several_channels_patch PATCH /api/rest/v1/channels Update/create several channels
CurrencyApi currencies_get GET /api/rest/v1/currencies/{code} Get a currency
CurrencyApi currencies_get_list GET /api/rest/v1/currencies Get a list of currencies
FamilyApi get_families GET /api/rest/v1/families Get list of families
FamilyApi get_families_code GET /api/rest/v1/families/{code} Get a family
FamilyApi patch_families PATCH /api/rest/v1/families Update/create several families
FamilyApi patch_families_code PATCH /api/rest/v1/families/{code} Update/create a family
FamilyApi post_families POST /api/rest/v1/families Create a new family
FamilyApi post_families_family_code_variants POST /api/rest/v1/families/{family_code}/variants Create a new family variant
FamilyVariantApi get_families_family_code_variants GET /api/rest/v1/families/{family_code}/variants Get list of family variants
FamilyVariantApi get_families_family_code_variants_code GET /api/rest/v1/families/{family_code}/variants/{code} Get a family variant
FamilyVariantApi patch_families_family_code_variants PATCH /api/rest/v1/families/{family_code}/variants Update/create several family variants
FamilyVariantApi patch_families_family_code_variants_code PATCH /api/rest/v1/families/{family_code}/variants/{code} Update/create a family variant
LocaleApi get_locales GET /api/rest/v1/locales Get a list of locales
LocaleApi get_locales_code GET /api/rest/v1/locales/{code} Get a locale
MeasureFamilyApi measure_families_get GET /api/rest/v1/measure-families/{code} Get a measure family
MeasureFamilyApi measure_families_get_list GET /api/rest/v1/measure-families Get list of measure familiy
MeasurementFamilyApi measurement_families_get_list GET /api/rest/v1/measurement-families Get list of measurement families
MeasurementFamilyApi patch_measurement_families PATCH /api/rest/v1/measurement-families Update/create several measurement families
OverviewApi get_endpoints GET /api/rest/v1 Get list of all endpoints
PAMAssetApi get_pam_assets GET /api/rest/v1/assets Get list of PAM assets
PAMAssetApi get_pam_assets_code GET /api/rest/v1/assets/{code} Get a PAM asset
PAMAssetApi patch_pam_assets PATCH /api/rest/v1/assets Update/create several PAM assets
PAMAssetApi patch_pam_assets_code PATCH /api/rest/v1/assets/{code} Update/create a PAM asset
PAMAssetApi post_pam_assets POST /api/rest/v1/assets Create a new PAM asset
PAMAssetCategoryApi get_asset_categories GET /api/rest/v1/asset-categories Get list of PAM asset categories
PAMAssetCategoryApi get_asset_categories_code GET /api/rest/v1/asset-categories/{code} Get a PAM asset category
PAMAssetCategoryApi patch_asset_categories PATCH /api/rest/v1/asset-categories Update/create several PAM asset categories
PAMAssetCategoryApi patch_asset_categories_code PATCH /api/rest/v1/asset-categories/{code} Update/create a PAM asset category
PAMAssetCategoryApi post_asset_categories POST /api/rest/v1/asset-categories Create a new PAM asset category
PAMAssetReferenceFileApi get_reference_files_channel_code_locale_code_download GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download Download a reference file
PAMAssetReferenceFileApi get_reference_files_locale_code GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code} Get a reference file
PAMAssetReferenceFileApi post_reference_files_locale_code POST /api/rest/v1/assets/{asset_code}/reference-files/{locale_code} Upload a new reference file
PAMAssetTagApi get_asset_tags GET /api/rest/v1/asset-tags Get list of PAM asset tags
PAMAssetTagApi get_asset_tags_code GET /api/rest/v1/asset-tags/{code} Get a PAM asset tag
PAMAssetTagApi patch_asset_tags_code PATCH /api/rest/v1/asset-tags/{code} Update/create a PAM asset tag
PAMAssetVariationFileApi get_variation_files_channel_code_locale_code GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code} Get a variation file
PAMAssetVariationFileApi get_variation_files_channel_code_locale_code_download GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download Download a variation file
PAMAssetVariationFileApi post_variation_files_channel_code_locale_code POST /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code} Upload a new variation file
ProductIdentifierApi delete_products_code DELETE /api/rest/v1/products/{code} Delete a product
ProductIdentifierApi get_draft_code GET /api/rest/v1/products/{code}/draft Get a draft
ProductIdentifierApi get_products GET /api/rest/v1/products Get list of products
ProductIdentifierApi get_products_code GET /api/rest/v1/products/{code} Get a product
ProductIdentifierApi patch_products PATCH /api/rest/v1/products Update/create several products
ProductIdentifierApi patch_products_code PATCH /api/rest/v1/products/{code} Update/create a product
ProductIdentifierApi post_products POST /api/rest/v1/products Create a new product
ProductIdentifierApi post_proposal POST /api/rest/v1/products/{code}/proposal Submit a draft for approval
ProductUuidApi delete_products_uuid_uuid DELETE /api/rest/v1/products-uuid/{uuid} Delete a product
ProductUuidApi get_draft_uuid_uuid GET /api/rest/v1/products-uuid/{uuid}/draft Get a draft
ProductUuidApi get_products_uuid GET /api/rest/v1/products-uuid Get list of products
ProductUuidApi get_products_uuid_uuid GET /api/rest/v1/products-uuid/{uuid} Get a product
ProductUuidApi patch_products_uuid PATCH /api/rest/v1/products-uuid Update/create several products
ProductUuidApi patch_products_uuid_uuid PATCH /api/rest/v1/products-uuid/{uuid} Update/create a product
ProductUuidApi post_products_uuid POST /api/rest/v1/products-uuid Create a new product
ProductUuidApi post_proposal_uuid POST /api/rest/v1/products-uuid/{uuid}/proposal Submit a draft for approval
ProductMediaFileApi get_media_files GET /api/rest/v1/media-files Get a list of product media files
ProductMediaFileApi get_media_files_code GET /api/rest/v1/media-files/{code} Get a product media file
ProductMediaFileApi get_media_files_code_download GET /api/rest/v1/media-files/{code}/download Download a product media file
ProductMediaFileApi post_media_files POST /api/rest/v1/media-files Create a new product media file
ProductModelApi delete_product_models_code DELETE /api/rest/v1/product-models/{code} Delete a product model
ProductModelApi get_product_model_draft_code GET /api/rest/v1/product-models/{code}/draft Get a draft
ProductModelApi get_product_models GET /api/rest/v1/product-models Get list of product models
ProductModelApi get_product_models_code GET /api/rest/v1/product-models/{code} Get a product model
ProductModelApi patch_product_models PATCH /api/rest/v1/product-models Update/create several product models
ProductModelApi patch_product_models_code PATCH /api/rest/v1/product-models/{code} Update/create a product model
ProductModelApi post_product_model_proposal POST /api/rest/v1/product-models/{code}/proposal Submit a draft for approval
ProductModelApi post_product_models POST /api/rest/v1/product-models Create a new product model
PublishedProductApi get_published_products GET /api/rest/v1/published-products Get list of published products
PublishedProductApi get_published_products_code GET /api/rest/v1/published-products/{code} Get a published product
ReferenceEntityApi get_reference_entities GET /api/rest/v1/reference-entities Get list of reference entities
ReferenceEntityApi get_reference_entities_code GET /api/rest/v1/reference-entities/{code} Get a reference entity
ReferenceEntityApi patch_reference_entity_code PATCH /api/rest/v1/reference-entities/{code} Update/create a reference entity
ReferenceEntityAttributeApi get_reference_entities_code_attributes GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes Get the list of attributes of a given reference entity
ReferenceEntityAttributeApi get_reference_entity_attributes_code GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code} Get an attribute of a given reference entity
ReferenceEntityAttributeApi patch_reference_entity_attributes_code PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code} Update/create an attribute of a given reference entity
ReferenceEntityAttributeOptionApi get_reference_entity_attributes_attribute_code_options GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options Get a list of attribute options of a given attribute for a given reference entity
ReferenceEntityAttributeOptionApi get_reference_entity_attributes_attribute_code_options_code GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code} Get an attribute option for a given attribute of a given reference entity
ReferenceEntityAttributeOptionApi patch_reference_entity_attributes_attribute_code_options_code PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code} Update/create a reference entity attribute option
ReferenceEntityMediaFileApi get_reference_entity_media_files_code GET /api/rest/v1/reference-entities-media-files/{code} Download the media file associated to a reference entity or a record
ReferenceEntityMediaFileApi post_reference_entity_media_files POST /api/rest/v1/reference-entities-media-files Create a new media file for a reference entity or a record
ReferenceEntityRecordApi get_reference_entity_records GET /api/rest/v1/reference-entities/{reference_entity_code}/records Get the list of the records of a reference entity
ReferenceEntityRecordApi get_reference_entity_records_code GET /api/rest/v1/reference-entities/{reference_entity_code}/records/{code} Get a record of a given reference entity
ReferenceEntityRecordApi patch_reference_entity_records PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records Update/create several reference entity records
ReferenceEntityRecordApi patch_reference_entity_records_code PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records/{code} Update/create a record of a given reference entity
SystemApi get_system_information GET /api/rest/v1/system-information Get system information

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Metadata

Release files for akeneo-python-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for akeneo-python-sdk 1.0.0
File Size Uploaded Provenance Actions
akeneo_python_sdk-1.0.0.tar.gz 167.3 kB Without provenance Details for akeneo_python_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for akeneo-python-sdk 1.0.0
File Interpreter ABI Platform Actions
akeneo_python_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for akeneo_python_sdk-1.0.0-py3-none-any.whl

Total release size: 826.5 kB

Release files / akeneo_python_sdk-1.0.0.tar.gz

Download URL akeneo_python_sdk-1.0.0.tar.gz
Size 167.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0b7c8c39bc2d8309f08353ecdeac2e9d50613c3bc93adb1da04ab6ae1057f0f8
BLAKE2b-256 checksum
How to use checksums
ebb7981c746984266bd6d73f27bc323bde4b2184795d42d2522997b9637182dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / akeneo_python_sdk-1.0.0-py3-none-any.whl

Download URL akeneo_python_sdk-1.0.0-py3-none-any.whl
Size 659.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e109e318590ccffb353604c1f6d266920f8406f67c2081252d87cd02962d8ef5
BLAKE2b-256 checksum
How to use checksums
5f5823e48c82a9c6dd1b7f0ad9e3ee5ba52956136b32979b654fc43bd12483ca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for akeneo-python-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page