python-casahome 0.2.0__py3-none-any.whl

casahome/models/availability.py

@@ -0,0 +1,39 @@
+"""Static availability detail, never slot submission. UNVERIFIED wire shape.
+
+Fields inferred from the app. Status remains a string so new values survive.
+Integer times are retained without promoting their units to observed evidence.
+"""
+
+from casahome.models._base import CasaModel
+
+
+class MemberAvailabilitySummary(CasaModel):
+    id: str
+    request_id: str
+    home_id: str
+    status: str
+    slot_count: int
+    first_submitted_at: int | None = None
+    last_submitted_at: int | None = None
+    created_at: int
+
+
+class MemberAvailabilitySlot(CasaModel):
+    id: str
+    member_availability_request_id: str
+    start_time: int
+    end_time: int
+
+
+class MemberAvailabilityConstraints(CasaModel):
+    snap_minutes: int
+    min_slot_minutes: int
+    default_duration_minutes: int
+    lead_time_minutes: int
+
+
+class MemberAvailabilityDetail(CasaModel):
+    availability_request: MemberAvailabilitySummary
+    slots: list[MemberAvailabilitySlot]
+    home_timezone: str
+    constraints: MemberAvailabilityConstraints

casahome/models/bootstrap.py

@@ -0,0 +1,134 @@
+"""Models for ``POST /protected/member/bootstrap`` (VERIFIED)."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import Field
+
+from ._base import CasaModel, epoch_to_dt
+from .enums import HomeStatusField, PaymentMethodTypeField
+
+
+class UserDeviceRequest(CasaModel):
+    device_id: str
+    device_name: str
+    system_name: str
+    system_version: str
+    model: str
+    language: str
+    timezone: str
+    app: str
+    app_version: str
+    app_build: str
+    fcm_token: str | None = None
+    voip_token: str | None = None
+
+
+class HomeBadgeCounts(CasaModel):
+    computed_at: int
+    total: int
+    features: dict[str, int] = Field(default_factory=dict)
+
+    @property
+    def computed_at_dt(self) -> datetime | None:
+        return epoch_to_dt(self.computed_at)
+
+
+class PendingAgreement(CasaModel):
+    """``MemberSimpleHomeAgreement``. ``content`` is the full agreement text."""
+
+    id: str
+    name: str
+    content: str
+
+
+class AppUpdate(CasaModel):
+    force_update_required: bool
+    current_build: str
+    min_required_build: str
+    message: str
+    update_url: str | None = None
+
+
+class MemberWaitlistEntry(CasaModel):
+    id: str
+    address_street_number: str
+    address_street: str
+    address_city: str
+    address_state: str
+    address_postal_code: str
+    status: str
+    created_at: int
+
+
+class MemberSimpleHome(CasaModel):
+    id: str
+    address_street_number: str
+    address_street: str
+    address_city: str
+    address_state: str
+    address_postal_code: str
+    latitude: float | None = None
+    longitude: float | None = None
+    timezone: str | None = None
+    status: HomeStatusField
+    card_surcharge_rate: float = 0.0
+    has_payment_method: bool = False
+    membership_active: bool = False
+    is_multi_user_home: bool = False
+    has_pending_post_onboarding: bool = False
+    pending_agreements: list[PendingAgreement] = Field(default_factory=list)
+    address_subpremise: str | None = None
+    home_image_url: str | None = None
+    home_image_url_cache_key: str | None = None
+    payment_description: str | None = None
+    payment_method_type: PaymentMethodTypeField | None = None
+    payment_method_last4: str | None = None
+    payment_method_brand: str | None = None
+    membership_name: str | None = None
+    membership_plan: Any | None = None
+    membership_amount: str | None = None
+    membership_next_renewal: int | None = None
+    matterport_model_id: str | None = None
+    matterport_model_password: str | None = None
+    badge_counts: HomeBadgeCounts | None = None
+    # Observed in traffic but absent from the app's Codable model.
+    plan_state: str | None = None
+    route: str | None = None
+    is_primary_member: bool | None = None
+    past_due_until: int | None = None
+    scheduled_change: Any | None = None
+
+    @property
+    def display_address(self) -> str:
+        street = f"{self.address_street_number} {self.address_street}"
+        if self.address_subpremise:
+            street = f"{street} {self.address_subpremise}"
+        return f"{street}, {self.address_city}, {self.address_state} {self.address_postal_code}"
+
+
+class Bootstrap(CasaModel):
+    id: str
+    created_at: int
+    phone_number: str
+    email: str
+    first_name: str
+    last_name: str
+    homes: list[MemberSimpleHome] = Field(default_factory=list)
+    waitlist_entries: list[MemberWaitlistEntry] = Field(default_factory=list)
+    is_casa_collective: bool = False
+    avatar_url: str | None = None
+    avatar_url_cache_key: str | None = None
+    app_update: AppUpdate | None = None
+    # Observed in traffic but absent from the app's Codable model.
+    calendar_sync_active: bool | None = None
+    calendar_sync_email: str | None = None
+    calendar_sync_insufficient_scope: bool | None = None
+    calendar_sync_options: list[Any] = Field(default_factory=list)
+    user_prefs: list[Any] = Field(default_factory=list)
+
+    @property
+    def created_at_dt(self) -> datetime | None:
+        return epoch_to_dt(self.created_at)

casahome/models/calendar.py

@@ -0,0 +1,33 @@
+"""Visit calendar models (UNVERIFIED endpoint)."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import Field
+
+from ._base import CasaModel, epoch_to_dt
+
+
+class CalendarEvent(CasaModel):
+    """``VisitCalendarEvent``. ``kind`` is a Swift enum with associated payloads
+    (vendor visit or DTD), so its wire shape is unknown. Kept loose until traffic
+    shows it."""
+
+    id: str
+    start_time: int
+    end_time: int
+    kind: Any = None
+
+    @property
+    def start_dt(self) -> datetime | None:
+        return epoch_to_dt(self.start_time)
+
+    @property
+    def end_dt(self) -> datetime | None:
+        return epoch_to_dt(self.end_time)
+
+
+class VisitsCalendarResponse(CasaModel):
+    events: list[CalendarEvent] = Field(default_factory=list)

casahome/models/catalogs.py

@@ -0,0 +1,73 @@
+"""Inventory catalogs and recurring vendors. Vendor list items remain UNVERIFIED."""
+
+from pydantic import Field, JsonValue, RootModel
+
+from casahome.models._base import CasaModel
+from casahome.models.home import EntityMake
+
+
+class RoomType(CasaModel):
+    id: str
+    name: str
+
+
+class RoomTypesResponse(RootModel[list[RoomType]]):
+    """The room type catalog is a bare list."""
+
+
+class InventoryMakesResponse(CasaModel):
+    makes: list[EntityMake]
+
+
+class InventoryEnumOption(CasaModel):
+    """One inventory enum option. VERIFIED populated (live GET, 2026-10)."""
+
+    id: str
+    type: str
+    name: str
+    symbol_name: str | None = None
+    category: str | None = None
+    icon_url: str | None = None
+
+
+class InventoryEnumsResponse(CasaModel):
+    """Inventory enum catalog. VERIFIED envelope (live GET, 2026-10)."""
+
+    enums: list[InventoryEnumOption]
+
+
+class RecurringVendorCategory(CasaModel):
+    id: str
+    name: str
+    sort_order: int
+    primary_color: str
+    icon_url: str
+    icon_symbol_name: str
+    pattern_url: str
+    vendor_type_description: str
+
+
+class RecurringVendorCategoriesResponse(RootModel[list[RecurringVendorCategory]]):
+    """Populated category metadata observed."""
+
+
+class RecurringVendor(CasaModel):
+    """Minimal static SimpleDtd fields. Nested events and invoices remain opaque."""
+
+    id: str | None = None
+    home_id: str | None = None
+    vendor_id: str | None = None
+    vendor_name: str | None = None
+    service_category: str | None = None
+    dtd_category_id: str | None = None
+    rrule: str | None = None
+    start_date: str | None = None
+    duration_seconds: int | None = None
+    next_visit_epoch_seconds: int | None = None
+    payment_pending: bool | None = None
+    events: list[JsonValue] = Field(default_factory=list)
+    invoices: list[JsonValue] = Field(default_factory=list)
+
+
+class RecurringVendorsResponse(RootModel[list[RecurringVendor]]):
+    """Bare list. Empty in the saved response."""

casahome/models/credits.py

@@ -0,0 +1,29 @@
+"""Credits models (UNVERIFIED endpoint)."""
+
+from __future__ import annotations
+
+from pydantic import Field
+
+from ._base import CasaModel
+
+
+class CreditHistory(CasaModel):
+    id: str
+    issued_at: int
+    amount: int
+    available_amount: int
+    expires_at: int | None = None
+
+
+class ConsumptionHistory(CasaModel):
+    id: str
+    date: int
+    consumed_amount: int
+
+
+class MemberCredits(CasaModel):
+    home_id: str
+    total_available: int
+    handyman_hourly_rate_cents: int
+    credits_history: list[CreditHistory] = Field(default_factory=list)
+    consumption_history: list[ConsumptionHistory] = Field(default_factory=list)

casahome/models/documents.py

@@ -0,0 +1,127 @@
+"""Document envelopes observed empty. Item schemas are static and UNVERIFIED."""
+
+from pydantic import Field
+
+from casahome.models._base import CasaModel
+
+
+class DocumentOrganization(CasaModel):
+    id: str | None = None
+    status: str | None = None
+    error_code: str | None = None
+    can_retry: bool | None = None
+    completed_at: int | None = None
+
+
+class DocumentExtraction(DocumentOrganization):
+    pending_count: int | None = None
+    pending_structure_count: int | None = None
+    accepted_count: int | None = None
+    dismissed_count: int | None = None
+    already_handled_count: int | None = None
+
+
+class HomeDocument(CasaModel):
+    id: str | None = None
+    home_id: str | None = None
+    original_filename: str | None = None
+    name: str | None = None
+    document_type: str | None = None
+    document_date: str | None = None
+    mimetype: str | None = None
+    size_bytes: int | None = None
+    uploaded_by_name: str | None = None
+    created_at: int | None = None
+    updated_at: int | None = None
+    organization: DocumentOrganization | None = None
+    extraction: DocumentExtraction | None = None
+
+
+class DocumentsResponse(CasaModel):
+    documents: list[HomeDocument]
+    next_cursor: str | None = None
+
+
+class DocumentType(CasaModel):
+    key: str
+    label: str
+    description: str
+
+
+class DocumentTypesResponse(CasaModel):
+    """Populated document policy and upload limits were observed."""
+
+    types: list[DocumentType]
+    max_file_size_bytes: int
+    max_files_per_upload: int
+    allowed_mimetypes: list[str]
+    max_organization_size_bytes: int | None = None
+
+
+class DocumentCitation(CasaModel):
+    page_index: int | None = None
+    page_label: str | None = None
+    excerpt: str | None = None
+
+
+class WorkDocumentSource(CasaModel):
+    document_id: str | None = None
+    name: str | None = None
+    available: bool | None = None
+    document_date: str | None = None
+    citations: list[DocumentCitation] = Field(default_factory=list)
+
+
+class WorkDocumentSourceResponse(CasaModel):
+    source: WorkDocumentSource | None
+
+
+class DocumentDetailsResponse(CasaModel):
+    """UNVERIFIED document detail envelope."""
+
+    document: HomeDocument
+
+
+class DocumentSuggestion(CasaModel):
+    """Static document suggestion fields."""
+
+    id: str
+    todo_id: str
+    title: str
+    action: str
+    reason: str
+    area: str | None = None
+    citations: list[DocumentCitation]
+    state: str
+    work_deleted: bool
+    task_id: str | None = None
+    request_id: str | None = None
+
+
+class DocumentSuggestionsResponse(CasaModel):
+    """UNVERIFIED suggestions envelope."""
+
+    suggestions: list[DocumentSuggestion]
+    analysis_status: str | None = None
+    limitations: list[str]
+
+
+class DocumentStructureSuggestion(CasaModel):
+    """Static structure suggestion metadata."""
+
+    id: str
+    section: str
+    title: str
+    current_values: list[str]
+    current_label: str
+    proposed_label: str
+    reason: str
+    state: str
+    changed_since_analysis: bool
+    citations: list[DocumentCitation]
+
+
+class DocumentStructureSuggestionsResponse(CasaModel):
+    """UNVERIFIED structure suggestion page."""
+
+    suggestions: list[DocumentStructureSuggestion]

casahome/models/enums.py

@@ -0,0 +1,183 @@
+"""String enums transcribed from the Casa app binary.
+
+Values are the Swift case names. Model fields type these as ``Enum | str`` so an
+unseen value from the server degrades to a plain string instead of failing.
+The Swift ``unknown`` fallback case is included because the app defines it,
+but the server is not expected to send it.
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from typing import Annotated
+
+from pydantic import Field
+
+
+class MemberSimpleHomeStatus(StrEnum):
+    ONBOARDING = "onboarding"
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+    UNKNOWN = "unknown"
+
+
+class PaymentMethodType(StrEnum):
+    CARD = "card"
+    US_BANK_ACCOUNT = "us_bank_account"
+    UNKNOWN = "unknown"
+
+
+class RequestType(StrEnum):
+    CONCIERGE = "concierge"
+    HANDYMAN = "handyman"
+    THIRD_PARTY = "third_party"
+    UNKNOWN = "unknown"
+
+
+class RequestStatus(StrEnum):
+    PENDING_CONCIERGE = "pending_concierge"
+    PENDING_MEMBER = "pending_member"
+    PENDING_VENDOR = "pending_vendor"
+    COMPLETED = "completed"
+    CANCELED = "canceled"
+    UNKNOWN = "unknown"
+
+
+class SenderRole(StrEnum):
+    CONCIERGE = "concierge"
+    MEMBER = "member"
+    VENDOR = "vendor"
+    SYSTEM = "system"
+    UNKNOWN = "unknown"
+
+
+class VisitType(StrEnum):
+    HANDYMAN = "handyman"
+    THIRD_PARTY = "third_party"
+    UNKNOWN = "unknown"
+
+
+class VendorVisitStatus(StrEnum):
+    DRAFT = "draft"
+    SCHEDULED = "scheduled"
+    IN_PROGRESS = "in_progress"
+    WRAP_UP = "wrap_up"
+    COMPLETED = "completed"
+    CANCELED = "canceled"
+    UNKNOWN = "unknown"
+
+
+class TodoStatus(StrEnum):
+    PREPARING = "preparing"
+    NEEDS_SUPPORT_CONFIRMATION = "needs_support_confirmation"
+    NEEDS_INPUT = "needs_input"
+    READY_FOR_CONCIERGE = "ready_for_concierge"
+    FAILED = "failed"
+    MATERIALIZED = "materialized"
+    SUGGESTION_CONCIERGE_APPROVAL_PENDING = "suggestion_concierge_approval_pending"
+    SUGGESTION_CONCIERGE_APPROVED = "suggestion_concierge_approved"
+    SUGGESTION_CONCIERGE_REJECTED = "suggestion_concierge_rejected"
+    SUGGESTION_MEMBER_REVIEW_PENDING = "suggestion_member_review_pending"
+    SUGGESTION_MEMBER_REJECTED = "suggestion_member_rejected"
+    UNKNOWN = "unknown"
+
+
+class TodoCreatorRole(StrEnum):
+    MEMBER = "member"
+    CONCIERGE = "concierge"
+    VENDOR = "vendor"
+    CASA_AI = "casa_ai"
+    UNKNOWN = "unknown"
+
+
+class TodoLaneCardKind(StrEnum):
+    TODO = "todo"
+    TASK = "task"
+    UNKNOWN = "unknown"
+
+
+class TodoLaneCardState(StrEnum):
+    PREPARING = "preparing"
+    NEEDS_INPUT = "needs_input"
+    READY_FOR_CONCIERGE = "ready_for_concierge"
+    FAILED = "failed"
+    READY_FOR_SCHEDULING = "ready_for_scheduling"
+    UNKNOWN = "unknown"
+
+
+class PackageDirection(StrEnum):
+    INBOUND = "inbound"
+    OUTBOUND = "outbound"
+    UNKNOWN = "unknown"
+
+
+class PackagePickupStatus(StrEnum):
+    AWAITING_PICKUP = "awaiting_pickup"
+    PICKED_UP = "picked_up"
+    DROPPED_OFF = "dropped_off"
+    MISSED_PICKUP = "missed_pickup"
+    UNKNOWN = "unknown"
+
+
+class WeatherCondition(StrEnum):
+    BLIZZARD = "blizzard"
+    BLOWING_SNOW = "blowingSnow"
+    BREEZY = "breezy"
+    CLEAR = "clear"
+    CLOUDY = "cloudy"
+    DRIZZLE = "drizzle"
+    DUST = "dust"
+    FOG = "fog"
+    FREEZING_DRIZZLE = "freezingDrizzle"
+    FREEZING_RAIN = "freezingRain"
+    FLURRIES = "flurries"
+    FRIGID = "frigid"
+    HAIL = "hail"
+    HAZE = "haze"
+    HEAVY_RAIN = "heavyRain"
+    HEAVY_SNOW = "heavySnow"
+    HOT = "hot"
+    HURRICANE = "hurricane"
+    ISOLATED_THUNDERSTORMS = "isolatedThunderstorms"
+    MOSTLY_CLEAR = "mostlyClear"
+    MOSTLY_CLOUDY = "mostlyCloudy"
+    MIXED_RAIN_AND_SLEET = "mixedRainAndSleet"
+    MIXED_RAIN_AND_SNOW = "mixedRainAndSnow"
+    MIXED_RAINFALL = "mixedRainfall"
+    MIXED_SNOW_AND_SLEET = "mixedSnowAndSleet"
+    PARTLY_CLOUDY = "partlyCloudy"
+    RAIN = "rain"
+    SCATTERED_SHOWERS = "scatteredShowers"
+    SCATTERED_SNOW_SHOWERS = "scatteredSnowShowers"
+    SCATTERED_THUNDERSTORMS = "scatteredThunderstorms"
+    SEVERE_THUNDERSTORM = "severeThunderstorm"
+    SHOWERS = "showers"
+    SLEET = "sleet"
+    SMOKE = "smoke"
+    SNOW = "snow"
+    SNOW_SHOWERS = "snowShowers"
+    THUNDERSTORM = "thunderstorm"
+    TORNADO = "tornado"
+    TROPICAL_STORM = "tropicalStorm"
+    WINDY = "windy"
+    UNKNOWN = "unknown"
+
+
+# Lenient field types. ``left_to_right`` makes pydantic try the enum first and
+# fall back to ``str`` for values the app binary didn't know about.
+_LTR = Field(union_mode="left_to_right")
+
+HomeStatusField = Annotated[MemberSimpleHomeStatus | str, _LTR]
+PaymentMethodTypeField = Annotated[PaymentMethodType | str, _LTR]
+RequestTypeField = Annotated[RequestType | str, _LTR]
+RequestStatusField = Annotated[RequestStatus | str, _LTR]
+SenderRoleField = Annotated[SenderRole | str, _LTR]
+VisitTypeField = Annotated[VisitType | str, _LTR]
+VendorVisitStatusField = Annotated[VendorVisitStatus | str, _LTR]
+TodoStatusField = Annotated[TodoStatus | str, _LTR]
+TodoCreatorRoleField = Annotated[TodoCreatorRole | str, _LTR]
+TodoLaneCardKindField = Annotated[TodoLaneCardKind | str, _LTR]
+TodoLaneCardStateField = Annotated[TodoLaneCardState | str, _LTR]
+PackageDirectionField = Annotated[PackageDirection | str, _LTR]
+PackagePickupStatusField = Annotated[PackagePickupStatus | str, _LTR]
+WeatherConditionField = Annotated[WeatherCondition | str, _LTR]

casahome/models/feed.py

@@ -0,0 +1,30 @@
+"""Home feed cards, ``/protected/home/{home_id}/feed``.
+
+VERIFIED by a live GET (2026-10) with ``app_build=698``: an envelope
+``cards`` holding populated items. Every card had the keys modeled below.
+``props`` varies by ``template_id`` (titles, captions, actions, images,
+colors, ``visual_*`` styling, onboarding counts), so it stays a JSON dict.
+``children`` was empty on every observed card. It's typed recursively on the
+assumption children are cards too, which is UNVERIFIED. Unknown fields ride
+along in ``model_extra``.
+"""
+
+from __future__ import annotations
+
+from pydantic import Field, JsonValue
+
+from casahome.models._base import CasaModel
+
+
+class HomeFeedCard(CasaModel):
+    id: str
+    template_id: str
+    name: str
+    props: dict[str, JsonValue] = Field(default_factory=dict)
+    show_starts_at_minutes_after_onboarding: int
+    show_ends_at_minutes_after_onboarding: int | None = None
+    children: list[HomeFeedCard] = Field(default_factory=list)
+
+
+class HomeFeedResponse(CasaModel):
+    cards: list[HomeFeedCard]

casahome/models/help_center.py

@@ -0,0 +1,45 @@
+"""Help center bundle models, inferred from the app.
+
+A populated ``member_ios`` bundle parsed with these models in live traffic
+(2026-10). Because ``populate_by_name``
+accepts either spelling, that doesn't confirm the camelCase aliases are the
+wire keys. No other app ID, article-view tracking or feedback is inferred.
+"""
+
+from pydantic import Field
+
+from casahome.models._base import CasaModel
+
+
+class HelpCenterTopic(CasaModel):
+    id: str
+    slug: str
+    name: str
+    blurb: str
+    system_image: str = Field(alias="systemImage")
+    hero_image_url: str | None = Field(default=None, alias="heroImageURL")
+    sort_order: int = Field(alias="sortOrder")
+
+
+class HelpCenterArticle(CasaModel):
+    id: str
+    topic_id: str = Field(alias="topicId")
+    slug: str
+    sort_order: int = Field(alias="sortOrder")
+    is_top_question: bool = Field(alias="isTopQuestion")
+    is_featured: bool = Field(alias="isFeatured")
+    article_version_id: str = Field(alias="articleVersionId")
+    version_number: int = Field(alias="versionNumber")
+    title: str
+    summary: str
+    body_markdown: str = Field(alias="bodyMarkdown")
+
+
+class HelpCenterBundle(CasaModel):
+    app: str
+    topics: list[HelpCenterTopic]
+    articles: list[HelpCenterArticle]
+
+
+class HelpCenterBundleResponse(CasaModel):
+    data: HelpCenterBundle