Chore Models¶
Classes for representing chores and their scheduling configuration.
Chore¶
Chore
¶
Bases: BaseModel
A household chore with scheduling and assignment details.
id
instance-attribute
¶
name = None
class-attribute
instance-attribute
¶
description = None
class-attribute
instance-attribute
¶
period_type = None
class-attribute
instance-attribute
¶
period_config = None
class-attribute
instance-attribute
¶
period_days = None
class-attribute
instance-attribute
¶
track_date_only = None
class-attribute
instance-attribute
¶
rollover = None
class-attribute
instance-attribute
¶
assignment_type = None
class-attribute
instance-attribute
¶
assignment_config = None
class-attribute
instance-attribute
¶
next_execution_assigned_to_user_id = None
class-attribute
instance-attribute
¶
userfields = None
class-attribute
instance-attribute
¶
last_tracked_time = None
class-attribute
instance-attribute
¶
next_estimated_execution_time = None
class-attribute
instance-attribute
¶
last_done_by = None
class-attribute
instance-attribute
¶
track_count = None
class-attribute
instance-attribute
¶
next_execution_assigned_user = None
class-attribute
instance-attribute
¶
from_current_response(resp)
classmethod
¶
Create from a current-chores API response.
from_details_response(resp)
classmethod
¶
Create from a chore-details API response.
get_details(api_client)
¶
Fetch and populate full chore details and userfields from the API.
PeriodType¶
Scheduling period types for chores.
PeriodType
¶
Bases: str, Enum
Chore recurrence period type.
MANUALLY = 'manually'
class-attribute
instance-attribute
¶
DYNAMIC_REGULAR = 'dynamic-regular'
class-attribute
instance-attribute
¶
DAILY = 'daily'
class-attribute
instance-attribute
¶
WEEKLY = 'weekly'
class-attribute
instance-attribute
¶
MONTHLY = 'monthly'
class-attribute
instance-attribute
¶
YEARLY = 'yearly'
class-attribute
instance-attribute
¶
ADAPTIVE = 'adaptive'
class-attribute
instance-attribute
¶
HOURLY = 'hourly'
class-attribute
instance-attribute
¶
AssignmentType¶
How chores are assigned to users.
AssignmentType
¶
Bases: str, Enum
Chore assignment strategy.