Skip to content

Models

The models expose a subset of the API response fields. Unmodeled fields are ignored during validation and are not preserved in the model's output.

pyholdsport.HoldsportTeam

Bases: BaseModel

Data model for team in Holdsport.

id: int instance-attribute

name: str instance-attribute

primary_color: str instance-attribute

secondary_color: str instance-attribute

role: HoldsportRole instance-attribute

pyholdsport.HoldsportMember

Bases: BaseModel

Data model for member in Holdsport.

id: int instance-attribute

firstname: str instance-attribute

lastname: str instance-attribute

role: HoldsportRole instance-attribute

member_number: str instance-attribute

birthday: str | bool = Field(description='Return value is False for insufficient permissions') class-attribute instance-attribute

addresses: list[HoldsportAddress] instance-attribute

profile_picture_path: str instance-attribute

pyholdsport.HoldsportActivity

Bases: BaseModel

Data model for activity in Holdsport.

id: int instance-attribute

name: str instance-attribute

starttime: str instance-attribute

endtime: str instance-attribute

comment: str instance-attribute

place: str instance-attribute

pickup_place: str instance-attribute

pickup_time: str = Field(description='Pickup time in HH:MM format, or an empty string if not set') class-attribute instance-attribute

status: int instance-attribute

registration_type: int instance-attribute

activities_users: list[HoldsportActivitiesUser] = Field(description='Activity users, including entries with Unknown status; not necessarily a complete team roster') class-attribute instance-attribute

event_type: str instance-attribute

event_type_id: int instance-attribute

pyholdsport.HoldsportActivitiesUser

Bases: BaseModel

Data model for activity user in Holdsport.

id: int instance-attribute

name: str instance-attribute

status: str instance-attribute

status_code: HoldsportActivityUserStatus instance-attribute

updated_at: str instance-attribute

user_id: int instance-attribute

pyholdsport.HoldsportActivityUserStatus

Bases: IntEnum

Holdsport activity user attendance status enumeration.

ATTENDING = 1 class-attribute instance-attribute

NOT_ATTENDING = 2 class-attribute instance-attribute

AVAILABLE = 3 class-attribute instance-attribute

SELECTED = 4 class-attribute instance-attribute

UNKNOWN = 5 class-attribute instance-attribute

pyholdsport.HoldsportRole

Bases: IntEnum

Holdsport member role enumeration.

PLAYER = 1 class-attribute instance-attribute

COACH = 2 class-attribute instance-attribute

ASSISTANT_COACH = 3 class-attribute instance-attribute

INJURED = 4 class-attribute instance-attribute

INACTIVE = 5 class-attribute instance-attribute

TEAM_LEADER = 6 class-attribute instance-attribute

pyholdsport.HoldsportAddress

Bases: BaseModel

Data model for address in Holdsport.

street: str = Field(description='Return value is empty for insufficient permissions') class-attribute instance-attribute

city: str = Field(description='Return value is empty for insufficient permissions') class-attribute instance-attribute

postcode: str = Field(description='Return value is empty for insufficient permissions') class-attribute instance-attribute

telephone: str = Field(description='Return value is empty for insufficient permissions') class-attribute instance-attribute

mobile: str = Field(description='Return value is empty for insufficient permissions') class-attribute instance-attribute

email: str | bool | None = Field(description='Return value is False for insufficient permissions') class-attribute instance-attribute

email_ex: str | bool | None = Field(description='Return value is False for insufficient permissions') class-attribute instance-attribute

pyholdsport.HoldsportNote

Bases: BaseModel

Data model for note in Holdsport.

body: str instance-attribute

created_at: str instance-attribute

created_by: str instance-attribute

title: str instance-attribute