mex.blueant.models package¶
Submodules¶
mex.blueant.models.person module¶
- class mex.blueant.models.person.BlueAntPerson(*, id: int, personnelNumber: str, firstname: str, lastname: str, email: Email)¶
Bases:
BaseModelModel class for Blue Ant persons.
- email: Email¶
- firstname: str¶
- id: int¶
- lastname: str¶
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'email': FieldInfo(annotation=Email, required=True), 'firstname': FieldInfo(annotation=str, required=True), 'id': FieldInfo(annotation=int, required=True), 'lastname': FieldInfo(annotation=str, required=True), 'personnelNumber': FieldInfo(annotation=str, required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- personnelNumber: str¶
- class mex.blueant.models.person.BlueAntPersonResponse(*, persons: list[BlueAntPerson])¶
Bases:
BaseModelResponse to GET request to Blue Ant API person endpoint.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'persons': FieldInfo(annotation=list[BlueAntPerson], required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- persons: list[BlueAntPerson]¶
mex.blueant.models.project module¶
- class mex.blueant.models.project.BlueAntClient(*, clientId: int)¶
Bases:
BaseModelModel class for Blue Ant clients.
- clientId: int¶
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'clientId': FieldInfo(annotation=int, required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class mex.blueant.models.project.BlueAntProject(*, clients: list[BlueAntClient], departmentId: int, end: TemporalEntity, name: str, number: str, projectLeaderId: int, start: TemporalEntity, statusId: int, typeId: int)¶
Bases:
BaseModelModel class for Blue Ant projects.
- clients: list[BlueAntClient]¶
- departmentId: int¶
- end: TemporalEntity¶
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'clients': FieldInfo(annotation=list[BlueAntClient], required=True), 'departmentId': FieldInfo(annotation=int, required=True), 'end': FieldInfo(annotation=TemporalEntity, required=True), 'name': FieldInfo(annotation=str, required=True), 'number': FieldInfo(annotation=str, required=True), 'projectLeaderId': FieldInfo(annotation=int, required=True), 'start': FieldInfo(annotation=TemporalEntity, required=True), 'statusId': FieldInfo(annotation=int, required=True), 'typeId': FieldInfo(annotation=int, required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- name: str¶
- number: str¶
- projectLeaderId: int¶
- start: TemporalEntity¶
- statusId: int¶
- typeId: int¶
- class mex.blueant.models.project.BlueAntProjectResponse(*, projects: list[BlueAntProject])¶
Bases:
BaseModelResponse to GET request to Blue Ant API projects endpoint.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}¶
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'projects': FieldInfo(annotation=list[BlueAntProject], required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- projects: list[BlueAntProject]¶