Skip to content

Commit ec4dacb

Browse files
chore: add missing docstrings
1 parent 9a11f98 commit ec4dacb

File tree

7 files changed

+14
-0
lines changed

7 files changed

+14
-0
lines changed

src/beeper_desktop_api/types/account.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010

1111
class Account(BaseModel):
12+
"""A chat account added to Beeper"""
13+
1214
account_id: str = FieldInfo(alias="accountID")
1315
"""Chat account added to Beeper. Use this to route account-scoped actions."""
1416

src/beeper_desktop_api/types/chat.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414

1515
class Participants(BaseModel):
16+
"""Chat participants information."""
17+
1618
has_more: bool = FieldInfo(alias="hasMore")
1719
"""True if there are more participants than included in items."""
1820

src/beeper_desktop_api/types/chats/reminder_create_params.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ class ReminderCreateParams(TypedDict, total=False):
1515

1616

1717
class Reminder(TypedDict, total=False):
18+
"""Reminder configuration"""
19+
1820
remind_at_ms: Required[Annotated[float, PropertyInfo(alias="remindAtMs")]]
1921
"""Unix timestamp in milliseconds when reminder should trigger"""
2022

src/beeper_desktop_api/types/focus_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,7 @@
66

77

88
class FocusResponse(BaseModel):
9+
"""Response indicating successful app focus action."""
10+
911
success: bool
1012
"""Whether the app was successfully opened/focused."""

src/beeper_desktop_api/types/shared/attachment.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212

1313
class Size(BaseModel):
14+
"""Pixel dimensions of the attachment: width/height in px."""
15+
1416
height: Optional[float] = None
1517

1618
width: Optional[float] = None

src/beeper_desktop_api/types/shared/error.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ class DetailsIssuesIssue(BaseModel):
2020

2121

2222
class DetailsIssues(BaseModel):
23+
"""Validation error details"""
24+
2325
issues: List[DetailsIssuesIssue]
2426
"""List of validation issues"""
2527

src/beeper_desktop_api/types/shared/user.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111

1212
class User(BaseModel):
13+
"""User the account belongs to."""
14+
1315
id: str
1416
"""Stable Beeper user ID. Use as the primary key when referencing a person."""
1517

0 commit comments

Comments
 (0)