python-casahome 0.2.0__py3-none-any.whl

casahome/models/__init__.py

@@ -0,0 +1,477 @@
+"""Pydantic models for Casa API payloads."""
+
+from ._base import CasaModel
+from .ai import (
+    CasaAIActiveResponse,
+    CasaAIBootstrapResponse,
+    CasaAIConversation,
+    CasaAIMessage,
+    CasaAIMessageFeedback,
+    CasaAIMessagePart,
+    CasaAIMessagesResponse,
+    CasaAIStarterSuggestion,
+)
+from .assets import (
+    HomeMember,
+    HomeMembersResponse,
+    HomeVehicle,
+    ReleaseNote,
+    ReleaseNoteSection,
+    ReleaseNotesResponse,
+    UtilitiesInsightsResponse,
+    UtilityInsightsAccount,
+    UtilityInsightsService,
+    UtilityInsightsStatement,
+    UtilityUsageGraph,
+    UtilityUsageGraphWindow,
+    VehiclePowertrain,
+    VehiclesResponse,
+)
+from .availability import (
+    MemberAvailabilityConstraints,
+    MemberAvailabilityDetail,
+    MemberAvailabilitySlot,
+    MemberAvailabilitySummary,
+)
+from .bootstrap import (
+    AppUpdate,
+    Bootstrap,
+    HomeBadgeCounts,
+    MemberSimpleHome,
+    MemberWaitlistEntry,
+    PendingAgreement,
+    UserDeviceRequest,
+)
+from .calendar import CalendarEvent, VisitsCalendarResponse
+from .catalogs import (
+    InventoryEnumOption,
+    InventoryEnumsResponse,
+    InventoryMakesResponse,
+    RecurringVendor,
+    RecurringVendorCategoriesResponse,
+    RecurringVendorCategory,
+    RecurringVendorsResponse,
+    RoomType,
+    RoomTypesResponse,
+)
+from .credits import ConsumptionHistory, CreditHistory, MemberCredits
+from .documents import (
+    DocumentCitation,
+    DocumentDetailsResponse,
+    DocumentExtraction,
+    DocumentOrganization,
+    DocumentsResponse,
+    DocumentStructureSuggestion,
+    DocumentStructureSuggestionsResponse,
+    DocumentSuggestion,
+    DocumentSuggestionsResponse,
+    DocumentType,
+    DocumentTypesResponse,
+    HomeDocument,
+    WorkDocumentSource,
+    WorkDocumentSourceResponse,
+)
+from .enums import (
+    MemberSimpleHomeStatus,
+    PackageDirection,
+    PackagePickupStatus,
+    PaymentMethodType,
+    RequestStatus,
+    RequestType,
+    SenderRole,
+    TodoCreatorRole,
+    TodoLaneCardKind,
+    TodoLaneCardState,
+    TodoStatus,
+    VendorVisitStatus,
+    VisitType,
+    WeatherCondition,
+)
+from .feed import HomeFeedCard, HomeFeedResponse
+from .help_center import (
+    HelpCenterArticle,
+    HelpCenterBundle,
+    HelpCenterBundleResponse,
+    HelpCenterTopic,
+)
+from .home import (
+    EntityIdentity,
+    EntityImage,
+    EntityMake,
+    EntityModel,
+    EntityProperty,
+    HomeDetails,
+    HomeDetailsResponse,
+    HomeRoom,
+    HomeStory,
+    ModelProperty,
+    PropertyValue,
+    SimpleEntity,
+    WeatherResponse,
+)
+from .images import (
+    MatterportImage,
+    MatterportImagesResponse,
+    MediaAttachment,
+    RoomImageCandidate,
+    RoomImageOptionsResponse,
+    RoomMemberImage,
+)
+from .mailbox import (
+    MailboxMailItem,
+    MailboxMailItemsResponse,
+    MailboxOverviewResponse,
+    MemberMailbox,
+    PackageItem,
+    PackagesResponse,
+)
+from .maintenance import (
+    AutopilotCategoriesResponse,
+    AutopilotCategory,
+    AutopilotEntityAssociation,
+    AutopilotHomeAssociation,
+    AutopilotIllustration,
+    AutopilotIneligiblePlan,
+    AutopilotPlan,
+    AutopilotPlanRequirement,
+    AutopilotPricingPolicy,
+    AutopilotRequirementOption,
+    AutopilotRequirementProperty,
+    AutopilotRequirementRoomCandidate,
+    AutopilotRequirementRoomProperty,
+    AutopilotRoomAssociation,
+    CalendarBusyBlock,
+    CalendarBusyResponse,
+    CompletedRequestsResponse,
+    InventoryServiceHistoryResponse,
+    ServiceHistoryItem,
+    ServiceHistoryPlan,
+)
+from .membership import (
+    MembershipBenefit,
+    MembershipDetails,
+    MembershipSavings,
+    MembershipSavingsBreakdown,
+    MembershipSavingsCategory,
+    MembershipSavingsMetadata,
+    MembershipSavingsSummary,
+)
+from .paint import (
+    InventoryPaintMatch,
+    InventoryPaintMatchesResponse,
+    PaintBrand,
+    PaintBrandsResponse,
+    PaintCollection,
+    PaintCollectionsResponse,
+    PaintColor,
+    PaintColorsResponse,
+    PaintSearchResponse,
+)
+from .preferences import (
+    AccessPreferencesResponse,
+    CalendarOption,
+    CalendarSyncResponse,
+    NotificationChannel,
+    NotificationGroup,
+    NotificationSettingsResponse,
+    NotificationType,
+    OnboardingAvailabilityResponse,
+    OnboardingDetailsResponse,
+    OnboardingEvent,
+    OnboardingSlot,
+    SchedulePreferencesResponse,
+    SchedulingDay,
+    SchedulingTimeOfDay,
+)
+from .purchases import (
+    ApprovedPurchase,
+    PurchaseApproval,
+    PurchasedItem,
+    PurchaseInvoice,
+    PurchasesResponse,
+    PurchaseVendor,
+    RequestPurchase,
+    ScopedPurchasesResponse,
+)
+from .read_todos import SuggestedTodosResponse, TodoDetailsResponse, TodoReadDetail
+from .referral import ReferralCode, ReferralCodeResponse
+from .requests import (
+    Pagination,
+    RequestCard,
+    RequestDetails,
+    RequestMessage,
+    RequestsLane,
+    RequestsResponse,
+    TasksLane,
+    TodosLane,
+    VendorVisit,
+)
+from .tasks import (
+    BookableHandymanTasksResponse,
+    GroupedTaskDetails,
+    GroupedTaskItem,
+    TaskDetails,
+    TaskDetailsVisit,
+    TaskUpdate,
+    VendorVisitAutopilotPlan,
+    VendorVisitAutopilotTaskTarget,
+)
+from .taxes import (
+    PropertyTaxesResponse,
+    PropertyTaxInstallment,
+    PropertyTaxRefresh,
+    PropertyTaxReport,
+    PropertyTaxSpecialAssessment,
+)
+from .todos import TodoDetail, TodoLaneCard
+from .visits import (
+    MemberInvoicePreview,
+    VendorVisitDetails,
+    VendorVisitMessagePreview,
+    VendorVisitRequestSummary,
+    VisitCall,
+    VisitCallParticipant,
+    VisitCallsResponse,
+    VisitConversation,
+    VisitConversationCounterparty,
+    VisitConversationLatestMessage,
+    VisitConversationLiveCall,
+    VisitConversationMessage,
+    VisitConversationParticipant,
+    VisitConversationSummary,
+    VisitConversationWindow,
+    VisitDetailVendor,
+)
+from .write_contracts import (
+    AttachMediaPayload,
+    BasicMessageResponse,
+    CreateTodoBody,
+    CreateTodoResponse,
+    SendRequestMessageRequest,
+    SendRequestMessageResponse,
+    UpdateEntityPropertiesRequest,
+    UpdateEntityProperty,
+    UpdateMultiEnumProperty,
+)
+
+__all__ = [
+    "AccessPreferencesResponse",
+    "AppUpdate",
+    "ApprovedPurchase",
+    "AttachMediaPayload",
+    "AutopilotCategoriesResponse",
+    "AutopilotCategory",
+    "AutopilotEntityAssociation",
+    "AutopilotHomeAssociation",
+    "AutopilotIllustration",
+    "AutopilotIneligiblePlan",
+    "AutopilotPlan",
+    "AutopilotPlanRequirement",
+    "AutopilotPricingPolicy",
+    "AutopilotRequirementOption",
+    "AutopilotRequirementProperty",
+    "AutopilotRequirementRoomCandidate",
+    "AutopilotRequirementRoomProperty",
+    "AutopilotRoomAssociation",
+    "BasicMessageResponse",
+    "BookableHandymanTasksResponse",
+    "Bootstrap",
+    "CalendarBusyBlock",
+    "CalendarBusyResponse",
+    "CalendarEvent",
+    "CalendarOption",
+    "CalendarSyncResponse",
+    "CasaAIActiveResponse",
+    "CasaAIBootstrapResponse",
+    "CasaAIConversation",
+    "CasaAIMessage",
+    "CasaAIMessageFeedback",
+    "CasaAIMessagePart",
+    "CasaAIMessagesResponse",
+    "CasaAIStarterSuggestion",
+    "CasaModel",
+    "CompletedRequestsResponse",
+    "ConsumptionHistory",
+    "CreateTodoBody",
+    "CreateTodoResponse",
+    "CreditHistory",
+    "DocumentCitation",
+    "DocumentDetailsResponse",
+    "DocumentExtraction",
+    "DocumentOrganization",
+    "DocumentStructureSuggestion",
+    "DocumentStructureSuggestionsResponse",
+    "DocumentSuggestion",
+    "DocumentSuggestionsResponse",
+    "DocumentType",
+    "DocumentTypesResponse",
+    "DocumentsResponse",
+    "EntityIdentity",
+    "EntityImage",
+    "EntityMake",
+    "EntityModel",
+    "EntityProperty",
+    "GroupedTaskDetails",
+    "GroupedTaskItem",
+    "HelpCenterArticle",
+    "HelpCenterBundle",
+    "HelpCenterBundleResponse",
+    "HelpCenterTopic",
+    "HomeBadgeCounts",
+    "HomeDetails",
+    "HomeDetailsResponse",
+    "HomeDocument",
+    "HomeFeedCard",
+    "HomeFeedResponse",
+    "HomeMember",
+    "HomeMembersResponse",
+    "HomeRoom",
+    "HomeStory",
+    "HomeVehicle",
+    "InventoryEnumOption",
+    "InventoryEnumsResponse",
+    "InventoryMakesResponse",
+    "InventoryPaintMatch",
+    "InventoryPaintMatchesResponse",
+    "InventoryServiceHistoryResponse",
+    "MailboxMailItem",
+    "MailboxMailItemsResponse",
+    "MailboxOverviewResponse",
+    "MatterportImage",
+    "MatterportImagesResponse",
+    "MediaAttachment",
+    "MemberAvailabilityConstraints",
+    "MemberAvailabilityDetail",
+    "MemberAvailabilitySlot",
+    "MemberAvailabilitySummary",
+    "MemberCredits",
+    "MemberInvoicePreview",
+    "MemberMailbox",
+    "MemberSimpleHome",
+    "MemberSimpleHomeStatus",
+    "MemberWaitlistEntry",
+    "MembershipBenefit",
+    "MembershipDetails",
+    "MembershipSavings",
+    "MembershipSavingsBreakdown",
+    "MembershipSavingsCategory",
+    "MembershipSavingsMetadata",
+    "MembershipSavingsSummary",
+    "ModelProperty",
+    "NotificationChannel",
+    "NotificationGroup",
+    "NotificationSettingsResponse",
+    "NotificationType",
+    "OnboardingAvailabilityResponse",
+    "OnboardingDetailsResponse",
+    "OnboardingEvent",
+    "OnboardingSlot",
+    "PackageDirection",
+    "PackageItem",
+    "PackagePickupStatus",
+    "PackagesResponse",
+    "Pagination",
+    "PaintBrand",
+    "PaintBrandsResponse",
+    "PaintCollection",
+    "PaintCollectionsResponse",
+    "PaintColor",
+    "PaintColorsResponse",
+    "PaintSearchResponse",
+    "PaymentMethodType",
+    "PendingAgreement",
+    "PropertyTaxInstallment",
+    "PropertyTaxRefresh",
+    "PropertyTaxReport",
+    "PropertyTaxSpecialAssessment",
+    "PropertyTaxesResponse",
+    "PropertyValue",
+    "PurchaseApproval",
+    "PurchaseInvoice",
+    "PurchaseVendor",
+    "PurchasedItem",
+    "PurchasesResponse",
+    "RecurringVendor",
+    "RecurringVendorCategoriesResponse",
+    "RecurringVendorCategory",
+    "RecurringVendorsResponse",
+    "ReferralCode",
+    "ReferralCodeResponse",
+    "ReleaseNote",
+    "ReleaseNoteSection",
+    "ReleaseNotesResponse",
+    "RequestCard",
+    "RequestDetails",
+    "RequestMessage",
+    "RequestPurchase",
+    "RequestStatus",
+    "RequestType",
+    "RequestsLane",
+    "RequestsResponse",
+    "RoomImageCandidate",
+    "RoomImageOptionsResponse",
+    "RoomMemberImage",
+    "RoomType",
+    "RoomTypesResponse",
+    "SchedulePreferencesResponse",
+    "SchedulingDay",
+    "SchedulingTimeOfDay",
+    "ScopedPurchasesResponse",
+    "SendRequestMessageRequest",
+    "SendRequestMessageResponse",
+    "SenderRole",
+    "ServiceHistoryItem",
+    "ServiceHistoryPlan",
+    "SimpleEntity",
+    "SuggestedTodosResponse",
+    "TaskDetails",
+    "TaskDetailsVisit",
+    "TaskUpdate",
+    "TasksLane",
+    "TodoCreatorRole",
+    "TodoDetail",
+    "TodoDetailsResponse",
+    "TodoLaneCard",
+    "TodoLaneCardKind",
+    "TodoLaneCardState",
+    "TodoReadDetail",
+    "TodoStatus",
+    "TodosLane",
+    "UpdateEntityPropertiesRequest",
+    "UpdateEntityProperty",
+    "UpdateMultiEnumProperty",
+    "UserDeviceRequest",
+    "UtilitiesInsightsResponse",
+    "UtilityInsightsAccount",
+    "UtilityInsightsService",
+    "UtilityInsightsStatement",
+    "UtilityUsageGraph",
+    "UtilityUsageGraphWindow",
+    "VehiclePowertrain",
+    "VehiclesResponse",
+    "VendorVisit",
+    "VendorVisitAutopilotPlan",
+    "VendorVisitAutopilotTaskTarget",
+    "VendorVisitDetails",
+    "VendorVisitMessagePreview",
+    "VendorVisitRequestSummary",
+    "VendorVisitStatus",
+    "VisitCall",
+    "VisitCallParticipant",
+    "VisitCallsResponse",
+    "VisitConversation",
+    "VisitConversationCounterparty",
+    "VisitConversationLatestMessage",
+    "VisitConversationLiveCall",
+    "VisitConversationMessage",
+    "VisitConversationParticipant",
+    "VisitConversationSummary",
+    "VisitConversationWindow",
+    "VisitDetailVendor",
+    "VisitType",
+    "VisitsCalendarResponse",
+    "WeatherCondition",
+    "WeatherResponse",
+    "WorkDocumentSource",
+    "WorkDocumentSourceResponse",
+]

casahome/models/_base.py

@@ -0,0 +1,25 @@
+"""Shared model base and helpers."""
+
+from __future__ import annotations
+
+from datetime import UTC, datetime
+
+from pydantic import BaseModel, ConfigDict
+
+
+class CasaModel(BaseModel):
+    """Base for all Casa wire models.
+
+    ``extra="allow"`` is deliberate. Casa ships new fields constantly, and the
+    library must not break when it does. Unknown fields ride along in
+    ``model_extra``.
+    """
+
+    model_config = ConfigDict(extra="allow", populate_by_name=True, frozen=False)
+
+
+def epoch_to_dt(value: int | None) -> datetime | None:
+    """Convert Casa's epoch-second integers to aware UTC datetimes."""
+    if value is None:
+        return None
+    return datetime.fromtimestamp(value, tz=UTC)

casahome/models/ai.py

@@ -0,0 +1,58 @@
+"""Casa AI reads only. Message and active-response schemas are UNVERIFIED.
+
+Static message-part payloads are tagged unions with unresolved wire encoding.
+They remain JSON values rather than guessed discriminated models.
+"""
+
+from pydantic import Field, JsonValue
+
+from casahome.models._base import CasaModel
+from casahome.models.images import MediaAttachment
+
+
+class CasaAIConversation(CasaModel):
+    id: str
+
+
+class CasaAIStarterSuggestion(CasaModel):
+    prompt: str
+    system_image: str | None = None
+
+
+class CasaAIMessagePart(CasaModel):
+    id: str | None = None
+    payload: JsonValue = None
+
+
+class CasaAIMessageFeedback(CasaModel):
+    rating: str | None = None
+
+
+class CasaAIMessage(CasaModel):
+    id: str | None = None
+    content: str | None = None
+    sender_role: str | None = None
+    created_at: int | None = None
+    parts: list[CasaAIMessagePart] = Field(default_factory=list)
+    attachments: list[MediaAttachment] = Field(default_factory=list)
+    feedback: CasaAIMessageFeedback | None = None
+
+
+class CasaAIMessagesResponse(CasaModel):
+    items: list[CasaAIMessage]
+    next_cursor: str | None = None
+
+
+class CasaAIActiveResponse(CasaModel):
+    message_id: str | None = None
+    status_message: str | None = None
+    parts: list[CasaAIMessagePart] = Field(default_factory=list)
+
+
+class CasaAIBootstrapResponse(CasaModel):
+    conversation: CasaAIConversation | None
+    messages: CasaAIMessagesResponse
+    active_response: CasaAIActiveResponse | None
+    starter_suggestions: list[CasaAIStarterSuggestion]
+    event_cursor: str | None = None
+    send_to_human_target_message_id: str | None = None

casahome/models/assets.py

@@ -0,0 +1,123 @@
+"""Members, vehicles, utilities, and release notes.
+
+Vehicles and utility services were empty. Their optional item fields are known
+from static Codable metadata. Vehicle readings remain opaque JSON until observed.
+"""
+
+from pydantic import Field, JsonValue
+
+from casahome.models._base import CasaModel
+
+
+class HomeMember(CasaModel):
+    id: str
+    first_name: str
+    last_name: str
+    user_id: str | None = None
+    phone: str | None = None
+    email: str | None = None
+    gender: str | None = None
+    date_of_birth: str | None = None
+    relationship_to_primary: str | None = None
+    avatar_url: str | None = None
+    avatar_url_cache_key: str | None = None
+    expires_at: int | None = None
+
+
+class HomeMembersResponse(CasaModel):
+    members: list[HomeMember]
+
+
+class VehiclePowertrain(CasaModel):
+    type: str | None = None
+    display_name: str | None = None
+
+
+class HomeVehicle(CasaModel):
+    id: str | None = None
+    home_id: str | None = None
+    status: str | None = None
+    make: str | None = None
+    model: str | None = None
+    year: int | None = None
+    display_name: str | None = None
+    vin: str | None = None
+    powertrain: VehiclePowertrain | None = None
+    permissions: list[str] = Field(default_factory=list)
+    last_synced_at: str | None = None
+    last_successful_sync_at: str | None = None
+    readings: JsonValue = None
+
+
+class VehiclesResponse(CasaModel):
+    vehicles: list[HomeVehicle]
+
+
+class UtilityInsightsStatement(CasaModel):
+    id: str | None = None
+    ends_at: int | None = None
+    total_amount_usd_due: float | None = None
+    service_usage_amount: float | None = None
+    service_amount_usd: float | None = None
+
+
+class UtilityUsageGraphWindow(CasaModel):
+    id: str | None = None
+    starts_at: int | None = None
+    ends_at: int | None = None
+    usage_values: list[float] = Field(default_factory=list)
+
+
+class UtilityUsageGraph(CasaModel):
+    id: str | None = None
+    period: str | None = None
+    windows: list[UtilityUsageGraphWindow] = Field(default_factory=list)
+
+
+class UtilityInsightsAccount(CasaModel):
+    id: str | None = None
+    account_number: str | None = None
+    address_line: str | None = None
+    address_location: str | None = None
+    provider_name: str | None = None
+    image_url: str | None = None
+    image_url_cache_key: str | None = None
+    is_selected: bool | None = None
+    service_types: list[str] = Field(default_factory=list)
+    credential_status: str | None = None
+
+
+class UtilityInsightsService(CasaModel):
+    id: str | None = None
+    service_type: str | None = None
+    usage_unit: str | None = None
+    statements: list[UtilityInsightsStatement] = Field(default_factory=list)
+    interval_graphs: list[UtilityUsageGraph] = Field(default_factory=list)
+    accounts: list[UtilityInsightsAccount] = Field(default_factory=list)
+
+
+class UtilitiesInsightsResponse(CasaModel):
+    services: list[UtilityInsightsService]
+
+
+class ReleaseNoteSection(CasaModel):
+    id: str
+    content: str
+    title: str | None = None
+    hero_image_url: str | None = None
+
+
+class ReleaseNote(CasaModel):
+    id: str
+    title: str
+    version: str
+    date: int
+    min_build_number: int
+    sections: list[ReleaseNoteSection]
+    max_build_number: int | None = None
+    prelude: str | None = None
+    hero_image_url: str | None = None
+
+
+class ReleaseNotesResponse(CasaModel):
+    data: list[ReleaseNote]