feat(translations): add List and Edit PreTranslation APIs (#277)

crowdin · Nov 1, 2024 · 36988cb · 36988cb
1 parent f1c2df1
commit 36988cb
Show file tree

Hide file tree

Showing 5 changed files with 251 additions and 131 deletions.
diff --git a/src/Crowdin.Api/Translations/PreTranslationPatch.cs b/src/Crowdin.Api/Translations/PreTranslationPatch.cs
@@ -0,0 +1,21 @@
+
+using System.ComponentModel;
+using JetBrains.Annotations;
+using Newtonsoft.Json;
+
+namespace Crowdin.Api.Translations
+{
+    [PublicAPI]
+    public class PreTranslationPatch : PatchEntry
+    {
+        [JsonProperty("path")]
+        public PreTranslationPatchPath Path { get; set; }
+    }
+
+    [PublicAPI]
+    public enum PreTranslationPatchPath
+    {
+        [Description("/status")]
+        Status
+    }
+}
diff --git a/src/Crowdin.Api/Translations/TranslationsApiExecutor.cs b/src/Crowdin.Api/Translations/TranslationsApiExecutor.cs
@@ -26,6 +26,42 @@ public TranslationsApiExecutor(ICrowdinApiClient apiClient, IJsonParser jsonPars
             _jsonParser = jsonParser;
         }
 
+        /// <summary>
+        /// List Pre-Translations. Documentation:
+        /// <a href="https://support.crowdin.com/developer/api/v2/#tag/Translations/operation/api.projects.pre-translations.getMany">Crowdin API</a>
+        /// <a href="https://support.crowdin.com/developer/api/v2/string-based/#tag/Translations/operation/api.projects.pre-translations.getMany">Crowdin String Based API</a>
+        /// <a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translations/operation/api.projects.pre-translations.getMany">Crowdin Enterprise API</a>
+        /// </summary>
+        [PublicAPI]
+        public async Task<ResponseList<PreTranslation>> ListPreTranslations(
+            int projectId,
+            int limit = 25,
+            int offset = 0)
+        {
+            var url = $"/projects/{projectId}/pre-translations";
+
+            IDictionary<string, string> queryParams = Utils.CreateQueryParamsFromPaging(limit, offset);
+            CrowdinApiResult result = await _apiClient.SendGetRequest(url, queryParams);
+            return _jsonParser.ParseResponseList<PreTranslation>(result.JsonObject);
+        }
+
+        /// <summary>
+        /// Edit Pre-Translation. Documentation:
+        /// <a href="https://support.crowdin.com/developer/api/v2/#tag/Translations/operation/api.projects.pre-translations.patch">Crowdin API</a>
+        /// <a href="https://support.crowdin.com/developer/api/v2/string-based/#tag/Translations/operation/api.projects.pre-translations.patch">Crowdin String Based API</a>
+        /// <a href="https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translations/operation/api.projects.pre-translations.patch">Crowdin Enterprise API</a>
+        /// </summary>
+        [PublicAPI]
+        public async Task<PreTranslation> EditPreTranslation(
+            int projectId,
+            string preTranslationId,
+            IEnumerable<PreTranslationPatch> patches)
+        {
+            var url = $"/projects/{projectId}/pre-translations/{preTranslationId}";
+            CrowdinApiResult result = await _apiClient.SendPatchRequest(url, patches);
+            return _jsonParser.ParseResponseObject<PreTranslation>(result.JsonObject);
+        }
+
         /// <summary>
         /// Get pre-translation status. Documentation:
         /// <a href="https://support.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get">Crowdin API</a>

diff --git a/tests/Crowdin.Api.Tests/Core/Resources/Translations.Designer.cs b/tests/Crowdin.Api.Tests/Core/Resources/Translations.Designer.cs
diff --git a/tests/Crowdin.Api.Tests/Core/Resources/Translations.resx b/tests/Crowdin.Api.Tests/Core/Resources/Translations.resx
@@ -241,4 +241,73 @@
   }
 }</value>
   </data>
+  <data name="CommonResources_PreTranslations_List" xml:space="preserve">
+      <value>{
+  "data": [
+    {
+      "identifier": "9e7de270-4f83-41cb-b606-2f90631f26e2",
+      "status": "created",
+      "progress": 90,
+      "attributes": {
+        "languageIds": [
+          "uk"
+        ],
+        "fileIds": [
+          742
+        ],
+        "method": "tm",
+        "autoApproveOption": "all",
+        "duplicateTranslations": true,
+        "skipApprovedTranslations": true,
+        "translateUntranslatedOnly": true,
+        "translateWithPerfectMatchOnly": true
+      },
+      "createdAt": "2019-09-20T14:05:50+00:00",
+      "updatedAt": "2019-09-20T14:05:50+00:00",
+      "startedAt": "2019-09-20T14:05:50+00:00",
+      "finishedAt": "2019-09-20T14:05:50+00:00"
+    }
+  ],
+  "pagination": {
+    "offset": 0,
+    "limit": 25
+  }
+}</value>
+  </data>
+  <data name="CommonResources_PreTranslation" xml:space="preserve">
+      <value>{
+  "data": {
+    "identifier": "9e7de270-4f83-41cb-b606-2f90631f26e2",
+    "status": "created",
+    "progress": 90,
+    "attributes": {
+      "languageIds": [
+        "uk"
+      ],
+      "fileIds": [
+        742
+      ],
+      "method": "tm",
+      "autoApproveOption": "all",
+      "duplicateTranslations": true,
+      "skipApprovedTranslations": true,
+      "translateUntranslatedOnly": true,
+      "translateWithPerfectMatchOnly": true
+    },
+    "createdAt": "2019-09-20T14:05:50+00:00",
+    "updatedAt": "2019-09-20T14:05:50+00:00",
+    "startedAt": "2019-09-20T14:05:50+00:00",
+    "finishedAt": "2019-09-20T14:05:50+00:00"
+  }
+}</value>
+  </data>
+  <data name="EditPreTranslation_Request" xml:space="preserve">
+      <value>[
+  {
+    "path": "/status",
+    "op": "replace",
+    "value": "status"
+  }
+]</value>
+  </data>
 </root>