API Updates: Glossaries: add new fields support

Author: innomaxx

src/Crowdin.Api/Glossaries/AddTermRequest.cs

@@ -1,4 +1,5 @@
 
+using System;
 using JetBrains.Annotations;
 using Newtonsoft.Json;
 
@@ -25,6 +26,25 @@ public class AddTermRequest
         [JsonProperty("partOfSpeech")]
         public PartOfSpeech? PartOfSpeech { get; set; }
 
+        [JsonProperty("status")]
+        public TermStatus? Status { get; set; }
+        
+        [JsonProperty("type")]
+        public TermType? Type { get; set; }
+        
+        [JsonProperty("gender")]
+        public TermGender? Gender { get; set; }
+        
+        [JsonProperty("note")]
+        public string? Note { get; set; }
+        
+        [JsonProperty("url")]
+        public string? Url { get; set; }
+        
+        [JsonProperty("conceptId")]
+        public int? ConceptId { get; set; }
+        
+        [Obsolete]
         [JsonProperty("translationOfTermId")]
         public int? TranslationOfTermId { get; set; }
     }

src/Crowdin.Api/Glossaries/ExportGlossaryRequest.cs

@@ -1,4 +1,5 @@
 
+using System.Collections.Generic;
 using JetBrains.Annotations;
 using Newtonsoft.Json;
 
@@ -9,5 +10,8 @@ public class ExportGlossaryRequest
     {
         [JsonProperty("format")]
         public GlossaryFormat Format { get; set; }
+        
+        [JsonProperty("exportFields")]
+        public ICollection<GlossaryExportFieldId> ExportFields { get; set; }
     }
 }

src/Crowdin.Api/Glossaries/GlossariesApiExecutor.cs

@@ -190,10 +190,10 @@ public async Task<GlossaryImportStatus> CheckGlossaryImportStatus(int glossaryId
         [PublicAPI]
         public Task<ResponseList<Term>> ListTerms(
             int glossaryId, int? userId = null, string? languageId = null,
-            int? translationOfTermId = null, int limit = 25, int offset = 0)
+            int? translationOfTermId = null, int? conceptId = null, int limit = 25, int offset = 0)
         {
             return ListTerms(glossaryId,
-                new TermsListParams(limit, offset, userId, languageId, translationOfTermId));
+                new TermsListParams(limit, offset, userId, languageId, translationOfTermId, conceptId));
         }
 
         /// <summary>
@@ -228,12 +228,15 @@ public async Task<Term> AddTerm(int glossaryId, AddTermRequest request)
         /// <a href="https://support.crowdin.com/enterprise/api/#operation/api.glossaries.terms.deleteMany">Crowdin Enterprise API</a>
         /// </summary>
         [PublicAPI]
-        public async Task ClearGlossary(int glossaryId, string? languageId = null, int? translationOfTermId = null)
+        public async Task ClearGlossary(
+            int glossaryId, string? languageId = null,
+            int? conceptId = null, int? translationOfTermId = null)
         {
             string url = FormUrl_Terms(glossaryId);
 
             var queryParams = new Dictionary<string, string>();
             queryParams.AddParamIfPresent("languageId", languageId);
+            queryParams.AddParamIfPresent("conceptId", conceptId);
             queryParams.AddParamIfPresent("translationOfTermId", translationOfTermId);
 
             HttpStatusCode statusCode = await _apiClient.SendDeleteRequest(url, queryParams);

src/Crowdin.Api/Glossaries/GlossaryExportFieldId.cs

@@ -0,0 +1,34 @@
+
+using System.ComponentModel;
+using JetBrains.Annotations;
+
+namespace Crowdin.Api.Glossaries
+{
+    [PublicAPI]
+    public enum GlossaryExportFieldId
+    {
+        [Description("term")]
+        Term,
+        
+        [Description("description")]
+        Description,
+        
+        [Description("partOfSpeech")]
+        PartOfSpeech,
+        
+        [Description("type")]
+        Type,
+        
+        [Description("status")]
+        Status,
+        
+        [Description("gender")]
+        Gender,
+        
+        [Description("note")]
+        Note,
+        
+        [Description("url")]
+        Url
+    }
+}

src/Crowdin.Api/Glossaries/GlossaryFormat.cs

@@ -10,6 +10,9 @@ public enum GlossaryFormat
         [Description("tbx")]
         Tbx,
 
+        [Description("tbx_v3")]
+        TbxV3,
+        
         [Description("csv")]
         Csv,
 

src/Crowdin.Api/Glossaries/Term.cs

@@ -29,6 +29,24 @@ public class Term
         [JsonProperty("partOfSpeech")]
         public PartOfSpeech PartOfSpeech { get; set; }
 
+        [JsonProperty("status")]
+        public TermStatus Status { get; set; }
+        
+        [JsonProperty("type")]
+        public TermType Type { get; set; }
+        
+        [JsonProperty("gender")]
+        public TermGender Gender { get; set; }
+        
+        [JsonProperty("note")]
+        public string Note { get; set; }
+        
+        [JsonProperty("url")]
+        public string Url { get; set; }
+        
+        [JsonProperty("conceptId")]
+        public int? ConceptId { get; set; }
+        
         [JsonProperty("lemma")]
         public string Lemma { get; set; }
 

src/Crowdin.Api/Glossaries/TermGender.cs

@@ -0,0 +1,22 @@
+
+using System.ComponentModel;
+using JetBrains.Annotations;
+
+namespace Crowdin.Api.Glossaries
+{
+    [PublicAPI]
+    public enum TermGender
+    {
+        [Description("masculine")]
+        Masculine,
+        
+        [Description("feminine")]
+        Feminine,
+        
+        [Description("neuter")]
+        Neuter,
+        
+        [Description("other")]
+        Other
+    }
+}

src/Crowdin.Api/Glossaries/TermPatch.cs

@@ -22,6 +22,21 @@ public enum TermPatchPath
         Description,
 
         [Description("/partOfSpeech")]
-        PartOfSpeech
+        PartOfSpeech,
+        
+        [Description("/status")]
+        Status,
+        
+        [Description("/type")]
+        Type,
+        
+        [Description("/gender")]
+        Gender,
+        
+        [Description("/url")]
+        Url,
+        
+        [Description("/note")]
+        Note
     }
 }

src/Crowdin.Api/Glossaries/TermStatus.cs

@@ -0,0 +1,22 @@
+
+using System.ComponentModel;
+using JetBrains.Annotations;
+
+namespace Crowdin.Api.Glossaries
+{
+    [PublicAPI]
+    public enum TermStatus
+    {
+        [Description("preferred")]
+        Preferred,
+        
+        [Description("admitted")]
+        Admitted,
+        
+        [Description("not recommended")]
+        NotRecommended,
+        
+        [Description("obsolete")]
+        Obsolete
+    }
+}

src/Crowdin.Api/Glossaries/TermType.cs

@@ -0,0 +1,28 @@
+
+using System.ComponentModel;
+using JetBrains.Annotations;
+
+namespace Crowdin.Api.Glossaries
+{
+    [PublicAPI]
+    public enum TermType
+    {
+        [Description("full form")]
+        FullForm,
+        
+        [Description("acronym")]
+        Acronym,
+        
+        [Description("abbreviation")]
+        Abbreviation,
+        
+        [Description("short form")]
+        ShortForm,
+        
+        [Description("phrase")]
+        Phrase,
+        
+        [Description("variant")]
+        Variant
+    }
+}