Unités produits¶

Sous-client pour les endpoints /v1/units.

Classes: - henrri_connect.units.asynchro.AsyncUnitsClient : Accès asynchrone aux endpoints unités. - henrri_connect.units.synchro.SyncUnitsClient : Accès synchrone aux endpoints unités.

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

class henrri_connect.units.AsyncUnitsClient(client)[source]

Bases : object

Accès asynchrone aux unités.

Arugments - client (AsyncHenrriClient) : Client asynchrone pour acceder aux endpoints.

Methods - list_units() : Liste toutes les unités disponibles. - add(unit: Unit) : Crée une nouvelle unité. - get(unit_id: int) : Récupère une unité par son identifiant.

async list_units()[source]

Liste toutes les unités disponibles.

Arguments - None

Returns - ListResponse[Unit] : Liste de unités.

Type renvoyé:: ListResponse[Unit]

async add(unit)[source]

Crée une nouvelle unité.

Arguments - unit: Unit : Unité à crée.

Returns - Unit : Unité crée.

Type renvoyé:: Unit

async get(unit_id)[source]

Récupère une unité par son identifiant.

Arguments - unit_id (int) : Identifiant de l’unité.

Returns - Unit : Unité.

Type renvoyé:: Unit

class henrri_connect.units.ListResponse(**data)[source]

Bases : CamelModel, Generic[T]

Réponse liste générique.

Attributs - elements: Liste d’éléments. - meta: Métadonnées de la réponse liste (si applicable).

elements: list[T] | None

meta: MetaListResponse | 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.units.SyncUnitsClient(client)[source]

Bases : object

Accès synchrone aux unités.

Arguments - client (SyncHenrriClient) : Client synchrone pour acceder aux endpoints.

Methods - list_units() : Liste toutes les unités disponibles. - add(unit: Unit) : Crée une nouvelle unité. - get(unit_id: int) : Récupère une unité par son identifiant.

list_units()[source]

Liste toutes les unités disponibles.

Arguments - None

Returns - ListResponse[Unit] : Liste de unités.

Type renvoyé:: ListResponse[Unit]

add(unit)[source]

Crée une nouvelle unité.

Arguments - unit: Unit : Unité à crée.

Returns - Unit : Unité crée.

Type renvoyé:: Unit

get(unit_id)[source]

Récupère une unité par son identifiant.

Arguments - unit_id (int) : Identifiant de l’unité.

Returns - Unit : Unité.

Type renvoyé:: Unit

class henrri_connect.units.Unit(**data)[source]

Bases : CamelModel

Représente une unité dans l’API Henrri Connect.

Attributs: - id: Identifiant de l’unité. - name: Nom de l’unité. - unit_kind: Type de l’unité. - links: Liens associés à l’unité.

id: int | None

name: str

unit_kind: UnitKind | None

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].