python-terminusgps 34.1.0__py3-none-any.whl → 35.1.0__py3-none-any.whl

{python_terminusgps-34.1.0.dist-info → python_terminusgps-35.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 34.1.0
+Version: 35.1.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-34.1.0.dist-info → python_terminusgps-35.1.0.dist-info}/RECORD

@@ -15,7 +15,7 @@ terminusgps/authorizenet/tests/test_auth.py,sha256=sdByYrcv8RKjcJckOHbyHH1z_M4qr
 terminusgps/authorizenet/tests/test_profiles.py,sha256=tvLBY0iSAC33RlWiBP_NSnPskUQBjfrf0YHMpR-m22k,7566
 terminusgps/authorizenet/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/aws/notifications.py,sha256=tYU1VMmkq9Bg0CBCirVtUcNBLNkl5XnCBwzQgYIlDQU,5836
+terminusgps/aws/notifications.py,sha256=i6BR4G-uw5m9i4FaHzjmLZb3ufdqSpeFfg3MwTXILVI,7296
 terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
 terminusgps/aws/utils.py,sha256=68GWcllu4h41qzFiKdUkWOAA4LDsTPqRY446VRMxYsY,116
 terminusgps/aws/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -54,7 +54,7 @@ terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 terminusgps/wialon/tests/test_items.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/wialon/tests/test_session.py,sha256=9mBlYchMo9NeqRIZsmxYzrM1zBHorqu4ooxqSNppLpI,1336
 terminusgps/wialon/tests/test_utils.py,sha256=SK4PxJQGECFnzx_EQeRAQfsQ5_3FLaVcis2W9u_ibuI,1730
-python_terminusgps-34.1.0.dist-info/METADATA,sha256=rSD4YC5vTMvT3ML8Yi9sM5zVFSQU5NJI_Y9kR8nIgyA,1616
-python_terminusgps-34.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-34.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-34.1.0.dist-info/RECORD,,
+python_terminusgps-35.1.0.dist-info/METADATA,sha256=uIku-n8_UI-SA-M-ojn5NpxbNoP9Yjmn6G-bKMJ9WO8,1616
+python_terminusgps-35.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-35.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-35.1.0.dist-info/RECORD,,

terminusgps/aws/notifications.py

@@ -1,46 +1,75 @@
-import asyncio
-import uuid
-from collections.abc import Sequence
+import os
 from contextlib import AsyncExitStack
 
 from aiobotocore.session import AioSession
 
-from terminusgps.django.validators import validate_e164_phone_number
-
 
 class AsyncNotificationManager:
+    """Asyncronously delivers notifications using `AWS End User Messaging <https://docs.aws.amazon.com/end-user-messaging/>`_."""
+
     def __init__(
-        self, group_id: str | None = None, region_name: str = "us-east-1"
+        self,
+        origin_pool_arn: str | None = os.getenv("AWS_MESSAGING_ORIGIN_POOL"),
+        configuration_set: str | None = os.getenv("AWS_MESSAGING_CONFIGURATION"),
+        max_sms_price: str = "0.20",
+        max_voice_price: str = "0.20",
+        region_name: str = "us-east-1",
+        debug_enabled: bool = False,
     ) -> None:
         """
-        Sets :py:attr:`group_id` and :py:attr:`region_name` if provided.
-
+        Sets attributes on the notification manager.
+
+        :param origin_pool_arn: A phone pool ARN for notification dispatch. Default is :envvar:`AWS_MESSAGING_ORIGIN_POOL`.
+        :type origin_pool_arn: :py:obj:`str` | :py:obj:`None`
+        :param configuration_set: An end-user messaging configuration set ARN. Default is :envvar:`AWS_MESSAGING_CONFIGURATION`.
+        :type configuration_set: :py:obj:`str` | :py:obj:`None`
+        :param max_sms_price: Max price to spend on a single SMS message.
+        :type max_sms_price: :py:obj:`str`
+        :param max_voice_price: Max price to spend per minute on a single voice message.
+        :type max_voice_price: :py:obj:`str`
+        :param region_name: An AWS region name used to open an AWS client.
+        :type region_name: :py:obj:`str`
+        :param debug_enabled: Whether or not to enable debug mode.
+        :type debug_enabled: :py:obj:`None`
+        :raises ValueError: If ``origin_pool_arn`` wasn't provided and :envvar:`AWS_MESSAGING_ORIGIN_POOL` wasn't set.
+        :raises ValueError: If ``configuration_set`` wasn't provided and :envvar:`AWS_MESSAGING_CONFIGURATION` wasn't set.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
+        if origin_pool_arn is None:
+            raise ValueError(f"'origin_pool_arn' is required, got '{origin_pool_arn}'.")
+        if configuration_set is None:
+            raise ValueError(
+                f"'configuration_set' is required, got '{configuration_set}'."
+            )
+
         self._exit_stack = AsyncExitStack()
-        self._sns_client = None
+        self._pinpoint_client = None
         self._region_name = region_name
-        self.group_id = group_id
+        self._origin_pool_arn = origin_pool_arn
+        self._configuration_set = configuration_set
+        self._max_sms_price = max_sms_price
+        self._max_voice_price = max_voice_price
+        self._debug = debug_enabled
 
     async def __aenter__(self) -> "AsyncNotificationManager":
         """
-        Creates an asyncronous session and client.
+        Creates asyncronous clients.
 
         :returns: The notification manager.
         :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncNotificationManager`
 
         """
         session = AioSession()
-        self._sns_client = await self._exit_stack.enter_async_context(
-            session.create_client("sns", region_name=self.region_name)
+        self._pinpoint_client = await self._exit_stack.enter_async_context(
+            session.create_client("pinpoint-sms-voice-v2", region_name=self.region_name)
         )
         return self
 
     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
         """
-        Destroys the asyncronous session.
+        Destroys asyncronous clients.
 
         :param exc_type: Exception type.
         :param exc_val: Exception value.
@@ -62,132 +91,107 @@ class AsyncNotificationManager:
         return self._region_name
 
     @property
-    def group_id(self) -> str:
-        """
-        A message group id.
-
-        :type: :py:obj:`str`
+    def configuration_set(self) -> str:
+        return self._configuration_set
 
-        """
-        return str(self._group_id)
-
-    @group_id.setter
-    def group_id(self, other: str | None) -> None:
-        """
-        Sets :py:attr:`group_id` to ``other``.
-
-        :param other: A message group id.
-        :type other: :py:obj:`str` | :py:obj:`None`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        if not other:
-            other = str(uuid.uuid4())
-        self._group_id = other
-
-    async def send_push_batch(self, target_arns: Sequence[str], message: str) -> None:
-        """
-        Sends a push notification to each AWS resource by ARN in ``target_arns``.
-
-        :param target_arns: A sequence of AWS resource ARNs.
-        :type target_arns: :py:obj:`~collections.abc.Sequence`
-        :param message: A message body.
-        :type message: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        await asyncio.gather(
-            *[self.send_push(target_arn=arn, message=message) for arn in target_arns]
-        )
-
-    async def send_sms_batch(self, to_numbers: Sequence[str], message: str) -> None:
-        """
-        Sends an sms message to each phone number in ``to_numbers``.
+    @property
+    def origin_pool(self) -> str:
+        return self._origin_pool_arn
 
-        :param to_numbers: A sequence of phone numbers.
-        :type to_numbers: :py:obj:`~collections.abc.Sequence`
-        :param message: A message body.
-        :type message: :py:obj:`str`
-        :raises ValidationError: If a ``to_number`` wasn't a valid E.164 formatted phone number.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+    @property
+    def max_sms_price(self) -> str:
+        return self._max_sms_price
 
-        """
-        for to_number in to_numbers:
-            validate_e164_phone_number(to_number)
+    @property
+    def max_voice_price(self) -> str:
+        return self._max_voice_price
 
-        await asyncio.gather(
-            *[self.send_sms(to_number=num, message=message) for num in to_numbers]
-        )
+    @property
+    def debug(self) -> bool:
+        return self._debug
 
     async def send_sms(
-        self, to_number: str, message: str, message_id: str | None = None
-    ) -> None:
-        """
-        Sends an sms to ``to_number``.
-
-        :param to_number: A destination phone number.
-        :type to_number: :py:obj:`str`
+        self,
+        phone: str,
+        message: str,
+        ttl: int = 300,
+        dry_run: bool = False,
+        feedback: bool = False,
+    ) -> dict:
+        """
+        Texts ``message`` to ``phone`` via sms.
+
+        :param phone: A destination phone number.
+        :type phone: :py:obj:`str`
         :param message: A message body.
         :type message: :py:obj:`str`
-        :param message_id: A message deduplication id. :py:func:`~uuid.uuid4` is used if ``message_id`` was not provided.
-        :type message_id: :py:obj:`str` | :py:obj:`None`
-        :raises ValidationError: If ``to_number`` wasn't a valid E.164 formatted phone number.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        validate_e164_phone_number(to_number)
-
-        if not message_id:
-            message_id = str(uuid.uuid4())
-
-        await self._sns_client.publish(
+        :param ttl: Time to live in ms. Default is ``300``.
+        :type ttl: :py:obj:`int`
+        :param dry_run: Whether or not to execute the voice message as a dry run. Default is :py:obj:`False`.
+        :type dry_run: :py:obj:`bool`
+        :param feedback: Whether or not to include message feedback in the response. Default is :py:obj:`False`.
+        :type feedback: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`_pinpoint_client` wasn't set.
+        :returns: A voice message response.
+        :rtype: :py:obj:`dict`
+
+        """
+        assert self._pinpoint_client, "Asyncronous client wasn't set."
+        return await self._pinpoint_client.send_text_message(
             **{
-                "PhoneNumber": to_number,
-                "Message": message,
-                "MessageDeduplicationId": message_id,
-                "MessageGroupId": self.group_id,
+                "DestinationPhoneNumber": phone,
+                "OriginationIdentity": self.origin_pool,
+                "MessageBody": message,
+                "MessageType": "TRANSACTIONAL",
+                "ConfigurationSetName": self.configuration_set,
+                "MaxPrice": self.max_sms_price,
+                "TimeToLive": ttl,
+                "DryRun": dry_run or self.debug,
+                "MessageFeedbackEnabled": feedback,
             }
         )
 
-    async def send_push(
-        self, target_arn: str, message: str, message_id: str | None = None
-    ) -> None:
+    async def send_voice(
+        self,
+        phone: str,
+        message: str,
+        ttl: int = 300,
+        voice_id: str = "Joanna",
+        dry_run: bool = False,
+        feedback: bool = False,
+    ) -> dict:
         """
-        Sends a push notification to ``target_arn``.
+        Calls ``phone`` and reads ``message`` aloud.
 
-        :param target_arn: An AWS resource ARN.
-        :type target_arn: :py:obj:`str`
+        :param phone: A destination phone number.
+        :type phone: :py:obj:`str`
         :param message: A message body.
         :type message: :py:obj:`str`
-        :param message_id: A message deduplication id. :py:func:`~uuid.uuid4` is used if ``message_id`` was not provided.
-        :type message_id: :py:obj:`str` | :py:obj:`None`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        if not message_id:
-            message_id = str(uuid.uuid4())
-
-        await self._sns_client.publish(
+        :param ttl: Time to live in ms. Default is ``300``.
+        :type ttl: :py:obj:`int`
+        :param voice_id: A voice id to use for speech synthesis.
+        :type voice_id: :py:obj:`str`
+        :param dry_run: Whether or not to execute the voice message as a dry run. Default is :py:obj:`False`.
+        :type dry_run: :py:obj:`bool`
+        :param feedback: Whether or not to include message feedback in the response. Default is :py:obj:`False`.
+        :type feedback: :py:obj:`bool`
+        :raises AssertionError: If :py:attr:`_pinpoint_client` wasn't set.
+        :returns: A voice message response.
+        :rtype: :py:obj:`dict`
+
+        """
+        assert self._pinpoint_client, "Asyncronous client wasn't set."
+        return await self._pinpoint_client.send_voice_message(
             **{
-                "TargetArn": target_arn,
-                "Message": message,
-                "MessageDeduplicationId": message_id,
-                "MessageGroupId": self.group_id,
+                "DestinationPhoneNumber": phone,
+                "OriginationIdentity": self.origin_pool,
+                "MessageBody": message,
+                "MessageBodyTextType": "TEXT",
+                "VoiceId": voice_id.upper(),
+                "ConfigurationSetName": self.configuration_set,
+                "MaxPricePerMinute": self.max_voice_price,
+                "TimeToLive": ttl,
+                "DryRun": dry_run or self.debug,
+                "MessageFeedbackEnabled": feedback,
             }
         )
-
-
-async def main() -> None:
-    async with AsyncNotificationManager(str(uuid.uuid4())) as manager:
-        await manager.send_sms_batch(
-            ["+17133049421", "+18324667085", "+18322835634"], "This is a test message."
-        )
-
-
-if __name__ == "__main__":
-    asyncio.run(main())