3.3.13

Author: zhanganderson

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.3.13] - 2024-08-30
+
+- Update get messages
+
 ## [3.3.12] - 2024-08-8
 
 - Update privateNumber

README.md

@@ -505,6 +505,10 @@ following arguments:
 - `offset`: Use the offset to navigate between the response results.
   An offset of 0 will display the first page of results, and so on.
 - `filter`: Filter your Virtual Numbers by tag or by number.
+- `startTime`: By Default messages from last 30 days will be fetched.Use this parameter to fetch the messages from the time you want. Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2024-01-24T15:39:00Z".
+- `endTime`: By Default messages from last 30 days will be fetched. Use this parameter to fetch the messages till the time you want. Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2024-01-24T16:39:00Z".
+- `reverse`: If set to true the results will be returned in reverse order. Recent messages will be returned first. By default, the results will be returned in the order they were sent/received.
+- `direction`: Filter your messages by direction: outgoing or incoming.
 
 Raises `telstra.messaging.exceptions.MessageError` if anything goes wrong.
 
@@ -667,7 +671,7 @@ It takes the following arguments:
   Use ISO format(yyyy-mm-dd), e.g. "2019-08-24".
 - `report_callback_url`: The callbackUrl where notification
   is sent when report is ready for download.
-- `filter_`: Filter report messages by -
+- `filter`: Filter report messages by -
   tag - use one of the tags assigned to your message(s)
   number - either the Virtual Number used to send the message,
   or the Recipient Number the message was sent to.
@@ -691,7 +695,7 @@ For example:
 from telstra.messaging import reports
 
 reports_create_response = reports.create(
-        start_date="2023-03-15", end_date="2023-03-30", filter_="0412345678"
+        start_date="2023-03-15", end_date="2023-03-30", filter="0412345678"
     )
 ```
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "telstra.messaging"
-version = "3.3.12"
+version = "3.3.13"
 readme = "README.md"
 description = "SDK for the Telstra Messaging API V3 - Beta"
 license = "Apache-2.0"

telstra/messaging/__init__.py

@@ -1,3 +1,3 @@
 """Messaging."""
 
-__version__ = "3.3.12"
+__version__ = "3.3.13"

telstra/messaging/message.py

@@ -678,7 +678,11 @@ def get(message_id: types.TMessageId) -> TMessage:
 def _validate_get_all_args(
     limit: typing.Optional[types.TLimit] = None,
     offset: typing.Optional[types.TOffset] = None,
-    filter_: typing.Optional[types.TFilter] = None,
+    filter: typing.Optional[types.TFilter] = None,
+    startTime: typing.Optional[types.TStartTime] = None,
+    endTime: typing.Optional[types.TEndTime] = None,
+    reverse: typing.Optional[types.TReverse] = None,
+    direction: typing.Optional[types.TDirection] = None,
 ) -> None:
     # Validate limit
     if (limit is not None and not isinstance(limit, types.TLimit)) or (
@@ -703,17 +707,45 @@ def _validate_get_all_args(
         )
 
     # Validate filter
-    if filter_ is not None and not isinstance(filter_, types.TFilter):
+    if filter is not None and not isinstance(filter, types.TFilter):
         raise exceptions.MessageError(
             'the value of "filter" is not valid, expected a string, '
-            f'received "{filter_}"'
+            f'received "{filter}"'
+        )
+
+    if startTime is not None and not isinstance(startTime, types.TStartTime):
+        raise exceptions.MessageError(
+            'the value of "startTime" is not valid, expected a string, '
+            f'received "{startTime}"'
+        )
+
+    if endTime is not None and not isinstance(endTime, types.TEndTime):
+        raise exceptions.MessageError(
+            'the value of "endTime" is not valid, expected a string, '
+            f'received "{endTime}"'
+        )
+
+    if reverse is not None and not isinstance(reverse, types.TReverse):
+        raise exceptions.MessageError(
+            'the value of "reverse" is not valid, expected a bool, '
+            f'received "{reverse}"'
+        )
+
+    if direction is not None and not isinstance(direction, types.TDirection):
+        raise exceptions.MessageError(
+            'the value of "direction" is not valid, expected a string, '
+            f'received "{direction}"'
         )
 
 
 def get_all(
     limit: typing.Optional[types.TLimit] = None,
     offset: typing.Optional[types.TOffset] = None,
-    filter_: typing.Optional[types.TFilter] = None,
+    filter: typing.Optional[types.TFilter] = None,
+    startTime: typing.Optional[types.TStartTime] = None,
+    endTime: typing.Optional[types.TEndTime] = None,
+    reverse: typing.Optional[types.TReverse] = None,
+    direction: typing.Optional[types.TDirection] = None,
 ) -> TMessages:
     """
     Retrieve all messages.
@@ -725,7 +757,15 @@ def get_all(
 
     """
 
-    _validate_get_all_args(limit=limit, offset=offset, filter_=filter_)
+    _validate_get_all_args(
+        limit=limit,
+        offset=offset,
+        filter=filter,
+        startTime=startTime,
+        endTime=endTime,
+        reverse=reverse,
+        direction=direction,
+    )
 
     try:
         token = oauth.get_token()
@@ -742,7 +782,7 @@ def get_all(
         "Content-Type": "application/json",
     }
     messages_get_request = request.Request(
-        f"{_URL}{querystring.build(limit=limit, offset=offset, filter_=filter_)}",
+        f"{_URL}{querystring.build(limit=limit, offset=offset, filter=filter,starTime=startTime,endTime=endTime,reverse=reverse,direction=direction)}",
         headers=headers,
         method="GET",
     )

telstra/messaging/reports.py

@@ -165,7 +165,7 @@ def _validate_create_args(  # pylint: disable=too-many-arguments
     start_date: typing.Optional[str],
     end_date: typing.Optional[str],
     report_callback_url: typing.Optional[str],
-    filter_: typing.Optional[str],
+    filter: typing.Optional[str],
 ) -> None:
     """Validate the arguments for create report."""
     # Validate dates
@@ -183,18 +183,18 @@ def _validate_create_args(  # pylint: disable=too-many-arguments
     )
 
     # Validate filter
-    if filter_ is not None and not isinstance(filter_, str):
+    if filter is not None and not isinstance(filter, str):
         raise exceptions.ReportsError(
             'The value of "filter" is not valid, expected a string, '
-            f'received "{filter_}"'
+            f'received "{filter}"'
         )
 
 
 def create(
     start_date: typing.Optional[str],
     end_date: typing.Optional[str],
     report_callback_url: typing.Optional[str] = None,
-    filter_: typing.Optional[str] = None,
+    filter: typing.Optional[str] = None,
 ) -> TReport:
     """
     Create a report.
@@ -205,15 +205,15 @@ def create(
         start_date: Start date (inclusive) of reporting period here.
         end_date: End date (inclusive) of reporting period here.
         report_callback_url: Url to notify when report is ready for download.
-        filter_: Properties to filter the message report by
+        filter: Properties to filter the message report by
 
     """
 
     _validate_create_args(
         start_date=start_date,
         end_date=end_date,
         report_callback_url=report_callback_url,
-        filter_=filter_,
+        filter=filter,
     )
 
     try:
@@ -229,8 +229,8 @@ def create(
     }
     if report_callback_url is not None:
         data["reportCallbackUrl"] = report_callback_url
-    if filter_ is not None:
-        data["filter"] = filter_
+    if filter is not None:
+        data["filter"] = filter
     data_str = json.dumps(data).encode()
 
     headers = {

telstra/messaging/types.py

@@ -15,6 +15,10 @@
 TLimit = int
 TOffset = int
 TFilter = str
+TStartTime = str
+TEndTime = str
+TReverse = bool
+TDirection = str
 
 
 class TMultimediaContentTypes(Enum):

telstra/messaging/virtual_number.py

@@ -189,7 +189,7 @@ def assign(
 def _validate_get_all_args(
     limit: typing.Optional[types.TLimit] = None,
     offset: typing.Optional[types.TOffset] = None,
-    filter_: typing.Optional[types.TFilter] = None,
+    filter: typing.Optional[types.TFilter] = None,
 ) -> None:
     # Validate limit
     if (limit is not None and not isinstance(limit, types.TLimit)) or (
@@ -214,17 +214,17 @@ def _validate_get_all_args(
         )
 
     # Validate filter
-    if filter_ is not None and not isinstance(filter_, types.TFilter):
+    if filter is not None and not isinstance(filter, types.TFilter):
         raise exceptions.VirtualNumbersError(
             'the value of "filter" is not valid, expected a string, '
-            f'received "{filter_}"'
+            f'received "{filter}"'
         )
 
 
 def get_all(
     limit: typing.Optional[types.TLimit] = None,
     offset: typing.Optional[types.TOffset] = None,
-    filter_: typing.Optional[types.TFilter] = None,
+    filter: typing.Optional[types.TFilter] = None,
 ) -> TVirtualNumbers:
     """
     Retrieve all virtual numbers assigned to you.
@@ -233,7 +233,7 @@ def get_all(
 
     """
 
-    _validate_get_all_args(limit=limit, offset=offset, filter_=filter_)
+    _validate_get_all_args(limit=limit, offset=offset, filter=filter)
 
     try:
         token = oauth.get_token()
@@ -252,7 +252,7 @@ def get_all(
         "Cache-Control": "no-cache",
     }
     virtual_numbers_request = request.Request(
-        f"{_URL}" f"{querystring.build(limit=limit, offset=offset, filter=filter_)}",
+        f"{_URL}" f"{querystring.build(limit=limit, offset=offset, filter=filter)}",
         headers=headers,
         method="GET",
     )
@@ -534,7 +534,7 @@ def get_optouts(
 
     """
 
-    _validate_get_all_args(limit=limit, offset=offset, filter_=None)
+    _validate_get_all_args(limit=limit, offset=offset, filter=None)
 
     try:
         token = oauth.get_token()