notionary 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

notionary/__init__.py

@@ -1,14 +1,19 @@
 from .data_source.service import NotionDataSource
 from .database.service import NotionDatabase
+from .file_upload import FileUploadQuery, FileUploadQueryBuilder, NotionFileUpload
 from .page.content.markdown.builder import MarkdownBuilder
 from .page.service import NotionPage
-from .workspace import NotionWorkspace, NotionWorkspaceQueryConfigBuilder
+from .workspace import NotionWorkspace, NotionWorkspaceQueryConfigBuilder, WorkspaceQueryConfig
 
 __all__ = [
+    "FileUploadQuery",
+    "FileUploadQueryBuilder",
     "MarkdownBuilder",
     "NotionDataSource",
     "NotionDatabase",
+    "NotionFileUpload",
     "NotionPage",
     "NotionWorkspace",
     "NotionWorkspaceQueryConfigBuilder",
+    "WorkspaceQueryConfig",
 ]

notionary/blocks/enums.py

@@ -62,12 +62,6 @@ class BlockType(StrEnum):
     VIDEO = "video"
 
 
-class FileType(StrEnum):
-    EXTERNAL = "external"
-    FILE = "file"
-    FILE_UPLOAD = "file_upload"
-
-
 class CodingLanguage(StrEnum):
     ABAP = "abap"
     ARDUINO = "arduino"

notionary/blocks/schemas.py

@@ -4,41 +4,38 @@ from typing import Annotated, Literal
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from notionary.blocks.enums import BlockColor, BlockType, CodingLanguage, FileType
+from notionary.blocks.enums import BlockColor, BlockType, CodingLanguage
 from notionary.blocks.rich_text.models import RichText
+from notionary.shared.models.file import ExternalFile, FileUploadFile, NotionHostedFile
 from notionary.shared.models.icon import Icon
 from notionary.shared.models.parent import Parent
 from notionary.user.schemas import PartialUserDto
 
 # ============================================================================
-# File-related models
+# File Data wrapper with caption
 # ============================================================================
 
 
-class ExternalFile(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    url: str
+class CaptionMixin(BaseModel):
+    caption: list[RichText] = Field(default_factory=list)
+    name: str | None = None
 
 
-class NotionHostedFile(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    url: str
-    expiry_time: str
+class ExternalFileWithCaption(CaptionMixin, ExternalFile):
+    pass
 
 
-class FileUploadFile(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    id: str
+class NotionHostedFileWithCaption(CaptionMixin, NotionHostedFile):
+    pass
 
 
-class FileData(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    caption: list[RichText] = Field(default_factory=list)
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionHostedFile | None = None
-    file_upload: FileUploadFile | None = None
-    name: str | None = None
+class FileUploadFileWithCaption(CaptionMixin, FileUploadFile):
+    pass
+
+
+type FileWithCaption = Annotated[
+    ExternalFileWithCaption | NotionHostedFileWithCaption | FileUploadFileWithCaption, Field(discriminator="type")
+]
 
 
 # ============================================================================
@@ -65,24 +62,14 @@ class BaseBlock(BaseModel):
 # ============================================================================
 
 
-class AudioData(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    caption: list[RichText] = Field(default_factory=list)
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionHostedFile | None = None
-    file_upload: FileUploadFile | None = None
-    name: str | None = None
-
-
 class AudioBlock(BaseBlock):
     type: Literal[BlockType.AUDIO] = BlockType.AUDIO
-    audio: AudioData
+    audio: FileWithCaption
 
 
 class CreateAudioBlock(BaseModel):
     type: Literal[BlockType.AUDIO] = BlockType.AUDIO
-    audio: AudioData
+    audio: FileWithCaption
 
 
 # ============================================================================
@@ -90,8 +77,7 @@ class CreateAudioBlock(BaseModel):
 # ============================================================================
 
 
-class BookmarkData(BaseModel):
-    caption: list[RichText] = Field(default_factory=list)
+class BookmarkData(CaptionMixin):
     url: str
 
 
@@ -224,8 +210,7 @@ class CreateChildDatabaseBlock(BaseModel):
 # ============================================================================
 
 
-class CodeData(BaseModel):
-    caption: list[RichText] = Field(default_factory=list)
+class CodeData(CaptionMixin):
     rich_text: list[RichText]
     language: CodingLanguage = CodingLanguage.PLAIN_TEXT
 
@@ -311,9 +296,8 @@ class CreateDividerBlock(BaseModel):
 # ============================================================================
 
 
-class EmbedData(BaseModel):
+class EmbedData(CaptionMixin):
     url: str
-    caption: list[RichText] = Field(default_factory=list)
 
 
 class EmbedBlock(BaseBlock):
@@ -352,12 +336,12 @@ class CreateEquationBlock(BaseModel):
 
 class FileBlock(BaseBlock):
     type: Literal[BlockType.FILE] = BlockType.FILE
-    file: FileData
+    file: FileWithCaption
 
 
 class CreateFileBlock(BaseModel):
     type: Literal[BlockType.FILE] = BlockType.FILE
-    file: FileData
+    file: FileWithCaption
 
 
 # ============================================================================
@@ -416,24 +400,14 @@ CreateHeadingBlock = CreateHeading1Block | CreateHeading2Block | CreateHeading3B
 # ============================================================================
 
 
-class ImageData(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    caption: list[RichText] = Field(default_factory=list)
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionHostedFile | None = None
-    file_upload: FileUploadFile | None = None
-    name: str | None = None
-
-
 class ImageBlock(BaseBlock):
     type: Literal[BlockType.IMAGE] = BlockType.IMAGE
-    image: ImageData
+    image: FileWithCaption
 
 
 class CreateImageBlock(BaseModel):
     type: Literal[BlockType.IMAGE] = BlockType.IMAGE
-    image: ImageData
+    image: FileWithCaption
 
 
 # ============================================================================
@@ -497,24 +471,14 @@ class CreateParagraphBlock(BaseModel):
 # ============================================================================
 
 
-class PdfData(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    caption: list[RichText] = Field(default_factory=list)
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionHostedFile | None = None
-    file_upload: FileUploadFile | None = None
-    name: str | None = None
-
-
 class PdfBlock(BaseBlock):
     type: Literal[BlockType.PDF] = BlockType.PDF
-    pdf: PdfData
+    pdf: FileWithCaption
 
 
 class CreatePdfBlock(BaseModel):
     type: Literal[BlockType.PDF] = BlockType.PDF
-    pdf: PdfData
+    pdf: FileWithCaption
 
 
 # ============================================================================
@@ -669,31 +633,21 @@ class CreateToggleBlock(BaseModel):
 # ============================================================================
 
 
-class VideoData(BaseModel):
-    model_config = ConfigDict(from_attributes=True)
-    caption: list[RichText] = Field(default_factory=list)
-    type: FileType
-    external: ExternalFile | None = None
-    file: NotionHostedFile | None = None
-    file_upload: FileUploadFile | None = None
-    name: str | None = None
-
-
 class VideoBlock(BaseBlock):
     type: Literal[BlockType.VIDEO] = BlockType.VIDEO
-    video: VideoData
+    video: FileWithCaption
 
 
 class CreateVideoBlock(BaseModel):
     type: Literal[BlockType.VIDEO] = BlockType.VIDEO
-    video: VideoData
+    video: FileWithCaption
 
 
 # ============================================================================
 # Block Union Type
 # ============================================================================
 
-Block = Annotated[
+type Block = Annotated[
     (
         AudioBlock
         | BookmarkBlock
@@ -743,7 +697,7 @@ class BlockChildrenResponse(BaseModel):
     request_id: str
 
 
-BlockCreatePayload = Annotated[
+type BlockCreatePayload = Annotated[
     (
         CreateAudioBlock
         | CreateBookmarkBlock

notionary/comments/schemas.py

@@ -8,10 +8,6 @@ from pydantic import BaseModel, Field
 
 from notionary.blocks.rich_text.models import RichText
 
-# ---------------------------
-# Comment Parent
-# ---------------------------
-
 
 class CommentParentType(StrEnum):
     PAGE_ID = "page_id"
@@ -28,7 +24,7 @@ class BlockCommentParent(BaseModel):
     block_id: str
 
 
-CommentParent = PageCommentParent | BlockCommentParent
+type CommentParent = PageCommentParent | BlockCommentParent
 
 
 # ---------------------------
@@ -96,7 +92,7 @@ class CustomCommentDisplayName(BaseModel):
     custom: CustomDisplayName
 
 
-CommentDisplayNameInput = IntegrationDisplayName | UserDisplayName | CustomCommentDisplayName
+type CommentDisplayNameInput = IntegrationDisplayName | UserDisplayName | CustomCommentDisplayName
 
 
 class CommentDisplayNameDto(BaseModel):
@@ -189,8 +185,6 @@ class UserRef(BaseModel):
 
 
 class CommentDto(BaseModel):
-    """Comment object as returned by the API"""
-
     object: Literal["comment"] = "comment"
     id: str
 
@@ -217,24 +211,3 @@ class CommentListResponse(BaseModel):
     results: list[CommentDto] = Field(default_factory=list)
     next_cursor: str | None = None
     has_more: bool = False
-
-
-# ---------------------------
-# Convenience Builders
-# ---------------------------
-
-
-class CommentDisplayNameBuilder:
-    """Helper class to build display names easily"""
-
-    @staticmethod
-    def integration() -> IntegrationDisplayName:
-        return IntegrationDisplayName()
-
-    @staticmethod
-    def user() -> UserDisplayName:
-        return UserDisplayName()
-
-    @staticmethod
-    def custom(name: str) -> CustomCommentDisplayName:
-        return CustomCommentDisplayName(custom=CustomDisplayName(name=name))

notionary/data_source/properties/schemas.py

@@ -1,7 +1,7 @@
 from enum import StrEnum
-from typing import Annotated, Literal, TypeVar
+from typing import Literal, TypeVar
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field
 
 from notionary.shared.properties.type import PropertyType
 from notionary.shared.typings import JsonDict
@@ -126,109 +126,11 @@ class DataSourceStatusGroup(BaseModel):
     option_ids: list[str]
 
 
-# ============================================================================
-# Config Models
-# ============================================================================
-
-
 class DataSourceStatusConfig(BaseModel):
     options: list[DataSourcePropertyOption] = Field(default_factory=list)
     groups: list[DataSourceStatusGroup] = Field(default_factory=list)
 
 
-class DataSourceSelectConfig(BaseModel):
-    options: list[DataSourcePropertyOption] = Field(default_factory=list)
-
-
-class DataSourceMultiSelectConfig(BaseModel):
-    options: list[DataSourcePropertyOption] = Field(default_factory=list)
-
-
-class DataSourceRelationConfig(BaseModel):
-    data_source_id: str
-    type: RelationType = RelationType.SINGLE_PROPERTY
-    single_property: JsonDict = Field(default_factory=dict)
-
-
-class DataSourceNumberConfig(BaseModel):
-    format: NumberFormat
-
-
-class DataSourceFormulaConfig(BaseModel):
-    expression: str
-
-
-class DataSourceUniqueIdConfig(BaseModel):
-    prefix: str | None = None
-
-
-class DataSourceRollupConfig(BaseModel):
-    function: RollupFunction
-    relation_property_id: str
-    relation_property_name: str
-    rollup_property_id: str
-    rollup_property_name: str
-
-
-class DataSourceDateConfig(BaseModel): ...
-
-
-class DataSourceCreatedTimeConfig(BaseModel): ...
-
-
-class DataSourceCreatedByConfig(BaseModel): ...
-
-
-class DataSourceLastEditedTimeConfig(BaseModel): ...
-
-
-class DataSourceLastEditedByConfig(BaseModel): ...
-
-
-class DataSourceLastVisitedTimeConfig(BaseModel): ...
-
-
-class DataSourceTitleConfig(BaseModel): ...
-
-
-class DataSourceRichTextConfig(BaseModel): ...
-
-
-class DataSourceURLConfig(BaseModel): ...
-
-
-class DataSourcePeopleConfig(BaseModel): ...
-
-
-class DataSourceCheckboxConfig(BaseModel): ...
-
-
-class DataSourceEmailConfig(BaseModel): ...
-
-
-class DataSourcePhoneNumberConfig(BaseModel): ...
-
-
-class DataSourceFilesConfig(BaseModel): ...
-
-
-class DataSourceButtonConfig(BaseModel): ...
-
-
-class DataSourceLocationConfig(BaseModel): ...
-
-
-class DataSourceVerificationConfig(BaseModel): ...
-
-
-class DataSourcePlaceConfig(BaseModel): ...
-
-
-# ============================================================================
-# Property Models
-# ============================================================================
-
-
 class DataSourceStatusProperty(DataSourceProperty):
     type: Literal[PropertyType.STATUS] = PropertyType.STATUS
     status: DataSourceStatusConfig = Field(default_factory=DataSourceStatusConfig)
@@ -242,6 +144,10 @@ class DataSourceStatusProperty(DataSourceProperty):
         return [group.name for group in self.status.groups]
 
 
+class DataSourceSelectConfig(BaseModel):
+    options: list[DataSourcePropertyOption] = Field(default_factory=list)
+
+
 class DataSourceSelectProperty(DataSourceProperty):
     type: Literal[PropertyType.SELECT] = PropertyType.SELECT
     select: DataSourceSelectConfig = Field(default_factory=DataSourceSelectConfig)
@@ -251,6 +157,10 @@ class DataSourceSelectProperty(DataSourceProperty):
         return [option.name for option in self.select.options]
 
 
+class DataSourceMultiSelectConfig(BaseModel):
+    options: list[DataSourcePropertyOption] = Field(default_factory=list)
+
+
 class DataSourceMultiSelectProperty(DataSourceProperty):
     type: Literal[PropertyType.MULTI_SELECT] = PropertyType.MULTI_SELECT
     multi_select: DataSourceMultiSelectConfig = Field(default_factory=DataSourceMultiSelectConfig)
@@ -260,6 +170,13 @@ class DataSourceMultiSelectProperty(DataSourceProperty):
         return [option.name for option in self.multi_select.options]
 
 
+# https://developers.notion.com/reference/property-object
+class DataSourceRelationConfig(BaseModel):
+    data_source_id: str | None = None
+    type: RelationType = RelationType.SINGLE_PROPERTY
+    single_property: JsonDict = Field(default_factory=dict)
+
+
 class DataSourceRelationProperty(DataSourceProperty):
     type: Literal[PropertyType.RELATION] = PropertyType.RELATION
     relation: DataSourceRelationConfig = Field(default_factory=DataSourceRelationConfig)
@@ -269,51 +186,90 @@ class DataSourceRelationProperty(DataSourceProperty):
         return self.relation.data_source_id
 
 
+class DataSourceDateConfig(BaseModel): ...
+
+
 class DataSourceDateProperty(DataSourceProperty):
     type: Literal[PropertyType.DATE] = PropertyType.DATE
     date: DataSourceDateConfig = Field(default_factory=DataSourceDateConfig)
 
 
+class DataSourceCreatedTimeConfig(BaseModel): ...
+
+
 class DataSourceCreatedTimeProperty(DataSourceProperty):
     type: Literal[PropertyType.CREATED_TIME] = PropertyType.CREATED_TIME
     created_time: DataSourceCreatedTimeConfig = Field(default_factory=DataSourceCreatedTimeConfig)
 
 
+class DataSourceCreatedByConfig(BaseModel): ...
+
+
 class DataSourceCreatedByProperty(DataSourceProperty):
     type: Literal[PropertyType.CREATED_BY] = PropertyType.CREATED_BY
     created_by: DataSourceCreatedByConfig = Field(default_factory=DataSourceCreatedByConfig)
 
 
+class DataSourceLastEditedTimeConfig(BaseModel): ...
+
+
 class DataSourceLastEditedTimeProperty(DataSourceProperty):
     type: Literal[PropertyType.LAST_EDITED_TIME] = PropertyType.LAST_EDITED_TIME
     last_edited_time: DataSourceLastEditedTimeConfig = Field(default_factory=DataSourceLastEditedTimeConfig)
 
 
+class DataSourceLastEditedByConfig(BaseModel): ...
+
+
 class DataSourceLastEditedByProperty(DataSourceProperty):
     type: Literal[PropertyType.LAST_EDITED_BY] = PropertyType.LAST_EDITED_BY
     last_edited_by: DataSourceLastEditedByConfig = Field(default_factory=DataSourceLastEditedByConfig)
 
 
+class DataSourceLastVisitedTimeConfig(BaseModel): ...
+
+
+class DataSourceLastVisitedTimeProperty(DataSourceProperty):
+    type: Literal[PropertyType.LAST_VISITED_TIME] = PropertyType.LAST_VISITED_TIME
+    last_visited_time: DataSourceLastVisitedTimeConfig = Field(default_factory=DataSourceLastVisitedTimeConfig)
+
+
+class DataSourceTitleConfig(BaseModel): ...
+
+
 class DataSourceTitleProperty(DataSourceProperty):
     type: Literal[PropertyType.TITLE] = PropertyType.TITLE
     title: DataSourceTitleConfig = Field(default_factory=DataSourceTitleConfig)
 
 
+class DataSourceRichTextConfig(BaseModel): ...
+
+
 class DataSourceRichTextProperty(DataSourceProperty):
     type: Literal[PropertyType.RICH_TEXT] = PropertyType.RICH_TEXT
     rich_text: DataSourceRichTextConfig = Field(default_factory=DataSourceRichTextConfig)
 
 
+class DataSourceURLConfig(BaseModel): ...
+
+
 class DataSourceURLProperty(DataSourceProperty):
     type: Literal[PropertyType.URL] = PropertyType.URL
     url: DataSourceURLConfig = Field(default_factory=DataSourceURLConfig)
 
 
+class DataSourcePeopleConfig(BaseModel): ...
+
+
 class DataSourcePeopleProperty(DataSourceProperty):
     type: Literal[PropertyType.PEOPLE] = PropertyType.PEOPLE
     people: DataSourcePeopleConfig = Field(default_factory=DataSourcePeopleConfig)
 
 
+class DataSourceNumberConfig(BaseModel):
+    format: NumberFormat
+
+
 class DataSourceNumberProperty(DataSourceProperty):
     type: Literal[PropertyType.NUMBER] = PropertyType.NUMBER
     number: DataSourceNumberConfig
@@ -323,26 +279,42 @@ class DataSourceNumberProperty(DataSourceProperty):
         return self.number.format
 
 
+class DataSourceCheckboxConfig(BaseModel): ...
+
+
 class DataSourceCheckboxProperty(DataSourceProperty):
     type: Literal[PropertyType.CHECKBOX] = PropertyType.CHECKBOX
     checkbox: DataSourceCheckboxConfig = Field(default_factory=DataSourceCheckboxConfig)
 
 
+class DataSourceEmailConfig(BaseModel): ...
+
+
 class DataSourceEmailProperty(DataSourceProperty):
     type: Literal[PropertyType.EMAIL] = PropertyType.EMAIL
     email: DataSourceEmailConfig = Field(default_factory=DataSourceEmailConfig)
 
 
+class DataSourcePhoneNumberConfig(BaseModel): ...
+
+
 class DataSourcePhoneNumberProperty(DataSourceProperty):
     type: Literal[PropertyType.PHONE_NUMBER] = PropertyType.PHONE_NUMBER
     phone_number: DataSourcePhoneNumberConfig = Field(default_factory=DataSourcePhoneNumberConfig)
 
 
+class DataSourceFilesConfig(BaseModel): ...
+
+
 class DataSourceFilesProperty(DataSourceProperty):
     type: Literal[PropertyType.FILES] = PropertyType.FILES
     files: DataSourceFilesConfig = Field(default_factory=DataSourceFilesConfig)
 
 
+class DataSourceFormulaConfig(BaseModel):
+    expression: str
+
+
 class DataSourceFormulaProperty(DataSourceProperty):
     type: Literal[PropertyType.FORMULA] = PropertyType.FORMULA
     formula: DataSourceFormulaConfig
@@ -352,6 +324,14 @@ class DataSourceFormulaProperty(DataSourceProperty):
         return self.formula.expression
 
 
+class DataSourceRollupConfig(BaseModel):
+    function: RollupFunction
+    relation_property_id: str
+    relation_property_name: str
+    rollup_property_id: str
+    rollup_property_name: str
+
+
 class DataSourceRollupProperty(DataSourceProperty):
     type: Literal[PropertyType.ROLLUP] = PropertyType.ROLLUP
     rollup: DataSourceRollupConfig
@@ -361,6 +341,10 @@ class DataSourceRollupProperty(DataSourceProperty):
         return self.rollup.function
 
 
+class DataSourceUniqueIdConfig(BaseModel):
+    prefix: str | None = None
+
+
 class DataSourceUniqueIdProperty(DataSourceProperty):
     type: Literal[PropertyType.UNIQUE_ID] = PropertyType.UNIQUE_ID
     unique_id: DataSourceUniqueIdConfig = Field(default_factory=DataSourceUniqueIdConfig)
@@ -370,11 +354,43 @@ class DataSourceUniqueIdProperty(DataSourceProperty):
         return self.unique_id.prefix
 
 
-# ============================================================================
-# Discriminated Union
-# ============================================================================
+class DataSourceButtonConfig(BaseModel): ...
+
+
+class DataSourceButtonProperty(DataSourceProperty):
+    type: Literal[PropertyType.BUTTON] = PropertyType.BUTTON
+    button: DataSourceButtonConfig = Field(default_factory=DataSourceButtonConfig)
+
+
+class DataSourceLocationConfig(BaseModel): ...
+
+
+class DataSourceLocationProperty(DataSourceProperty):
+    type: Literal[PropertyType.LOCATION] = PropertyType.LOCATION
+    location: DataSourceLocationConfig = Field(default_factory=DataSourceLocationConfig)
+
+
+class DataSourcePlaceConfig(BaseModel): ...
+
+
+class DataSourcePlaceProperty(DataSourceProperty):
+    type: Literal[PropertyType.PLACE] = PropertyType.PLACE
+    place: DataSourcePlaceConfig = Field(default_factory=DataSourcePlaceConfig)
+
+
+class DataSourceVerificationConfig(BaseModel): ...
+
+
+class DataSourceVerificationProperty(DataSourceProperty):
+    type: Literal[PropertyType.VERIFICATION] = PropertyType.VERIFICATION
+    verification: DataSourceVerificationConfig = Field(default_factory=DataSourceVerificationConfig)
+
+
+class DataSourceUnknownProperty(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
 
-DiscriminatedDataSourceProperty = Annotated[
+type AnyDataSourceProperty = (
     DataSourceStatusProperty
     | DataSourceSelectProperty
     | DataSourceMultiSelectProperty
@@ -384,6 +400,7 @@ DiscriminatedDataSourceProperty = Annotated[
     | DataSourceCreatedByProperty
     | DataSourceLastEditedTimeProperty
     | DataSourceLastEditedByProperty
+    | DataSourceLastVisitedTimeProperty
     | DataSourceTitleProperty
     | DataSourceRichTextProperty
     | DataSourceURLProperty
@@ -395,8 +412,12 @@ DiscriminatedDataSourceProperty = Annotated[
     | DataSourceFilesProperty
     | DataSourceFormulaProperty
     | DataSourceRollupProperty
-    | DataSourceUniqueIdProperty,
-    Field(discriminator="type"),
-]
+    | DataSourceUniqueIdProperty
+    | DataSourceButtonProperty
+    | DataSourceLocationProperty
+    | DataSourcePlaceProperty
+    | DataSourceVerificationProperty
+    | DataSourceUnknownProperty
+)
 
 DataSourcePropertyT = TypeVar("DataSourcePropertyT", bound=DataSourceProperty)