chzzk-python 0.1.0__py3-none-any.whl

chzzk/api/chat.py

@@ -0,0 +1,239 @@
+"""Chat API service for Chzzk."""
+
+from __future__ import annotations
+
+from chzzk.api.base import AsyncBaseService, BaseService
+from chzzk.http import CHAT_NOTICE_URL, CHAT_SEND_URL, CHAT_SETTINGS_URL
+from chzzk.models.chat import (
+    ChatAvailableCondition,
+    ChatAvailableGroup,
+    ChatMessageResponse,
+    ChatSettings,
+    UpdateChatSettingsRequest,
+)
+
+
+class ChatService(BaseService):
+    """Synchronous Chat API service.
+
+    Provides access to chat-related API endpoints.
+    """
+
+    def send_message(self, message: str) -> ChatMessageResponse:
+        """Send a chat message.
+
+        Args:
+            message: The message to send.
+
+        Returns:
+            ChatMessageResponse containing the message ID.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = self._http.post(
+            CHAT_SEND_URL,
+            json={"message": message},
+            headers=self._get_token_headers(),
+        )
+        return ChatMessageResponse.model_validate(data)
+
+    def register_notice(
+        self,
+        *,
+        message: str | None = None,
+        message_id: str | None = None,
+    ) -> None:
+        """Register a chat notice.
+
+        Either message or message_id must be provided.
+
+        Args:
+            message: The notice message content.
+            message_id: The message ID to use as notice.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+            ValueError: If neither message nor message_id is provided.
+        """
+        if message is None and message_id is None:
+            msg = "Either message or message_id must be provided"
+            raise ValueError(msg)
+
+        payload: dict[str, str] = {}
+        if message is not None:
+            payload["message"] = message
+        if message_id is not None:
+            payload["messageId"] = message_id
+
+        self._http.post(
+            CHAT_NOTICE_URL,
+            json=payload,
+            headers=self._get_token_headers(),
+        )
+
+    def get_settings(self) -> ChatSettings:
+        """Get chat settings.
+
+        Returns:
+            ChatSettings object containing the chat configuration.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = self._http.get(CHAT_SETTINGS_URL, headers=self._get_token_headers())
+        return ChatSettings.model_validate(data)
+
+    def update_settings(
+        self,
+        *,
+        chat_available_condition: ChatAvailableCondition | None = None,
+        chat_available_group: ChatAvailableGroup | None = None,
+        allow_subscriber_in_follower_mode: bool | None = None,
+        min_follower_minute: int | None = None,
+        chat_emoji_mode: bool | None = None,
+        chat_slow_mode_sec: int | None = None,
+    ) -> None:
+        """Update chat settings.
+
+        Args:
+            chat_available_condition: Chat availability condition.
+            chat_available_group: Chat availability group.
+            allow_subscriber_in_follower_mode: Allow subscribers in follower-only mode.
+            min_follower_minute: Minimum follower minutes required.
+            chat_emoji_mode: Enable emoji-only mode.
+            chat_slow_mode_sec: Slow mode delay in seconds.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        request = UpdateChatSettingsRequest(
+            chat_available_condition=chat_available_condition,
+            chat_available_group=chat_available_group,
+            allow_subscriber_in_follower_mode=allow_subscriber_in_follower_mode,
+            min_follower_minute=min_follower_minute,
+            chat_emoji_mode=chat_emoji_mode,
+            chat_slow_mode_sec=chat_slow_mode_sec,
+        )
+        self._http.put(
+            CHAT_SETTINGS_URL,
+            json=request.model_dump(by_alias=True, exclude_none=True),
+            headers=self._get_token_headers(),
+        )
+
+
+class AsyncChatService(AsyncBaseService):
+    """Asynchronous Chat API service.
+
+    Provides access to chat-related API endpoints.
+    """
+
+    async def send_message(self, message: str) -> ChatMessageResponse:
+        """Send a chat message.
+
+        Args:
+            message: The message to send.
+
+        Returns:
+            ChatMessageResponse containing the message ID.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = await self._http.post(
+            CHAT_SEND_URL,
+            json={"message": message},
+            headers=await self._get_token_headers(),
+        )
+        return ChatMessageResponse.model_validate(data)
+
+    async def register_notice(
+        self,
+        *,
+        message: str | None = None,
+        message_id: str | None = None,
+    ) -> None:
+        """Register a chat notice.
+
+        Either message or message_id must be provided.
+
+        Args:
+            message: The notice message content.
+            message_id: The message ID to use as notice.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+            ValueError: If neither message nor message_id is provided.
+        """
+        if message is None and message_id is None:
+            msg = "Either message or message_id must be provided"
+            raise ValueError(msg)
+
+        payload: dict[str, str] = {}
+        if message is not None:
+            payload["message"] = message
+        if message_id is not None:
+            payload["messageId"] = message_id
+
+        await self._http.post(
+            CHAT_NOTICE_URL,
+            json=payload,
+            headers=await self._get_token_headers(),
+        )
+
+    async def get_settings(self) -> ChatSettings:
+        """Get chat settings.
+
+        Returns:
+            ChatSettings object containing the chat configuration.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = await self._http.get(CHAT_SETTINGS_URL, headers=await self._get_token_headers())
+        return ChatSettings.model_validate(data)
+
+    async def update_settings(
+        self,
+        *,
+        chat_available_condition: ChatAvailableCondition | None = None,
+        chat_available_group: ChatAvailableGroup | None = None,
+        allow_subscriber_in_follower_mode: bool | None = None,
+        min_follower_minute: int | None = None,
+        chat_emoji_mode: bool | None = None,
+        chat_slow_mode_sec: int | None = None,
+    ) -> None:
+        """Update chat settings.
+
+        Args:
+            chat_available_condition: Chat availability condition.
+            chat_available_group: Chat availability group.
+            allow_subscriber_in_follower_mode: Allow subscribers in follower-only mode.
+            min_follower_minute: Minimum follower minutes required.
+            chat_emoji_mode: Enable emoji-only mode.
+            chat_slow_mode_sec: Slow mode delay in seconds.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        request = UpdateChatSettingsRequest(
+            chat_available_condition=chat_available_condition,
+            chat_available_group=chat_available_group,
+            allow_subscriber_in_follower_mode=allow_subscriber_in_follower_mode,
+            min_follower_minute=min_follower_minute,
+            chat_emoji_mode=chat_emoji_mode,
+            chat_slow_mode_sec=chat_slow_mode_sec,
+        )
+        await self._http.put(
+            CHAT_SETTINGS_URL,
+            json=request.model_dump(by_alias=True, exclude_none=True),
+            headers=await self._get_token_headers(),
+        )

chzzk/api/live.py

@@ -0,0 +1,212 @@
+"""Live API service for Chzzk."""
+
+from __future__ import annotations
+
+from chzzk.api.base import AsyncBaseService, BaseService
+from chzzk.http import LIVE_SETTING_URL, LIVES_URL, STREAM_KEY_URL
+from chzzk.models.common import CategoryType
+from chzzk.models.live import (
+    LiveInfo,
+    LiveListResponse,
+    LiveSetting,
+    StreamKey,
+    UpdateLiveSettingRequest,
+)
+
+
+class LiveService(BaseService):
+    """Synchronous Live API service.
+
+    Provides access to live broadcast-related API endpoints.
+    """
+
+    def get_lives(
+        self,
+        *,
+        size: int = 20,
+        next_token: str | None = None,
+    ) -> LiveListResponse:
+        """Get a list of live broadcasts.
+
+        Args:
+            size: Number of results per page.
+            next_token: Pagination token for the next page.
+
+        Returns:
+            LiveListResponse containing list of LiveInfo and pagination info.
+
+        Raises:
+            ChzzkAPIError: If the API request fails.
+        """
+        params: dict[str, str | int] = {"size": size}
+        if next_token:
+            params["next"] = next_token
+
+        data = self._http.get(
+            LIVES_URL,
+            params=params,
+            headers=self._get_client_headers(),
+        )
+
+        lives = [LiveInfo.model_validate(item) for item in data.get("data", [])]
+        page_data = data.get("page", {})
+        from chzzk.models.common import Page
+
+        return LiveListResponse(data=lives, page=Page.model_validate(page_data))
+
+    def get_stream_key(self) -> StreamKey:
+        """Get the stream key for the authenticated user's channel.
+
+        Returns:
+            StreamKey object containing the stream key.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = self._http.get(STREAM_KEY_URL, headers=self._get_token_headers())
+        return StreamKey.model_validate(data)
+
+    def get_setting(self) -> LiveSetting:
+        """Get the live broadcast setting for the authenticated user's channel.
+
+        Returns:
+            LiveSetting object containing the broadcast settings.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = self._http.get(LIVE_SETTING_URL, headers=self._get_token_headers())
+        return LiveSetting.model_validate(data)
+
+    def update_setting(
+        self,
+        *,
+        default_live_title: str | None = None,
+        category_type: CategoryType | None = None,
+        category_id: str | None = None,
+        tags: list[str] | None = None,
+    ) -> None:
+        """Update the live broadcast setting.
+
+        Args:
+            default_live_title: Default title for the broadcast.
+            category_type: Category type.
+            category_id: Category ID.
+            tags: List of tags for the broadcast.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        request = UpdateLiveSettingRequest(
+            default_live_title=default_live_title,
+            category_type=category_type,
+            category_id=category_id,
+            tags=tags,
+        )
+        self._http.patch(
+            LIVE_SETTING_URL,
+            json=request.model_dump(by_alias=True, exclude_none=True),
+            headers=self._get_token_headers(),
+        )
+
+
+class AsyncLiveService(AsyncBaseService):
+    """Asynchronous Live API service.
+
+    Provides access to live broadcast-related API endpoints.
+    """
+
+    async def get_lives(
+        self,
+        *,
+        size: int = 20,
+        next_token: str | None = None,
+    ) -> LiveListResponse:
+        """Get a list of live broadcasts.
+
+        Args:
+            size: Number of results per page.
+            next_token: Pagination token for the next page.
+
+        Returns:
+            LiveListResponse containing list of LiveInfo and pagination info.
+
+        Raises:
+            ChzzkAPIError: If the API request fails.
+        """
+        params: dict[str, str | int] = {"size": size}
+        if next_token:
+            params["next"] = next_token
+
+        data = await self._http.get(
+            LIVES_URL,
+            params=params,
+            headers=self._get_client_headers(),
+        )
+
+        lives = [LiveInfo.model_validate(item) for item in data.get("data", [])]
+        page_data = data.get("page", {})
+        from chzzk.models.common import Page
+
+        return LiveListResponse(data=lives, page=Page.model_validate(page_data))
+
+    async def get_stream_key(self) -> StreamKey:
+        """Get the stream key for the authenticated user's channel.
+
+        Returns:
+            StreamKey object containing the stream key.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = await self._http.get(STREAM_KEY_URL, headers=await self._get_token_headers())
+        return StreamKey.model_validate(data)
+
+    async def get_setting(self) -> LiveSetting:
+        """Get the live broadcast setting for the authenticated user's channel.
+
+        Returns:
+            LiveSetting object containing the broadcast settings.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        data = await self._http.get(LIVE_SETTING_URL, headers=await self._get_token_headers())
+        return LiveSetting.model_validate(data)
+
+    async def update_setting(
+        self,
+        *,
+        default_live_title: str | None = None,
+        category_type: CategoryType | None = None,
+        category_id: str | None = None,
+        tags: list[str] | None = None,
+    ) -> None:
+        """Update the live broadcast setting.
+
+        Args:
+            default_live_title: Default title for the broadcast.
+            category_type: Category type.
+            category_id: Category ID.
+            tags: List of tags for the broadcast.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        request = UpdateLiveSettingRequest(
+            default_live_title=default_live_title,
+            category_type=category_type,
+            category_id=category_id,
+            tags=tags,
+        )
+        await self._http.patch(
+            LIVE_SETTING_URL,
+            json=request.model_dump(by_alias=True, exclude_none=True),
+            headers=await self._get_token_headers(),
+        )

chzzk/api/restriction.py

@@ -0,0 +1,147 @@
+"""Restriction API service for Chzzk."""
+
+from __future__ import annotations
+
+from chzzk.api.base import AsyncBaseService, BaseService
+from chzzk.http import RESTRICT_CHANNELS_URL
+from chzzk.models.restriction import RestrictedChannel
+
+
+class RestrictionService(BaseService):
+    """Synchronous Restriction API service.
+
+    Provides access to restriction-related API endpoints.
+    """
+
+    def get_list(
+        self,
+        *,
+        size: int = 20,
+        next_token: str | None = None,
+    ) -> list[RestrictedChannel]:
+        """Get the list of restricted channels.
+
+        Args:
+            size: Number of results per page.
+            next_token: Pagination token for the next page.
+
+        Returns:
+            List of RestrictedChannel objects.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        params: dict[str, str | int] = {"size": size}
+        if next_token:
+            params["next"] = next_token
+
+        data = self._http.get(
+            RESTRICT_CHANNELS_URL,
+            params=params,
+            headers=self._get_token_headers(),
+        )
+        channels = data.get("data", [])
+        return [RestrictedChannel.model_validate(item) for item in channels]
+
+    def add(self, target_channel_id: str) -> None:
+        """Add a channel to the restriction list.
+
+        Args:
+            target_channel_id: The channel ID to restrict.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        self._http.post(
+            RESTRICT_CHANNELS_URL,
+            json={"targetChannelId": target_channel_id},
+            headers=self._get_token_headers(),
+        )
+
+    def remove(self, target_channel_id: str) -> None:
+        """Remove a channel from the restriction list.
+
+        Args:
+            target_channel_id: The channel ID to unrestrict.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        self._http.delete(
+            RESTRICT_CHANNELS_URL,
+            json={"targetChannelId": target_channel_id},
+            headers=self._get_token_headers(),
+        )
+
+
+class AsyncRestrictionService(AsyncBaseService):
+    """Asynchronous Restriction API service.
+
+    Provides access to restriction-related API endpoints.
+    """
+
+    async def get_list(
+        self,
+        *,
+        size: int = 20,
+        next_token: str | None = None,
+    ) -> list[RestrictedChannel]:
+        """Get the list of restricted channels.
+
+        Args:
+            size: Number of results per page.
+            next_token: Pagination token for the next page.
+
+        Returns:
+            List of RestrictedChannel objects.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        params: dict[str, str | int] = {"size": size}
+        if next_token:
+            params["next"] = next_token
+
+        data = await self._http.get(
+            RESTRICT_CHANNELS_URL,
+            params=params,
+            headers=await self._get_token_headers(),
+        )
+        channels = data.get("data", [])
+        return [RestrictedChannel.model_validate(item) for item in channels]
+
+    async def add(self, target_channel_id: str) -> None:
+        """Add a channel to the restriction list.
+
+        Args:
+            target_channel_id: The channel ID to restrict.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        await self._http.post(
+            RESTRICT_CHANNELS_URL,
+            json={"targetChannelId": target_channel_id},
+            headers=await self._get_token_headers(),
+        )
+
+    async def remove(self, target_channel_id: str) -> None:
+        """Remove a channel from the restriction list.
+
+        Args:
+            target_channel_id: The channel ID to unrestrict.
+
+        Raises:
+            InvalidTokenError: If the access token is invalid.
+            ChzzkAPIError: If the API request fails.
+        """
+        await self._http.delete(
+            RESTRICT_CHANNELS_URL,
+            json={"targetChannelId": target_channel_id},
+            headers=await self._get_token_headers(),
+        )