Merge pull request #23 from crowdin/feature/more-methods

Add methods: String Translations, Reports

Author: andrii-bodnar

Crowdin.sln.DotSettings.user

@@ -1,9 +1,13 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateStaticFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=5496421d_002D469b_002D475a_002D92e0_002D082040a541e9/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" IsActive="True" Name="All tests from Solution" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
   &lt;Solution /&gt;&#xD;
 &lt;/SessionState&gt;</s:String>
+	<s:Boolean x:Key="/Default/ResxEditorPersonal/CheckedGroups/=tests_002FCrowdin_002EApi_002ETests_002FCore_002FResources_002FReports/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/ResxEditorPersonal/CheckedGroups/=tests_002FCrowdin_002EApi_002ETests_002FCore_002FResources_002FSourceFiles/@EntryIndexedValue">False</s:Boolean>
+	<s:Boolean x:Key="/Default/ResxEditorPersonal/CheckedGroups/=tests_002FCrowdin_002EApi_002ETests_002FCore_002FResources_002FTranslations/@EntryIndexedValue">False</s:Boolean>
 
 
 

src/Crowdin.Api/Core/Converters/DescriptionEnumConverter.cs

@@ -19,20 +19,30 @@ public override bool CanConvert(Type objectType)
 
         public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
         {
-            if (value != null)
+            if (value is null) return;
+            Type valueType = value.GetType();
+            
+            if (valueType.IsDefined(typeof(StrictStringRepresentation)))
             {
-                if (value
-                    .GetType()
-                    .GetMember(value.ToString())
-                    .First()
-                    .IsDefined(typeof(DescriptionAttribute), false))
-                {
-                    writer.WriteValue((value as Enum).ToDescriptionString());
-                }
-                else
+                string? memberName = Enum.GetName(valueType, value);
+
+                if (memberName is null)
                 {
-                    writer.WriteValue(Convert.ToInt32(value));
+                    throw new Exception($"Value {value} not found on enum type {valueType.Name}");
                 }
+                
+                writer.WriteValue(memberName);
+            }
+            else if (valueType
+                     .GetMember(value.ToString())
+                     .First()
+                     .IsDefined(typeof(DescriptionAttribute), false))
+            {
+                writer.WriteValue((value as Enum).ToDescriptionString());
+            }
+            else
+            {
+                writer.WriteValue(Convert.ToInt32(value));
             }
         }
 
@@ -71,4 +81,10 @@ public override void WriteJson(JsonWriter writer, object? value, JsonSerializer
             throw new ArgumentException();
         }
     }
+
+    [AttributeUsage(AttributeTargets.Enum)]
+    public class StrictStringRepresentation : Attribute
+    {
+        
+    }
 }

src/Crowdin.Api/CrowdinApiClient.cs

@@ -12,8 +12,12 @@
 using Crowdin.Api.Core.Converters;
 using Crowdin.Api.Languages;
 using Crowdin.Api.ProjectsGroups;
+using Crowdin.Api.Reports;
+using Crowdin.Api.Screenshots;
 using Crowdin.Api.SourceFiles;
+using Crowdin.Api.SourceStrings;
 using Crowdin.Api.Storage;
+using Crowdin.Api.StringTranslations;
 using Crowdin.Api.Translations;
 using Crowdin.Api.TranslationStatus;
 
@@ -32,10 +36,18 @@ public class CrowdinApiClient : ICrowdinApiClient
 
         public ProjectsGroupsApiExecutor ProjectsGroups { get; }
 
+        public ReportsApiExecutor Reports { get; }
+        
+        public ScreenshotsApiExecutor Screenshots { get; }
+        
         public SourceFilesApiExecutor SourceFiles { get; }
 
+        public SourceStringsApiExecutor SourceStrings { get; }
+        
         public StorageApiExecutor Storage { get; }
 
+        public StringTranslationsApiExecutor StringTranslations { get; }
+        
         public TranslationsApiExecutor Translations { get; }
 
         public TranslationStatusApiExecutor TranslationStatus { get; set; }
@@ -85,8 +97,12 @@ public CrowdinApiClient(CrowdinCredentials credentials)
 
             Languages = new LanguagesApiExecutor(this);
             ProjectsGroups = new ProjectsGroupsApiExecutor(this);
+            Reports = new ReportsApiExecutor(this);
+            Screenshots = new ScreenshotsApiExecutor(this);
             SourceFiles = new SourceFilesApiExecutor(this);
+            SourceStrings = new SourceStringsApiExecutor(this);
             Storage = new StorageApiExecutor(this);
+            StringTranslations = new StringTranslationsApiExecutor(this);
             Translations = new TranslationsApiExecutor(this);
             TranslationStatus = new TranslationStatusApiExecutor(this);
         }
@@ -130,15 +146,19 @@ public Task<CrowdinApiResult> SendPostRequest(
             return SendRequest(request);
         }
 
-        public Task<CrowdinApiResult> SendPutRequest(string subUrl, object body)
+        public Task<CrowdinApiResult> SendPutRequest(string subUrl, object? body = null)
         {
             var request = new HttpRequestMessage
             {
                 Method = HttpMethod.Put,
-                RequestUri = new Uri(FormRequestUrl(subUrl)),
-                Content = CreateJsonContent(body)
+                RequestUri = new Uri(FormRequestUrl(subUrl))
             };
 
+            if (body != null)
+            {
+                request.Content = CreateJsonContent(body);
+            }
+
             return SendRequest(request);
         }
 
@@ -154,12 +174,12 @@ public Task<CrowdinApiResult> SendPatchRequest(string subUrl, IEnumerable<PatchE
             return SendRequest(request);
         }
 
-        public Task<HttpStatusCode> SendDeleteRequest(string subUrl)
+        public Task<HttpStatusCode> SendDeleteRequest(string subUrl, IDictionary<string, string>? queryParams = null)
         {
             var request = new HttpRequestMessage
             {
                 Method = HttpMethod.Delete,
-                RequestUri = new Uri(FormRequestUrl(subUrl))
+                RequestUri = new Uri(FormRequestUrl(subUrl, queryParams))
             };
 
             return SendRequest(request).ContinueWith(task => task.Result.StatusCode);

src/Crowdin.Api/ICrowdinApiClient.cs

@@ -17,11 +17,11 @@ public interface ICrowdinApiClient
 
         Task<CrowdinApiResult> SendPostRequest(string subUrl, object body, IDictionary<string, string>? extraHeaders = null);
 
-        Task<CrowdinApiResult> SendPutRequest(string subUrl, object body);
+        Task<CrowdinApiResult> SendPutRequest(string subUrl, object? body = null);
 
         Task<CrowdinApiResult> SendPatchRequest(string subUrl, IEnumerable<PatchEntry> body);
 
-        Task<HttpStatusCode> SendDeleteRequest(string subUrl);
+        Task<HttpStatusCode> SendDeleteRequest(string subUrl, IDictionary<string, string>? queryParams = null);
 
         Task<CrowdinApiResult> UploadFile(string subUrl, string filename, Stream fileStream);
     }

src/Crowdin.Api/Reports/ContributionRawDataGenerateReportRequest.cs

@@ -0,0 +1,57 @@
+
+using System;
+using System.ComponentModel;
+using JetBrains.Annotations;
+using Newtonsoft.Json;
+
+#nullable enable
+
+namespace Crowdin.Api.Reports
+{
+    [PublicAPI]
+    public class ContributionRawDataGenerateReportRequest : GenerateReportRequest
+    {
+        [JsonProperty("name")]
+        public string Name => "contribution-raw-data";
+        
+        [JsonProperty("schema")]
+#pragma warning disable CS8618
+        public RequestSchema Schema { get; set; }
+#pragma warning restore CS8618
+
+        [PublicAPI]
+        public class RequestSchema
+        {
+            [JsonProperty("mode")]
+            public ContributionReportMode Mode { get; set; }
+            
+            [JsonProperty("unit")]
+            public ReportUnit? Unit { get; set; }
+            
+            [JsonProperty("languageId")]
+            public string? LanguageId { get; set; }
+            
+            [JsonProperty("userId")]
+            public string? UserId { get; set; }
+            
+            [JsonProperty("dateFrom")]
+            public DateTimeOffset? DateFrom { get; set; }
+            
+            [JsonProperty("dateTo")]
+            public DateTimeOffset? DateTo { get; set; }
+        }
+    }
+
+    [PublicAPI]
+    public enum ContributionReportMode
+    {
+        [Description("translations")]
+        Translations,
+        
+        [Description("approvals")]
+        Approvals,
+        
+        [Description("votes")]
+        Votes
+    }
+}