Add block property in paginated block children response

Author: KoditkarVedant

Src/Notion.Client/Api/Blocks/BlocksClient.cs

@@ -6,7 +6,7 @@
 
 namespace Notion.Client
 {
-    public class BlocksClient : IBlocksClient
+    public sealed partial class BlocksClient : IBlocksClient
     {
         private readonly IRestClient _client;
 
@@ -15,28 +15,6 @@ public BlocksClient(IRestClient client)
             _client = client;
         }
 
-        public async Task<PaginatedList<IBlock>> RetrieveChildrenAsync(
-            string blockId,
-            BlocksRetrieveChildrenParameters parameters = null, CancellationToken cancellationToken = default)
-        {
-            if (string.IsNullOrWhiteSpace(blockId))
-            {
-                throw new ArgumentNullException(nameof(blockId));
-            }
-
-            var url = BlocksApiUrls.RetrieveChildren(blockId);
-
-            var queryParameters = (IBlocksRetrieveChildrenQueryParameters)parameters;
-
-            var queryParams = new Dictionary<string, string>
-            {
-                { "start_cursor", queryParameters?.StartCursor },
-                { "page_size", queryParameters?.PageSize?.ToString() }
-            };
-
-            return await _client.GetAsync<PaginatedList<IBlock>>(url, queryParams, cancellationToken: cancellationToken);
-        }
-
         public async Task<PaginatedList<IBlock>> AppendChildrenAsync(
             string blockId,
             BlocksAppendChildrenParameters parameters = null, CancellationToken cancellationToken = default)

Src/Notion.Client/Api/Blocks/IBlocksClient.cs

@@ -18,11 +18,22 @@ public interface IBlocksClient
         /// <param name="blockId"></param>
         /// <param name="updateBlock"></param>
         /// <returns>Block</returns>
-        Task<IBlock> UpdateAsync(string blockId, IUpdateBlock updateBlock, CancellationToken cancellationToken = default);
+        Task<IBlock> UpdateAsync(string blockId, IUpdateBlock updateBlock,
+            CancellationToken cancellationToken = default);
 
-        Task<PaginatedList<IBlock>> RetrieveChildrenAsync(
-            string blockId,
-            BlocksRetrieveChildrenParameters parameters = null, CancellationToken cancellationToken = default);
+        /// <summary>
+        ///     Returns a paginated array of child block objects contained in the block using the ID specified.
+        ///     <br/>
+        ///     In order to receive a complete representation of a block, you may need to recursively retrieve the
+        ///     block children of child blocks.
+        /// </summary>
+        /// <param name="request"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<RetrieveChildrenResponse> RetrieveChildrenAsync(
+            BlockRetrieveChildrenRequest request,
+            CancellationToken cancellationToken = default
+        );
 
         /// <summary>
         ///     Creates and appends new children blocks to the parent block_id specified.

Src/Notion.Client/Api/Blocks/RequestParams/BlocksRetrieveChildrenParameters.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Notion.Client
+{
+    public sealed partial class BlocksClient
+    {
+        public async Task<RetrieveChildrenResponse> RetrieveChildrenAsync(
+            BlockRetrieveChildrenRequest request,
+            CancellationToken cancellationToken = default)
+        {
+            if (string.IsNullOrWhiteSpace(request.BlockId))
+            {
+                throw new ArgumentNullException(nameof(request.BlockId));
+            }
+
+            var url = ApiEndpoints.BlocksApiUrls.RetrieveChildren(request.BlockId);
+
+            var queryParameters = (IBlockRetrieveChildrenQueryParameters)request;
+
+            var queryParams = new Dictionary<string, string>
+            {
+                { "start_cursor", queryParameters?.StartCursor },
+                { "page_size", queryParameters?.PageSize?.ToString() }
+            };
+
+            return await _client.GetAsync<RetrieveChildrenResponse>(
+                url,
+                queryParams,
+                cancellationToken: cancellationToken
+            );
+        }
+    }
+}

Src/Notion.Client/Api/Blocks/RequestParams/IBlocksRetrieveChildrenQueryParameters.cs

@@ -0,0 +1,13 @@
+namespace Notion.Client
+{
+    public class BlockRetrieveChildrenRequest :
+        IBlockRetrieveChildrenQueryParameters,
+        IBlockRetrieveChildrenPathParameters
+    {
+        public string StartCursor { get; set; }
+
+        public int? PageSize { get; set; }
+
+        public string BlockId { get; set; }
+    }
+}

Src/Notion.Client/Api/Blocks/RetrieveChildren/BlocksClient.cs

@@ -0,0 +1,7 @@
+namespace Notion.Client
+{
+    public interface IBlockRetrieveChildrenPathParameters
+    {
+        public string BlockId { get; set; }
+    }
+}

Src/Notion.Client/Api/Blocks/RetrieveChildren/Request/BlockRetrieveChildrenRequest.cs

@@ -0,0 +1,6 @@
+namespace Notion.Client
+{
+    public interface IBlockRetrieveChildrenQueryParameters : IPaginationParameters
+    {
+    }
+}

Src/Notion.Client/Api/Blocks/RetrieveChildren/Request/IBlockRetrieveChildrenPathParameters.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace Notion.Client
+{
+    public class RetrieveChildrenResponse : PaginatedList<IBlock>
+    {
+        [JsonProperty("block")]
+        public Dictionary<string, object> Block { get; set; }
+    }
+}

Src/Notion.Client/Api/Blocks/RetrieveChildren/Request/IBlockRetrieveChildrenQueryParameters.cs

@@ -68,7 +68,10 @@ public async Task UpdateBlockAsync_UpdatesGivenBlock()
         var blockId = blocks.Results.First().Id;
         await Client.Blocks.UpdateAsync(blockId, new BreadcrumbUpdateBlock());
 
-        blocks = await Client.Blocks.RetrieveChildrenAsync(page.Id);
+        blocks = await Client.Blocks.RetrieveChildrenAsync(new BlockRetrieveChildrenRequest
+        {
+            BlockId = page.Id
+        });
         blocks.Results.Should().HaveCount(1);
 
         // cleanup
@@ -121,7 +124,10 @@ public async Task UpdateAsync_UpdatesGivenBlock(
         var blockId = blocks.Results.First().Id;
         await Client.Blocks.UpdateAsync(blockId, updateBlock);
 
-        blocks = await Client.Blocks.RetrieveChildrenAsync(page.Id);
+        blocks = await Client.Blocks.RetrieveChildrenAsync(new BlockRetrieveChildrenRequest
+        {
+            BlockId = page.Id
+        });
         blocks.Results.Should().HaveCount(1);
 
         var updatedBlock = blocks.Results.First();
@@ -443,7 +449,9 @@ private static IEnumerable<object[]> BlockData()
                     var tableBlock = block.Should().NotBeNull().And.BeOfType<TableBlock>().Subject;
                     tableBlock.HasChildren.Should().BeTrue();
 
-                    var children = client.Blocks.RetrieveChildrenAsync(tableBlock.Id).GetAwaiter().GetResult();
+                    var children = client.Blocks.RetrieveChildrenAsync(new BlockRetrieveChildrenRequest{
+                        BlockId = tableBlock.Id
+                    }).GetAwaiter().GetResult();
 
                     children.Results.Should().ContainSingle()
                         .Subject.Should().BeOfType<TableRowBlock>()