Merge pull request #436 from notion-dotnet/435-add-support-for-reading-and-writing-names-and-caption-to-file-blocks

Add support for reading and writing Name & Caption properties to file blocks

Author: KoditkarVedant

Src/Notion.Client/Models/File/FIleInput/ExternalFileInput.cs

@@ -1,4 +1,5 @@
-using Newtonsoft.Json;
+using System.Collections.Generic;
+using Newtonsoft.Json;
 
 namespace Notion.Client
 {
@@ -7,6 +8,12 @@ public class ExternalFileInput : IFileObjectInput
         [JsonProperty("external")]
         public Data External { get; set; }
 
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("caption")]
+        public IEnumerable<RichTextBaseInput> Caption { get; set; }
+
         public class Data
         {
             [JsonProperty("url")]

Src/Notion.Client/Models/File/FIleInput/IFileObjectInput.cs

@@ -1,6 +1,14 @@
-namespace Notion.Client
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace Notion.Client
 {
     public interface IFileObjectInput
     {
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("caption")]
+        public IEnumerable<RichTextBaseInput> Caption { get; set; }
     }
 }

Src/Notion.Client/Models/File/FIleInput/UploadedFileInput.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace Notion.Client
@@ -8,6 +9,12 @@ public class UploadedFileInput : IFileObjectInput
         [JsonProperty("file")]
         public Data File { get; set; }
 
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("caption")]
+        public IEnumerable<RichTextBaseInput> Caption { get; set; }
+
         public class Data
         {
             [JsonProperty("url")]

Src/Notion.Client/Models/File/FileObject.cs

@@ -12,6 +12,9 @@ public abstract class FileObject : IPageIcon
         [JsonProperty("caption")]
         public IEnumerable<RichTextBase> Caption { get; set; }
 
+        /// <summary>
+        /// The name of the file block, as shown in the Notion UI. Note that the UI may auto-append .pdf or other extensions.
+        /// </summary>
         [JsonProperty("name")]
         public string Name { get; set; }
 

Test/Notion.IntegrationTests/BlocksClientTests.cs

@@ -399,6 +399,54 @@ private static IEnumerable<object[]> BlockData()
                         .Subject.Should().BeOfType<RichTextText>()
                         .Subject.Text.Content.Should().Be("Data");
                 })
+            },
+            new object[]
+            {
+                new FileBlockRequest {
+                    File = new ExternalFile
+                    {
+                        Name = "Test file",
+                        External = new ExternalFile.Info
+                        {
+                            Url = "https://www.iaspaper.net/wp-content/uploads/2017/09/TNEA-Online-Application.jpg"
+                        },
+                        Caption = new List<RichTextBase>
+                        {
+                            new RichTextTextInput { Text = new Text { Content = "Test file" } }
+                        }
+                    }
+                },
+                new FileUpdateBlock
+                {
+                    File = new ExternalFileInput
+                    {
+                        Name = "Test file name",
+                        External = new ExternalFileInput.Data
+                        {
+                            Url = "https://www.iaspaper.net/wp-content/uploads/2017/09/TNEA-Online-Application.jpg"
+                        },
+                        Caption = new List<RichTextBaseInput>
+                        {
+                            new RichTextTextInput { Text = new Text { Content = "Test file caption" } }
+                        }
+                    }
+                },
+                new Action<IBlock, INotionClient>((block, client) =>
+                {
+                    var fileBlock = block.Should().NotBeNull().And.BeOfType<FileBlock>().Subject;
+                    fileBlock.HasChildren.Should().BeFalse();
+
+                    var file = fileBlock.File.Should().NotBeNull().And.BeOfType<ExternalFile>().Subject;
+
+                    // NOTE: The name of the file block, as shown in the Notion UI. Note that the UI may auto-append .pdf or other extensions.
+                    file.Name.Should().Be("Test file name.jpg");
+
+                    file.External.Should().NotBeNull();
+                    file.External.Url.Should().Be("https://www.iaspaper.net/wp-content/uploads/2017/09/TNEA-Online-Application.jpg");
+                    file.Caption.Should().NotBeNull().And.ContainSingle()
+                        .Subject.Should().BeOfType<RichTextText>().Subject
+                        .Text.Content.Should().Be("Test file caption");
+                })
             }
         };
     }