chzzk-python 0.1.0__py3-none-any.whl

chzzk/models/live.py

@@ -0,0 +1,78 @@
+"""Pydantic models for Live API."""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+from chzzk.models.common import CategoryType, Page
+
+
+class LiveInfo(BaseModel):
+    """Live broadcast information."""
+
+    live_id: int = Field(alias="liveId")
+    live_title: str = Field(alias="liveTitle")
+    live_thumbnail_image_url: str | None = Field(default=None, alias="liveThumbnailImageUrl")
+    concurrent_user_count: int = Field(alias="concurrentUserCount")
+    open_date: datetime = Field(alias="openDate")
+    adult: bool
+    tags: list[str] = Field(default_factory=list)
+    category_type: CategoryType | None = Field(default=None, alias="categoryType")
+    live_category: str | None = Field(default=None, alias="liveCategory")
+    live_category_value: str | None = Field(default=None, alias="liveCategoryValue")
+    channel_id: str = Field(alias="channelId")
+    channel_name: str = Field(alias="channelName")
+    channel_image_url: str | None = Field(default=None, alias="channelImageUrl")
+
+    model_config = {"populate_by_name": True}
+
+
+class LiveListResponse(BaseModel):
+    """Response model for live list endpoint."""
+
+    data: list[LiveInfo]
+    page: Page
+
+    model_config = {"populate_by_name": True}
+
+
+class StreamKey(BaseModel):
+    """Stream key information."""
+
+    stream_key: str = Field(alias="streamKey")
+
+    model_config = {"populate_by_name": True}
+
+
+class LiveSettingCategory(BaseModel):
+    """Category information in live setting."""
+
+    category_type: CategoryType = Field(alias="categoryType")
+    category_id: str = Field(alias="categoryId")
+    category_value: str = Field(alias="categoryValue")
+    poster_image_url: str | None = Field(default=None, alias="posterImageUrl")
+
+    model_config = {"populate_by_name": True}
+
+
+class LiveSetting(BaseModel):
+    """Live broadcast setting information."""
+
+    default_live_title: str | None = Field(default=None, alias="defaultLiveTitle")
+    category: LiveSettingCategory | None = None
+    tags: list[str] = Field(default_factory=list)
+
+    model_config = {"populate_by_name": True}
+
+
+class UpdateLiveSettingRequest(BaseModel):
+    """Request model for updating live setting."""
+
+    default_live_title: str | None = Field(default=None, serialization_alias="defaultLiveTitle")
+    category_type: CategoryType | None = Field(default=None, serialization_alias="categoryType")
+    category_id: str | None = Field(default=None, serialization_alias="categoryId")
+    tags: list[str] | None = None
+
+    model_config = {"populate_by_name": True}

chzzk/models/restriction.py

@@ -0,0 +1,18 @@
+"""Pydantic models for Restriction API."""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import BaseModel, Field
+
+
+class RestrictedChannel(BaseModel):
+    """Restricted channel information."""
+
+    restricted_channel_id: str = Field(alias="restrictedChannelId")
+    restricted_channel_name: str = Field(alias="restrictedChannelName")
+    release_date: datetime | None = Field(default=None, alias="releaseDate")
+    created_date: datetime = Field(alias="createdDate")
+
+    model_config = {"populate_by_name": True}

chzzk/models/session.py

@@ -0,0 +1,161 @@
+"""Pydantic models for Session API."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import StrEnum
+
+from pydantic import BaseModel, Field
+
+
+class EventType(StrEnum):
+    """Event type enumeration for session events."""
+
+    CHAT = "CHAT"
+    DONATION = "DONATION"
+    SUBSCRIPTION = "SUBSCRIPTION"
+
+
+class SystemMessageType(StrEnum):
+    """System message type enumeration."""
+
+    CONNECTED = "connected"
+    SUBSCRIBED = "subscribed"
+    UNSUBSCRIBED = "unsubscribed"
+    REVOKED = "revoked"
+
+
+class DonationType(StrEnum):
+    """Donation type enumeration."""
+
+    CHAT = "CHAT"
+    VIDEO = "VIDEO"
+
+
+class UserRoleCode(StrEnum):
+    """User role code enumeration."""
+
+    STREAMER = "streamer"
+    COMMON_USER = "common_user"
+    STREAMING_CHANNEL_MANAGER = "streaming_channel_manager"
+    STREAMING_CHAT_MANAGER = "streaming_chat_manager"
+
+
+# API Response Models
+
+
+class SessionAuthResponse(BaseModel):
+    """Response model for session creation (auth)."""
+
+    url: str
+
+    model_config = {"populate_by_name": True}
+
+
+class SubscribedEvent(BaseModel):
+    """Subscribed event information."""
+
+    event_type: EventType = Field(alias="eventType")
+    channel_id: str = Field(alias="channelId")
+
+    model_config = {"populate_by_name": True}
+
+
+class SessionInfo(BaseModel):
+    """Session information."""
+
+    session_key: str = Field(alias="sessionKey")
+    connected_date: datetime = Field(alias="connectedDate")
+    disconnected_date: datetime | None = Field(default=None, alias="disconnectedDate")
+    subscribed_events: list[SubscribedEvent] = Field(default_factory=list, alias="subscribedEvents")
+
+    model_config = {"populate_by_name": True}
+
+
+class SessionListResponse(BaseModel):
+    """Response model for session list."""
+
+    data: list[SessionInfo]
+
+    model_config = {"populate_by_name": True}
+
+
+# Socket.IO Event Models
+
+
+class Badge(BaseModel):
+    """Badge information for chat profile."""
+
+    image_url: str | None = Field(default=None, alias="imageUrl")
+
+    model_config = {"populate_by_name": True}
+
+
+class ChatProfile(BaseModel):
+    """Chat message sender profile."""
+
+    nickname: str
+    badges: list[Badge] = Field(default_factory=list)
+    verified_mark: bool = Field(default=False, alias="verifiedMark")
+
+    model_config = {"populate_by_name": True}
+
+
+class ChatEvent(BaseModel):
+    """Chat event message from Socket.IO."""
+
+    channel_id: str = Field(alias="channelId")
+    sender_channel_id: str = Field(alias="senderChannelId")
+    profile: ChatProfile
+    content: str
+    emojis: dict[str, str] = Field(default_factory=dict)
+    message_time: int = Field(alias="messageTime")
+    user_role_code: UserRoleCode | None = Field(default=None, alias="userRoleCode")
+
+    model_config = {"populate_by_name": True}
+
+
+class DonationEvent(BaseModel):
+    """Donation event message from Socket.IO."""
+
+    channel_id: str = Field(alias="channelId")
+    donation_type: DonationType = Field(alias="donationType")
+    donator_channel_id: str = Field(alias="donatorChannelId")
+    donator_nickname: str = Field(alias="donatorNickname")
+    pay_amount: str = Field(alias="payAmount")
+    donation_text: str = Field(alias="donationText")
+    emojis: dict[str, str] = Field(default_factory=dict)
+
+    model_config = {"populate_by_name": True}
+
+
+class SubscriptionEvent(BaseModel):
+    """Subscription event message from Socket.IO."""
+
+    channel_id: str = Field(alias="channelId")
+    subscriber_channel_id: str = Field(alias="subscriberChannelId")
+    subscriber_nickname: str = Field(alias="subscriberNickname")
+    month: int
+    tier_no: int = Field(alias="tierNo")
+    tier_name: str = Field(alias="tierName")
+
+    model_config = {"populate_by_name": True}
+
+
+class SystemEventData(BaseModel):
+    """System event data."""
+
+    session_key: str | None = Field(default=None, alias="sessionKey")
+    event_type: EventType | None = Field(default=None, alias="eventType")
+    channel_id: str | None = Field(default=None, alias="channelId")
+
+    model_config = {"populate_by_name": True}
+
+
+class SystemEvent(BaseModel):
+    """System event message from Socket.IO."""
+
+    type: SystemMessageType
+    data: SystemEventData | None = None
+
+    model_config = {"populate_by_name": True}

chzzk/models/user.py

@@ -0,0 +1,14 @@
+"""Pydantic models for User API."""
+
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+
+
+class UserInfo(BaseModel):
+    """User information returned from /users/me endpoint."""
+
+    channel_id: str = Field(alias="channelId")
+    channel_name: str = Field(alias="channelName")
+
+    model_config = {"populate_by_name": True}

chzzk/realtime/__init__.py

@@ -0,0 +1,8 @@
+"""Realtime event client for Chzzk SDK."""
+
+from chzzk.realtime.client import AsyncChzzkEventClient, ChzzkEventClient
+
+__all__ = [
+    "AsyncChzzkEventClient",
+    "ChzzkEventClient",
+]