EN-376 Add contributors and note to language variants

kontent-ai · Dec 10, 2024 · 23ad422 · 23ad422
1 parent 4685d24
commit 23ad422
Show file tree

Hide file tree

Showing 16 changed files with 180 additions and 15 deletions.
diff --git a/Kontent.Ai.Management.Tests/CodeSamples/CmApiV2.cs b/Kontent.Ai.Management.Tests/CodeSamples/CmApiV2.cs
@@ -2025,7 +2025,15 @@ public async void PutVariantWorkflow()
         var exception = await Record.ExceptionAsync(async () =>
                 await client.ChangeLanguageVariantWorkflowAsync(
                     new LanguageVariantIdentifier(itemIdentifier, languageIdentifier),
-                    new WorkflowStepIdentifier(Reference.ById(Guid.Empty), workflowStepIdentifier)
+                    new ChangeLanguageVariantWorkflowModel(Reference.ById(Guid.Empty), workflowStepIdentifier)
+                        {
+                            DueDate = new DueDateModel
+                            {
+                                Value = DateTime.UtcNow.AddDays(42)
+                            },
+                            Contributors = new List<UserIdentifier> { UserIdentifier.ByEmail("[email protected]") },
+                            Note = "Moving this to the next workflow step."
+                    }
                     ));
         Assert.Null(exception);
     }

diff --git a/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariant.json b/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariant.json
@@ -176,6 +176,12 @@
   "due_date": {
     "value": "2092-01-07T06:04:00.7069564Z"
   },
+  "contributors": [
+    {
+      "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+    }
+  ],
+  "note": "Just a note",
   "item": {
     "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
   },

diff --git a/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariants.json b/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariants.json
@@ -177,6 +177,12 @@
     "due_date": {
       "value": "2092-01-07T06:04:00.7069564Z"
     },
+    "contributors": [
+      {
+        "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+      }
+    ],
+    "note": "Just a note",
     "item": {
       "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
     },
@@ -363,6 +369,12 @@
     "due_date": {
       "value": "2092-01-07T06:04:00.7069564Z"
     },
+    "contributors": [
+      {
+        "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+      }
+    ],
+    "note": "Just a note",
     "item": {
       "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
     },

diff --git a/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage1.json b/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage1.json
@@ -178,6 +178,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "00000000-0000-0000-0000-000000000000"
       },
@@ -364,6 +370,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "00000000-0000-0000-0000-000000000000"
       },

diff --git a/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage2.json b/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage2.json
@@ -178,6 +178,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "10000000-0000-0000-0000-000000000000"
       },
@@ -364,6 +370,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "10000000-0000-0000-0000-000000000000"
       },

diff --git a/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage3.json b/Kontent.Ai.Management.Tests/Data/LanguageVariant/LanguageVariantsPage3.json
@@ -178,6 +178,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "20000000-0000-0000-0000-000000000000"
       },
@@ -367,6 +373,12 @@
       "due_date": {
         "value": "2092-01-07T06:04:00.7069564Z"
       },
+      "contributors": [
+        {
+          "id": "4b628214-e4fe-4fe0-b1ff-955df33e1515"
+        }
+      ],
+      "note": "Just a note",
       "item": {
         "id": "20000000-0000-0000-0000-000000000000"
       },

diff --git a/Kontent.Ai.Management.Tests/ManagementClientTests/LanguageVariantTests.cs b/Kontent.Ai.Management.Tests/ManagementClientTests/LanguageVariantTests.cs
@@ -528,6 +528,8 @@ private static LanguageVariantModel GetExpectedLanguageVariantModel(
             Workflow = new WorkflowStepIdentifier(Reference.ById(Guid.Parse("00000000-0000-0000-0000-000000000000")), Reference.ById(Guid.Parse("eee6db3b-545a-4785-8e86-e3772c8756f9"))),
             Schedule = GetExpectedScheduleResponseModel(),
             DueDate = GetExpectedDueDateModel(),
+            Contributors = GetExpectedContributors(),
+            Note = "Just a note",
             Elements = ElementsData.GetExpectedDynamicElements(),
         };
 
@@ -544,6 +546,8 @@ private static LanguageVariantModel<ComplexTestModel> GetExpectedComplexTestMode
             Workflow = new WorkflowStepIdentifier(Reference.ById(Guid.Parse("00000000-0000-0000-0000-000000000000")), Reference.ById(Guid.Parse("eee6db3b-545a-4785-8e86-e3772c8756f9"))),
             Schedule = GetExpectedScheduleResponseModel(),
             DueDate = GetExpectedDueDateModel(),
+            Contributors = GetExpectedContributors(),
+            Note = "Just a note",
             Elements = ElementsData.GetExpectedStronglyTypedElementsModel(),
         };
 
@@ -558,6 +562,9 @@ private static LanguageVariantModel<ComplexTestModel> GetExpectedComplexTestMode
     private static DueDateModel GetExpectedDueDateModel() =>
         new() { Value = DateTimeOffset.Parse("2092-01-07T06:04:00.7069564Z").UtcDateTime };
 
+    private static List<UserIdentifier> GetExpectedContributors() =>
+        new List<UserIdentifier>() { UserIdentifier.ById("4b628214-e4fe-4fe0-b1ff-955df33e1515") };
+
     private class CombinationOfIdentifiersAndUrl : IEnumerable<object[]>
     {
 

diff --git a/Kontent.Ai.Management.Tests/ManagementClientTests/PublishingTests.cs b/Kontent.Ai.Management.Tests/ManagementClientTests/PublishingTests.cs
@@ -2,7 +2,6 @@
 using Kontent.Ai.Management.Models.LanguageVariants;
 using Kontent.Ai.Management.Models.Publishing;
 using Kontent.Ai.Management.Models.Shared;
-using Kontent.Ai.Management.Models.Workflow;
 using Kontent.Ai.Management.Tests.Base;
 using System;
 using System.Collections;
@@ -28,18 +27,18 @@ public async void ChangeLanguageVariantWorkflowAsync_ChangesWorkflow(LanguageVar
     {
         var client = _scenario.CreateManagementClient();
 
-        var workflowIdentifier = new WorkflowStepIdentifier
+        var model = new ChangeLanguageVariantWorkflowModel
             (
                 workflowIdentifier: Reference.ById(Guid.NewGuid()),
                 stepIdentifier: Reference.ById(Guid.NewGuid())
             );
 
-        await client.ChangeLanguageVariantWorkflowAsync(variantIdentifier, workflowIdentifier);
+        await client.ChangeLanguageVariantWorkflowAsync(variantIdentifier, model);
 
         _scenario
             .CreateExpectations()
             .HttpMethod(HttpMethod.Put)
-            .RequestPayload(workflowIdentifier)
+            .RequestPayload(model)
             .Url($"{expectedUrl}/change-workflow")
             .Validate();
     }
@@ -49,13 +48,13 @@ public async void ChangeLanguageVariantWorkflowAsync_NoIdentifier_Throws()
     {
         var client = _scenario.CreateManagementClient();
 
-        var workflowIdentifier = new WorkflowStepIdentifier
+        var model = new ChangeLanguageVariantWorkflowModel
             (
                 workflowIdentifier: Reference.ById(Guid.NewGuid()),
                 stepIdentifier: Reference.ById(Guid.NewGuid())
             );
 
-        await client.Invoking(x => x.ChangeLanguageVariantWorkflowAsync(null, workflowIdentifier)).Should().ThrowAsync<ArgumentNullException>();
+        await client.Invoking(x => x.ChangeLanguageVariantWorkflowAsync(null, model)).Should().ThrowAsync<ArgumentNullException>();
     }
 
     [Fact]

diff --git a/Kontent.Ai.Management/IManagementClient.cs b/Kontent.Ai.Management/IManagementClient.cs
@@ -164,8 +164,8 @@ public interface IManagementClient
     /// Changes workflow.
     /// </summary>
     /// <param name="identifier">Identifier of the language variant to be changed.</param>
-    /// <param name="workflowStepIdentifier">Workflow step identifier to set.</param>
-    Task ChangeLanguageVariantWorkflowAsync(LanguageVariantIdentifier identifier, WorkflowStepIdentifier workflowStepIdentifier);
+    /// <param name="changeModel">Change language variant workflow model.</param>
+    Task ChangeLanguageVariantWorkflowAsync(LanguageVariantIdentifier identifier, ChangeLanguageVariantWorkflowModel changeModel);
 
     /// <summary>
     /// Creates the asset folder.

diff --git a/Kontent.Ai.Management/ManagementClient.Publishing.cs b/Kontent.Ai.Management/ManagementClient.Publishing.cs
@@ -1,6 +1,5 @@
 using Kontent.Ai.Management.Models.LanguageVariants;
 using Kontent.Ai.Management.Models.Publishing;
-using Kontent.Ai.Management.Models.Workflow;
 using System;
 using System.Net.Http;
 using System.Threading.Tasks;
@@ -13,15 +12,15 @@ namespace Kontent.Ai.Management;
 public sealed partial class ManagementClient
 {
     /// <inheritdoc />
-    public async Task ChangeLanguageVariantWorkflowAsync(LanguageVariantIdentifier identifier, WorkflowStepIdentifier workflowStepIdentifier)
+    public async Task ChangeLanguageVariantWorkflowAsync(LanguageVariantIdentifier identifier, ChangeLanguageVariantWorkflowModel changeModel)
     {
         ArgumentNullException.ThrowIfNull(identifier);
 
-        ArgumentNullException.ThrowIfNull(workflowStepIdentifier);
+        ArgumentNullException.ThrowIfNull(changeModel);
 
         var endpointUrl = _urlBuilder.BuildWorkflowChangeUrl(identifier);
 
-        await _actionInvoker.InvokeMethodAsync(endpointUrl, HttpMethod.Put, workflowStepIdentifier);
+        await _actionInvoker.InvokeMethodAsync(endpointUrl, HttpMethod.Put, changeModel);
     }
 
     /// <inheritdoc />

diff --git a/Kontent.Ai.Management/Models/LanguageVariants/ChangeLanguageVariantWorkflowModel.cs b/Kontent.Ai.Management/Models/LanguageVariants/ChangeLanguageVariantWorkflowModel.cs
@@ -0,0 +1,52 @@
+using Kontent.Ai.Management.Models.Shared;
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace Kontent.Ai.Management.Models.LanguageVariants;
+
+/// <summary>
+/// Represents a change language variant workflow model.
+/// </summary>
+public sealed class ChangeLanguageVariantWorkflowModel
+{
+    /// <summary>
+    /// Represents the identifier of the workflow.
+    /// </summary>
+    [JsonProperty("workflow_identifier")]
+    public Reference Workflow { get; set; }
+
+    /// <summary>
+    /// Represents the identifier of the step in the workflow.
+    /// </summary>
+    [JsonProperty("step_identifier")]
+    public Reference Step { get; set; }
+
+    /// <summary>
+    /// Gets or sets due date.
+    /// </summary>
+    [JsonProperty("due_date")]
+    public DueDateModel DueDate { get; set; }
+
+    /// <summary>
+    /// Gets or sets a note.
+    /// </summary>
+    [JsonProperty("note")]
+    public string Note { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contributors.
+    /// </summary>
+    [JsonProperty("contributors")]
+    public IEnumerable<UserIdentifier> Contributors { get; set; }
+
+    /// <summary>
+    /// Creates an instance of the change language variant workflow model.
+    /// </summary>
+    /// <param name="workflowIdentifier">The identifier of the workflow.</param>
+    /// <param name="stepIdentifier">The identifier of the workflow step.</param>
+    public ChangeLanguageVariantWorkflowModel(Reference workflowIdentifier, Reference stepIdentifier)
+    {
+        Workflow = workflowIdentifier;
+        Step = stepIdentifier;
+    }
+}
diff --git a/Kontent.Ai.Management/Models/LanguageVariants/LanguageVariantModel.cs b/Kontent.Ai.Management/Models/LanguageVariants/LanguageVariantModel.cs
@@ -53,4 +53,16 @@ public sealed class LanguageVariantModel
     /// </summary>
     [JsonProperty("due_date")]
     public DueDateModel DueDate { get; set; }
+
+    /// <summary>
+    /// Gets or sets a note.
+    /// </summary>
+    [JsonProperty("note")]
+    public string Note { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contributors.
+    /// </summary>
+    [JsonProperty("contributors")]
+    public IEnumerable<UserIdentifier> Contributors { get; set; }
 }
diff --git a/Kontent.Ai.Management/Models/LanguageVariants/LanguageVariantUpsertModel.cs b/Kontent.Ai.Management/Models/LanguageVariants/LanguageVariantUpsertModel.cs
@@ -1,4 +1,5 @@
-using Kontent.Ai.Management.Models.Workflow;
+using Kontent.Ai.Management.Models.Shared;
+using Kontent.Ai.Management.Models.Workflow;
 using Newtonsoft.Json;
 using System.Collections.Generic;
 
@@ -25,6 +26,18 @@ public sealed class LanguageVariantUpsertModel
     /// </summary>
     public DueDateModel DueDate { get; set; }
 
+    /// <summary>
+    /// Gets or sets a note.
+    /// </summary>
+    [JsonProperty("note")]
+    public string Note { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contributors.
+    /// </summary>
+    [JsonProperty("contributors")]
+    public IEnumerable<UserIdentifier> Contributors { get; set; }
+
     /// <summary>
     /// Creates an instance of the language variant upsert model.
     /// </summary>
@@ -37,5 +50,7 @@ internal LanguageVariantUpsertModel(LanguageVariantModel languageVariant)
         Elements = languageVariant.Elements;
         Workflow = languageVariant.Workflow;
         DueDate = languageVariant.DueDate;
+        Note = languageVariant.Note;
+        Contributors = languageVariant.Contributors;
     }
 }
diff --git a/Kontent.Ai.Management/Models/Shared/UserIdentifier.cs b/Kontent.Ai.Management/Models/Shared/UserIdentifier.cs
@@ -1,4 +1,6 @@
-namespace Kontent.Ai.Management.Models.Shared;
+using Newtonsoft.Json;
+
+namespace Kontent.Ai.Management.Models.Shared;
 
 /// <summary>
 /// Represents identifier of users.
@@ -10,11 +12,13 @@ private UserIdentifier() { }
     /// <summary>
     /// Gets the id of the identifier.
     /// </summary>
+    [JsonProperty("id", DefaultValueHandling = DefaultValueHandling.Ignore)]
     public string Id { get; private set; }
 
     /// <summary>
     /// Gets the email of the identifier.
     /// </summary>
+    [JsonProperty("email", DefaultValueHandling = DefaultValueHandling.Ignore)]
     public string Email { get; private set; }
 
     /// <summary>

diff --git a/Kontent.Ai.Management/Models/StronglyTyped/LanguageVariantModel.cs b/Kontent.Ai.Management/Models/StronglyTyped/LanguageVariantModel.cs
@@ -4,6 +4,7 @@
 using Kontent.Ai.Management.Models.Workflow;
 using Newtonsoft.Json;
 using System;
+using System.Collections.Generic;
 
 namespace Kontent.Ai.Management.Models.StronglyTyped;
 
@@ -53,4 +54,16 @@ namespace Kontent.Ai.Management.Models.StronglyTyped;
     /// </summary>
     [JsonProperty("due_date")]
     public DueDateModel DueDate { get; set; }
+
+    /// <summary>
+    /// Gets or sets a note.
+    /// </summary>
+    [JsonProperty("note")]
+    public string Note { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contributors.
+    /// </summary>
+    [JsonProperty("contributors")]
+    public IEnumerable<UserIdentifier> Contributors { get; set; }
 }