Fix file representation

ErikMcClure · ErikMcClure · commit e1d80ac293f2 · 2024-08-26T23:47:17.000-07:00
diff --git a/src/models/block.rs b/src/models/block.rs
@@ -16,6 +16,8 @@ pub struct BlockCommon {
     #[serde(with = "time::serde::iso8601")]
     pub last_edited_time: OffsetDateTime,
     pub has_children: bool,
+    pub archived: bool,
+    pub in_trash: bool,
     pub created_by: UserCommon,
     pub last_edited_by: UserCommon,
 }
@@ -58,17 +60,33 @@ pub struct ExternalFileObject {
 #[serde(tag = "type")]
 #[serde(rename_all = "snake_case")]
 pub enum FileOrEmojiObject {
-    Emoji { emoji: String },
-    File,
-    External,
+    Emoji {
+        emoji: String,
+    },
+    File {
+        caption: Vec<RichText>,
+        file: InternalFileObject,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        name: Option<String>,
+    },
+    External {
+        external: ExternalFileObject,
+    },
 }
 
 #[derive(Serialize, Deserialize, Debug, Eq, PartialEq, Clone)]
 #[serde(tag = "type")]
 #[serde(rename_all = "snake_case")]
 pub enum FileObject {
-    File,
-    External,
+    File {
+        caption: Vec<RichText>,
+        file: InternalFileObject,
+        #[serde(skip_serializing_if = "Option::is_none")]
+        name: Option<String>,
+    },
+    External {
+        external: ExternalFileObject,
+    },
 }
 
 #[derive(Serialize, Deserialize, Debug, Eq, PartialEq, Clone)]
@@ -354,7 +372,6 @@ pub enum Block {
         #[serde(flatten)]
         common: BlockCommon,
         file: FileObject,
-        caption: Text,
     },
     Pdf {
         #[serde(flatten)]
@@ -509,7 +526,7 @@ impl From<Block> for CreateBlock {
             Block::Embed { embed, .. } => CreateBlock::Embed { embed },
             Block::Image { image, .. } => CreateBlock::Image { image },
             Block::Video { video, .. } => CreateBlock::Video { video },
-            Block::File { file, caption, .. } => CreateBlock::File { file, caption },
+            Block::File { file, .. } => CreateBlock::File { file },
             Block::Pdf { pdf, .. } => CreateBlock::Pdf { pdf },
             Block::Bookmark { bookmark, .. } => CreateBlock::Bookmark { bookmark },
             Block::Equation { equation, .. } => CreateBlock::Equation { equation },
@@ -590,7 +607,6 @@ pub enum CreateBlock {
     },
     File {
         file: FileObject,
-        caption: Text,
     },
     Pdf {
         pdf: FileObject,
diff --git a/src/models/block/tests.rs b/src/models/block/tests.rs
@@ -32,6 +32,8 @@ mod tests {
                     )
                     .unwrap(),
                     has_children: false,
+                    archived: false,
+                    in_trash: false,
                     created_by: UserCommon {
                         id: UserId::from_str("6419f912-5293-4ea8-b2c8-9c3ce44f90e3").unwrap(),
                         name: None,
@@ -229,14 +231,38 @@ mod tests {
     fn file_object() {
         let file_object: FileOrEmojiObject =
             serde_json::from_str(include_str!("tests/file_object.json")).unwrap();
-        assert_eq!(file_object, FileOrEmojiObject::File)
+        assert_eq!(file_object, 
+            FileOrEmojiObject::File {
+                caption: Vec::new(), 
+                name: Some("blah.rs".into()), 
+                file: InternalFileObject {
+                    expiry_time: OffsetDateTime::parse(
+                        "2022-05-13T21:10:35.817Z",
+                        &Iso8601::DEFAULT
+                    ).unwrap(), 
+                    url: "https://s3.us-west-2.amazonaws.com/secure.notion-static.com/2703e742-ace5-428c-a74d-1c587ceddc32/DiRT_Rally.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45EIPT3X45%2F20220513%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20220513T201035Z&X-Amz-Expires=3600&X-Amz-Signature=714b49bde0b499fb8f3aae1a88a8cbd374f2b09c1d128e91cac49e85ce0e00fb&X-Amz-SignedHeaders=host&x-id=GetObject".into()
+                }
+            }
+        )
+    }
+
+    #[test]
+    fn file_page() {
+        let _: Object = serde_json::from_str(include_str!("tests/file_page.json")).unwrap();
     }
 
     #[test]
     fn external_file_object() {
         let external_file_object: FileOrEmojiObject =
             serde_json::from_str(include_str!("tests/external_file_object.json")).unwrap();
-        assert_eq!(external_file_object, FileOrEmojiObject::External)
+        assert_eq!(
+            external_file_object,
+            FileOrEmojiObject::External {
+                external: ExternalFileObject {
+                    url: "https://nerdist.com/wp-content/uploads/2020/07/maxresdefault.jpg".into()
+                }
+            }
+        )
     }
 
     #[test]
@@ -259,6 +285,8 @@ mod tests {
                         )
                         .unwrap(),
                         has_children: true,
+                        archived: false,
+                        in_trash: false,
                         created_by: UserCommon {
                             id: UserId::from_str("e2507360-468c-4e0f-a928-7bbcbbb45353").unwrap(),
                             name: None,
diff --git a/src/models/block/tests/callout.json b/src/models/block/tests/callout.json
@@ -13,6 +13,7 @@
   },
   "has_children": true,
   "archived": false,
+  "in_trash": false,
   "type": "callout",
   "callout": {
     "rich_text": [
diff --git a/src/models/block/tests/file_object.json b/src/models/block/tests/file_object.json
@@ -1,7 +1,9 @@
 {
+  "caption": [],
   "type": "file",
   "file": {
     "url": "https://s3.us-west-2.amazonaws.com/secure.notion-static.com/2703e742-ace5-428c-a74d-1c587ceddc32/DiRT_Rally.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45EIPT3X45%2F20220513%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20220513T201035Z&X-Amz-Expires=3600&X-Amz-Signature=714b49bde0b499fb8f3aae1a88a8cbd374f2b09c1d128e91cac49e85ce0e00fb&X-Amz-SignedHeaders=host&x-id=GetObject",
     "expiry_time": "2022-05-13T21:10:35.817Z"
-  }
+  },
+  "name": "blah.rs"
 }
diff --git a/src/models/block/tests/file_page.json b/src/models/block/tests/file_page.json
@@ -0,0 +1,65 @@
+{
+  "object": "list",
+  "results": [
+    {
+      "object": "block",
+      "id": "47a920e4-346c-4df8-ae78-905ce10adcb8",
+      "parent": {
+        "type": "page_id",
+        "page_id": "13d6da82-2f93-43fa-8ec1-4c89b8184d5a"
+      },
+      "created_time": "2022-12-15T00:18:00.000Z",
+      "last_edited_time": "2022-12-15T00:18:00.000Z",
+      "created_by": {
+        "object": "user",
+        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
+      },
+      "last_edited_by": {
+        "object": "user",
+        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
+      },
+      "has_children": false,
+      "archived": false,
+      "in_trash": false,
+      "type": "paragraph",
+      "paragraph": {
+        "rich_text": [],
+        "color": "default"
+      }
+    },
+    {
+      "object": "block",
+      "id": "3c29dedf-00a5-4915-b137-120c61f5e5d8",
+      "parent": {
+        "type": "page_id",
+        "page_id": "13d6da82-2f93-43fa-8ec1-4c89b8184d5a"
+      },
+      "created_time": "2022-12-15T00:18:00.000Z",
+      "last_edited_time": "2022-12-15T00:18:00.000Z",
+      "created_by": {
+        "object": "user",
+        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
+      },
+      "last_edited_by": {
+        "object": "user",
+        "id": "c2f20311-9e54-4d11-8c79-7398424ae41e"
+      },
+      "has_children": false,
+      "archived": false,
+      "in_trash": false,
+      "type": "file",
+      "file": {
+        "caption": [],
+        "type": "file",
+        "file": {
+          "url": "https://s3.us-west-2.amazonaws.com/secure.notion-static.com/fa6c03f0-e608-45d0-9327-4cd7a5e56e71/TestFile.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45EIPT3X45%2F20221215%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20221215T002012Z&X-Amz-Expires=3600&X-Amz-Signature=bf13ca59f618077852298cb92aedc4dd1becdc961c31d73cbc030ef93f2853c4&X-Amz-SignedHeaders=host&x-id=GetObject",
+          "expiry_time": "2022-12-15T01:20:12.928Z"
+        }
+      }
+    }
+  ],
+  "next_cursor": null,
+  "has_more": false,
+  "type": "block",
+  "block": {}
+}
diff --git a/src/models/block/tests/heading_1.json b/src/models/block/tests/heading_1.json
@@ -13,6 +13,7 @@
   },
   "has_children": false,
   "archived": false,
+  "in_trash": false,
   "type": "heading_1",
   "heading_1": {
     "rich_text": [
diff --git a/src/models/mod.rs b/src/models/mod.rs
@@ -18,7 +18,6 @@ use std::hash::{Hash, Hasher};
 use crate::ids::{AsIdentifier, BlockId, DatabaseId, PageId};
 use crate::models::block::{Block, CreateBlock, FileObject, FileOrEmojiObject};
 use block::ExternalFileObject;
-use serde_json::Value;
 
 use crate::models::error::ErrorResponse;
 use crate::models::paging::PagingCursor;
@@ -284,11 +283,10 @@ pub struct Page {
     /// The archived status of the page.
     pub archived: bool,
     pub properties: Properties,
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub icon: Option<IconObject>,
     pub parent: Parent,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub icon: Option<FileOrEmojiObject>,
-    #[serde(skip_serializing_if = "Option::is_none")]
     pub url: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub blocks: Option<Vec<Block>>,
diff --git a/src/models/properties.rs b/src/models/properties.rs
@@ -255,7 +255,7 @@ pub enum PropertyConfiguration {
     },
     /// Undocumented property of wiki pages
     Verification {
-         id: PropertyId
+        id: PropertyId,
     },
     /// See <https://developers.notion.com/reference/database#last-edited-by-configuration>
     LastEditBy {
@@ -385,25 +385,16 @@ pub enum PropertyValue {
         rollup: Option<RollupValue>,
     },
     /// <https://developers.notion.com/reference/property-object#people-configuration>
-    People {
-        id: PropertyId,
-        people: Vec<User>,
-    },
+    People { id: PropertyId, people: Vec<User> },
     /// <https://developers.notion.com/reference/property-object#files-configuration>
     Files {
         id: PropertyId,
         files: Option<Vec<FileReference>>,
     },
     /// <https://developers.notion.com/reference/property-object#checkbox-configuration>
-    Checkbox {
-        id: PropertyId,
-        checkbox: bool,
-    },
+    Checkbox { id: PropertyId, checkbox: bool },
     /// <https://developers.notion.com/reference/property-object#url-configuration>
-    Url {
-        id: PropertyId,
-        url: Option<String>,
-    },
+    Url { id: PropertyId, url: Option<String> },
     /// <https://developers.notion.com/reference/property-object#email-configuration>
     Email {
         id: PropertyId,
@@ -421,10 +412,7 @@ pub enum PropertyValue {
         created_time: OffsetDateTime,
     },
     /// <https://developers.notion.com/reference/property-object#created-by-configuration>
-    CreatedBy {
-        id: PropertyId,
-        created_by: User,
-    },
+    CreatedBy { id: PropertyId, created_by: User },
     /// <https://developers.notion.com/reference/property-object#last-edited-time-configuration>
     LastEditedTime {
         id: PropertyId,
@@ -457,11 +445,7 @@ pub struct VerificationValue {
 pub struct UniqueIdValue {
     pub number: Number,
     pub prefix: Option<String>,
-        unique_id: UniqueidValue,
-    },
-    Button {
-        id: PropertyId,
-    },
+    pub unique_id: UniqueidValue,
 }
 
 #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
diff --git a/src/models/tests/page.json b/src/models/tests/page.json
@@ -4,6 +4,7 @@
   "created_time": "2020-03-17T19:10:04.968Z",
   "last_edited_time": "2020-03-17T21:49:37.913Z",
   "archived": false,
+  "in_trash": false,
   "parent": {
     "type": "workspace"
   },
@@ -55,4 +56,4 @@
       ]
     }
   }
-}
+}
diff --git a/src/models/tests/query_result.json b/src/models/tests/query_result.json
@@ -11,6 +11,7 @@
         "database_id": "5d794de0-2224-49d3-86f9-3540db13d884"
       },
       "archived": false,
+      "in_trash": false,
       "properties": {
         "Name": {
           "id": "title",
@@ -40,4 +41,4 @@
   ],
   "next_cursor": null,
   "has_more": false
-}
+}
diff --git a/src/models/tests/search_results.json b/src/models/tests/search_results.json
@@ -176,6 +176,7 @@
         "page_id": "7c"
       },
       "archived": false,
+      "in_trash": false,
       "properties": {
         "title": {
           "id": "title",
@@ -206,4 +207,4 @@
   ],
   "next_cursor": null,
   "has_more": false
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`{`
	`2`	`+ "caption": [],`
`2`	`3`	`"type": "file",`
`3`	`4`	`"file": {`
`4`	`5`	`"url": "https://s3.us-west-2.amazonaws.com/secure.notion-static.com/2703e742-ace5-428c-a74d-1c587ceddc32/DiRT_Rally.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45EIPT3X45%2F20220513%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20220513T201035Z&X-Amz-Expires=3600&X-Amz-Signature=714b49bde0b499fb8f3aae1a88a8cbd374f2b09c1d128e91cac49e85ce0e00fb&X-Amz-SignedHeaders=host&x-id=GetObject",`
`5`	`6`	`"expiry_time": "2022-05-13T21:10:35.817Z"`
`6`		`- }`
	`7`	`+ },`
	`8`	`+ "name": "blah.rs"`
`7`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`"created_time": "2020-03-17T19:10:04.968Z",`
`5`	`5`	`"last_edited_time": "2020-03-17T21:49:37.913Z",`
`6`	`6`	`"archived": false,`
	`7`	`+ "in_trash": false,`
`7`	`8`	`"parent": {`
`8`	`9`	`"type": "workspace"`
`9`	`10`	`},`
`@@ -55,4 +56,4 @@`
`55`	`56`	`]`
`56`	`57`	`}`
`57`	`58`	`}`
`58`		`-}`
	`59`	`+}`