feat: add updateOption support for source string editing endpoints

crowdin_api/api_resources/source_strings/enums.py

@@ -38,3 +38,9 @@ class ListStringsOrderBy(Enum):
     CREATED_AT = "createdAt"
     UPDATED_AT = "updatedAt"
     TYPE = "type"
+
+
+class StringUpdateOption(Enum):
+    CLEAR_TRANSLATIONS_AND_APPROVALS = "clear_translations_and_approvals"
+    KEEP_TRANSLATIONS = "keep_translations"
+    KEEP_TRANSLATIONS_AND_APPROVALS = "keep_translations_and_approvals"

crowdin_api/api_resources/source_strings/resource.py

@@ -2,12 +2,16 @@
 
 from crowdin_api.api_resources.abstract.resources import BaseResource
 from crowdin_api.api_resources.enums import DenormalizePlaceholders
-from crowdin_api.api_resources.source_strings.enums import ScopeFilter
+from crowdin_api.api_resources.source_strings.enums import (
+    ScopeFilter,
+    StringUpdateOption,
+)
 from crowdin_api.api_resources.source_strings.types import (
     SourceStringsPatchRequest,
     StringBatchOperationPatchRequest,
 )
 from crowdin_api.sorting import Sorting
+from crowdin_api.utils import convert_enum_to_string_if_exists
 
 
 class SourceStringsResource(BaseResource):
@@ -145,6 +149,7 @@ def edit_string(
         stringId: int,
         data: Iterable[SourceStringsPatchRequest],
         projectId: Optional[int] = None,
+        updateOption: Optional[StringUpdateOption] = None,
     ):
         """
         Edit String.
@@ -154,17 +159,27 @@ def edit_string(
         """
 
         projectId = projectId or self.get_project_id()
+        params = {}
 
-        return self.requester.request(
-            method="patch",
-            path=self.get_source_strings_path(projectId=projectId, stringId=stringId),
-            request_data=data,
-        )
+        if updateOption is not None:
+            params["updateOption"] = convert_enum_to_string_if_exists(updateOption)
+
+        request_kwargs = {
+            "method": "patch",
+            "path": self.get_source_strings_path(projectId=projectId, stringId=stringId),
+            "request_data": data,
+        }
+
+        if params:
+            request_kwargs["params"] = params
+
+        return self.requester.request(**request_kwargs)
 
     def string_batch_operation(
         self,
         data: Iterable[StringBatchOperationPatchRequest],
         projectId: Optional[int] = None,
+        updateOption: Optional[StringUpdateOption] = None,
     ):
         """
         String Batch Operations.
@@ -174,9 +189,18 @@ def string_batch_operation(
         """
 
         projectId = projectId or self.get_project_id()
+        params = {}
 
-        return self.requester.request(
-            method="patch",
-            path=self.get_source_strings_path(projectId=projectId),
-            request_data=data,
-        )
+        if updateOption is not None:
+            params["updateOption"] = convert_enum_to_string_if_exists(updateOption)
+
+        request_kwargs = {
+            "method": "patch",
+            "path": self.get_source_strings_path(projectId=projectId),
+            "request_data": data,
+        }
+
+        if params:
+            request_kwargs["params"] = params
+
+        return self.requester.request(**request_kwargs)

crowdin_api/api_resources/source_strings/tests/test_source_strings_resources.py

@@ -8,6 +8,7 @@
     SourceStringsPatchPath,
     StringBatchOperationsPath,
     StringBatchOperations,
+    StringUpdateOption,
 )
 from crowdin_api.api_resources.source_strings.resource import SourceStringsResource
 from crowdin_api.requester import APIRequester
@@ -198,6 +199,41 @@ def test_edit_string(self, m_request, base_absolut_url):
             path=resource.get_source_strings_path(projectId=1, stringId=2),
         )
 
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_edit_string_with_update_option(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        data = [
+            {
+                "value": "test",
+                "op": PatchOperation.REPLACE,
+                "path": SourceStringsPatchPath.TEXT,
+            },
+        ]
+
+        resource = self.get_resource(base_absolut_url)
+        assert (
+            resource.edit_string(
+                projectId=1,
+                stringId=2,
+                data=data,
+                updateOption=StringUpdateOption.KEEP_TRANSLATIONS,
+            )
+            == "response"
+        )
+
+        m_request.assert_called_once_with(
+            method="patch",
+            request_data=data,
+            params={
+                "updateOption": "keep_translations",
+            },
+            path=resource.get_source_strings_path(
+                projectId=1,
+                stringId=2,
+            ),
+        )
+
     @mock.patch("crowdin_api.requester.APIRequester.request")
     def test_string_batch_operation(self, m_request, base_absolut_url):
         m_request.return_value = "response"
@@ -221,3 +257,34 @@ def test_string_batch_operation(self, m_request, base_absolut_url):
             path=resource.get_source_strings_path(1),
             request_data=data,
         )
+
+    @mock.patch("crowdin_api.requester.APIRequester.request")
+    def test_string_batch_operation_with_update_option(self, m_request, base_absolut_url):
+        m_request.return_value = "response"
+
+        data = [
+            {
+                "op": StringBatchOperations.REPLACE,
+                "path": StringBatchOperationsPath.IS_HIDDEN,
+                "value": True,
+            },
+        ]
+
+        resource = self.get_resource(base_absolut_url)
+        assert (
+            resource.string_batch_operation(
+                projectId=1,
+                data=data,
+                updateOption=StringUpdateOption.KEEP_TRANSLATIONS,
+            )
+            == "response"
+        )
+
+        m_request.assert_called_once_with(
+            method="patch",
+            path=resource.get_source_strings_path(1),
+            request_data=data,
+            params={
+                "updateOption": "keep_translations",
+            },
+        )