add get doc group info

Author: AlexNDRmac

Diff for: SignNow.Net.Examples/ExamplesRunner.cs

@@ -944,7 +944,7 @@ public async Task CreateDocumentGroup()
 
             var documents = new List<SignNowDocument>();
 
-            for (int i = 1; i < 2; i++)
+            for (int i = 0; i < 2; i++)
             {
                 var upload = await testContext.Documents
                     .UploadDocumentAsync(fileStream, $"ForDocumentGroupFile-{i}.pdf");

Diff for: SignNow.Net.Test/UnitTests/Responses/DocumentGroupInfoResponseTest.cs

@@ -0,0 +1,84 @@
+using System.Linq;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using SignNow.Net.Model.Responses;
+
+namespace UnitTests.Responses
+{
+    [TestClass]
+    public class DocumentGroupInfoResponseTest
+    {
+        [TestMethod]
+        public void ShouldProperDeserialize()
+        {
+            var jsonResponse = @"{
+            ""data"": {
+                ""id"": ""03c74b3083f34ebf8ef40a3039dfb32c85a08437"",
+                ""name"": ""CreateDocumentGroupTest"",
+                ""created"": 1729535107,
+                ""updated"": 1729535107,
+                ""invite_id"": null,
+                ""pending_step_id"": null,
+                ""state"": ""created"",
+                ""sign_as_merged"": null,
+                ""last_invite_id"": null,
+                ""owner_email"": ""[email protected]"",
+                ""folder_id"": ""e1d8d63ba51c4009ab9941f279c908a0fd5a5e48"",
+                ""documents"": [
+                    {
+                        ""roles"": [],
+                        ""document_name"": ""ForDocumentGroupFile-1"",
+                        ""page_count"": 1,
+                        ""id"": ""66974a4b421546a69167ba342d1ae94af56ce351"",
+                        ""updated"": 1729535105,
+                        ""folder_id"": ""e1d8d63ba51c4009ab9941f279c908a0fd5a5e48"",
+                        ""owner"": {
+                            ""id"": ""50204b3344984768bb16d61f8550f8b5edfd719a"",
+                            ""email"": ""[email protected]""
+                        },
+                        ""thumbnail"": {
+                            ""small"": ""https://api-eval.signnow.com/document/66974a4b421546a69167ba342d1ae94af56ce351/thumbnail?size=small"",
+                            ""medium"": ""https://api-eval.signnow.com/document/66974a4b421546a69167ba342d1ae94af56ce351/thumbnail?size=medium"",
+                            ""large"": ""https://api-eval.signnow.com/document/66974a4b421546a69167ba342d1ae94af56ce351/thumbnail?size=large""
+                        },
+                        ""origin_document_id"": null,
+                        ""has_unassigned_field"": false,
+                        ""has_credit_card_number"": false,
+                        ""field_invites"": [],
+                        ""shared_with_team"": null,
+                        ""settings"": [],
+                        ""allow_to_remove"": true
+                    }
+                ],
+                ""owner"": {
+                    ""id"": ""50204b3344984768bb16d61f8550f8b5edfd719a"",
+                    ""email"": ""[email protected]"",
+                    ""organization"": {
+                        ""id"": ""44f2dc3eef1c4924a8aea48d238968402abc745f""
+                    }
+                },
+                ""cc_emails"": [],
+                ""freeform_invite"": {
+                    ""id"": null,
+                    ""last_id"": null
+                },
+                ""originator_organization_settings"": [
+                    {
+                        ""setting"": ""mobileweb_option"",
+                        ""value"": ""app_or_mobileweb_choice""
+                    }
+                ],
+                ""mail_provider"": null
+                }
+            }";
+
+            var response = TestUtils.DeserializeFromJson<DocumentGroupInfoResponse>(jsonResponse);
+
+            Assert.AreEqual("03c74b3083f34ebf8ef40a3039dfb32c85a08437", response.Data.Id);
+            Assert.AreEqual("CreateDocumentGroupTest", response.Data.Name);
+            Assert.AreEqual(1, response.Data.Documents.Count);
+            Assert.AreEqual("ForDocumentGroupFile-1", response.Data.Documents.FirstOrDefault()?.Name);
+            Assert.AreEqual("50204b3344984768bb16d61f8550f8b5edfd719a", response.Data.Owner.Id);
+            Assert.AreEqual("44f2dc3eef1c4924a8aea48d238968402abc745f", response.Data.Owner.Organization.Id);
+        }
+    }
+}

Diff for: SignNow.Net/Interfaces/IDocumentGroup.cs

@@ -20,5 +20,13 @@ public interface IDocumentGroup
         /// <param name="cancellationToken">Propagates notification that operations should be canceled.</param>
         /// <returns></returns>
         Task<DocumentGroupCreateResponse> CreateDocumentGroupAsync(string groupName, IEnumerable<SignNowDocument> documents, CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Getting basic information about document groups.
+        /// </summary>
+        /// <param name="documentGroupId">ID of the Document Group</param>
+        /// <param name="cancellationToken">Propagates notification that operations should be canceled.</param>
+        /// <returns></returns>
+        Task<DocumentGroupInfoResponse> GetDocumentGroupInfoAsync(string documentGroupId, CancellationToken cancellationToken = default);
     }
 }

Diff for: SignNow.Net/Model/Organization.cs

@@ -0,0 +1,9 @@
+using SignNow.Net.Model.Responses.GenericResponses;
+
+namespace SignNow.Net.Model
+{
+    public class Organization : IdResponse
+    {
+
+    }
+}

Diff for: SignNow.Net/Model/Owner.cs

@@ -0,0 +1,22 @@
+using Newtonsoft.Json;
+
+namespace SignNow.Net.Model
+{
+    public class Owner
+    {
+        [JsonProperty("id")]
+        public string Id { get; set; }
+
+        /// <summary>
+        /// Email of document owner.
+        /// </summary>
+        [JsonProperty("email")]
+        public string Email { get; set; }
+
+        /// <summary>
+        /// Organization info.
+        /// </summary>
+        [JsonProperty("organization", NullValueHandling = NullValueHandling.Ignore)]
+        public Organization Organization { get; set; }
+    }
+}

Diff for: SignNow.Net/Model/Responses/CreateDocumentFromTemplateResponse.cs

@@ -1,16 +1,11 @@
-using Newtonsoft.Json;
+using SignNow.Net.Model.Responses.GenericResponses;
 
 namespace SignNow.Net.Model.Responses
 {
     /// <summary>
     /// Represents response from signNow API for Create Document from Template request.
     /// </summary>
-    public class CreateDocumentFromTemplateResponse
+    public class CreateDocumentFromTemplateResponse :IdResponse
     {
-        /// <summary>
-        /// Identity of new Document.
-        /// </summary>
-        [JsonProperty("id")]
-        public string Id { get; set; }
     }
 }

Diff for: SignNow.Net/Model/Responses/DocumentGroupInfoResponse.cs

@@ -0,0 +1,170 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using SignNow.Net.Internal.Helpers.Converters;
+using SignNow.Net.Model.Responses.GenericResponses;
+
+namespace SignNow.Net.Model.Responses
+{
+    public class DocumentGroupInfoResponse
+    {
+        [JsonProperty("data")]
+        public DocumentGroupData Data { get; set; }
+    }
+
+    public class DocumentGroupData : IdResponse
+    {
+        /// <summary>
+        /// Document Group name.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Timestamp of document group creation.
+        /// </summary>
+        [JsonProperty("created")]
+        [JsonConverter(typeof(UnixTimeStampJsonConverter))]
+        public DateTime Created { get; set; }
+
+        /// <summary>
+        /// Timestamp of document group update.
+        /// </summary>
+        [JsonProperty("updated")]
+        [JsonConverter(typeof(UnixTimeStampJsonConverter))]
+        public DateTime Updated { get; set; }
+
+        /// <summary>
+        /// Identity of invite for Document Group.
+        /// </summary>
+        [JsonProperty("invite_id")]
+        public string InviteId { get; set; }
+
+        /// <summary>
+        /// Identity of pending step for Document Group.
+        /// </summary>
+        [JsonProperty("pending_step_id")]
+        public string PendingStepId { get; set; }
+
+        /// <summary>
+        /// Identity of last invite for Document Group.
+        /// </summary>
+        [JsonProperty("last_invite_id")]
+        public string LastInviteId { get; set; }
+
+        /// <summary>
+        /// Document Group state.
+        /// </summary>
+        [JsonProperty("state")]
+        public string State { get; set; }
+
+        /// <summary>
+        /// Owner email address.
+        /// </summary>
+        [JsonProperty("owner_email")]
+        public string OwnerEmail { get; set; }
+
+        /// <summary>
+        /// An ID of folder with document group.
+        /// </summary>
+        [JsonProperty("folder_id")]
+        public string FolderId { get; set; }
+
+        [JsonProperty("documents")]
+        public IReadOnlyList<GroupDocumentsInfo> Documents { get; set; }
+
+        /// <summary>
+        /// Document owner info.
+        /// </summary>
+        [JsonProperty("owner")]
+        public Owner Owner { get; set; }
+
+        /// <summary>
+        /// CC emails list.
+        /// </summary>
+        [JsonProperty("cc_emails")]
+        public IReadOnlyList<string> CcEmails { get; set; }
+
+        /// <summary>
+        /// Freeform invite info.
+        /// </summary>
+        [JsonProperty("freeform_invite")]
+        public FreeFormInviteInfo FreeFormInvite { get; set; }
+    }
+
+    public class GroupDocumentsInfo : IdResponse
+    {
+        /// <summary>
+        /// List with document roles.
+        /// </summary>
+        [JsonProperty("roles")]
+        public IReadOnlyList<string> Roles { get; set; }
+
+        /// <summary>
+        /// Document name.
+        /// </summary>
+        [JsonProperty("document_name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Pages count.
+        /// </summary>
+        [JsonProperty("page_count")]
+        public int Pages { get; set; }
+
+        /// <summary>
+        /// Timestamp of document update.
+        /// </summary>
+        [JsonProperty("updated")]
+        [JsonConverter(typeof(UnixTimeStampJsonConverter))]
+        public DateTime Updated { get; set; }
+
+        /// <summary>
+        /// An ID of folder with document.
+        /// </summary>
+        [JsonProperty("folder_id")]
+        public string FolderId { get; set; }
+
+        /// <summary>
+        /// Document owner info.
+        /// </summary>
+        [JsonProperty("owner")]
+        public Owner Owner { get; set; }
+
+        /// <summary>
+        /// Document thumbnails
+        /// </summary>
+        [JsonProperty("thumbnail")]
+        public Thumbnail Thumbnail { get; set; }
+
+        /// <summary>
+        /// An ID of document origin.
+        /// </summary>
+        [JsonProperty("origin_document_id")]
+        public string OriginDocumentId { get; set; }
+
+        /// <summary>
+        /// Is the document has unassigned field.
+        /// </summary>
+        [JsonProperty("has_unassigned_field")]
+        public bool HasUnassignedField { get; set; }
+
+        /// <summary>
+        /// Is the document has a credit card number.
+        /// </summary>
+        [JsonProperty("has_credit_card_number")]
+        public bool HasCreditCardNumber { get; set; }
+
+        /// <summary>
+        /// Is the document can be removed from document group.
+        /// </summary>
+        [JsonProperty("allow_to_remove")]
+        public bool IsAllowedToRemove { get; set; }
+    }
+
+    public class FreeFormInviteInfo : IdResponse
+    {
+        [JsonProperty("last_id")]
+        public string LastId { get; set; }
+    }
+}

Diff for: SignNow.Net/Service/DocumentGroupService.cs

@@ -3,6 +3,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using SignNow.Net.Interfaces;
+using SignNow.Net.Internal.Extensions;
 using SignNow.Net.Internal.Requests;
 using SignNow.Net.Model;
 using SignNow.Net.Model.Responses;
@@ -36,5 +37,20 @@ public async Task<DocumentGroupCreateResponse> CreateDocumentGroupAsync(string g
                 .RequestAsync<DocumentGroupCreateResponse>(requestOptions, cancellationToken)
                 .ConfigureAwait(false);
         }
+
+        /// <inheritdoc />
+        public async Task<DocumentGroupInfoResponse> GetDocumentGroupInfoAsync(string documentGroupId, CancellationToken cancellationToken = default)
+        {
+            Token.TokenType = TokenType.Bearer;
+            var requestOption = new GetHttpRequestOptions
+            {
+                RequestUrl = new Uri(ApiBaseUrl, $"/v2/document-groups/{documentGroupId.ValidateId()}"),
+                Token = Token
+            };
+
+            return await SignNowClient
+                .RequestAsync<DocumentGroupInfoResponse>(requestOption, cancellationToken)
+                .ConfigureAwait(false);
+        }
     }
 }