smsaero-api-async 3.0.0__tar.gz → 3.1.0__tar.gz

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/CONTRIBUTING.md

@@ -93,4 +93,4 @@ Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
-3. The pull request should work with Python 3.6+, PyPy. Check [https://travis-ci.org/smsaero/smsaero_python_async/pull_requests](https://travis-ci.org/smsaero/smsaero_python_async/pull_requests) and make sure that the tests pass for all supported Python versions.
+3. The pull request should work with Python 3.7+, PyPy. Check [https://travis-ci.org/smsaero/smsaero_python_async/pull_requests](https://travis-ci.org/smsaero/smsaero_python_async/pull_requests) and make sure that the tests pass for all supported Python versions.

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: smsaero_api_async
-Version: 3.0.0
-Summary: SmsAero Async API client
+Version: 3.1.0
+Summary: SMS Aero Async API client
 Home-page: https://github.com/smsaero/smsaero_python/
-Author: SmsAero
+Author: SMS Aero
 Author-email: admin@smsaero.ru
 License: MIT
 Keywords: smsaero,api,smsaero_api_async,sms,hlr,viber
@@ -13,7 +13,6 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -27,7 +26,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Communications :: Telephony
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
@@ -45,7 +44,7 @@ Requires-Dist: bandit>=1.7.9; extra == "dev"
 Requires-Dist: build>=1.2.1; extra == "dev"
 Requires-Dist: twine>=5.1.1; extra == "dev"
 
-# SmsAero async API client
+# Python async library for sending SMS messages via SMS Aero API
 
 [![PyPI version](https://badge.fury.io/py/smsaero-api-async.svg)](https://badge.fury.io/py/smsaero-api-async)
 [![Python Versions](https://img.shields.io/pypi/pyversions/smsaero-api-async.svg)](https://pypi.org/project/smsaero-api-async/)
@@ -88,8 +87,25 @@ async def send_sms(phone: int, message: str) -> None:
         await api.close_session()
 
 
+async def send_telegram_code(phone: int, code: int) -> None:
+    """
+    Sends a Telegram code
+
+    Parameters:
+    phone (int): The phone number to which the Telegram code will be sent.
+    code (int): The Telegram code (4 to 8 digits).
+    """
+    api = smsaero.SmsAero(SMSAERO_EMAIL, SMSAERO_API_KEY)
+    try:
+        result = await api.send_telegram(phone, code)
+        pprint.pprint(result)
+    finally:
+        await api.close_session()
+
+
 if __name__ == '__main__':
     asyncio.run(send_sms(70000000000, 'Hello, World!'))
+    asyncio.run(send_telegram_code(79990000000, 1234))
 ```
 
 #### Exceptions:
@@ -117,7 +133,7 @@ docker run -it --rm 'smsaero/smsaero_python_async:latest' smsaero_send --email "
 
 ## Compatibility:
 
-* Currently version of library is compatible with Python 3.6+.
+* Currently version of library is compatible with Python 3.7+.
 
 
 ## License:

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/README.md

@@ -1,4 +1,4 @@
-# SmsAero async API client
+# Python async library for sending SMS messages via SMS Aero API
 
 [![PyPI version](https://badge.fury.io/py/smsaero-api-async.svg)](https://badge.fury.io/py/smsaero-api-async)
 [![Python Versions](https://img.shields.io/pypi/pyversions/smsaero-api-async.svg)](https://pypi.org/project/smsaero-api-async/)
@@ -41,8 +41,25 @@ async def send_sms(phone: int, message: str) -> None:
         await api.close_session()
 
 
+async def send_telegram_code(phone: int, code: int) -> None:
+    """
+    Sends a Telegram code
+
+    Parameters:
+    phone (int): The phone number to which the Telegram code will be sent.
+    code (int): The Telegram code (4 to 8 digits).
+    """
+    api = smsaero.SmsAero(SMSAERO_EMAIL, SMSAERO_API_KEY)
+    try:
+        result = await api.send_telegram(phone, code)
+        pprint.pprint(result)
+    finally:
+        await api.close_session()
+
+
 if __name__ == '__main__':
     asyncio.run(send_sms(70000000000, 'Hello, World!'))
+    asyncio.run(send_telegram_code(79990000000, 1234))
 ```
 
 #### Exceptions:
@@ -70,7 +87,7 @@ docker run -it --rm 'smsaero/smsaero_python_async:latest' smsaero_send --email "
 
 ## Compatibility:
 
-* Currently version of library is compatible with Python 3.6+.
+* Currently version of library is compatible with Python 3.7+.
 
 
 ## License:

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/setup.py

@@ -1,4 +1,4 @@
-"""Setup script for the SmsAero API client package."""
+"""Setup script for the SMS Aero API client package."""
 
 from setuptools import setup, find_packages
 
@@ -9,8 +9,8 @@ with open("README.md", "r", encoding="utf-8") as file:
 
 setup(
     name="smsaero_api_async",
-    version="3.0.0",
-    description="SmsAero Async API client",
+    version="3.1.0",
+    description="SMS Aero Async API client",
     keywords=[
         "smsaero",
         "api",
@@ -21,13 +21,13 @@ setup(
     ],
     long_description=long_description,
     long_description_content_type="text/markdown",
-    author="SmsAero",
+    author="SMS Aero",
     author_email="admin@smsaero.ru",
     help_center="https://smsaero.ru/support/",
     url="https://github.com/smsaero/smsaero_python/",
     license="MIT",
     packages=find_packages(exclude=["tests", "tests.*"]),
-    python_requires=">=3.6",
+    python_requires=">=3.7",
     include_package_data=True,
     install_requires=[
         "setuptools",
@@ -55,7 +55,6 @@ setup(
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
-        "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
@@ -76,6 +75,6 @@ setup(
         ],
     },
     options={
-        "bdist_wheel": {"universal": True},
+        "bdist_wheel": {"universal": False},
     },
 )

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/smsaero/__init__.py

@@ -1103,6 +1103,77 @@ class SmsAero:
         self.page_validate(page)
         return await self.request("viber/statistic", {"sendingId": int(sending_id)}, page=page)
 
+    async def send_telegram(
+        self,
+        number: Union[int, List[int]],
+        code: int,
+        sign: Optional[str] = None,
+        text: Optional[str] = None,
+    ) -> Dict:
+        """
+        Sends a Telegram code to the specified number or numbers.
+
+        Parameters:
+        number (Union[int, List[int]]): The recipient's phone number or a list of phone numbers.
+        code (int): The Telegram code (4 to 8 digits).
+        sign (str, optional): The SMS sender name.
+        text (str, optional): The SMS message text.
+
+        When using text and sign parameters, if the Telegram code is not delivered,
+        an SMS will be sent with the specified values.
+
+        Returns:
+        Dict: The server's response in JSON format.
+
+        Example response:
+        {
+            "id": 1,
+            "number": "79990000000",
+            "telegramCode": "1234",
+            "smsText": "Ваш код 1234",
+            "smsFrom": "SMS Aero",
+            "idSms": null,
+            "status": 0,
+            "extendStatus": "queue",
+            "cost": "1.00",
+            "dateCreate": 1732796285
+        }
+        """
+        self.send_telegram_validate(number, code, sign, text)
+        data: Dict = {"code": int(code)}
+        data.update(**self.fill_nums(number))
+        if sign:
+            data["sign"] = sign
+        if text:
+            data["text"] = text
+        return await self.request("telegram/send", data)
+
+    async def telegram_status(self, telegram_id: int) -> Dict:
+        """
+        Retrieves the status of a Telegram code delivery.
+
+        Parameters:
+        telegram_id (int): The message ID returned by the service when sending.
+
+        Returns:
+        Dict: The server's response in JSON format.
+
+        Example response:
+        {
+            "id": 1,
+            "number": "79990000000",
+            "telegramCode": "1234",
+            "smsText": "Ваш код 1234",
+            "smsFrom": "SMS Aero",
+            "idSms": null,
+            "status": 1,
+            "extendStatus": "delivery",
+            "cost": "1.00",
+            "dateCreate": 1732796285
+        }
+        """
+        return await self.request("telegram/status", {"id": int(telegram_id)})
+
     def phone_validation(self, number: Union[int, List[int]]) -> None:
         """
         Validates the phone number or a list of phone numbers.
@@ -1380,6 +1451,41 @@ class SmsAero:
             raise TypeError("Surname must be a string.")
         self.page_validate(page)
 
+    def send_telegram_validate(
+        self,
+        number: Union[int, List[int]],
+        code: int,
+        sign: Optional[str] = None,
+        text: Optional[str] = None,
+    ) -> None:
+        """
+        Validates the parameters for the send_telegram method.
+
+        Parameters:
+        number (Union[int, List[int]]): The recipient's phone number or a list of phone numbers.
+        code (int): The Telegram code (4 to 8 digits).
+        sign (str, optional): The SMS sender name.
+        text (str, optional): The SMS message text.
+
+        Raises:
+        TypeError: If any of the parameters have an incorrect type.
+        ValueError: If any of the parameters have an incorrect value.
+        """
+        if not isinstance(code, int):
+            raise TypeError("code must be an integer")
+        if not 4 <= len(str(code)) <= 8:
+            raise ValueError("Length of code must be between 4 and 8 digits")
+        if sign is not None and not isinstance(sign, str):
+            raise TypeError("sign must be a string")
+        if sign is not None and not 2 <= len(sign) <= 64:
+            raise ValueError("Length of sign must be between 2 and 64 characters")
+        if text is not None and not isinstance(text, str):
+            raise TypeError("text must be a string")
+        if text is not None and not 2 <= len(text) <= 640:
+            raise ValueError("Length of text must be between 2 and 640 characters")
+
+        self.phone_validation(number)
+
     @staticmethod
     def init_validate(
         api_key: str,

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/smsaero_api_async.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: smsaero_api_async
-Version: 3.0.0
-Summary: SmsAero Async API client
+Version: 3.1.0
+Summary: SMS Aero Async API client
 Home-page: https://github.com/smsaero/smsaero_python/
-Author: SmsAero
+Author: SMS Aero
 Author-email: admin@smsaero.ru
 License: MIT
 Keywords: smsaero,api,smsaero_api_async,sms,hlr,viber
@@ -13,7 +13,6 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -27,7 +26,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Communications :: Telephony
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
@@ -45,7 +44,7 @@ Requires-Dist: bandit>=1.7.9; extra == "dev"
 Requires-Dist: build>=1.2.1; extra == "dev"
 Requires-Dist: twine>=5.1.1; extra == "dev"
 
-# SmsAero async API client
+# Python async library for sending SMS messages via SMS Aero API
 
 [![PyPI version](https://badge.fury.io/py/smsaero-api-async.svg)](https://badge.fury.io/py/smsaero-api-async)
 [![Python Versions](https://img.shields.io/pypi/pyversions/smsaero-api-async.svg)](https://pypi.org/project/smsaero-api-async/)
@@ -88,8 +87,25 @@ async def send_sms(phone: int, message: str) -> None:
         await api.close_session()
 
 
+async def send_telegram_code(phone: int, code: int) -> None:
+    """
+    Sends a Telegram code
+
+    Parameters:
+    phone (int): The phone number to which the Telegram code will be sent.
+    code (int): The Telegram code (4 to 8 digits).
+    """
+    api = smsaero.SmsAero(SMSAERO_EMAIL, SMSAERO_API_KEY)
+    try:
+        result = await api.send_telegram(phone, code)
+        pprint.pprint(result)
+    finally:
+        await api.close_session()
+
+
 if __name__ == '__main__':
     asyncio.run(send_sms(70000000000, 'Hello, World!'))
+    asyncio.run(send_telegram_code(79990000000, 1234))
 ```
 
 #### Exceptions:
@@ -117,7 +133,7 @@ docker run -it --rm 'smsaero/smsaero_python_async:latest' smsaero_send --email "
 
 ## Compatibility:
 
-* Currently version of library is compatible with Python 3.6+.
+* Currently version of library is compatible with Python 3.7+.
 
 
 ## License:

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/tests/test_smsaero.py

@@ -802,3 +802,92 @@ class TestSmsAero(unittest.TestCase):
                 "number": 79031234567,
             },
         )
+
+    @patch.object(SmsAero, "request")
+    async def test_send_telegram(self, mock_request):
+        mock_request.return_value = {
+            "id": 1,
+            "number": "79990000000",
+            "telegramCode": "1234",
+            "smsText": "Ваш код 1234",
+            "smsFrom": "SMS Aero",
+            "idSms": None,
+            "status": 0,
+            "extendStatus": "queue",
+            "cost": "1.00",
+            "dateCreate": 1732796285,
+        }
+
+        result = await self.smsaero.send_telegram(79990000000, 1234)
+
+        self.assertEqual(
+            result,
+            {
+                "id": 1,
+                "number": "79990000000",
+                "telegramCode": "1234",
+                "smsText": "Ваш код 1234",
+                "smsFrom": "SMS Aero",
+                "idSms": None,
+                "status": 0,
+                "extendStatus": "queue",
+                "cost": "1.00",
+                "dateCreate": 1732796285,
+            },
+        )
+        mock_request.assert_called_once_with("telegram/send", {"code": 1234, "number": 79990000000})
+
+    @patch.object(SmsAero, "request")
+    async def test_send_telegram_with_sign_and_text(self, mock_request):
+        mock_request.return_value = {"success": True}
+
+        result = await self.smsaero.send_telegram(79990000000, 1234, "TestSign", "Your code is 1234")
+
+        self.assertEqual(result, {"success": True})
+        mock_request.assert_called_once_with(
+            "telegram/send", {"code": 1234, "number": 79990000000, "sign": "TestSign", "text": "Your code is 1234"}
+        )
+
+    @patch.object(SmsAero, "request")
+    async def test_send_telegram_with_list_of_numbers(self, mock_request):
+        mock_request.return_value = {"success": True}
+        numbers = [79990000000, 79990000001]
+
+        result = await self.smsaero.send_telegram(numbers, 1234)
+
+        self.assertEqual(result, {"success": True})
+        mock_request.assert_called_once_with("telegram/send", {"code": 1234, "numbers": numbers})
+
+    @patch.object(SmsAero, "request")
+    async def test_telegram_status(self, mock_request):
+        mock_request.return_value = {
+            "id": 1,
+            "number": "79990000000",
+            "telegramCode": "1234",
+            "smsText": "Ваш код 1234",
+            "smsFrom": "SMS Aero",
+            "idSms": None,
+            "status": 1,
+            "extendStatus": "delivery",
+            "cost": "1.00",
+            "dateCreate": 1732796285,
+        }
+
+        result = await self.smsaero.telegram_status(1)
+
+        self.assertEqual(
+            result,
+            {
+                "id": 1,
+                "number": "79990000000",
+                "telegramCode": "1234",
+                "smsText": "Ваш код 1234",
+                "smsFrom": "SMS Aero",
+                "idSms": None,
+                "status": 1,
+                "extendStatus": "delivery",
+                "cost": "1.00",
+                "dateCreate": 1732796285,
+            },
+        )
+        mock_request.assert_called_once_with("telegram/status", {"id": 1})

{smsaero_api_async-3.0.0 → smsaero_api_async-3.1.0}/tests/test_validators.py

@@ -335,3 +335,29 @@ class TestSmsAeroValidators(unittest.TestCase):
             self.smsaero.contact_list_validate(page="invalid_page")
         with self.assertRaises(ValueError):
             self.smsaero.contact_list_validate(number=[79038805678, "invalid_number"])
+
+    def test_send_telegram_validate(self):
+        with self.assertRaises(TypeError):
+            self.smsaero.send_telegram_validate("invalid_number", 1234)
+        with self.assertRaises(TypeError):
+            self.smsaero.send_telegram_validate(79990000000, "invalid_code")
+        with self.assertRaises(TypeError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, 123)
+        with self.assertRaises(TypeError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, "sign", 123)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 123)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 123456789)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, "T")
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, "T" * 65)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, "sign", "T")
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(79990000000, 1234, "sign", "T" * 641)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate(123, 1234)
+        with self.assertRaises(ValueError):
+            self.smsaero.send_telegram_validate([123, 1234567890123456], 1234)