Add rcs channel (#64)

* Added RCS channel class and send_rcs model

* Changed send_rcs model

* Added send RCS message endpoint

* Added send_bulk_rcs_message

* Added integrations tests

* Added RcsMessageBody model tests

* Added tests for send_bulk_rcs_message

* Changed model and tests naming

* Added tests for smsFailover

* Updated sdk version and README.md

* Updated RCS tests, corrected naming

* Corrected naming in content_description test

* Refactored RCS test

* Run pre-commit hooks

* Corrected integration test naming

Author: dlozina

README.md

@@ -5,6 +5,7 @@ Python client for Infobip's  API channels.
 - Whatsapp -> [Docs](https://www.infobip.com/docs/api#channels/whatsapp)
 - WebRTC -> [Docs](https://www.infobip.com/docs/api#channels/webrtc/)
 - MMS -> [Docs](https://www.infobip.com/docs/api#channels/mms)
+- RCS -> [Docs](https://www.infobip.com/docs/api#channels/rcs)
 
 #### Table of contents:
 

infobip_channels/__init__.py

@@ -1,5 +1,6 @@
 from .mms.channel import MMSChannel
+from .rcs.channel import RCSChannel
 from .web_rtc.channel import WebRtcChannel
 from .whatsapp.channel import WhatsAppChannel
 
-__all__ = ["WhatsAppChannel", "WebRtcChannel", "MMSChannel"]
+__all__ = ["WhatsAppChannel", "WebRtcChannel", "MMSChannel", "RCSChannel"]

infobip_channels/core/models.py

@@ -35,15 +35,15 @@ def validate_scheme(cls, value: str) -> str:
 
 
 class UrlLengthValidatorMixin:
-    MAX_URL_LENGTH = 2048
+    _MAX_URL_LENGTH = 2048
 
     @classmethod
     def validate_url_length(cls, value: str) -> str:
         if not isinstance(value, str):
             return value
 
-        if len(value) > cls.MAX_URL_LENGTH:
-            raise ValueError(f"Url length must be less than {cls.MAX_URL_LENGTH}")
+        if len(value) > cls._MAX_URL_LENGTH:
+            raise ValueError(f"Url length must be less than {cls._MAX_URL_LENGTH}")
 
         return value
 

infobip_channels/rcs/Models/__init__.py

@@ -0,0 +1,8 @@
+from typing import List
+
+from infobip_channels.core.models import MessageBodyBase
+from infobip_channels.rcs.Models.body.send_rcs_message import RCSMessageBody
+
+
+class RCSMessageBodyList(MessageBodyBase):
+    messages: List[RCSMessageBody]

infobip_channels/rcs/Models/body/__init__.py

@@ -0,0 +1,215 @@
+from enum import Enum
+from typing import List, Optional, Union
+
+try:
+    from typing import Literal
+except ImportError:
+    from typing_extensions import Literal
+
+from pydantic import AnyHttpUrl, Field, confloat, constr, validator
+
+from infobip_channels.core.models import (
+    CamelCaseModel,
+    MessageBodyBase,
+    UrlLengthValidatorMixin,
+)
+
+
+class ValidityPeriodTimeUnitEnum(str, Enum):
+    SECONDS = "SECONDS"
+    MINUTES = "MINUTES"
+    HOURS = "HOURS"
+    DAYS = "DAYS"
+
+
+class CardWidth(str, Enum):
+    SMALL = "SMALL"
+    MEDIUM = "MEDIUM"
+
+
+class HeightEnum(str, Enum):
+    SHORT = "SHORT"
+    MEDIUM = "MEDIUM"
+    TALL = "TALL"
+
+
+class AlignmentEnum(str, Enum):
+    LEFT = "LEFT"
+    RIGHT = "RIGHT"
+
+
+class OrientationEnum(str, Enum):
+    HORIZONTAL = "HORIZONTAL"
+    VERTICAL = "VERTICAL"
+
+
+class FileProperties(CamelCaseModel, UrlLengthValidatorMixin):
+    url: AnyHttpUrl
+
+    _MAX_URL_LENGTH = 1000
+
+    @validator("url", pre=True)
+    def validate_url_length(cls, value: str) -> str:
+        return super().validate_url_length(value)
+
+
+class ThumbnailProperties(CamelCaseModel, UrlLengthValidatorMixin):
+    url: AnyHttpUrl
+
+    _MAX_URL_LENGTH = 1000
+
+    @validator("url", pre=True)
+    def validate_url_length(cls, value: str) -> str:
+        return super().validate_url_length(value)
+
+
+class Suggestion(CamelCaseModel):
+    text: constr(min_length=1, max_length=25)
+    postback_data: constr(min_length=1, max_length=2048)
+
+
+class SuggestionReply(Suggestion):
+    type: Literal["REPLY"]
+
+
+class SuggestionOpenUrl(Suggestion, UrlLengthValidatorMixin):
+    type: Literal["OPEN_URL"]
+    url: AnyHttpUrl
+
+    _MAX_URL_LENGTH = 1000
+
+    @validator("url", pre=True)
+    def validate_url_length(cls, value: str) -> str:
+        return super().validate_url_length(value)
+
+
+class SuggestionDialPhone(Suggestion):
+    type: Literal["DIAL_PHONE"]
+    phone_number: Optional[constr(regex=r"\+?\d{5,15}")] = None  # noqa: F722
+
+
+class SuggestionShowLocation(Suggestion):
+    type: Literal["SHOW_LOCATION"]
+    latitude: confloat(ge=-90, le=90)
+    longitude: confloat(ge=-180, le=180)
+    label: Optional[constr(min_length=1, max_length=100)] = None
+
+
+class SuggestionRequestLocation(Suggestion):
+    type: Literal["REQUEST_LOCATION"]
+
+
+class CardMedia(CamelCaseModel):
+    file: FileProperties
+    thumbnail: Optional[ThumbnailProperties] = None
+    height: HeightEnum
+
+
+class CardContent(CamelCaseModel):
+    title: Optional[constr(min_length=1, max_length=200)] = None
+    description: Optional[constr(min_length=1, max_length=2000)] = None
+    media: Optional[CardMedia] = None
+    suggestions: Optional[
+        List[
+            Union[
+                SuggestionShowLocation,
+                SuggestionDialPhone,
+                SuggestionOpenUrl,
+                SuggestionReply,
+                SuggestionRequestLocation,
+            ]
+        ]
+    ] = None
+
+    @validator("suggestions")
+    def validate_suggestions(cls, suggestions: List[Suggestion]) -> List[Suggestion]:
+        if len(suggestions) > 4:
+            raise ValueError("There can be only four suggestions in a card")
+        return suggestions
+
+
+class Contents(CardContent):
+    pass
+
+
+class ContentCarousel(CamelCaseModel):
+    type: Literal["CAROUSEL"]
+    card_width: CardWidth
+    contents: List[Contents]
+    suggestions: Optional[
+        List[
+            Union[
+                SuggestionShowLocation,
+                SuggestionDialPhone,
+                SuggestionOpenUrl,
+                SuggestionReply,
+                SuggestionRequestLocation,
+            ]
+        ]
+    ] = None
+
+    @validator("contents")
+    def validate_contents(cls, contents: List[Contents]) -> List[Contents]:
+        if len(contents) < 2 or len(contents) > 10:
+            raise ValueError("There can be only 2 - 10 content objects in a Carousel")
+
+        return contents
+
+
+class ContentCard(CamelCaseModel):
+    type: Literal["CARD"]
+    orientation: OrientationEnum
+    alignment: AlignmentEnum
+    content: CardContent
+    suggestions: Optional[
+        List[
+            Union[
+                SuggestionShowLocation,
+                SuggestionDialPhone,
+                SuggestionOpenUrl,
+                SuggestionReply,
+                SuggestionRequestLocation,
+            ]
+        ]
+    ] = None
+
+
+class ContentFile(CamelCaseModel):
+    type: Literal["FILE"]
+    file: FileProperties
+    thumbnail: Optional[ThumbnailProperties] = None
+
+
+class ContentText(CamelCaseModel):
+    type: Literal["TEXT"]
+    text: constr(min_length=1, max_length=1000)
+    suggestions: Optional[
+        List[
+            Union[
+                SuggestionShowLocation,
+                SuggestionDialPhone,
+                SuggestionOpenUrl,
+                SuggestionReply,
+                SuggestionRequestLocation,
+            ]
+        ]
+    ] = []
+
+
+class SmsFailover(CamelCaseModel):
+    from_number: constr(min_length=1) = Field(alias="from")
+    text: constr(min_length=1)
+    validity_period: Optional[int] = None
+    validity_period_time_unit: Optional[ValidityPeriodTimeUnitEnum] = None
+
+
+class RCSMessageBody(MessageBodyBase):
+    from_number: Optional[str] = Field(alias="from")
+    to: str
+    validity_period: Optional[int] = None
+    validity_period_time_unit: Optional[ValidityPeriodTimeUnitEnum] = None
+    content: Union[ContentCarousel, ContentCard, ContentFile, ContentText]
+    sms_failover: Optional[SmsFailover] = None
+    notify_url: Optional[str] = None
+    callback_data: Optional[str] = None
+    message_id: Optional[str] = None

infobip_channels/rcs/Models/body/send_bulk_rcs_message.py

@@ -0,0 +1,36 @@
+from typing import Dict, List, Optional
+
+from infobip_channels.core.models import CamelCaseModel, ResponseBase, ResponseStatus
+
+
+class ServiceException(CamelCaseModel):
+    message_id: str
+    text: str
+    validation_errors: Optional[Dict[str, List[str]]] = None
+
+
+class RequestError(CamelCaseModel):
+    service_exception: ServiceException
+
+
+class RCSResponseError(ResponseBase):
+    request_error: RequestError
+
+
+class SendRcsResponseMessage(CamelCaseModel):
+    to: Optional[str] = None
+    message_count: Optional[int] = None
+    message_id: Optional[str] = None
+    status: ResponseStatus
+
+
+class RCSResponseOK(ResponseBase):
+    messages: List[SendRcsResponseMessage]
+
+
+class Message(CamelCaseModel):
+    messages: List[SendRcsResponseMessage]
+
+
+class RCSResponseOKList(ResponseBase):
+    list: List[Message]