python-terminusgps 35.0.0__py3-none-any.whl → 35.4.0__py3-none-any.whl

{python_terminusgps-35.0.0.dist-info → python_terminusgps-35.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 35.0.0
+Version: 35.4.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-35.0.0.dist-info → python_terminusgps-35.4.0.dist-info}/RECORD

@@ -15,14 +15,11 @@ 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=HQDsxvFh_8vpAvoOo0K_3nteV0ArM-kgSeMhNzBx3es,9618
-terminusgps/aws/secrets.py,sha256=MxQEmmBLpMUQ2tYAsHdCYf-7RZ84LiogdKcTsACX5dw,361
-terminusgps/aws/speech.py,sha256=8d4kLzc1obzW7uAhlSBmPWh_hw92d1eydcIiQROTj7A,4563
-terminusgps/aws/utils.py,sha256=68GWcllu4h41qzFiKdUkWOAA4LDsTPqRY446VRMxYsY,116
+terminusgps/aws/notifications.py,sha256=76YnACuVIMs5EujEATqcBf8HcCFxs2649fnLx9nSauc,11103
+terminusgps/aws/secrets.py,sha256=-9gNTaagJbWpeqTNXdxXsMVKUF2_mwzx5XvqTOFcqYU,670
 terminusgps/aws/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/tests/test_notifications.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/aws/tests/test_secrets.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-terminusgps/aws/tests/test_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 terminusgps/django/mixins.py,sha256=Q9ZJuzpk3d9lDnlVA8ZTVvnZWxB13p08EQ8yVJcztn4,1034
 terminusgps/django/settings.py,sha256=yJIcBE0xjY60AXF_gonY5hS3ofseqPW2k9uSoELgoho,639
@@ -41,21 +38,21 @@ terminusgps/wialon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 terminusgps/wialon/constants.py,sha256=Ju2XL2A4DPFD-w8NjYqEfnnqregl1luPT0XGhGSUnO8,6316
 terminusgps/wialon/flags.py,sha256=M50EdhxQ8IMnJnU0mrHK7-h8Asc6tvNiTOOfd1dBW6A,12815
 terminusgps/wialon/session.py,sha256=09WYWvON_H844IFfdt7_x1we6tHhQSkt9K_BEedBjv0,10396
-terminusgps/wialon/utils.py,sha256=JWHZ7VEeo8VNBH67gjOAQk5ITKuPllWDlJ4dVSQ5blA,11002
+terminusgps/wialon/utils.py,sha256=SwpcxLPBLy0u3AT84G-Co4wxmhRrPFyW3jo_9O6ICvk,11008
 terminusgps/wialon/validators.py,sha256=j5vrtcfClAzRdRkWTvRRAmrne1t0R6cKkmYdE7fAkSs,4247
 terminusgps/wialon/items/__init__.py,sha256=3BVthghekMvhMQSzQgBMlD_phxmKSmp3Zvmo-z0O8Bs,211
-terminusgps/wialon/items/base.py,sha256=7J5B-EPj997GJV7TbZP7pAfjl2G4nTcKmP-RMxmuzoY,10959
+terminusgps/wialon/items/base.py,sha256=YpOPxghLYDZmWQZRb64CjwCq_0rTmm83cIYZm2oN5LY,9344
 terminusgps/wialon/items/resource.py,sha256=DDnyL_Y5P3DxiirUkQb9y4cokMXZVq3xnfn16Vx8sxk,16992
 terminusgps/wialon/items/retranslator.py,sha256=sVEWrp8q1I-tO_rMTCH7TeQDDbZryIq8d9KVnhYyhH0,3795
 terminusgps/wialon/items/route.py,sha256=amNPKZqgl8pEzKA_XJudnvBPzEsfHTmrC7uF15sZVI4,1216
-terminusgps/wialon/items/unit.py,sha256=0XPLfpFh7djiVOcuZE-lUdB_-_LRSO8C2PvfzBFh3HQ,10744
+terminusgps/wialon/items/unit.py,sha256=G72CSpu5pcilGjXQDz8yTZ-xwWXm1rCYZUkG98lY-8w,10504
 terminusgps/wialon/items/unit_group.py,sha256=QV2ZZgICaN3n6W1pFIyMLyNKB6KYBsLyKG64i-qXoOg,4113
 terminusgps/wialon/items/user.py,sha256=5LgwalGO8KS_7psmAVmAlnC0S6SPBDZMOuT5ZqPKRmo,7758
 terminusgps/wialon/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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-35.0.0.dist-info/METADATA,sha256=FJGCV_uc4f3OcIqAv0Lyl2w9jSFw2X6a-0Ev1wNU3xc,1616
-python_terminusgps-35.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-python_terminusgps-35.0.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-python_terminusgps-35.0.0.dist-info/RECORD,,
+python_terminusgps-35.4.0.dist-info/METADATA,sha256=yyOAC6wbzHngb7UQQuqNchUZeeikcsH43qdyJLwBQTg,1616
+python_terminusgps-35.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+python_terminusgps-35.4.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+python_terminusgps-35.4.0.dist-info/RECORD,,

terminusgps/aws/notifications.py

@@ -1,60 +1,95 @@
 import asyncio
 import os
-import uuid
 from collections.abc import Sequence
 from contextlib import AsyncExitStack
 
 from aiobotocore.session import AioSession
+from loguru import logger
 
-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/>`_."""
 
-class AsyncPollyManager:
     def __init__(
-        self, bucket_name: str | None = None, region_name: str = "us-east-1"
+        self,
+        origin_pool_arn: str | None = None,
+        configuration_set: str | None = None,
+        max_sms_price: str = "0.20",
+        max_voice_price: str = "0.20",
+        region_name: str = "us-east-1",
+        debug_enabled: bool = False,
+        logger_level: int = 10,
+        logger_days: int = 10,
     ) -> None:
-        self._exit_stack = AsyncExitStack()
-        self._polly_client = None
-        self._region_name = region_name
-        self._bucket_name = bucket_name or os.getenv("AWS_POLLY_BUCKET_NAME", "")
-
-    @property
-    def region_name(self) -> str:
         """
-        An AWS region name.
-
-        :type: :py:obj:`str`
-
-        """
-        return self._region_name
+        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. Default is :py:obj:`"0.20"`.
+        :type max_sms_price: :py:obj:`str`
+        :param max_voice_price: Max price to spend per minute on a single voice message. Default is :py:obj:`"0.20"`.
+        :type max_voice_price: :py:obj:`str`
+        :param region_name: An AWS region name used to open an AWS client. Default is :py:obj:`"us-east-1"`.
+        :type region_name: :py:obj:`str`
+        :param debug_enabled: Whether or not to enable debug mode. Default is :py:obj:`False`
+        :type debug_enabled: :py:obj:`False`
+        :param logger_level: A logger level. Default is :py:obj:`int`
+        :type logger_level: :py:obj:`int`
+        :param logger_days: How long in days logging data should be saved.
+        :type logger_days: :py:obj:`int`
+        :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`
 
-    @property
-    def bucket_name(self) -> str:
         """
-        The AWS bucket that will host audio files.
+        if not origin_pool_arn and not os.getenv("AWS_MESSAGING_ORIGIN_POOL"):
+            raise ValueError(f"'origin_pool_arn' is required, got '{origin_pool_arn}'.")
+        if not configuration_set and not os.getenv("AWS_MESSAGING_CONFIGURATION"):
+            raise ValueError(
+                f"'configuration_set' is required, got '{configuration_set}'."
+            )
 
-        :type: :py:obj:`str`
+        self._origin_pool_arn = origin_pool_arn or os.getenv(
+            "AWS_MESSAGING_ORIGIN_POOL", ""
+        )
+        self._configuration_set = configuration_set or os.getenv(
+            "AWS_MESSAGING_CONFIGURATION", ""
+        )
 
-        """
-        return self._bucket_name
+        self._exit_stack = AsyncExitStack()
+        self._pinpoint_client = None
+        self._region_name = region_name
+        self._max_sms_price = max_sms_price
+        self._max_voice_price = max_voice_price
+        self._debug = debug_enabled
+        logger.add(
+            f"logs/{self.__class__.__name__}.log",
+            level=logger_level,
+            retention=f"{logger_days} days",
+            diagnose=debug_enabled,
+        )
 
-    async def __aenter__(self) -> "AsyncPollyManager":
+    async def __aenter__(self) -> "AsyncNotificationManager":
         """
-        Creates an asyncronous session and client.
+        Creates asyncronous clients.
 
-        :returns: The polly manager.
-        :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncPollyManager`
+        :returns: The notification manager.
+        :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncNotificationManager`
 
         """
         session = AioSession()
-        self._polly_client = await self._exit_stack.enter_async_context(
-            session.create_client("polly", 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.
@@ -65,247 +100,206 @@ class AsyncPollyManager:
         """
         await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb)
 
-    async def synthesize_speech(
-        self,
-        message: str,
-        format: str = "ogg_vorbis",
-        sample_rate: int = 22050,
-        language_code: str = "en-US",
-    ) -> None:
-        """
-        Synthesizes the message into an audio file and saves it to the S3 bucket.
-
-        :param message: A message to be read aloud.
-        :type message: :py:obj:`str`
-        :param format: A file format. Default is ``"ogg_vorbis"``.
-        :type format: :py:obj:`str`
-        :param sample_rate: The audio frequency in Hz. Default is ``22050``.
-        :type sample_rate: :py:obj:`int`
-        :param language_code: The language to use in the synthesis. Default is ``"en-US"``.
-        :type language_code: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        await self._polly_client.start_speech_synthesis_task(
-            **{
-                "Engine": "standard",
-                "LanguageCode": language_code,
-                "OutputFormat": format,
-                "OutputS3BucketName": self.bucket_name,
-                "SampleRate": str(sample_rate),
-                "Text": f"<speak>{message}</speak>",
-                "TextType": "ssml",
-                "VoiceId": "Joanna",
-            }
-        )
-
-    async def synthesize_speech_batch(
-        self,
-        messages: Sequence[str],
-        format: str = "ogg_vorbis",
-        sample_rate: int = 22050,
-        language_code: str = "en-US",
-    ) -> None:
-        """
-        Synthesizes a sequence of messages into audio files and saves them to the S3 bucket.
-
-        :param messages: A sequence of messages to be read aloud.
-        :type messages: :py:obj:`Sequence`
-        :param format: A file format. Default is ``"ogg_vorbis"``.
-        :type format: :py:obj:`str`
-        :param sample_rate: The audio frequency in Hz. Default is ``22050``.
-        :type sample_rate: :py:obj:`int`
-        :param language_code: The language to use in the synthesis. Default is ``"en-US"``.
-        :type language_code: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        await asyncio.gather(
-            *[
-                self.synthesize_speech(
-                    message=message,
-                    format=format,
-                    sample_rate=sample_rate,
-                    language_code=language_code,
-                )
-                for message in messages
-            ]
-        )
-
-
-class AsyncNotificationManager:
-    def __init__(
-        self, group_id: str | None = None, region_name: str = "us-east-1"
-    ) -> None:
+    @property
+    def region_name(self) -> str:
         """
-        Sets :py:attr:`group_id` and :py:attr:`region_name`.
+        An AWS region name.
 
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :type: :py:obj:`str`
 
         """
-        self._exit_stack = AsyncExitStack()
-        self._sns_client = None
-        self._region_name = region_name
-        self.group_id = group_id
+        return self._region_name
 
-    async def __aenter__(self) -> "AsyncNotificationManager":
+    @property
+    def configuration_set(self) -> str:
         """
-        Creates an asyncronous session and client.
+        The configuration set to use for messaging.
 
-        :returns: The notification manager.
-        :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncNotificationManager`
+        :type: :py:obj:`str`
 
         """
-        session = AioSession()
-        self._sns_client = await self._exit_stack.enter_async_context(
-            session.create_client("sns", region_name=self.region_name)
-        )
-        return self
+        return self._configuration_set
 
-    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
+    @property
+    def origin_pool(self) -> str:
         """
-        Destroys the asyncronous session.
+        The origination pool to use for messaging.
 
-        :param exc_type: Exception type.
-        :param exc_val: Exception value.
-        :param exc_tb: Exception traceback.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :type: :py:obj:`str`
 
         """
-        await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb)
+        return self._origin_pool_arn
 
     @property
-    def region_name(self) -> str:
+    def max_sms_price(self) -> str:
         """
-        An AWS region name.
+        The max allowed price per sms message.
 
         :type: :py:obj:`str`
+        :value: :py:obj:`"0.20"`
 
         """
-        return self._region_name
+        return self._max_sms_price
 
     @property
-    def group_id(self) -> str:
+    def max_voice_price(self) -> str:
         """
-        A message group id.
+        The max allowed price per voice message.
 
         :type: :py:obj:`str`
+        :value: :py:obj:`"0.20"`
 
         """
-        return str(self._group_id)
+        return self._max_voice_price
 
-    @group_id.setter
-    def group_id(self, other: str | None) -> None:
+    @property
+    def debug(self) -> bool:
         """
-        Sets :py:attr:`group_id` to ``other``.
-
-        If ``other`` isn't provided, instead set :py:attr:`group_id` to :py:func:`~uuid.uuid4`.
+        Whether or not debug mode is enabled.
 
-        :param other: A message group id.
-        :type other: :py:obj:`str` | :py:obj:`None`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :type: :py:obj:`bool`
+        :value: :py:obj:`False`
 
         """
-        if not other:
-            other = str(uuid.uuid4())
-        self._group_id = other
+        return self._debug
 
     async def send_sms(
-        self, to_number: str, message: str, message_id: str | None = None
-    ) -> None:
+        self,
+        phone: str,
+        message: str,
+        ttl: int = 300,
+        dry_run: bool = False,
+        feedback: bool = False,
+    ) -> dict[str, str]:
         """
-        Sends an sms to ``to_number``.
+        Texts ``message`` to ``phone`` via sms.
 
-        :param to_number: A destination phone number.
-        :type to_number: :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`
-        :raises ValidationError: If ``to_number`` wasn't a valid E.164 formatted phone number.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :param ttl: Time to live in ms. Default is :py:obj:`300`.
+        :type ttl: :py:obj:`int`
+        :param dry_run: Whether or not to execute the 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: An sms message response.
+        :rtype: :py:obj:`dict`
 
         """
-        validate_e164_phone_number(to_number)
+        assert self._pinpoint_client, "Asyncronous client wasn't set."
 
-        if not message_id:
-            message_id = str(uuid.uuid4())
-
-        await self._sns_client.publish(
+        logger.debug(f"Texting '{message}' to '{phone}'...")
+        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[str, str]:
         """
-        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 :py:obj:`300`.
+        :type ttl: :py:obj:`int`
+        :param voice_id: A voice id to use for speech synthesis. Default is :py:obj:`"Joanna"`.
+        :type voice_id: :py:obj:`str`
+        :param dry_run: Whether or not to execute the 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."
+
+        logger.debug(f"Reading '{message}' aloud to '{phone}'...")
+        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 send_sms_batch(self, to_numbers: Sequence[str], message: str) -> None:
+    async def batch_send_sms(
+        self, phones: Sequence[str], message: str, **kwargs
+    ) -> list[dict[str, str]]:
         """
-        Sends an sms message to each phone number in ``to_numbers``.
+        Sends ``message`` to all phone numbers in ``phones`` via sms.
 
-        :param to_numbers: A sequence of phone numbers.
-        :type to_numbers: :py:obj:`~collections.abc.Sequence`
+        :param phones: A sequence of phone numbers.
+        :type phones: :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`
+        :param kwargs: Additional keyword arguments passed to :py:meth:`~terminusgps.aws.notifications.AsyncNotificationManager.send_sms`.
+        :raises AssertionError: If :py:attr:`_pinpoint_client` wasn't set.
+        :returns: A list of sms message responses.
+        :rtype: :py:obj:`dict`
 
-        """
-        for to_number in to_numbers:
-            validate_e164_phone_number(to_number)
+        .. seealso::
+            :py:meth:`~terminusgps.aws.notifications.AsyncNotificationManager.send_sms` for details on available keyword arguments.
 
-        await asyncio.gather(
-            *[self.send_sms(to_number=num, message=message) for num in to_numbers]
+        """
+        assert self._pinpoint_client, "Asyncronous client wasn't set."
+        return await asyncio.gather(
+            *[self.send_sms(phone=phone, message=message, **kwargs) for phone in phones]
         )
 
-    async def send_push_batch(self, target_arns: Sequence[str], message: str) -> None:
+    async def batch_send_voice(
+        self, phones: Sequence[str], message: str, **kwargs
+    ) -> list[dict[str, str]]:
         """
-        Sends a push notification to each AWS resource by ARN in ``target_arns``.
+        Calls each number in ``phones`` and reads ``message`` aloud.
 
-        :param target_arns: A sequence of AWS resource ARNs.
-        :type target_arns: :py:obj:`~collections.abc.Sequence`
+        :param phone: A sequence of phone numbers.
+        :type phone: :py:obj:`~collections.abc.Sequence`
         :param message: A message body.
         :type message: :py:obj:`str`
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :param kwargs: Additional keyword arguments passed to :py:meth:`~terminusgps.aws.notifications.AsyncNotificationManager.send_voice`.
+        :raises AssertionError: If :py:attr:`_pinpoint_client` wasn't set.
+        :returns: A voice message response.
+        :rtype: :py:obj:`dict`
+
+        .. seealso::
+            :py:meth:`~terminusgps.aws.notifications.AsyncNotificationManager.send_voice` for details on available keyword arguments.
 
         """
-        await asyncio.gather(
-            *[self.send_push(target_arn=arn, message=message) for arn in target_arns]
+        assert self._pinpoint_client, "Asyncronous client wasn't set."
+        return await asyncio.gather(
+            *[
+                self.send_voice(phone=phone, message=message, **kwargs)
+                for phone in phones
+            ]
         )

terminusgps/aws/secrets.py

@@ -4,7 +4,17 @@ import boto3
 
 
 def get_secret(name: str, region: str = "us-east-1") -> dict[str, str]:
-    """Logs into the default AWS CLI session and returns a secret value."""
+    """
+    Logs into the default AWS CLI session and returns a secret value.
+
+    :param name: An AWS `secretsmanager <https://docs.aws.amazon.com/secretsmanager/>`_ name.
+    :type name: :py:obj:`str`
+    :param region: An AWS region name. Default is :py:obj:`"us-east-1"`.
+    :type region: :py:obj:`str`
+    :returns: A secret value dictionary.
+    :rtype: :py:obj:`dict`
+
+    """
     client = boto3.Session().client(service_name="secretsmanager", region_name=region)
     secret = client.get_secret_value(SecretId=name)["SecretString"]
     return json.loads(secret)

terminusgps/wialon/items/base.py

@@ -155,13 +155,24 @@ class WialonBase:
         )
         self._name = new_name
 
-    def get_cfield_id(self, key: str) -> int | None:
+    def delete(self) -> None:
+        """
+        Deletes the Wialon object.
+
+        :raises WialonError: If something goes wrong with Wialon.
+        :returns: Nothing.
+        :rtype: :py:obj:`None`
+
         """
-        Returns a custom field id by its key, if it exists.
+        self.session.wialon_api.item_delete_item(**{"itemId": self.id})
 
-        :param key: A custom field key.
+    def _get_cfield_id(self, key: str) -> int | None:
+        """
+        Returns a custom field id by key.
+
+        :param key: A custom field key (name).
         :type key: :py:obj:`str`
-        :returns: A custom field id, if any.
+        :returns: The custom field's id as an integer, if found.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
@@ -173,17 +184,18 @@ class WialonBase:
             .get("flds", {})
             .values()
         )
+
         for field in cfields:
             if field["n"] == key:
                 return int(field["id"])
 
-    def get_afield_id(self, key: str) -> int | None:
+    def _get_afield_id(self, key: str) -> int | None:
         """
-        Returns an admin field id by its key, if it exists.
+        Returns an admin field id by key.
 
-        :param key: An admin field key.
+        :param key: An admin field key (name).
         :type key: :py:obj:`str`
-        :returns: An admin field id, if any.
+        :returns: The admin field's id as an integer, if found.
         :rtype: :py:obj:`int` | :py:obj:`None`
 
         """
@@ -195,130 +207,79 @@ class WialonBase:
             .get("aflds", {})
             .values()
         )
+
         for field in afields:
             if field["n"] == key:
                 return int(field["id"])
 
-    def add_afield(self, key: str, value: str) -> None:
+    def update_afield(self, key: str, value: str) -> None:
         """
-        Adds an admin field to the Wialon object.
+        Updates an admin field by key.
 
-        :param key: A key (name) for the admin field.
+        :param key: An admin field key (name).
         :type key: :py:obj:`str`
-        :param value: A value for the admin field.
+        :param value: A string.
         :type value: :py:obj:`str`
         :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-        self.session.wialon_api.item_update_admin_field(
-            **{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
-        )
+        field_id: int | None = self._get_afield_id(key)
 
-    def update_afield(self, id: int, key: str, value: str) -> None:
-        """
-        Updates an admin field by id.
-
-        :param id: The admin field id.
-        :type id: :py:obj:`int`
-        :param key: A key (name) for the admin field.
-        :type key: :py:obj:`str`
-        :param value: A value for the admin field.
-        :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.item_update_admin_field(
-            **{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
-        )
-
-    def add_cfield(self, key: str, value: str) -> None:
-        """
-        Adds a custom field to the Wialon object.
-
-        :param key: A key (name) for the custom field.
-        :type key: :py:obj:`str`
-        :param value: A value for the custom field.
-        :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.item_update_custom_field(
-            **{"itemId": self.id, "id": 0, "callMode": "create", "n": key, "v": value}
-        )
+        if field_id is not None:
+            self.session.wialon_api.item_update_admin_field(
+                **{
+                    "itemId": self.id,
+                    "id": field_id,
+                    "callMode": "update",
+                    "n": key,
+                    "v": value,
+                }
+            )
+        else:
+            self.session.wialon_api.item_update_admin_field(
+                **{"itemId": self.id, "callMode": "create", "n": key, "v": value}
+            )
 
-    def update_cfield(self, id: int, key: str, value: str) -> None:
+    def update_cfield(self, key: str, value: str) -> None:
         """
         Updates a custom field by id.
 
-        :param id: The admin field id.
-        :type id: :py:obj:`int`
-        :param field: A key (name) for the custom field.
-        :type field: :py:obj:`str`
-        :param field: A value for the custom field.
-        :type field: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.item_update_custom_field(
-            **{"itemId": self.id, "id": id, "callMode": "update", "n": key, "v": value}
-        )
-
-    def add_cproperty(self, key: str, value: str) -> None:
-        """
-        Adds a custom property to the Wialon object.
-
-        :param key: A key (name) for the custom property.
+        :param key: A custom field key (name).
         :type key: :py:obj:`str`
-        :param value: A value for the custom property.
+        :param value: A string.
         :type value: :py:obj:`str`
         :raises WialonError: If something goes wrong with Wialon.
         :returns: Nothing.
         :rtype: :py:obj:`None`
 
         """
-        self.session.wialon_api.item_update_custom_property(
-            **{"itemId": self.id, "name": key, "value": value}
-        )
+        field_id: int | None = self._get_cfield_id(key)
 
-    def add_profile_field(self, key: str, value: str) -> None:
-        """
-        Adds a profile field to the Wialon object.
-
-        :param key: A key (name) for the profile field.
-        :type key: :py:obj:`str`
-        :param value: A value for the profile field.
-        :type value: :py:obj:`str`
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        self.session.wialon_api.item_update_profile_field(
-            **{"itemId": self.id, "n": key, "v": value}
-        )
+        if field_id is not None:
+            self.session.wialon_api.item_update_custom_field(
+                **{
+                    "itemId": self.id,
+                    "id": field_id,
+                    "callMode": "update",
+                    "n": key,
+                    "v": value,
+                }
+            )
+        else:
+            self.session.wialon_api.item_update_custom_field(
+                **{"itemId": self.id, "callMode": "create", "n": key, "v": value}
+            )
 
-    def delete(self) -> None:
+    @property
+    def cfields(self) -> dict[str, str]:
         """
-        Deletes the Wialon object.
+        Custom fields for the Wialon object.
 
-        :raises WialonError: If something goes wrong with Wialon.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
+        :type: :py:obj:`dict`
 
         """
-        self.session.wialon_api.item_delete_item(**{"itemId": self.id})
-
-    @property
-    def cfields(self) -> dict[str, str]:
-        """Custom fields for the Wialon object."""
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DataFlag.UNIT_CUSTOM_FIELDS}
         )
@@ -327,7 +288,12 @@ class WialonBase:
 
     @property
     def afields(self) -> dict[str, str]:
-        """Admin fields for the Wialon object."""
+        """
+        Admin fields for the Wialon object.
+
+        :type: :py:obj:`dict`
+
+        """
         response = self.session.wialon_api.core_search_item(
             **{"id": self.id, "flags": flags.DataFlag.UNIT_ADMIN_FIELDS}
         )

terminusgps/wialon/items/unit.py

@@ -249,29 +249,27 @@ class WialonUnit(WialonBase):
             **{"itemId": self.id, "phoneNumber": quote_plus(phone)}
         )
 
-    def get_phone_numbers(self) -> list[str]:
+    def get_phone_numbers(
+        self, cfield_key: str = "to_number", afield_key: str = "to_number"
+    ) -> list[str]:
         """
         Retrieves all phone numbers assigned to the unit.
 
         This includes any attached drivers, custom/admin fields or otherwise assigned phone numbers.
 
+        :param cfield_key: A custom field key used to retrieve phone numbers. Default is :py:obj:`"to_number"`.
+        :type cfield_key: :py:obj:`str`
+        :param afield_key: An admin field key used to retrieve phone numbers. Default is :py:obj:`"to_number"`.
+        :type afield_key: :py:obj:`str`
         :raises WialonError: If something goes wrong with Wialon.
         :returns: A list of phone numbers.
         :rtype: :py:obj:`list`
 
         """
-        phone_numbers: list[str] = []
-        phones_0: list[str] | None = self._get_driver_phone_numbers()
-        phones_1: list[str] | None = self._get_cfield_phone_numbers()
-        phones_2: list[str] | None = self._get_afield_phone_numbers()
-
-        if phones_0 is not None:
-            phone_numbers.extend(phones_0)
-        if phones_1 is not None:
-            phone_numbers.extend(phones_1)
-        if phones_2 is not None:
-            phone_numbers.extend(phones_2)
-        return list(dict.fromkeys(phone_numbers))  # Removes duplicate phone numbers
+        phones_0: list[str] = self._get_driver_phone_numbers()
+        phones_1: list[str] = self._get_cfield_phone_numbers(key=cfield_key)
+        phones_2: list[str] = self._get_afield_phone_numbers(key=afield_key)
+        return list(frozenset(phones_0 + phones_1 + phones_2))
 
     def clean_phone_numbers(self, phones: list[str]) -> list[str]:
         """Takes a list of phone numbers and returns a list of clean phone numbers."""
@@ -281,43 +279,43 @@ class WialonUnit(WialonBase):
             for clean_num in (num.split(",") if "," in num else [num])
         ]
 
-    def _get_afield_phone_numbers(self, key: str = "to_number") -> list[str] | None:
+    def _get_afield_phone_numbers(self, key: str) -> list[str]:
         """
-        Retrives any phone numbers saved in an admin field by key.
+        Retrives phone numbers saved in an admin field by key.
 
-        :param key: An admin field key. Default is ``"to_number"``.
+        :param key: An admin field key.
         :type key: :py:obj:`str`
         :raises WialonError: If something goes wrong with Wialon.
-        :returns: A list of phone numbers, if the unit has admin phone number fields.
-        :rtype: :py:obj:`list` | :py:obj:`None`
+        :returns: A list of phone numbers.
+        :rtype: :py:obj:`list`
 
         """
-        for field_name, field_val in self.afields.items():
-            if field_name == key:
-                return self.clean_phone_numbers([field_val])
+        if key not in self.afields.keys():
+            return []
+        return self.clean_phone_numbers([self.afields[key]])
 
-    def _get_cfield_phone_numbers(self, key: str = "to_number") -> list[str] | None:
+    def _get_cfield_phone_numbers(self, key: str) -> list[str]:
         """
-        Retrives any phone numbers saved in a custom field by key.
+        Retrives phone numbers saved in a custom field by key.
 
-        :param key: A custom field key. Default is ``"to_number"``.
+        :param key: A custom field key.
         :type key: :py:obj:`str`
         :raises WialonError: If something goes wrong with Wialon.
-        :returns: A list of phone numbers, if the unit has custom phone number fields.
-        :rtype: :py:obj:`list` | :py:obj:`None`
+        :returns: A list of phone numbers.
+        :rtype: :py:obj:`list`
 
         """
-        for field_name, field_val in self.cfields.items():
-            if field_name == key:
-                return self.clean_phone_numbers([field_val])
+        if key not in self.cfields.keys():
+            return []
+        return self.clean_phone_numbers([self.cfields[key]])
 
-    def _get_driver_phone_numbers(self) -> list[str] | None:
+    def _get_driver_phone_numbers(self) -> list[str]:
         """
-        Retrieves any phone numbers assigned to drivers attached to the unit.
+        Returns a list of phone numbers assigned to drivers attached to the unit.
 
         :raises WialonError: If something goes wrong with Wialon.
-        :returns: A list of phone numbers, if the unit has attached drivers with phone numbers.
-        :rtype: :py:obj:`list` | :py:obj:`None`
+        :returns: A list of phone numbers.
+        :rtype: :py:obj:`list`
 
         """
         response = self.session.wialon_api.resource_get_unit_drivers(
@@ -326,3 +324,4 @@ class WialonUnit(WialonBase):
         if response:
             dirty_phones = [driver[0].get("ph") for driver in response.values()]
             return self.clean_phone_numbers(dirty_phones)
+        return []

terminusgps/wialon/utils.py

@@ -294,9 +294,9 @@ def generate_wialon_password(length: int = 32) -> str:
         - At least one special symbol.
         - At least three digits.
 
-    :param length: Length of the generated password. Default is ``32``.
+    :param length: Length of the generated password. Default is :py:obj:`32`.
     :type length: :py:obj:`int`
-    :raises ValueError: If :py:length is less than ``8`` or greater than ``64``.
+    :raises ValueError: If ``length`` is less than ``8`` or greater than ``64``.
     :returns: A Wialon compliant password.
     :rtype: :py:obj:`str`
 

terminusgps/aws/speech.py

@@ -1,146 +0,0 @@
-import asyncio
-import os
-from collections.abc import Sequence
-from contextlib import AsyncExitStack
-
-from aiobotocore.session import AioSession
-
-
-class AsyncSpeechSynthesisManager:
-    def __init__(
-        self, bucket_name: str | None = None, region_name: str = "us-east-1"
-    ) -> None:
-        self._exit_stack = AsyncExitStack()
-        self._polly_client = None
-        self._region_name = region_name
-        self._bucket_name = bucket_name or os.getenv("AWS_POLLY_BUCKET_NAME", "")
-
-    @property
-    def region_name(self) -> str:
-        """
-        An AWS region name.
-
-        :type: :py:obj:`str`
-
-        """
-        return self._region_name
-
-    @property
-    def bucket_name(self) -> str:
-        """
-        The AWS bucket that will host audio files.
-
-        :type: :py:obj:`str`
-
-        """
-        return self._bucket_name
-
-    async def __aenter__(self) -> "AsyncSpeechSynthesisManager":
-        """
-        Creates an asyncronous session and client.
-
-        :returns: The polly manager.
-        :rtype: :py:obj:`~terminusgps.aws.notifications.AsyncPollyManager`
-
-        """
-        session = AioSession()
-        self._polly_client = await self._exit_stack.enter_async_context(
-            session.create_client("polly", region_name=self.region_name)
-        )
-        return self
-
-    async def __aexit__(self, exc_type, exc_val, exc_tb) -> None:
-        """
-        Destroys the asyncronous session.
-
-        :param exc_type: Exception type.
-        :param exc_val: Exception value.
-        :param exc_tb: Exception traceback.
-        :returns: Nothing.
-        :rtype: :py:obj:`None`
-
-        """
-        await self._exit_stack.__aexit__(exc_type, exc_val, exc_tb)
-
-    async def synthesize_speech(
-        self,
-        message: str,
-        format: str = "ogg_vorbis",
-        sample_rate: int = 22050,
-        language_code: str = "en-US",
-    ) -> None:
-        """
-        Synthesizes the message into an audio file and saves it to the S3 bucket.
-
-        :param message: A message to be read aloud.
-        :type message: :py:obj:`str`
-        :param format: A file format. Default is ``"ogg_vorbis"``.
-        :type format: :py:obj:`str`
-        :param sample_rate: The audio frequency in Hz. Default is ``22050``.
-        :type sample_rate: :py:obj:`int`
-        :param language_code: The language to use in the synthesis. Default is ``"en-US"``.
-        :type language_code: :py:obj:`str`
-        :returns: The audio file URI.
-        :rtype: :py:obj:`str`
-
-        """
-        response = await self._polly_client.start_speech_synthesis_task(
-            **{
-                "Engine": "standard",
-                "LanguageCode": language_code,
-                "OutputFormat": format,
-                "OutputS3BucketName": self.bucket_name,
-                "SampleRate": str(sample_rate),
-                "Text": f"<speak>{message}</speak>",
-                "TextType": "ssml",
-                "VoiceId": "Joanna",
-            }
-        )
-        print(f"{response = }")
-        return response.get("SynthesisTask", {}).get("OutputUri", "")
-
-    async def synthesize_speech_batch(
-        self,
-        messages: Sequence[str],
-        format: str = "ogg_vorbis",
-        sample_rate: int = 22050,
-        language_code: str = "en-US",
-    ) -> None:
-        """
-        Synthesizes a sequence of messages into audio files and saves them to the S3 bucket.
-
-        :param messages: A sequence of messages to be read aloud.
-        :type messages: :py:obj:`Sequence`
-        :param format: A file format. Default is ``"ogg_vorbis"``.
-        :type format: :py:obj:`str`
-        :param sample_rate: The audio frequency in Hz. Default is ``22050``.
-        :type sample_rate: :py:obj:`int`
-        :param language_code: The language to use in the synthesis. Default is ``"en-US"``.
-        :type language_code: :py:obj:`str`
-        :returns: A list of audio file URIs.
-        :rtype: :py:obj:`list`
-
-        """
-        await asyncio.gather(
-            *[
-                self.synthesize_speech(
-                    message=message,
-                    format=format,
-                    sample_rate=sample_rate,
-                    language_code=language_code,
-                )
-                for message in messages
-            ]
-        )
-
-
-async def main() -> None:
-    async with AsyncSpeechSynthesisManager() as manager:
-        uri = await manager.synthesize_speech(
-            "Oh yeah, I'm creating another test audio file."
-        )
-        print(f"{uri = }")
-
-
-if __name__ == "__main__":
-    asyncio.run(main())

terminusgps/aws/utils.py

@@ -1,5 +0,0 @@
-import requests
-
-
-def get_public_ip() -> str:
-    return requests.get("https://checkip.amazonaws.com").text.strip()