fix: add updateResultRequest

Author: Priyadarshini Piramanayagam

nisystemlink/clients/result/_result_client.py

@@ -5,7 +5,10 @@
 from nisystemlink.clients import core
 from nisystemlink.clients.core._uplink._base_client import BaseClient
 from nisystemlink.clients.core._uplink._methods import delete, get, post
-from nisystemlink.clients.result.models import Result
+from nisystemlink.clients.result.models import (
+    Result,
+    UpdateResultRequest,
+)
 from uplink import Field, Query, retry, returns
 
 from . import models
@@ -125,8 +128,8 @@ def query_result_values(self, query: models.QueryResultValuesRequest) -> List[st
         ...
 
     @post("update-results", args=[Field("results"), Field("replace")])
-    def update_results(
-        self, results: List[Result], replace: bool = False
+    def __update_results(
+        self, results: List[UpdateResultRequest], replace: bool = False
     ) -> models.ResultsPartialSuccess:
         """Updates a list of results with optional field replacement.
 
@@ -147,6 +150,37 @@ def update_results(
         """
         ...
 
+    def update_results(
+        self,
+        results: List[UpdateResultRequest],
+        replace: bool = False,
+        allow_workspace_update: bool = False,
+    ) -> models.ResultsPartialSuccess:
+        """Updates a list of results with optional field replacement.
+
+        Args:
+            `results`: A list of results to update. Results are matched for update by id.
+            `replace`: Replace the existing fields instead of merging them. Defaults to `False`.
+                If this is `True`, then `keywords` and `properties` for the result will be
+                    replaced by what is in the `results` provided in this request.
+                If this is `False`, then the `keywords` and `properties` in this request will
+                    merge with what is already present in the server resource.
+            `allow_workspace_update`: If this is set to `False`, the `workspace` field will be set to None
+                before updating.
+
+        Returns: A list of updates results, results that failed to update, and errors for
+            failures.
+
+        Raises:
+            ApiException: if unable to communicate with the ``/nitestmonitor`` Service
+                or provided an invalid argument.
+        """
+        if not allow_workspace_update:
+            for result in results:
+                result.workspace = None
+
+        return self.__update_results(results, replace)
+
     @delete("results/{id}")
     def delete_result(self, id: str) -> None:
         """Deletes a single result by id.

nisystemlink/clients/result/models/__init__.py

@@ -2,6 +2,7 @@
 from ._results_partial_success import ResultsPartialSuccess
 from ._delete_results_partial_success import DeleteResultsPartialSuccess
 from ._paged_results import PagedResults
+from ._update_result_request import UpdateResultRequest
 from ._query_results_request import (
     QueryResultsRequest,
     ResultField,

nisystemlink/clients/result/models/_update_result_request.py

@@ -0,0 +1,54 @@
+from datetime import datetime
+from typing import Dict, List, Optional
+
+from nisystemlink.clients.core._uplink._json_model import JsonModel
+from nisystemlink.clients.result.models._result import StatusObject
+
+
+class UpdateResultRequest(JsonModel):
+    """Contains information about a result."""
+
+    status: StatusObject
+    """The status of the result."""
+
+    started_at: Optional[datetime]
+    """The time that the result started."""
+
+    program_name: str
+    """The name of the program that generated this result."""
+
+    id: Optional[str]
+    """The globally unique id of the result."""
+
+    system_id: Optional[str]
+    """The id of the system that generated this result."""
+
+    host_name: Optional[str]
+    """The name of the host that generated this result."""
+
+    part_number: Optional[str]
+    """The part number is the unique identifier of a product within a single org."""
+
+    serial_number: Optional[str]
+    """The serial number of the system that generated this result."""
+
+    total_time_in_seconds: Optional[float]
+    """The total time that the result took to run in seconds."""
+
+    keywords: Optional[List[str]]
+    """A list of keywords that categorize this result."""
+
+    properties: Optional[Dict[str, str]]
+    """A list of custom properties for this result."""
+
+    operator: Optional[str]
+    """The operator that ran the result."""
+
+    file_ids: Optional[List[str]]
+    """A list of file ids that are attached to this result."""
+
+    data_table_ids: Optional[List[str]]
+    """A list of data table ids that are attached to this result."""
+
+    workspace: Optional[str]
+    """The id of the workspace that this product belongs to."""