Update pytest code, Add cancel_scheduled_message method in message_service.py, Fix errors in rcs_options.py

Author: Palbahngmiyine

solapi/lib/string_date_transfer.py

@@ -80,9 +80,15 @@ def string_date_transfer(value: Union[str, datetime]):
     if isinstance(value, str):
         try:
             value = parse_iso(value)
-        except Exception as e:
-            raise InvalidDateError("Invalid Date") from e
-
+        except InvalidDateError:  # parse_iso가 실패한 경우
+            try:
+                # "YYYY-MM-DD HH:MM:SS" 형식 시도
+                value = datetime.strptime(value, "%Y-%m-%d %H:%M:%S")
+            except ValueError as e:
+                # 두 형식 모두 실패한 경우 원래 에러 발생
+                raise InvalidDateError(
+                    "Invalid Date format. Expected ISO 8601 or YYYY-MM-DD HH:MM:SS"
+                ) from e
     return value
 
 

solapi/model/rcs/rcs_options.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from enum import Enum
-from typing import Any, Optional
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict
 from pydantic.alias_generators import to_camel
@@ -27,15 +27,6 @@ def __repr__(self):
         return repr(self.value)
 
 
-class RcsAdditionalBody(BaseModel):
-    title: str
-    description: str
-    image_id: Optional[str] = None
-    buttons: Optional[dict[str, str]] = None
-
-    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
-
-
 class RcsButtonType(str, Enum):
     """
     'WL'(웹링크), 'ML'(지도[좌표]), 'MQ'(지도[쿼리]), 'MR'(위치공유),
@@ -74,6 +65,15 @@ class RcsButton(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
 
 
+class RcsAdditionalBody(BaseModel):
+    title: str
+    description: str
+    image_id: Optional[str] = None
+    buttons: Optional[list[RcsButton]] = None
+
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+
+
 class RcsOption(BaseModel):
     brand_id: Optional[str] = None
     template_id: Optional[str] = None
@@ -82,8 +82,7 @@ class RcsOption(BaseModel):
     mms_type: Optional[RcsMmsType] = None
     commercial_type: Optional[bool] = None
     disable_sms: Optional[bool] = False
-    additional_body: Optional[Any] = None
-    # additional_body: Optional[list[RcsAdditionalBody]] = None
+    additional_body: Optional[list[RcsAdditionalBody]] = None
     buttons: Optional[list[RcsButton]] = None
 
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)

solapi/model/request/__init__.py

@@ -1,2 +1,2 @@
 # NOTE: Python SDK가 업데이트 될 때마다 Version도 갱신해야 함!
-VERSION = "python/5.0.0"
+VERSION = "python/5.0.1"

solapi/model/request/messages/get_messages.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import Optional, Union
 
-from pydantic import BaseModel, ConfigDict, Field, computed_field
+from pydantic import BaseModel, ConfigDict, Field, field_validator
 from pydantic.alias_generators import to_camel
 
 from solapi.lib.string_date_transfer import format_with_transfer
@@ -24,18 +24,11 @@ class GetMessagesRequest(BaseModel):
 
     model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)
 
-    @computed_field(alias="startDate")
-    @property
-    def formatted_start_date(self) -> Union[str, None]:
-        if self.start_date is not None:
-            return format_with_transfer(self.start_date)
-        else:
-            return None
-
-    @computed_field(alias="endDate")
-    @property
-    def formatted_end_date(self) -> Union[str, None]:
-        if self.end_date is not None:
-            return format_with_transfer(self.end_date)
-        else:
-            return None
+    @field_validator("start_date", "end_date", mode="before")
+    @classmethod
+    def format_dates(
+        cls, value: Union[str, datetime, None]
+    ) -> Union[str, datetime, None]:
+        if isinstance(value, str):
+            return format_with_transfer(value)
+        return value

solapi/services/message_service.py

@@ -88,8 +88,6 @@ def send(
                     )
 
             payload.extend(messages)
-        else:
-            raise TypeError("Invalid message type")
 
         if len(payload) == 0:
             raise ValueError("The data must have at least one message.")
@@ -168,6 +166,21 @@ def upload_file(
         )
         return FileUploadResponse.model_validate(response)
 
+    def cancel_scheduled_message(self, group_id: str) -> GroupMessageResponse:
+        """Cancel a reserved message.
+
+        This method cancels a message that was previously scheduled to be sent.
+        It requires the group_id of the message to be canceled.
+        """
+        response = default_fetcher(
+            self.auth_info,
+            request={
+                "url": f"{self.base_url}/messages/v4/groups/{group_id}/schedule",
+                "method": RequestMethod.DELETE,
+            },
+        )
+        return GroupMessageResponse.model_validate(response)
+
     def get_groups(self, query: Optional[GetGroupsRequest] = None) -> GetGroupsResponse:
         """Retrieve message groups (메시지 그룹) from the Solapi API.
 

tests/test_group.py

@@ -2,12 +2,13 @@
 
 from solapi.model.response.groups.get_group_messages import GetGroupMessagesResponse
 from solapi.model.response.groups.get_groups import GetGroupsResponse
+from solapi.services.message_service import SolapiMessageService
 
 
 class TestGroup:
     """Test cases for group-related functionality."""
 
-    def test_get_groups(self, message_service):
+    def test_get_groups(self, message_service: SolapiMessageService):
         """
         Test getting message groups.
 
@@ -41,7 +42,7 @@ def test_get_groups(self, message_service):
             # Test get_group method with this group ID
             self.test_get_group(message_service, group_id)
 
-    def test_get_group(self, message_service, group_id=None):
+    def test_get_group(self, message_service: SolapiMessageService, group_id=None):
         """
         Test getting a specific message group.
 
@@ -92,15 +93,15 @@ def test_get_group_messages(self, message_service, group_id=None):
         assert isinstance(response, GetGroupMessagesResponse)
 
         # Verify response has required fields
-        assert hasattr(response, "messages")
+        assert hasattr(response, "message_list")
 
         # Print message information for verification
-        print(f"Number of messages in group: {len(response.messages)}")
+        print(f"Number of messages in group: {len(response.message_list)}")
 
         # If there are messages, verify the structure of the first message
-        if response.messages:
-            message = response.messages[0]
-            print(f"Message ID: {message.message_id}")
-            print(f"Status: {message.status}")
-            print(f"To: {message.to}")
-            print(f"From: {message.from_}")
+        if response.message_list:
+            for message in response.message_list.values():
+                print(f"Message ID: {message.message_id}")
+                print(f"Status: {message.status_code}")
+                print(f"To: {message.to}")
+                print(f"From: {message.from_}")

tests/test_messages.py

@@ -24,20 +24,18 @@ def test_get_messages(self, message_service):
         assert isinstance(response, GetMessagesResponse)
 
         # Verify response has required fields
-        assert hasattr(response, "messages")
-        assert hasattr(response, "total_count")
+        assert hasattr(response, "message_list")
 
         # Print message information for verification
-        print(f"Total messages: {response.total_count}")
-        print(f"Messages in response: {len(response.messages)}")
+        print(f"Messages in response: {len(response.message_list)}")
 
         # If there are messages, verify the structure of the first message
-        if response.messages:
-            message = response.messages[0]
-            print(f"Message ID: {message.message_id}")
-            print(f"Status: {message.status}")
-            print(f"To: {message.to}")
-            print(f"From: {message.from_}")
+        if response.message_list:
+            for message in response.message_list.values():
+                print(f"Message ID: {message.message_id}")
+                print(f"Status: {message.status_code}")
+                print(f"To: {message.to}")
+                print(f"From: {message.from_}")
 
     def test_get_messages_with_date_filter(self, message_service):
         """
@@ -67,20 +65,15 @@ def test_get_messages_with_date_filter(self, message_service):
         assert isinstance(response, GetMessagesResponse)
 
         # Verify response has required fields
-        assert hasattr(response, "messages")
-        assert hasattr(response, "total_count")
+        assert hasattr(response, "message_list")
 
         # Print message information for verification
-        print(
-            f"Total messages in date range {start_date_str} to {end_date_str}: {response.total_count}"
-        )
-        print(f"Messages in response: {len(response.messages)}")
+        print(f"Messages in response: {len(response.message_list)}")
 
         # If there are messages, verify the structure of the first message
-        if response.messages:
-            message = response.messages[0]
-            print(f"Message ID: {message.message_id}")
-            print(f"Status: {message.status}")
-            print(f"To: {message.to}")
-            print(f"From: {message.from_}")
-            print(f"Date: {message.date_created}")
+        if response.message_list:
+            for message in response.message_list.values():
+                print(f"Message ID: {message.message_id}")
+                print(f"Status: {message.status_code}")
+                print(f"To: {message.to}")
+                print(f"From: {message.from_}")

tests/test_simple_send.py

@@ -7,6 +7,7 @@
 from solapi.model.kakao.kakao_option import KakaoOption
 from solapi.model.request.storage import FileTypeEnum
 from solapi.model.response.send_message_response import SendMessageResponse
+from solapi.services.message_service import SolapiMessageService
 
 
 class TestSimpleSend:
@@ -51,7 +52,7 @@ def test_send_sms(self, message_service, test_phone_numbers):
         print(f"Successful messages: {response.group_info.count.registered_success}")
         print(f"Failed messages: {response.group_info.count.registered_failed}")
 
-        return response.group_info.group_id
+        assert response.group_info.group_id is not None
 
     def test_send_mms(self, message_service, test_phone_numbers):
         """
@@ -113,7 +114,7 @@ def test_send_mms(self, message_service, test_phone_numbers):
         print(f"Successful messages: {response.group_info.count.registered_success}")
         print(f"Failed messages: {response.group_info.count.registered_failed}")
 
-        return response.group_info.group_id
+        assert response.group_info.group_id is not None
 
     def test_send_kakao_alimtalk(
         self, message_service, test_phone_numbers, test_kakao_options
@@ -166,7 +167,7 @@ def test_send_kakao_alimtalk(
             )
             print(f"Failed messages: {response.group_info.count.registered_failed}")
 
-            return response.group_info.group_id
+            assert response.group_info.group_id is not None
         except Exception as e:
             # This test may fail if Kakao template is not properly set up
             pytest.skip(f"Kakao Alimtalk test skipped: {str(e)}")
@@ -232,7 +233,7 @@ def test_send_many(self, message_service, test_phone_numbers):
                 print(f"To: {failed.message.to}")
                 print(f"Error: {failed.error.message}")
 
-        return response.group_info.group_id
+        assert response.group_info.group_id is not None
 
     def test_send_with_reservation(self, message_service, test_phone_numbers):
         """
@@ -250,14 +251,11 @@ def test_send_with_reservation(self, message_service, test_phone_numbers):
             from_=test_phone_numbers["sender"],
             to=test_phone_numbers["recipient"],
             text="[테스트] SOLAPI Python SDK를 사용한 예약 발송 테스트입니다.",
+            scheduled_date=datetime.now() + timedelta(minutes=10),
         )
 
-        # Create config with scheduled date (10 minutes in the future)
-        scheduled_date = datetime.now() + timedelta(minutes=10)
-        config = SendRequestConfig(scheduled_date=scheduled_date)
-
-        # Send message with reservation
-        response = message_service.send(message, config)
+        # Send message
+        response = message_service.send(message)
 
         # Verify response type
         assert isinstance(response, SendMessageResponse)
@@ -267,15 +265,50 @@ def test_send_with_reservation(self, message_service, test_phone_numbers):
         assert hasattr(response.group_info, "group_id")
         assert hasattr(response.group_info, "count")
 
-        # Verify message was scheduled successfully
+        # Verify message was sent successfully
         assert response.group_info.count.total > 0
         assert response.group_info.count.registered_success > 0
 
         # Print response information for verification
         print(f"Group ID: {response.group_info.group_id}")
-        print(f"Scheduled date: {scheduled_date}")
         print(f"Total messages: {response.group_info.count.total}")
         print(f"Successful messages: {response.group_info.count.registered_success}")
         print(f"Failed messages: {response.group_info.count.registered_failed}")
 
-        return response.group_info.group_id
+        assert response.group_info.group_id is not None
+
+    def test_cancel_reservation(
+        self, message_service: SolapiMessageService, test_phone_numbers
+    ):
+        """
+        Test cancelling a reserved message.
+
+        This test verifies that the cancel_scheduled_message method works correctly.
+
+        Args:
+            message_service: The SolapiMessageService fixture
+            test_phone_numbers: Dictionary with sender and recipient phone numbers
+        """
+        # Create message with reservation
+        message = RequestMessage(
+            from_=test_phone_numbers["sender"],
+            to=test_phone_numbers["recipient"],
+            text="[테스트] SOLAPI Python SDK 예약 취소 테스트입니다.",
+        )
+        request_config = SendRequestConfig(
+            scheduled_date=datetime.now() + timedelta(minutes=10)
+        )
+
+        # Send message and get group_id
+        send_response = message_service.send(message, request_config)
+        group_id = send_response.group_info.group_id
+
+        # Cancel reservation
+        cancel_response = message_service.cancel_scheduled_message(group_id)
+
+        # Verify cancellation response
+        assert cancel_response.group_id is not None
+
+        # Print cancellation information for verification
+        # print(f"Cancellation status: {cancel_response.status}")
+        print(f"Cancelled message ID: {cancel_response.group_id}")