Add check for dict in serialize function (#48)

* fix: adds dict as a type to serialize in serialize util function, tests for additional_details in event reporting return data

* fix: extra newline

* chore: update changelog

* chore: update changelog with note about adding to param for event reporting, markdown lint

---------

Co-authored-by: dmurray <dave.murray@smartsheet.com>

Author: OhmniD

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/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)

tests/integration/test_events.py

@@ -25,6 +25,8 @@ def test_list_events(self, smart_setup):
             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,
@@ -41,6 +43,8 @@ def test_list_events(self, smart_setup):
                 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']