Add support for terminal actor message flag (#122)

Author: mvolfik

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+[1.1.0](../../releases/tag/v1.1.0) - Unreleased
+
+### Added
+
+- added support for `is_status_message_terminal` flag in Actor run status message update
+
 [1.0.0](../../releases/tag/v1.0.0) - 2023-03-13
 -----------------------------------------------
 

docs/docs.md

@@ -1987,7 +1987,7 @@ Return information about the actor run.
 
 ***
 
-#### [](#runclient-update) `RunClient.update(*, status_message=None)`
+#### [](#runclient-update) `RunClient.update(*, status_message=None, is_status_message_terminal=None)`
 
 Update the run with the specified fields.
 
@@ -1997,6 +1997,8 @@ Update the run with the specified fields.
 
   * **status_message** (`str`, *optional*) – The new status message for the run
 
+  * **is_status_message_terminal** (`bool`, *optional*) – Set this flag to True if this is the final status message of the Actor run.
+
 * **Returns**
 
   The updated run
@@ -4190,7 +4192,7 @@ Return information about the actor run.
 
 ***
 
-#### [](#runclientasync-update) `async RunClientAsync.update(*, status_message=None)`
+#### [](#runclientasync-update) `async RunClientAsync.update(*, status_message=None, is_status_message_terminal=None)`
 
 Update the run with the specified fields.
 
@@ -4200,6 +4202,8 @@ Update the run with the specified fields.
 
   * **status_message** (`str`, *optional*) – The new status message for the run
 
+  * **is_status_message_terminal** (`bool`, *optional*) – Set this flag to True if this is the final status message of the Actor run.
+
 * **Returns**
 
   The updated run

src/apify_client/clients/resource_clients/run.py

@@ -34,19 +34,21 @@ def get(self) -> Optional[Dict]:
         """
         return self._get()
 
-    def update(self, *, status_message: Optional[str] = None) -> Dict:
+    def update(self, *, status_message: Optional[str] = None, is_status_message_terminal: Optional[bool] = None) -> Dict:
         """Update the run with the specified fields.
 
         https://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run
 
         Args:
             status_message (str, optional): The new status message for the run
+            is_status_message_terminal (bool, optional): Set this flag to True if this is the final status message of the Actor run.
 
         Returns:
             dict: The updated run
         """
         updated_fields = {
             'statusMessage': status_message,
+            'isStatusMessageTerminal': is_status_message_terminal,
         }
 
         return self._update(_filter_out_none_values_recursively(updated_fields))
@@ -206,19 +208,21 @@ async def get(self) -> Optional[Dict]:
         """
         return await self._get()
 
-    async def update(self, *, status_message: Optional[str] = None) -> Dict:
+    async def update(self, *, status_message: Optional[str] = None, is_status_message_terminal: Optional[bool] = None) -> Dict:
         """Update the run with the specified fields.
 
         https://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run
 
         Args:
             status_message (str, optional): The new status message for the run
+            is_status_message_terminal (bool, optional): Set this flag to True if this is the final status message of the Actor run.
 
         Returns:
             dict: The updated run
         """
         updated_fields = {
             'statusMessage': status_message,
+            'isStatusMessageTerminal': is_status_message_terminal,
         }
 
         return await self._update(_filter_out_none_values_recursively(updated_fields))