Skip to content

Commit 4f5f51c

Browse files
PalbahngmiyinePalbahngmiyine
committed
Update version to 5.0.3 and add BMS (Brand Message Service) models
- Incremented version in pyproject.toml from 5.0.2 to 5.0.3. - Introduced new BMS message types in message_type.py. - Added BMS-related models including Bms, BmsButton, BmsCarousel, BmsCommerce, BmsCoupon, BmsVideo, and BmsOption. - Implemented validation logic for BMS models to ensure required fields are present. - Added tests for BMS functionality to ensure proper behavior and validation. This update enhances the SDK's capabilities for handling brand messaging services.
1 parent d5c5dbf commit 4f5f51c

14 files changed

Lines changed: 1541 additions & 4 deletions

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "solapi"
3-
version = "5.0.2"
3+
version = "5.0.3"
44
description = "SOLAPI SDK for Python"
55
authors = [
66
{ name = "SOLAPI Team", email = "contact@solapi.com" }

‎solapi/model/kakao/bms/__init__.py‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
"""BMS (카카오 브랜드 메시지) 자유형 모델."""
2+
3+
from solapi.model.kakao.bms.bms_button import (
4+
BmsAppButton,
5+
BmsBotKeywordButton,
6+
BmsBotTransferButton,
7+
BmsBusinessFormButton,
8+
BmsButton,
9+
BmsButtonLinkType,
10+
BmsChannelAddButton,
11+
BmsConsultButton,
12+
BmsLinkButton,
13+
BmsMessageDeliveryButton,
14+
BmsWebButton,
15+
)
16+
from solapi.model.kakao.bms.bms_carousel import (
17+
BmsCarouselCommerceItem,
18+
BmsCarouselCommerceSchema,
19+
BmsCarouselFeedItem,
20+
BmsCarouselFeedSchema,
21+
BmsCarouselHead,
22+
BmsCarouselTail,
23+
)
24+
from solapi.model.kakao.bms.bms_commerce import BmsCommerce
25+
from solapi.model.kakao.bms.bms_coupon import BmsCoupon
26+
from solapi.model.kakao.bms.bms_option import BmsChatBubbleType, BmsOption
27+
from solapi.model.kakao.bms.bms_video import BmsVideo
28+
from solapi.model.kakao.bms.bms_wide_item import BmsMainWideItem, BmsSubWideItem
29+
30+
__all__ = [
31+
# Button types
32+
"BmsButtonLinkType",
33+
"BmsWebButton",
34+
"BmsAppButton",
35+
"BmsChannelAddButton",
36+
"BmsBotKeywordButton",
37+
"BmsMessageDeliveryButton",
38+
"BmsConsultButton",
39+
"BmsBotTransferButton",
40+
"BmsBusinessFormButton",
41+
"BmsButton",
42+
"BmsLinkButton",
43+
# Commerce
44+
"BmsCommerce",
45+
# Coupon
46+
"BmsCoupon",
47+
# Video
48+
"BmsVideo",
49+
# Wide Item
50+
"BmsMainWideItem",
51+
"BmsSubWideItem",
52+
# Carousel
53+
"BmsCarouselHead",
54+
"BmsCarouselTail",
55+
"BmsCarouselFeedItem",
56+
"BmsCarouselFeedSchema",
57+
"BmsCarouselCommerceItem",
58+
"BmsCarouselCommerceSchema",
59+
# Option
60+
"BmsChatBubbleType",
61+
"BmsOption",
62+
]

‎solapi/model/kakao/bms/bms_button.py‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
from typing import Annotated, Literal, Optional, Union
2+
3+
from pydantic import BaseModel, ConfigDict, model_validator
4+
from pydantic.alias_generators import to_camel
5+
6+
BmsButtonLinkType = Literal["AC", "WL", "AL", "BK", "MD", "BC", "BT", "BF"]
7+
8+
9+
class BmsWebButton(BaseModel):
10+
"""WL: 웹 링크 버튼."""
11+
12+
link_type: Literal["WL"] = "WL"
13+
name: str
14+
link_mobile: str
15+
link_pc: Optional[str] = None
16+
target_out: Optional[bool] = None
17+
18+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
19+
20+
21+
class BmsAppButton(BaseModel):
22+
"""AL: 앱 링크 버튼. linkMobile, linkAndroid, linkIos 중 하나 이상 필수."""
23+
24+
link_type: Literal["AL"] = "AL"
25+
name: str
26+
link_mobile: Optional[str] = None
27+
link_android: Optional[str] = None
28+
link_ios: Optional[str] = None
29+
target_out: Optional[bool] = None
30+
31+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
32+
33+
@model_validator(mode="after")
34+
def validate_at_least_one_link(self) -> "BmsAppButton":
35+
if not any([self.link_mobile, self.link_android, self.link_ios]):
36+
raise ValueError(
37+
"AL 타입 버튼은 linkMobile, linkAndroid, linkIos 중 하나 이상 필수입니다."
38+
)
39+
return self
40+
41+
42+
class BmsChannelAddButton(BaseModel):
43+
"""AC: 채널 추가 버튼."""
44+
45+
link_type: Literal["AC"] = "AC"
46+
name: Optional[str] = None
47+
48+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
49+
50+
51+
class BmsBotKeywordButton(BaseModel):
52+
"""BK: 봇 키워드 버튼."""
53+
54+
link_type: Literal["BK"] = "BK"
55+
name: str
56+
chat_extra: Optional[str] = None
57+
58+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
59+
60+
61+
class BmsMessageDeliveryButton(BaseModel):
62+
"""MD: 메시지 전달 버튼."""
63+
64+
link_type: Literal["MD"] = "MD"
65+
name: str
66+
chat_extra: Optional[str] = None
67+
68+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
69+
70+
71+
class BmsConsultButton(BaseModel):
72+
"""BC: 상담 요청 버튼."""
73+
74+
link_type: Literal["BC"] = "BC"
75+
name: str
76+
chat_extra: Optional[str] = None
77+
78+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
79+
80+
81+
class BmsBotTransferButton(BaseModel):
82+
"""BT: 봇 전환 버튼."""
83+
84+
link_type: Literal["BT"] = "BT"
85+
name: str
86+
chat_extra: Optional[str] = None
87+
88+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
89+
90+
91+
class BmsBusinessFormButton(BaseModel):
92+
"""BF: 비즈니스폼 버튼."""
93+
94+
link_type: Literal["BF"] = "BF"
95+
name: str
96+
97+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
98+
99+
100+
BmsButton = Annotated[
101+
Union[
102+
BmsWebButton,
103+
BmsAppButton,
104+
BmsChannelAddButton,
105+
BmsBotKeywordButton,
106+
BmsMessageDeliveryButton,
107+
BmsConsultButton,
108+
BmsBotTransferButton,
109+
BmsBusinessFormButton,
110+
],
111+
"BMS 버튼 통합 타입 (linkType으로 구분)",
112+
]
113+
114+
BmsLinkButton = Annotated[
115+
Union[BmsWebButton, BmsAppButton],
116+
"BMS 링크 버튼 (WL, AL만 허용) - 캐러셀 등에서 사용",
117+
]

‎solapi/model/kakao/bms/bms_carousel.py‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
from typing import List, Optional, Union
2+
3+
from pydantic import BaseModel, ConfigDict, Field
4+
from pydantic.alias_generators import to_camel
5+
6+
from solapi.model.kakao.bms.bms_button import BmsAppButton, BmsWebButton
7+
from solapi.model.kakao.bms.bms_commerce import BmsCommerce
8+
from solapi.model.kakao.bms.bms_coupon import BmsCoupon
9+
10+
BmsLinkButton = Union[BmsWebButton, BmsAppButton]
11+
12+
13+
class BmsCarouselHead(BaseModel):
14+
header: Optional[str] = None
15+
content: Optional[str] = None
16+
image_id: Optional[str] = None
17+
link_mobile: Optional[str] = None
18+
link_pc: Optional[str] = None
19+
link_android: Optional[str] = None
20+
link_ios: Optional[str] = None
21+
22+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
23+
24+
25+
class BmsCarouselTail(BaseModel):
26+
link_mobile: Optional[str] = None
27+
link_pc: Optional[str] = None
28+
link_android: Optional[str] = None
29+
link_ios: Optional[str] = None
30+
31+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
32+
33+
34+
class BmsCarouselFeedItem(BaseModel):
35+
header: Optional[str] = None
36+
content: Optional[str] = None
37+
image_id: Optional[str] = None
38+
image_link: Optional[str] = None
39+
buttons: Optional[List[BmsLinkButton]] = None
40+
coupon: Optional[BmsCoupon] = None
41+
42+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
43+
44+
45+
class BmsCarouselFeedSchema(BaseModel):
46+
items: Optional[List[BmsCarouselFeedItem]] = Field(default=None, alias="list")
47+
tail: Optional[BmsCarouselTail] = None
48+
49+
model_config = ConfigDict(populate_by_name=True)
50+
51+
52+
class BmsCarouselCommerceItem(BaseModel):
53+
commerce: Optional[BmsCommerce] = None
54+
image_id: Optional[str] = None
55+
image_link: Optional[str] = None
56+
buttons: Optional[List[BmsLinkButton]] = None
57+
additional_content: Optional[str] = None
58+
coupon: Optional[BmsCoupon] = None
59+
60+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
61+
62+
63+
class BmsCarouselCommerceSchema(BaseModel):
64+
head: Optional[BmsCarouselHead] = None
65+
items: Optional[List[BmsCarouselCommerceItem]] = Field(default=None, alias="list")
66+
tail: Optional[BmsCarouselTail] = None
67+
68+
model_config = ConfigDict(populate_by_name=True)

‎solapi/model/kakao/bms/bms_commerce.py‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
from typing import Optional, Union
2+
3+
from pydantic import BaseModel, ConfigDict, field_validator, model_validator
4+
from pydantic.alias_generators import to_camel
5+
6+
7+
class BmsCommerce(BaseModel):
8+
title: Optional[str] = None
9+
regular_price: Optional[int] = None
10+
discount_price: Optional[int] = None
11+
discount_rate: Optional[int] = None
12+
discount_fixed: Optional[int] = None
13+
14+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
15+
16+
@field_validator(
17+
"regular_price",
18+
"discount_price",
19+
"discount_rate",
20+
"discount_fixed",
21+
mode="before",
22+
)
23+
@classmethod
24+
def coerce_to_int(cls, v: Union[int, float, str, None]) -> Optional[int]:
25+
if v is None:
26+
return None
27+
if isinstance(v, str):
28+
v = v.strip()
29+
if not v:
30+
return None
31+
return int(float(v))
32+
return int(v)
33+
34+
@model_validator(mode="after")
35+
def validate_price_combination(self) -> "BmsCommerce":
36+
if self.regular_price is None:
37+
return self
38+
39+
has_discount_price = self.discount_price is not None
40+
has_discount_rate = self.discount_rate is not None
41+
has_discount_fixed = self.discount_fixed is not None
42+
43+
if not has_discount_price and not has_discount_rate and not has_discount_fixed:
44+
return self
45+
46+
if has_discount_price and has_discount_rate and not has_discount_fixed:
47+
return self
48+
49+
if has_discount_price and has_discount_fixed and not has_discount_rate:
50+
return self
51+
52+
if has_discount_rate and has_discount_fixed:
53+
raise ValueError(
54+
"discountRate와 discountFixed는 동시에 사용할 수 없습니다. "
55+
"할인율(discountRate) 또는 정액할인(discountFixed) 중 하나만 선택하세요."
56+
)
57+
58+
if not has_discount_price and (has_discount_rate or has_discount_fixed):
59+
raise ValueError(
60+
"discountRate 또는 discountFixed를 사용하려면 "
61+
"discountPrice(할인가)도 함께 지정해야 합니다."
62+
)
63+
64+
if has_discount_price and not has_discount_rate and not has_discount_fixed:
65+
raise ValueError(
66+
"discountPrice를 사용하려면 discountRate(할인율) 또는 "
67+
"discountFixed(정액할인) 중 하나를 함께 지정해야 합니다."
68+
)
69+
70+
raise ValueError(
71+
"알 수 없는 가격 조합입니다. regularPrice만 사용하거나, "
72+
"regularPrice + discountPrice + discountRate/discountFixed 조합을 사용하세요."
73+
)

‎solapi/model/kakao/bms/bms_coupon.py‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import re
2+
from typing import Optional
3+
4+
from pydantic import BaseModel, ConfigDict, field_validator
5+
from pydantic.alias_generators import to_camel
6+
7+
WON_DISCOUNT_PATTERN = re.compile(r"^([1-9]\d{0,7})원 할인 쿠폰$")
8+
PERCENT_DISCOUNT_PATTERN = re.compile(r"^([1-9]\d?|100)% 할인 쿠폰$")
9+
FREE_COUPON_PATTERN = re.compile(r"^.{1,7} 무료 쿠폰$")
10+
UP_COUPON_PATTERN = re.compile(r"^.{1,7} UP 쿠폰$")
11+
12+
13+
def _is_valid_coupon_title(title: str) -> bool:
14+
if title == "배송비 할인 쿠폰":
15+
return True
16+
17+
won_match = WON_DISCOUNT_PATTERN.match(title)
18+
if won_match:
19+
num = int(won_match.group(1))
20+
return 1 <= num <= 99_999_999
21+
22+
if PERCENT_DISCOUNT_PATTERN.match(title):
23+
return True
24+
25+
if FREE_COUPON_PATTERN.match(title):
26+
return True
27+
28+
return bool(UP_COUPON_PATTERN.match(title))
29+
30+
31+
class BmsCoupon(BaseModel):
32+
title: Optional[str] = None
33+
description: Optional[str] = None
34+
link_mobile: Optional[str] = None
35+
link_pc: Optional[str] = None
36+
link_android: Optional[str] = None
37+
link_ios: Optional[str] = None
38+
39+
model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
40+
41+
@field_validator("title")
42+
@classmethod
43+
def validate_coupon_title(cls, v: Optional[str]) -> Optional[str]:
44+
if v is None:
45+
return v
46+
if not _is_valid_coupon_title(v):
47+
raise ValueError(
48+
"쿠폰 제목은 다음 형식 중 하나여야 합니다: "
49+
'"N원 할인 쿠폰" (1~99999999), '
50+
'"N% 할인 쿠폰" (1~100), '
51+
'"배송비 할인 쿠폰", '
52+
'"OOO 무료 쿠폰" (7자 이내), '
53+
'"OOO UP 쿠폰" (7자 이내)'
54+
)
55+
return v

0 commit comments

Comments
 (0)