Update serialize/deserialize models in message_service.py:

Palbahngmiyine · Palbahngmiyine · commit 33d6a059986a · 2025-03-17T16:59:01.000+09:00
* Update datetime timezone setting in string_date_transfer.py
diff --git a/.gitignore b/.gitignore
@@ -33,6 +33,7 @@ build/
 *.bak
 *.swp
 *.swo
+debug
 
 # ruff
 .ruff_cache/
diff --git a/examples/sms/sms.py b/examples/sms/sms.py
@@ -1,6 +1,9 @@
 from solapi.message_service import SolapiMessageService
 from solapi.model.message import Message
 
-test = SolapiMessageService(api_key="YOUR_API_KEY", api_secret="YOUR_API_SECRET")
-test2 = Message(from_="01012345678", to="01012345678", text="test")
-test.send(test2)
+message_service = SolapiMessageService(
+    api_key="YOUR_API_KEY", api_secret="YOUR_API_SECRET"
+)
+message = Message(from_="등록한 발신번호", to="01000000000", text="Hello World!")
+response = message_service.send(message)
+print(response)
diff --git a/solapi/lib/fetcher.py b/solapi/lib/fetcher.py
@@ -47,12 +47,11 @@ def default_fetcher(
         )
 
     # 4xx 에러 처리: 클라이언트 오류일 경우
-    # TODO: Custom Error 만들어야 함
     if 400 <= response.status_code < 500:
         error_response: dict[str, Any] = response.json()
         raise Exception(
             error_response.get("errorCode", "UnknownError"),
-            error_response.get("errorMessage", ""),
+            error_response.get("errorMessage", "An Error occurred"),
         )
     # 5xx 에러 처리: 서버 오류일 경우
     elif response.status_code >= 500:
diff --git a/solapi/lib/string_date_transfer.py b/solapi/lib/string_date_transfer.py
@@ -1,5 +1,6 @@
 import re
-from datetime import datetime
+import time
+from datetime import datetime, timedelta, timezone
 from typing import Union
 
 
@@ -24,7 +25,9 @@ def format_iso(date: datetime) -> str:
     Returns:
         ISO 8601 형식의 문자열 (예: '2023-01-01T12:00:00Z')
     """
-    return date.isoformat()
+    utc_offset_sec = time.altzone if time.localtime().tm_isdst else time.timezone
+    utc_offset = timedelta(seconds=-utc_offset_sec)
+    return date.replace(tzinfo=timezone(offset=utc_offset)).isoformat()
 
 
 def parse_iso(date_string: str) -> datetime:
@@ -83,7 +86,7 @@ def string_date_transfer(value: Union[str, datetime]):
     return value
 
 
-def format_with_transfer(value: str) -> str:
+def format_with_transfer(value: Union[str, datetime]) -> str:
     """
     string_date_transfer와 format_iso를 한번에 실행하는 함수
 
diff --git a/solapi/message_service.py b/solapi/message_service.py
@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Optional, Union
 
 from solapi.lib.authenticator import AuthenticationParameter
@@ -8,12 +9,13 @@
     SendMessageRequest,
     SendRequestConfig,
 )
+from solapi.model.response.send_message_response import SendMessageResponse
 
 
 class SolapiMessageService:
     def __init__(self, api_key: str, api_secret: str):
-        self.baseUrl = "https://api.solapi.com"
-        self._auth_info: AuthenticationParameter = {
+        self.base_url = "https://api.solapi.com"
+        self.auth_info: AuthenticationParameter = {
             "api_key": api_key,
             "api_secret": api_secret,
         }
@@ -22,34 +24,55 @@ def send(
         self,
         messages: Union[list[Message], Message],
         request_config: Optional[SendRequestConfig] = None,
-    ):
+    ) -> SendMessageResponse:
         payload = []
         if isinstance(messages, Message):
             payload.append(messages)
         elif isinstance(messages, list):
+            for message in messages:
+                if isinstance(message, Message) is not True:
+                    raise TypeError(
+                        "The messages parameter must be an instance of Message."
+                    )
+
             payload.extend(messages)
+        else:
+            raise TypeError("Invalid message type")
 
         if len(payload) == 0:
-            raise ValueError("데이터가 반드시 1건 이상 기입되어 있어야 합니다.")
+            raise ValueError("The data must have at least one message.")
 
         request = SendMessageRequest(messages=payload)
         if request_config is not None:
-            request.app_id = request_config["app_id"]
-            request.allow_duplicates = request_config["allow_duplicates"]
-            request.show_message_list = request_config["show_message_list"]
+            request.app_id = request_config.app_id
+            request.allow_duplicates = request_config.allow_duplicates
+            request.show_message_list = request_config.show_message_list
 
-            if request_config.scheduled_date != "":
+            if (
+                request_config.scheduled_date is not None
+                and request_config.scheduled_date != ""
+                and isinstance(request_config.scheduled_date, datetime)
+            ):
                 request.scheduled_date = format_with_transfer(
                     request_config.scheduled_date
                 )
 
-        print(request.model_dump(exclude_none=True, by_alias=True))
-
-        return default_fetcher(
-            self._auth_info,
+        response = default_fetcher(
+            self.auth_info,
             request={
                 "method": RequestMethod.POST,
-                "url": f"{self.baseUrl}/messages/v4/send-many/detail",
+                "url": f"{self.base_url}/messages/v4/send-many/detail",
             },
             data=request.model_dump(exclude_none=True, by_alias=True),
         )
+        deserialized_response: SendMessageResponse = SendMessageResponse.model_validate(
+            response
+        )
+
+        count = deserialized_response.count
+        failed_messages = deserialized_response.failed_message_list
+        registered_failed_count = count.registered_failed
+        if len(failed_messages) > 0 and count.total == registered_failed_count:
+            raise ValueError("an error occurred")
+
+        return deserialized_response
diff --git a/solapi/model/kakao/__init__.py b/solapi/model/kakao/__init__.py
diff --git a/solapi/model/kakao/kakao_option.py b/solapi/model/kakao/kakao_option.py
diff --git a/solapi/model/message.py b/solapi/model/message.py
@@ -2,7 +2,7 @@
 from enum import Enum
 from typing import Any, Optional
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class MessageType(Enum):
@@ -47,37 +47,55 @@ class FileIdsType(BaseModel):
 
 
 class Message(BaseModel):
-    from_: Optional[str] = Field(default=None, serialization_alias="from")
+    from_: Optional[str] = Field(
+        default=None, serialization_alias="from", validation_alias="from"
+    )
     to: str
     text: Optional[str] = None
-    image_id: Optional[str] = Field(default=None, serialization_alias="imageId")
+    image_id: Optional[str] = Field(
+        default=None, serialization_alias="imageId", validation_alias="imageId"
+    )
     country: str = "82"
-    message_id: Optional[str] = Field(default=None, serialization_alias="messageId")
-    group_id: Optional[str] = Field(default=None, serialization_alias="groupId")
+    message_id: Optional[str] = Field(
+        default=None, serialization_alias="messageId", validation_alias="messageId"
+    )
+    group_id: Optional[str] = Field(
+        default=None, serialization_alias="groupId", validation_alias="groupId"
+    )
     type: Optional[MessageType] = None
     auto_type_detect: Optional[bool] = Field(
-        default=True, serialization_alias="autoTypeDetect"
+        default=True,
+        serialization_alias="autoTypeDetect",
+        validation_alias="autoTypeDetect",
     )
     date_created: Optional[datetime] = Field(
-        default=None, serialization_alias="dateCreated"
+        default=None, serialization_alias="dateCreated", validation_alias="dateCreated"
     )
     date_updated: Optional[datetime] = Field(
-        default=None, serialization_alias="dateUpdated"
+        default=None, serialization_alias="dateUpdated", validation_alias="dateUpdated"
     )
     subject: Optional[str] = None
     log: Optional[list[dict[str, Any]]] = None
     replacements: Optional[list[dict[str, Any]]] = None
-    status_code: Optional[str] = Field(default=None, serialization_alias="statusCode")
+    status_code: Optional[str] = Field(
+        default=None, serialization_alias="statusCode", validation_alias="statusCode"
+    )
     custom_fields: Optional[dict[str, str]] = Field(
-        default=None, serialization_alias="customFields"
+        default=None,
+        serialization_alias="customFields",
+        validation_alias="customFields",
     )
     # TODO: kakaoOptions Model 정의해야 함..
     kakao_options: Optional[dict[str, Any]] = Field(
-        default=None, serialization_alias="kakaoOptions"
+        default=None,
+        serialization_alias="kakaoOptions",
+        validation_alias="kakaoOptions",
     )
     rcs_options: Optional[dict[str, Any]] = Field(
-        default=None, serialization_alias="rcsOptions"
+        default=None, serialization_alias="rcsOptions", validation_alias="rcsOptions"
     )
     fax_options: Optional[FileIdsType] = Field(
-        default=None, serialization_alias="faxOptions"
+        default=None, serialization_alias="faxOptions", validation_alias="faxOptions"
     )
+
+    model_config = ConfigDict(extra="ignore")
diff --git a/solapi/model/request/send_message_request.py b/solapi/model/request/send_message_request.py
@@ -1,5 +1,6 @@
 import platform
-from typing import Optional
+from datetime import datetime
+from typing import Optional, Union
 
 from pydantic import BaseModel, Field
 
@@ -12,7 +13,7 @@ class SendRequestConfig(BaseModel):
     show_message_list: bool = Field(
         default=False, serialization_alias="showMessageList"
     )
-    scheduled_date: Optional[str] = Field(
+    scheduled_date: Optional[Union[str, datetime]] = Field(
         default=None, serialization_alias="scheduledDate"
     )
 
diff --git a/solapi/model/response/__init__.py b/solapi/model/response/__init__.py
diff --git a/solapi/model/response/common_response.py b/solapi/model/response/common_response.py
@@ -0,0 +1,87 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class CountResponse(BaseModel):
+    total: int
+    sent_total: int = Field(..., validation_alias="sentTotal")
+    sent_success: int = Field(..., validation_alias="sentSuccess")
+    sent_pending: int = Field(..., validation_alias="sentPending")
+    sent_replacement: int = Field(..., validation_alias="sentReplacement")
+    refund: int
+    registered_failed: int = Field(..., validation_alias="registeredFailed")
+    registered_success: int = Field(..., validation_alias="registeredSuccess")
+
+    model_config = ConfigDict(extra="ignore")
+
+
+class CommonCashResponse(BaseModel):
+    requested: int
+    replacement: int
+    refund: int
+    sum: int
+
+    model_config = ConfigDict(extra="ignore")
+
+
+class CountForChargeResponse(BaseModel):
+    sms: dict[str, int]
+    lms: dict[str, int]
+    mms: dict[str, int]
+    ata: dict[str, int]
+    cta: dict[str, int]
+    cti: dict[str, int]
+    nsa: dict[str, int]
+    rcs_sms: dict[str, int]
+    rcs_lms: dict[str, int]
+    rcs_mms: dict[str, int]
+    rcs_tpl: dict[str, int]
+
+    model_config = ConfigDict(extra="ignore")
+
+
+class GroupMessageResponse(BaseModel):
+    # export type GroupMessageResponse = {
+    #   count: Count;
+    #   countForCharge: CountForCharge;
+    #   balance: CommonCashResponse;
+    #   point: CommonCashResponse;
+    #   app: App;
+    #   log: Log;
+    #   status: string;
+    #   allowDuplicates: boolean;
+    #   isRefunded: boolean;
+    #   accountId: string;
+    #   masterAccountId: string | null;
+    #   apiVersion: string;
+    #   groupId: string;
+    #   price: object;
+    #   dateCreated: string;
+    #   dateUpdated: string;
+    #   scheduledDate?: string;
+    #   dateSent?: string;
+    #   dateCompleted?: string;
+    # };
+    count: CountResponse
+    count_for_charge: Any = Field(..., validation_alias="countForCharge")
+    balance: CommonCashResponse
+    point: CommonCashResponse
+    app: Any
+    log: Any
+    status: str
+    allow_duplicates: bool = Field(..., validation_alias="allowDuplicates")
+    is_refunded: bool = Field(..., validation_alias="isRefunded")
+    account_id: str = Field(..., validation_alias="accountId")
+    master_account_id: str = Field(..., validation_alias="masterAccountId")
+    api_version: str = Field(..., validation_alias="apiVersion")
+    group_id: str = Field(..., validation_alias="groupId")
+    price: Any
+    date_created: datetime = Field(..., validation_alias="dateCreated")
+    date_updated: datetime = Field(..., validation_alias="dateUpdated")
+    scheduled_date: datetime = Field(..., validation_alias="scheduledDate")
+    date_sent: datetime = Field(..., validation_alias="dateSent")
+    date_completed: datetime = Field(..., validation_alias="dateCompleted")
+
+    model_config = ConfigDict(extra="ignore")
diff --git a/solapi/model/response/send_message_response.py b/solapi/model/response/send_message_response.py
@@ -0,0 +1,27 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from solapi.model.response.common_response import GroupMessageResponse
+
+
+class FailedMessage(BaseModel):
+    to: str
+    from_: str = Field(..., alias="from")
+    type: str
+    status_message: str = Field(..., alias="statusMessage")
+    country: str
+    message_id: str = Field(..., alias="messageId")
+    status_code: str = Field(..., alias="statusCode")
+    account_id: str = Field(..., alias="accountId")
+    custom_fields: Optional[dict[str, str]] = Field(
+        default=None, alias="customFields"
+    )
+
+
+class SendMessageResponse(BaseModel):
+    failed_message_list: list[FailedMessage] = Field(
+        ..., alias="failedMessageList"
+    )
+    group_info: GroupMessageResponse = Field(..., alias="groupInfo")
+    message_list: Optional[list] = Field(default=None, alias="messageList")

-Original file line number
+Diff line change
 *.bak
 *.swp
 *.swo
 +debug
 # ruff
 .ruff_cache/
Original file line number	Diff line number	Diff line change
`@@ -47,12 +47,11 @@ def default_fetcher(`
`47`	`47`	`)`
`48`	`48`
`49`	`49`	`# 4xx 에러 처리: 클라이언트 오류일 경우`
`50`		`- # TODO: Custom Error 만들어야 함`
`51`	`50`	`if 400 <= response.status_code < 500:`
`52`	`51`	`error_response: dict[str, Any] = response.json()`
`53`	`52`	`raise Exception(`
`54`	`53`	`error_response.get("errorCode", "UnknownError"),`
`55`		`- error_response.get("errorMessage", ""),`
	`54`	`+ error_response.get("errorMessage", "An Error occurred"),`
`56`	`55`	`)`
`57`	`56`	`# 5xx 에러 처리: 서버 오류일 경우`
`58`	`57`	`elif response.status_code >= 500:`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`import platform`
`2`		`-from typing import Optional`
	`2`	`+from datetime import datetime`
	`3`	`+from typing import Optional, Union`
`3`	`4`
`4`	`5`	`from pydantic import BaseModel, Field`
`5`	`6`
`@@ -12,7 +13,7 @@ class SendRequestConfig(BaseModel):`
`12`	`13`	`show_message_list: bool = Field(`
`13`	`14`	`default=False, serialization_alias="showMessageList"`
`14`	`15`	`)`
`15`		`- scheduled_date: Optional[str] = Field(`
	`16`	`+ scheduled_date: Optional[Union[str, datetime]] = Field(`
`16`	`17`	`default=None, serialization_alias="scheduledDate"`
`17`	`18`	`)`
`18`	`19`