orghandbookapi.schemas package¶
Submodules¶
orghandbookapi.schemas.activity module¶
- class orghandbookapi.schemas.activity.Activity(*, name: str, parent_id: int | None = None, level: int = 0, id: int)[source]¶
Bases:
ActivityBaseСхема валидации модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.activity.ActivityBase(*, name: str, parent_id: int | None = None, level: int = 0)[source]¶
Bases:
BaseModelСхема валидации базовой модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- level: int¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str¶
- parent_id: int | None¶
- class orghandbookapi.schemas.activity.ActivityCreate(*, name: str, parent_id: int | None = None, level: int = 0)[source]¶
Bases:
ActivityBaseСхема валидации создания модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.activity.ActivityTree(*, name: str, parent_id: int | None = None, level: int = 0, id: int, children: list[ActivityTree] = [])[source]¶
Bases:
ActivityСхема валидации дерева моделей видов деятельности.
- _abc_impl = <_abc._abc_data object>¶
- children: list[ActivityTree]¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.activity.ActivityUpdate(*, name: str | None = None, parent_id: int | None = None, level: int | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- level: int | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str | None¶
- parent_id: int | None¶
- class orghandbookapi.schemas.activity.ActivityWithRelations(*, name: str, parent_id: int | None = None, level: int = 0, id: int, parent: Activity | None = None, children: list[Activity] = [])[source]¶
Bases:
ActivityСхема валидации модели вида деятельности с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
orghandbookapi.schemas.building module¶
- class orghandbookapi.schemas.building.Building(*, address: str, longitude: float, latitude: float, id: int)[source]¶
Bases:
BuildingBaseСхема валидации модели здания.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.building.BuildingBase(*, address: str, longitude: float, latitude: float)[source]¶
Bases:
BaseModelСхема валидации базовой модели здания.
- _abc_impl = <_abc._abc_data object>¶
- address: str¶
- latitude: float¶
- longitude: float¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.building.BuildingCreate(*, address: str, longitude: float, latitude: float)[source]¶
Bases:
BuildingBaseСхема валидации создания модели здания.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.building.BuildingUpdate(*, address: str | None = None, longitude: float | None = None, latitude: float | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели здания.
- _abc_impl = <_abc._abc_data object>¶
- address: str | None¶
- latitude: float | None¶
- longitude: float | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.building.BuildingWithRelations(*, address: str, longitude: float, latitude: float, id: int, organizations: list[Organization] = [])[source]¶
Bases:
BuildingСхема валидации модели здания с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- organizations: list[Organization]¶
orghandbookapi.schemas.organization module¶
- class orghandbookapi.schemas.organization.Organization(*, legal_name: str, building_id: int, id: int)[source]¶
Bases:
OrganizationBaseСхема валидации модели организации.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.organization.OrganizationBase(*, legal_name: str, building_id: int)[source]¶
Bases:
BaseModelСхема валидации базовой модели организации.
- _abc_impl = <_abc._abc_data object>¶
- building_id: int¶
- legal_name: str¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.organization.OrganizationCreate(*, legal_name: str, building_id: int, phone_numbers: list[str], activity_ids: list[int])[source]¶
Bases:
OrganizationBaseСхема валидации создания модели организации.
- _abc_impl = <_abc._abc_data object>¶
- activity_ids: list[int]¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_numbers: list[str]¶
- class orghandbookapi.schemas.organization.OrganizationUpdate(*, legal_name: str | None = None, building_id: int | None = None, phone_numbers: list[str] | None = None, activity_ids: list[int] | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели организации.
- _abc_impl = <_abc._abc_data object>¶
- activity_ids: list[int] | None¶
- building_id: int | None¶
- legal_name: str | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_numbers: list[str] | None¶
- class orghandbookapi.schemas.organization.OrganizationWithRelations(*, legal_name: str, building_id: int, id: int, building: Building, phonenumbers: list[PhoneNumber], activities: list[Activity])[source]¶
Bases:
OrganizationСхема валидации модели организации с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phonenumbers: list[PhoneNumber]¶
- class orghandbookapi.schemas.organization.PhoneNumber(*, phone_number: str, id: int)[source]¶
Bases:
PhoneNumberBaseСхема валидации модели номера телефона.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.organization.PhoneNumberBase(*, phone_number: str)[source]¶
Bases:
BaseModelСхема валидации базовой модели номера телефона.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_number: str¶
- class orghandbookapi.schemas.organization.PhoneNumberCreate(*, phone_number: str)[source]¶
Bases:
PhoneNumberBaseСхема валидации создания модели номера телефона.
- _abc_impl = <_abc._abc_data object>¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
Module contents¶
- class orghandbookapi.schemas.Activity(*, name: str, parent_id: int | None = None, level: int = 0, id: int)[source]¶
Bases:
ActivityBaseСхема валидации модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- level: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str¶
- parent_id: int | None¶
- class orghandbookapi.schemas.ActivityCreate(*, name: str, parent_id: int | None = None, level: int = 0)[source]¶
Bases:
ActivityBaseСхема валидации создания модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- level: int¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str¶
- parent_id: int | None¶
- class orghandbookapi.schemas.ActivityTree(*, name: str, parent_id: int | None = None, level: int = 0, id: int, children: list[ActivityTree] = [])[source]¶
Bases:
ActivityСхема валидации дерева моделей видов деятельности.
- _abc_impl = <_abc._abc_data object>¶
- children: list[ActivityTree]¶
- id: int¶
- level: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str¶
- parent_id: int | None¶
- class orghandbookapi.schemas.ActivityUpdate(*, name: str | None = None, parent_id: int | None = None, level: int | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели вида деятельности.
- _abc_impl = <_abc._abc_data object>¶
- level: int | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str | None¶
- parent_id: int | None¶
- class orghandbookapi.schemas.ActivityWithRelations(*, name: str, parent_id: int | None = None, level: int = 0, id: int, parent: Activity | None = None, children: list[Activity] = [])[source]¶
Bases:
ActivityСхема валидации модели вида деятельности с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- level: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- name: str¶
- parent_id: int | None¶
- class orghandbookapi.schemas.Building(*, address: str, longitude: float, latitude: float, id: int)[source]¶
Bases:
BuildingBaseСхема валидации модели здания.
- _abc_impl = <_abc._abc_data object>¶
- address: str¶
- id: int¶
- latitude: float¶
- longitude: float¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.BuildingCreate(*, address: str, longitude: float, latitude: float)[source]¶
Bases:
BuildingBaseСхема валидации создания модели здания.
- _abc_impl = <_abc._abc_data object>¶
- address: str¶
- latitude: float¶
- longitude: float¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.BuildingUpdate(*, address: str | None = None, longitude: float | None = None, latitude: float | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели здания.
- _abc_impl = <_abc._abc_data object>¶
- address: str | None¶
- latitude: float | None¶
- longitude: float | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.BuildingWithRelations(*, address: str, longitude: float, latitude: float, id: int, organizations: list[Organization] = [])[source]¶
Bases:
BuildingСхема валидации модели здания с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- address: str¶
- id: int¶
- latitude: float¶
- longitude: float¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- organizations: list[Organization]¶
- class orghandbookapi.schemas.Organization(*, legal_name: str, building_id: int, id: int)[source]¶
Bases:
OrganizationBaseСхема валидации модели организации.
- _abc_impl = <_abc._abc_data object>¶
- building_id: int¶
- id: int¶
- legal_name: str¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class orghandbookapi.schemas.OrganizationCreate(*, legal_name: str, building_id: int, phone_numbers: list[str], activity_ids: list[int])[source]¶
Bases:
OrganizationBaseСхема валидации создания модели организации.
- _abc_impl = <_abc._abc_data object>¶
- activity_ids: list[int]¶
- building_id: int¶
- legal_name: str¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_numbers: list[str]¶
- class orghandbookapi.schemas.OrganizationUpdate(*, legal_name: str | None = None, building_id: int | None = None, phone_numbers: list[str] | None = None, activity_ids: list[int] | None = None)[source]¶
Bases:
BaseModelСхема валидации обновления модели организации.
- _abc_impl = <_abc._abc_data object>¶
- activity_ids: list[int] | None¶
- building_id: int | None¶
- legal_name: str | None¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_numbers: list[str] | None¶
- class orghandbookapi.schemas.OrganizationWithRelations(*, legal_name: str, building_id: int, id: int, building: Building, phonenumbers: list[PhoneNumber], activities: list[Activity])[source]¶
Bases:
OrganizationСхема валидации модели организации с отношениями.
- _abc_impl = <_abc._abc_data object>¶
- building_id: int¶
- id: int¶
- legal_name: str¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phonenumbers: list[PhoneNumber]¶
- class orghandbookapi.schemas.PhoneNumber(*, phone_number: str, id: int)[source]¶
Bases:
PhoneNumberBaseСхема валидации модели номера телефона.
- _abc_impl = <_abc._abc_data object>¶
- id: int¶
- model_config: ClassVar[ConfigDict] = {'from_attributes': True}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- phone_number: str¶