smartsheet-python-sdk 3.0.3__tar.gz → 3.0.4__tar.gz

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/ADVANCED.md

@@ -115,6 +115,13 @@ start consuming events. The `since` parameter can be set with a datetime value t
 (e.g. 2010-01-01T00:00:00Z) or as UNIX epoch (in which case the `numeric_dates` parameter must also be set to `True`.
 By default the `numeric_dates` parameter is set to `False`).
 
+The sample utilizes the `smartsheet_client.Events.list_events` method to request a list of events up to a certain
+point in the stream. The `to` parameter specifies the endpoint in time (i.e., event occurrence datetime) in the stream
+up to which events should be retrieved. This `to` parameter can be assigned a datetime value formatted either as
+ISO 8601 (e.g., 2020-12-31T23:59:59Z) or as UNIX epoch time, in which case the numeric_dates parameter must be set to True.
+If not specified, the `numeric_dates` parameter defaults to `False`, assuming the datetime is in ISO 8601 format.
+This allows for precise control over the range of events to be fetched, facilitating efficient data retrieval and processing.
+
 To consume the next list of events after the initial list of events is returned, set the `stream_position` parameter
 with the `next_stream_position` property obtained from the previous request and don't set the `since` parameter with
 any values. This is because when using the `list_events` method, either the `since` parameter or the `stream_position`

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.0.4] - 2024-07-29
+
+### Changed
+
+- Changed `serialize` function to also handle dicts - this allows the Event Reporting API to
+  return the `additionalDetails` object correctly
+
+### Added
+
+- `to` parameter added for Event Reporting - allows setting an end timestamp for filtering for
+  events
+
 ## [3.0.3] - 2024-07-17
 
 ### Fixed

{smartsheet-python-sdk-3.0.3/smartsheet_python_sdk.egg-info → smartsheet-python-sdk-3.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.0.3
+Version: 3.0.4
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 Home-page: http://smartsheet-platform.github.io/api-docs/
 Author: Smartsheet

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/pylintrc

@@ -9,3 +9,6 @@ output-format=colorized
 
 [BASIC]
 include-naming-hint=yes
+
+[FORMAT]
+max-line-length=160

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/smartsheet/events.py

@@ -30,13 +30,19 @@ class Events:
         self._log = logging.getLogger(__name__)
 
     def list_events(
-        self, since=None, stream_position=None, max_count=None, numeric_dates=None
+        self, since=None, to=None, stream_position=None, max_count=None, numeric_dates=None # pylint: disable=invalid-name
     ):
         """Get the list of all Events.
 
         Args:
             since (str or long): Starting time for events to return.
                 You must pass in a value for either since or streamPosition and never both.
+            to (str or long): Ending time for events to return.
+                This parameter specifies the endpoint in time for the events to be fetched.
+                Similar to the `since` parameter, `to` can be passed in either as a datetime string in
+                ISO 8601 format or as a UNIX epoch time in milliseconds. This allows for defining a
+                precise time range for the events query. Note that `to` is optional and can be used in
+                conjunction with `since` to specify both the start and end times for the event retrieval window.
             stream_position (str): Indicates next set of events to return.
                 Use value of nextStreamPosition returned from the previous call.
                 You must pass in a value for either since or streamPosition and never both.
@@ -53,9 +59,14 @@ class Events:
         _op["method"] = "GET"
         _op["path"] = "/events"
         if isinstance(since, datetime):
-            _op["query_params"]["since"] = since  # .isoformat()
+            _op["query_params"]["since"] = since.isoformat()
         else:
             _op["query_params"]["since"] = since
+
+        if isinstance(to, datetime):
+            _op["query_params"]["to"] = to.isoformat()
+        else:
+            _op["query_params"]["to"] = to
         _op["query_params"]["streamPosition"] = stream_position
         _op["query_params"]["maxCount"] = max_count
         _op["query_params"]["numericDates"] = numeric_dates

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/smartsheet/util.py

@@ -112,6 +112,14 @@ def serialize(obj):
                 serialized = serialize(item)
                 if not hasattr(serialized, "is_explicit_null"):
                     retval.append(serialized)
+
+    elif isinstance(obj, dict):
+        retval = {}
+        for key, value in obj.items():
+            serialized_value = serialize(value)
+            if not hasattr(serialized_value, "is_explicit_null"):
+                retval[key] = serialized_value
+
     else:
         retval = {}
         prop_list = get_child_properties(obj)

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/smartsheet/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.0.3'
-__version_tuple__ = version_tuple = (3, 0, 3)
+__version__ = version = '3.0.4'
+__version_tuple__ = version_tuple = (3, 0, 4)

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4/smartsheet_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.0.3
+Version: 3.0.4
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 Home-page: http://smartsheet-platform.github.io/api-docs/
 Author: Smartsheet

{smartsheet-python-sdk-3.0.3 → smartsheet-python-sdk-3.0.4}/tests/integration/test_events.py

@@ -3,7 +3,6 @@ import six
 from datetime import datetime, timedelta
 import smartsheet
 
-
 @pytest.mark.usefixtures("smart_setup")
 class TestEvents:
 
@@ -11,7 +10,9 @@ class TestEvents:
         smart = smart_setup['smart']
 
         last_hour = datetime.now() - timedelta(hours=1)
-        events_list = smart.Events.list_events(since=last_hour.isoformat(), max_count=10)
+        current_time = datetime.now()
+
+        events_list = smart.Events.list_events(since=last_hour.isoformat(), to=current_time.isoformat(), max_count=10)
         assert isinstance(events_list, smart.models.EventResult)
         assert len(events_list.data) <= 10
         for event in events_list.data:
@@ -24,6 +25,8 @@ class TestEvents:
             assert event.request_user_id is not None
             # assert event.access_token_name is not None
             assert event.source.value is not None
+            if event.additional_details is not None:
+                assert isinstance(event.additional_details, dict)
 
         while events_list.more_available:
             events_list = smart.Events.list_events(stream_position=events_list.next_stream_position, max_count=10,
@@ -40,6 +43,8 @@ class TestEvents:
                 assert event.request_user_id is not None
                 # assert event.access_token_name is not None
                 assert event.source.value is not None
+                if event.additional_details is not None:
+                    assert isinstance(event.additional_details, dict)
 
     def test_invalid_params(self, smart_setup):
         smart = smart_setup['smart']