Articles

Sous-client pour les endpoints /v1/items.

Classes: - henrri_connect.items.asynchro.AsyncItemsClient : Accès asynchrone aux endpoints articles. - henrri_connect.items.synchro.SyncItemsClient : Accès synchrone aux endpoints articles.

Notes: - Utiliser de préférence l’objet henrri_connect.SyncHenrriClient pour acceder aux endpoints. - Utiliser de préférence l’objet henrri_connect.AsyncHenrriClient pour acceder aux endpoints.

class henrri_connect.items.AsyncItemsClient(client)

Bases : object

Accès asynchrone aux endpoints articles.

Arguments - client : Objet henrri_connect.AsyncHenrriClient pour acceder aux endpoints.

Methods - list_items : Liste les articles avec pagination et filtres optionnels. - add : Crée un nouvel article. - get : Récupère un article par son identifiant. - modify : Modifie un article par son identifiant. - delete : Supprime un article par son identifiant. - get_most_used : Récupère les articles les plus utilisés. - get_best_sales : Récupère les articles les plus vendus. - list_with_selected_fields : Liste les articles avec sélection de champs.

async list_items(*, request, with_selected_fields=True, with_totals=False, only_current_page=True)

Overloads:

• self, request (ItemsQuery), with_selected_fields (bool), with_totals (bool), only_current_page (bool) → PagedListResponse[Item]

• self, request (ItemsQuery), with_selected_fields (bool), with_totals (None), only_current_page (None) → PagedListResponse[Item]

Liste les articles avec pagination et filtres optionnels.

Arguments - request (ItemsQuery) : Paramètres de recherche. - with_selected_fields (bool) : Si True, lance une requête de recherche avancée. - with_totals (bool) : Si True, renvoie les totaux. - only_current_page (bool) : Si True, renvoie uniquement les articles de la page actuelle.

Returns - PagedListResponse[Item] : Liste paginée d’articles.

async add(item)

Crée un nouvel article.

Arguments - item (Item) : Article à créer.

Returns - Item : Article créé.

Type renvoyé:

Item

async get(item_id)

Récupère un article par son identifiant.

Arguments - item_id (int) : Identifiant de l’article.

Returns - Item : Article trouvé.

Type renvoyé:

Item

async modify(item_id, item)

Met à jour un article existant.

Arguments - item_id (int) : Identifiant de l’article. - item (Item) : Article à mettre à jour.

Returns - Item : Article mis à jour.

Type renvoyé:

Item

async delete(item_id)

Supprime un article.

Arguments - item_id (int) : Identifiant de l’article à supprimer.

Returns - None : Article supprimé.

Type renvoyé:

None

async get_most_used()

Récupère les articles les plus utilisés.

Arguments - None

Returns - PagedListResponse[Item] : Liste paginée d’articles.

Type renvoyé:

PagedListResponse[Item]

async get_best_sales(*, year)

Récupère les articles les plus vendus.

Arguments - year (int) : Année de recherche.

Returns - PagedListResponse[Item] : Liste paginée d’articles.

Type renvoyé:

PagedListResponse[Item]

class henrri_connect.items.Item(**data)

Bases : CamelModel

Représente un article dans l’API Henrri Connect.

Attributs: - id: Identifiant unique de l’article. - reference: Référence de l’article. - description: Description de l’article. - is_tax_included: Indique si la taxe est incluse dans le prix. - selling_price_without_tax: Prix de vente hors taxe de l’article. - selling_price_with_tax: Prix de vente TTC de l’article. - purchase_price: Prix d’achat de l’article. - vat_percent: Taux de TVA de l’article. - is_a_group: Indique si l’article est un groupe d’articles. - item_category: Catégorie de l’article (si applicable). - item_category_id: Identifiant de la catégorie de l’article (si applicable). - unit_id: Identifiant de l’unité de l’article (si applicable). - parent_item_id: Id d’article parent si l’article est un élément d’un grp d’articles (si applicable). - creation_date: Date de création de l’article. - links: Liste de liens associés à l’article (si applicable).

id: int | None

reference: str | None

description: str | None

is_tax_included: bool

selling_price_without_tax: float | None

selling_price_with_tax: float | None

purchase_price: float

vat_percent: float

is_a_group: bool

item_category: ItemCategory | None

item_category_id: int | None

unit_id: int | None

parent_item_id: int | None

creation_date: str

links: list[Link] | None

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.items.ItemsQuery(**data)

Bases : CamelModel

Représente une requête de catégorie d’article dans l’API Henrri Connect.

Attributs: - page (int) : Index de la page de la requête (entre 1 et 2 147 483 647, defaut 1). - limit (int) : Nombre d’articles par page (entre 1 et 100, défaut 50). - search (str) : Chaine de recherche. - sort_by (str) : Champ de tri. - sort_order (SortOrder) : Ordre de tri (Ascending ou Descending). - min_id (int) : Identifiant minimal de l’article (entre 1 et 2 147 483 647). - from_date (str) : Date de début. - to_date (str) : Date de fin.

page: int

limit: int

search: str | None

sort_by: str | None

sort_order: SortOrder | None

min_id: int

from_date: str

to_date: str

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.items.PagedListResponse(**data)

Bases : CamelModel, Generic[T]

Réponse paginée générique.

Attributs - elements: Liste d’éléments de la page. - totals: Liste de cellules de total pour la page (si applicable). - display: Liste d’informations d’affichage pour les éléments de la page (si applicable). - meta: Métadonnées de la réponse paginée (si applicable).

elements: list[T] | None

totals: list[Cell] | None

display: list[ElementDisplay] | None

meta: MetaPagedListResponse | None

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class henrri_connect.items.SyncItemsClient(client)

Bases : object

Accès synchrone aux endpoints articles.

Arguments - client : Objet henrri_connect.SyncHenrriClient pour acceder aux endpoints.

Methods - list_items : Liste les articles avec pagination et filtres optionnels. - add : Crée un nouvel article. - get : Récupère un article par son identifiant. - modify : Modifie un article par son identifiant. - delete : Supprime un article par son identifiant. - get_most_used : Récupère les articles les plus utilisés. - get_best_sales : Récupère les articles les plus vendus. - list_with_selected_fields : Liste les articles avec sélection de champs.

list_items(*, request, with_selected_fields=True, with_totals=False, only_current_page=True)

Overloads:

• self, request (ItemsQuery), with_selected_fields (bool), with_totals (bool), only_current_page (bool) → PagedListResponse[Item]

• self, request (ItemsQuery), with_selected_fields (bool), with_totals (None), only_current_page (None) → PagedListResponse[Item]

Liste les articles avec pagination et filtres optionnels.

Arguments - request (ItemsQuery) : Paramètres de recherche. - with_selected_fields (bool) : Si True, lance une requête de recherche avancée. - with_totals (bool) : Si True, renvoie les totaux. - only_current_page (bool) : Si True, renvoie uniquement les articles de la page actuelle.

Returns - PagedListResponse[Item] : Liste paginée d’articles.

add(item)

Crée un nouvel article.

Arguments - item (Item) : Article à créer.

Returns - Item : Article créé.

Type renvoyé:

Item

get(item_id)

Récupère un article par son identifiant.

Arguments - item_id (int) : Identifiant de l’article.

Returns - Item : Article rencontré.

Type renvoyé:

Item

modify(item_id, item)

Met à jour un article existant.

Arguments - item_id (int) : Identifiant de l’article. - item (Item) : Article à mettre à jour.

Returns - Item : Article mis à jour.

Type renvoyé:

Item

delete(item_id)

Supprime un article.

Arguments - item_id (int) : Identifiant de l’article à supprimer.

Returns - None : Article supprimé.

Type renvoyé:

None

get_most_used()

Récupère les articles les plus utilisés.

Arguments - None

Returns - PagedListResponse[Item] : Liste paginée d’articles.

Type renvoyé:

PagedListResponse[Item]

get_best_sales(*, year)

Récupère les articles les plus vendus.

Arguments - year (int) : Année de recherche.

Returns - PagedListResponse[Item] : Liste paginée d’articles.

Type renvoyé:

PagedListResponse[Item]