Utilisateurs

Sous-client pour les endpoints /v1/users.

Classes: - henrri_connect.users.asynchro.AsyncUsersClient : Accès asynchrone aux endpoints utilisateurs. - henrri_connect.users.synchro.SyncUsersClient : Accès synchrone aux endpoints utilisateurs.

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.users.Address(**data)

Bases : CamelModel

Représente une adresse d’entreprise.

Attributs: - id: Identifiant unique de l’adresse. - address: Adresse de l’entreprise. - city: Ville de l’entreprise. - post_code: Code postal de l’entreprise. - country: Pays de l’entreprise. - is_post_code_shared: Indique si le code postal est partagé avec d’autres adresses. - links: Liste de liens associés à l’adresse (si applicable).

id: int | None

address: str | None

city: str | None

post_code: str | None

country: str | None

is_post_code_shared: bool

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.users.AsyncUsersClient(client)

Bases : object

Accès asynchrone aux endpoints utilisateurs.

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

Methods - get(user_id: int) : Récupère un utilisateur par son identifiant. - get_address(user_id: int) : Récupère l’adresse d’un utilisateur. - get_companies() : Récupère les entreprises associées à l’utilisateur courant. - authenticate() : Authentifie via les identifiants du client. - refresh_token(refresh_token: str) : Rafraîchit le token d’accès.

async get(user_id)

Récupère un utilisateur par son identifiant.

Arguments - user_id (int) : Identifiant de l’utilisateur.

Returns - User : Utilisateur.

Type renvoyé:

User

async get_address(user_id)

Récupère l’adresse d’un utilisateur.

Arguments: - user_id (int) : Identifiant de l’utilisateur.

Returns: - henrri_connect.models.Address : Adresse de l’utilisateur.

Type renvoyé:

Address

async get_companies()

Récupère les entreprises associées à l’utilisateur courant.

Returns: - list[UserAndCompany] : Entreprises.

Type renvoyé:

list[UserAndCompany]

async authenticate()

Authentifie via les identifiants du client.

Returns: - henrri_connect.models.TokenResponse : Objet contenant access_token et refresh_token.

Type renvoyé:

TokenResponse

async refresh_token(refresh_token)

Rafraîchit le token d’accès.

Arguments: - refresh_token (str) : Token de rafraîchissement.

Returns: - henrri_connect.models.TokenResponse : Objet contenant access_token et refresh_token.

Type renvoyé:

TokenResponse

class henrri_connect.users.SyncUsersClient(client)

Bases : object

Accès synchrone aux endpoints utilisateurs.

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

Methods: - get(user_id: int) : Récupère un utilisateur par son identifiant. - get_address(user_id: int) : Récupère l’adresse d’un utilisateur. - get_companies() : Récupère les entreprises associées à l’utilisateur courant. - authenticate() : Authentifie via les identifiants du client. - refresh_token(refresh_token: str) : Rafraîchit le token d’accès.

get(user_id)

Récupère un utilisateur par son identifiant.

Arguments: - user_id (int) : Identifiant de l’utilisateur.

Returns: - User : Utilisateur.

Type renvoyé:

User

get_address(user_id)

Récupère l’adresse d’un utilisateur.

Arguments: - user_id (int) : Identifiant de l’utilisateur.

Returns: - henrri_connect.models.Address : Adresse de l’utilisateur.

Type renvoyé:

Address

get_companies()

Récupère les entreprises associées à l’utilisateur courant.

Returns: - list[UserAndCompany] : Entreprises.

Type renvoyé:

list[UserAndCompany]

authenticate()

Authentifie via les identifiants du client.

Returns: - henrri_connect.models.TokenResponse : Objet contenant access_token et refresh_token.

Type renvoyé:

TokenResponse

refresh_token(refresh_token)

Rafraîchit le token d’accès.

Arguments: - refresh_token (str) : Token de rafraîchissement.

Returns: - henrri_connect.models.TokenResponse : Objet contenant access_token et refresh_token.

Type renvoyé:

TokenResponse

class henrri_connect.users.TokenResponse(**data)

Bases : CamelModel

Représente la réponse d’une authentification réussie ou d’un rafraîchissement de token.

Attributs: - access_token: Token d’accès. - identity_token: Token d’identité. - scope: Portée du token. - token_type: Type du token. - refresh_token: Token de rafraîchissement. - expires_in: Durée de validité du token en secondes. - is_error: Indique si la réponse contient une erreur. - error: Code de l’erreur (si applicable). - error_description: Description de l’erreur (si applicable).

access_token: str | None

identity_token: str | None

scope: str | None

token_type: str | None

refresh_token: str | None

expires_in: int

is_error: bool

error: str | None

error_description: str | 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.users.User(**data)

Bases : CamelModel

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

Attributs: - id: Identifiant de l’utilisateur. - email: Adresse email de l’utilisateur. - first_name: Prénom de l’utilisateur. - last_name: Nom de famille de l’utilisateur. - url_image: URL de l’image de profil de l’utilisateur. - first_connexion_date: Date de la première connexion de l’utilisateur. - last_connexion_date: Date de la dernière connexion de l’utilisateur. - connexion_count: Nombre de connexions de l’utilisateur. - created_from: Source de création de l’utilisateur. - phone_number: Numéro de téléphone de l’utilisateur. - creation_date: Date de création de l’utilisateur. - is_enabled: Indique si l’utilisateur est activé. - two_factor_enabled: Indique si l’authentification à deux facteurs est activée pour l’utilisateur. - address: Adresse de l’utilisateur (si applicable). - links: Liste de liens associés à l’utilisateur (si applicable).

id: int | None

email: str | None

first_name: str | None

last_name: str | None

url_image: str | None

first_connexion_date: str | None

last_connexion_date: str | None

connexion_count: str | None

created_from: str | None

phone_number: str | None

creation_date: str | None

is_enabled: bool

two_factor_enabled: bool

address: Address | 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].

class henrri_connect.users.UserAndCompany(**data)

Bases : CamelModel

Représente un utilisateur et son entreprise dans l’API Henrri Connect.

Attributs:

• user: Utilisateur de l’API Henrri Connect.

• company: Entreprise associée à l’utilisateur dans l’API Henrri Connect.

user: User

company: Company

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