create messages package

Author: maxkahan

messages/BUILD

@@ -0,0 +1,16 @@
+resource(name='pyproject', source='pyproject.toml')
+file(name='readme', source='README.md')
+
+files(sources=['tests/data/*'])
+
+python_distribution(
+    name='vonage-messages',
+    dependencies=[
+        ':pyproject',
+        ':readme',
+        'messages/src/vonage_messages',
+    ],
+    provides=python_artifact(),
+    generate_setup=False,
+    repositories=['@pypi'],
+)

messages/CHANGES.md

@@ -0,0 +1,2 @@
+# 1.0.0
+- Initial upload

messages/README.md

@@ -0,0 +1,10 @@
+# Vonage Messages Package
+
+This package contains the code to use [Vonage's Messages API](https://developer.vonage.com/en/messages/overview) in Python.
+
+## Usage
+
+It is recommended to use this as part of the main `vonage` package. The examples below assume you've created an instance of the `vonage.Vonage` class called `vonage_client`.
+
+### Send a message
+

messages/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = 'vonage-messages'
+version = '1.0.0'
+description = 'Vonage messages package'
+readme = "README.md"
+authors = [{ name = "Vonage", email = "[email protected]" }]
+requires-python = ">=3.8"
+dependencies = [
+  "vonage-http-client>=1.2.1",
+  "vonage-utils>=1.0.1",
+  "pydantic>=2.6.1",
+]
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: Apache Software License",
+]
+
+[project.urls]
+homepage = "https://github.com/Vonage/vonage-python-sdk"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

messages/src/vonage_messages/BUILD

@@ -0,0 +1 @@
+python_sources()

messages/src/vonage_messages/__init__.py

@@ -0,0 +1,27 @@
+# from .enums import ChannelType, Locale
+# from .errors import VerifyError
+# from .requests import (
+#     EmailChannel,
+#     SilentAuthChannel,
+#     SmsChannel,
+#     VerifyRequest,
+#     VoiceChannel,
+#     WhatsappChannel,
+# )
+# from .responses import CheckCodeResponse, StartVerificationResponse
+# from .verify_v2 import VerifyV2
+
+# __all__ = [
+#     'VerifyV2',
+#     'VerifyError',
+#     'ChannelType',
+#     'CheckCodeResponse',
+#     'Locale',
+#     'VerifyRequest',
+#     'SilentAuthChannel',
+#     'SmsChannel',
+#     'WhatsappChannel',
+#     'VoiceChannel',
+#     'EmailChannel',
+#     'StartVerificationResponse',
+# ]

messages/src/vonage_messages/enums.py

@@ -0,0 +1,32 @@
+from enum import Enum
+
+
+class MessageType(str, Enum):
+    TEXT = 'text'
+    IMAGE = 'image'
+    AUDIO = 'audio'
+    VIDEO = 'video'
+    FILE = 'file'
+    TEMPLATE = 'template'
+    STICKER = 'sticker'
+    CUSTOM = 'custom'
+    VCARD = 'vcard'
+
+
+class ChannelType(str, Enum):
+    SMS = 'sms'
+    MMS = 'mms'
+    WHATSAPP = 'whatsapp'
+    MESSENGER = 'messenger'
+    VIBER = 'viber_service'
+
+
+class WebhookVersion(str, Enum):
+    V0_1 = 'v0.1'
+    V1 = 'v1'
+
+
+class EncodingType(str, Enum):
+    TEXT = 'text'
+    UNICODE = 'unicode'
+    AUTO = 'auto'

messages/src/vonage_messages/errors.py

@@ -0,0 +1,5 @@
+from vonage_utils.errors import VonageError
+
+
+class MessagesError(VonageError):
+    """Indicates an error when using the Vonage Verify API."""

messages/src/vonage_messages/messages.py

@@ -0,0 +1,36 @@
+from pydantic import validate_call
+from vonage_http_client.http_client import HttpClient
+
+from .models.sms import BaseMessage
+from .responses import MessageUuid
+
+
+class Messages:
+    """Calls Vonage's Messages API.
+
+    This class provides methods to interact with Vonage's Messages API, allowing you to send messages.
+
+    Args:
+        http_client (HttpClient): An instance of the HttpClient class used to make HTTP requests.
+    """
+
+    def __init__(self, http_client: HttpClient) -> None:
+        self._http_client = http_client
+
+    @validate_call
+    def send(self, message: BaseMessage) -> MessageUuid:
+        """Send a message using Vonage's Messages API.
+
+        Args:
+            message (Message): The message to be sent.
+
+        Returns:
+            MessageUuid: The unique identifier of the sent message.
+        """
+        response = self._http_client.post(
+            self._http_client.api_host,
+            '/v1/messages',
+            message.model_dump(by_alias=True, exclude_none=True),
+        )
+
+        return MessageUuid(**response)

messages/src/vonage_messages/models/message.py

@@ -0,0 +1,13 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+from vonage_utils.types.phone_number import PhoneNumber
+
+from ..enums import WebhookVersion
+
+
+class BaseMessage(BaseModel):
+    to: PhoneNumber
+    client_ref: Optional[str] = Field(None, max_length=100)
+    webhook_url: Optional[str] = None
+    webhook_version: Optional[WebhookVersion] = None