Add silent message update support

 - Update Symphony APIs spec version

 - Add silent flag support according to the new spec.
   When silent is true, the new updated message is marked as read, otherwise is unread.
   True is the default value.

Author: yinan-symphony

api_client_generation/generate.sh

@@ -4,7 +4,7 @@ code_gen_dir=`pwd`
 project_root=$code_gen_dir/..
 echo $code_gen_dir
 
-commit_hash=136b530512eea112de73591906051871d034750a
+commit_hash=46abc03ad7225ebc32439c06920019c9d0fb0814
 api_spec_base_url=https://raw.githubusercontent.com/symphonyoss/symphony-api-spec/${commit_hash}
 echo $api_spec_base_url
 

symphony/bdk/core/service/message/message_service.py

@@ -466,7 +466,7 @@ async def search_messages_one_page(skip, limit):
 
     @retry
     async def update_message(self, stream_id: str, message_id: str, message: Union[str, Message], data=None,
-                             version: str = "") -> V4Message:
+                             silent=True, version: str = "") -> V4Message:
         """Update an existing message. The existing message must be a valid social message, that has not been deleted.
         See: `Update Message <https://developers.symphony.com/restapi/reference/update-message-v4>`_
 
@@ -476,12 +476,15 @@ async def update_message(self, stream_id: str, message_id: str, message: Union[s
           If it is a :py:class:`Message` instance, other parameters will be ignored.
           If it is a string, ``<messageML>`` tags can be omitted.
         :param data: an object (e.g. dict) that will be serialized into JSON using ``json.dumps``.
+        :param silent: a bool flag that will determine if the updated message is going to be marked as read (when true,
+          which is default value) or unread (when false).
         :param version: Optional message version in the format "major.minor".
           If empty, defaults to the latest supported version.
 
         :return: a V4Message object containing the details of the updated message.
         """
-        message_object = message if isinstance(message, Message) else Message(content=message, data=data, version=version)
+        message_object = message if isinstance(message, Message) else Message(content=message, data=data, silent=silent,
+                                                                              version=version)
 
         params = {
             "sid": stream_id,
@@ -490,7 +493,8 @@ async def update_message(self, stream_id: str, message_id: str, message: Union[s
             "key_manager_token": await self._auth_session.key_manager_token,
             "message": message_object.content,
             "data": message_object.data,
-            "version": message_object.version
+            "version": message_object.version,
+            "silent": str(message_object.silent)
         }
         return await self._messages_api.v4_stream_sid_message_mid_update_post(**params)
 

symphony/bdk/core/service/message/model.py

@@ -14,13 +14,15 @@ class Message:
     `Create Message <https://developers.symphony.com/restapi/reference/create-message-v4>`_.
     """
 
-    def __init__(self, content: str, data=None,
+    def __init__(self, content: str, data=None, silent=True,
                  attachments: List[Union[IO, Tuple[IO, IO]]] = None, version: str = ""):
         """Builds a message.
 
         :param content: the MessageML content to be sent. This is mandatory
           If there is no <messageML> tags, they will be added to the content.
-        :param data: an object (e.g. dict) that will be serialized into JSON using ``json.dumps``
+        :param data: an object (e.g. dict) that will be serialized into JSON using ``json.dumps``.
+        :param silent: the bool flag determine if the updated message will be marked as read (when it
+          is true and it s the default value) or unread (when it is false)
         :param attachments: list of attachments or list of (attachment, previews).
           These must be opened files either in binary or text mode.
           Previews are optional but if present, all attachments must have a preview.
@@ -32,6 +34,7 @@ def __init__(self, content: str, data=None,
         self._content = self._get_content(content)
         self._data = "" if data is None else json.dumps(data)
         self._version = version
+        self._silent = silent
         self._attachments, self._previews = self._get_attachments_and_previews(attachments)
 
     @property
@@ -58,6 +61,14 @@ def version(self) -> str:
         """
         return self._version
 
+    @property
+    def silent(self) -> str:
+        """Message silent flag
+
+        :return: the message silent value
+        """
+        return self._silent
+
     @property
     def attachments(self) -> List[IO]:
         """List of attachments

tests/core/service/message/message_service_test.py

@@ -421,4 +421,5 @@ async def test_update_message(mocked_api_client, message_service):
     message = await message_service.update_message("stream_id", "message_id", "test_message")
 
     assert message.message_id == "ikCBeVCgQT876veVzQzOV3___oNI6f8obQ"
-    assert message.user.user_id == 11338713662703
+    assert message.user.user_id == 11338713662703
+    assert message.silent

tests/core/service/message/model_test.py

@@ -6,10 +6,11 @@
 from symphony.bdk.core.service.message.model import Message
 
 
-def assert_message_properties_equal(actual_message, expected_content, expected_data, expected_version,
+def assert_message_properties_equal(actual_message, expected_content, expected_data, expected_silent, expected_version,
                                     expected_attachments, expected_previews):
     assert actual_message.content == expected_content
     assert actual_message.data == expected_data
+    assert actual_message.silent == expected_silent
     assert actual_message.version == expected_version
     assert actual_message.attachments == expected_attachments
     assert actual_message.previews == expected_previews
@@ -22,14 +23,14 @@ def test_create_message_with_no_content():
 
 def test_create_message_content_only_without_tags():
     assert_message_properties_equal(Message(content="Hello world!"),
-                                    "<messageML>Hello world!</messageML>", "", "", [], [])
+                                    "<messageML>Hello world!</messageML>", "", True, "", [], [])
 
 
 def test_create_message_content_only():
     content = "<messageML>Hello world!</messageML>"
 
     assert_message_properties_equal(Message(content=content),
-                                    content, "", "", [], [])
+                                    content, "", True, "", [], [])
 
 
 def test_create_message_content_data_version():
@@ -39,31 +40,31 @@ def test_create_message_content_data_version():
     json_data = json.dumps(data)
 
     assert_message_properties_equal(Message(content=content, version=version, data=data),
-                                    content, json_data, version, [], [])
+                                    content, json_data, True, version, [], [])
 
 
 def test_create_message_with_attachment():
     content = "<messageML>Hello world!</messageML>"
     attachments = ["some attachment"]
 
     assert_message_properties_equal(Message(content=content, attachments=attachments),
-                                    content, "", "", attachments, [])
+                                    content, "", True, "", attachments, [])
 
 
 def test_create_message_with_attachment_one_element_tuple():
     content = "<messageML>Hello world!</messageML>"
     attachment = "some attachment"
 
     assert_message_properties_equal(Message(content=content, attachments=[(attachment,)]),
-                                    content, "", "", [attachment], [])
+                                    content, "", True, "", [attachment], [])
 
 
 def test_create_message_with_attachment_and_preview():
     content = "<messageML>Hello world!</messageML>"
     attachment = "some attachment"
     preview = "some preview"
     assert_message_properties_equal(Message(content=content, attachments=[(attachment, preview)]),
-                                    content, "", "", [attachment], [preview])
+                                    content, "", True, "", [attachment], [preview])
 
 
 def test_create_message_with_attachment_and_no_preview_for_second_attachment():
@@ -76,3 +77,14 @@ def test_create_message_with_attachment_and_no_preview_for_first_attachment():
     with pytest.raises(MessageCreationError):
         Message(content="<messageML>Hello world!</messageML>",
                 attachments=["first attachment", ("second attachment", "second preview")])
+
+
+def test_create_message_content_data_version_silent():
+    content = "<messageML>Hello world!</messageML>"
+    version = "2.0"
+    data = ["foo", {"bar": ("baz", 1.0, 2)}]
+    silent = False
+    json_data = json.dumps(data)
+
+    assert_message_properties_equal(Message(content=content, version=version, data=data, silent=silent),
+                                    content, json_data, silent, version, [], [])

tests/resources/message_response/update_message.json

@@ -15,6 +15,7 @@
     "userAgent": "Agent-20.13.0-SNAPSHOT-Linux-4.14.243-185.433.amzn2.x86_64",
     "originalFormat": "com.symphony.messageml.v2",
     "sid": "b10d692f-899e-4601-b946-879da15c0462",
+    "silent": "true",
     "replacing": "PUQj2xA0eniBOfeNTbTu8X___oNdE9uDbQ",
     "initialTimestamp": 1634820957308,
     "initialMessageId": "PUQj2xA0eniBOfeNTbTu8X___oNdE9uDbQ"