Notion

notionsci.connections.notion special

client

NotionApiMixin dataclass

NotionApiMixin(client: Optional[notion_client.client.Client] = None)

NotionClient dataclass

NotionClient(client: Optional[notion_client.client.Client] = None)

structures special

blocks

Block dataclass

Block(object: str = 'block', id: Optional[str] = None, type: Optional[notionsci.connections.notion.structures.blocks.BlockType] = None, created_time: Optional[datetime.datetime] = None, last_edited_time: Optional[datetime.datetime] = None, archived: bool = False, has_children: bool = True, paragraph: Optional[notionsci.connections.notion.structures.blocks.ParagraphBlock] = None, heading_1: Optional[notionsci.connections.notion.structures.blocks.Heading1Block] = None, heading_2: Optional[notionsci.connections.notion.structures.blocks.Heading2Block] = None, heading_3: Optional[notionsci.connections.notion.structures.blocks.Heading3Block] = None, bulleted_list_item: Optional[notionsci.connections.notion.structures.blocks.BulletedListBlock] = None, numbered_list_item: Optional[notionsci.connections.notion.structures.blocks.NumberedListBlock] = None, to_do: Optional[notionsci.connections.notion.structures.blocks.TodoBlock] = None, toggle: Optional[notionsci.connections.notion.structures.blocks.ToggleBlock] = None, child_page: Optional[notionsci.connections.notion.structures.blocks.ChildPageBlock] = None, embed: Optional[notionsci.connections.notion.structures.blocks.EmbedBlock] = None, image: Optional[notionsci.connections.notion.structures.blocks.ImageBlock] = None, video: Optional[notionsci.connections.notion.structures.blocks.VideoBlock] = None, file: Optional[notionsci.connections.notion.structures.common.FileObject] = None, pdf: Optional[notionsci.connections.notion.structures.blocks.PdfBlock] = None, bookmark: Optional[notionsci.connections.notion.structures.blocks.BookmarkBlock] = None, equation: Optional[notionsci.connections.notion.structures.blocks.EquationBlock] = None, code: Optional[notionsci.connections.notion.structures.blocks.CodeBlock] = None, child_database: Optional[notionsci.connections.notion.structures.blocks.ChildDatabaseBlock] = None, table_of_contents: Optional[notionsci.connections.notion.structures.blocks.TableOfContentsBlock] = None, divider: Optional[notionsci.connections.notion.structures.blocks.DividerBlock] = None, unsupported: Optional[str] = None)

BlockType

An enumeration.

BookmarkBlock dataclass

BookmarkBlock(url: str, caption: List[notionsci.connections.notion.structures.common.RichText])

BulletedListBlock dataclass

BulletedListBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = )

ChildDatabaseBlock dataclass

ChildDatabaseBlock(title: str, database: Optional[ForwardRef('notionsci.connections.notion.Database')] = None, children: Optional[List[ForwardRef('notionsci.connections.notion.Page')]] = None)

ChildPageBlock dataclass

ChildPageBlock(title: str)

ChildrenMixin dataclass

ChildrenMixin(children: Optional[List[ForwardRef('Block')]] = None)

CodeBlock dataclass

CodeBlock(text: List[notionsci.connections.notion.structures.common.RichText], language: str)

DividerBlock dataclass

DividerBlock()

EmbedBlock dataclass

EmbedBlock(url: str, caption: List[notionsci.connections.notion.structures.common.RichText])

EquationBlock dataclass

EquationBlock(expression: str)

Heading1Block dataclass

Heading1Block(text: List[notionsci.connections.notion.structures.common.RichText])

Heading2Block dataclass

Heading2Block(text: List[notionsci.connections.notion.structures.common.RichText])

Heading3Block dataclass

Heading3Block(text: List[notionsci.connections.notion.structures.common.RichText])

HeadingBlock dataclass

HeadingBlock(text: List[notionsci.connections.notion.structures.common.RichText])

ImageBlock dataclass

ImageBlock(type: notionsci.connections.notion.structures.common.FileType, caption: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, file: types.Undefinable_FileTypeObject = None, external: types.Undefinable_FileTypeObject = None, name: types.Undefinable_str = None)

ListBlock dataclass

ListBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = )

NumberedListBlock dataclass

NumberedListBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = )

ParagraphBlock dataclass

ParagraphBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = )

PdfBlock dataclass

PdfBlock(type: notionsci.connections.notion.structures.common.FileType, caption: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, file: types.Undefinable_FileTypeObject = None, external: types.Undefinable_FileTypeObject = None, name: types.Undefinable_str = None)

TableOfContentsBlock dataclass

TableOfContentsBlock()

TodoBlock dataclass

TodoBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = , checked: Optional[bool] = None)

ToggleBlock dataclass

ToggleBlock(children: Optional[List[ForwardRef('Block')]] = None, text: List[notionsci.connections.notion.structures.common.RichText] = )

VideoBlock dataclass

VideoBlock(type: notionsci.connections.notion.structures.common.FileType, caption: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, file: types.Undefinable_FileTypeObject = None, external: types.Undefinable_FileTypeObject = None, name: types.Undefinable_str = None)

common

Annotation dataclass

Annotation(bold: bool, italic: bool, strikethrough: bool, underline: bool, code: bool, color: str)

EmojiObject dataclass

EmojiObject(emoji: str, type: str = 'emoji')

EquationObject dataclass

EquationObject(expression: str)

FileObject dataclass

FileObject(type: notionsci.connections.notion.structures.common.FileType, caption: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, file: types.Undefinable_FileTypeObject = None, external: types.Undefinable_FileTypeObject = None, name: types.Undefinable_str = None)

FileType

An enumeration.

FileTypeObject dataclass

FileTypeObject(url: str, expiry_time: Optional[datetime.datetime] = None)

MentionObject dataclass

MentionObject(type: str, user: types.Undefinable_UserObject = None, page: types.Undefinable_PageMention = None)

PageMention dataclass

PageMention(id: str)

RichText dataclass

RichText(type: notionsci.connections.notion.structures.common.RichTextType, plain_text: types.Undefinable_str = None, annotations: types.Undefinable_Annotation = None, href: types.Undefinable_str = None, text: types.Undefinable_TextObject = None, equation: types.Undefinable_EquationObject = None, mention: types.Undefinable_MentionObject = None)

RichTextType

An enumeration.

TextObject dataclass

TextObject(content: str, link: Optional[Dict] = None)

UserObject dataclass

UserObject(object: str = 'user', id: Optional[str] = None, type: Optional[str] = None, name: Optional[str] = None, avatar_url: Optional[str] = None, person: Optional[Dict] = None, bot: Optional[Dict] = None)

content

ContentObject dataclass

ContentObject(object: str, id: Optional[str] = None, parent: Optional[notionsci.connections.notion.structures.content.Parent] = None, url: Optional[str] = None, icon: Union[notionsci.connections.notion.structures.common.FileObject, notionsci.connections.notion.structures.common.EmojiObject, NoneType] = None, cover: Optional[notionsci.connections.notion.structures.common.FileObject] = None, created_time: Optional[datetime.datetime] = None, last_edited_time: Optional[datetime.datetime] = None)

Database dataclass

Database(properties: Dict[str, notionsci.connections.notion.structures.properties.PropertyDef] = , object: str = 'database', id: Optional[str] = None, parent: Optional[notionsci.connections.notion.structures.content.Parent] = None, url: Optional[str] = None, icon: Union[notionsci.connections.notion.structures.common.FileObject, notionsci.connections.notion.structures.common.EmojiObject, NoneType] = None, cover: Optional[notionsci.connections.notion.structures.common.FileObject] = None, created_time: Optional[datetime.datetime] = None, last_edited_time: Optional[datetime.datetime] = None, title: Optional[List[notionsci.connections.notion.structures.common.RichText]] = None)

HasPropertiesMixin dataclass

HasPropertiesMixin(properties: Dict[str, ~PT] = )

Page dataclass

Page(properties: Dict[str, notionsci.connections.notion.structures.properties.Property] = , children: Optional[List[ForwardRef('Block')]] = None, object: str = 'page', id: Optional[str] = None, parent: Optional[notionsci.connections.notion.structures.content.Parent] = None, url: Optional[str] = None, icon: Union[notionsci.connections.notion.structures.common.FileObject, notionsci.connections.notion.structures.common.EmojiObject, NoneType] = None, cover: Optional[notionsci.connections.notion.structures.common.FileObject] = None, created_time: Optional[datetime.datetime] = None, last_edited_time: Optional[datetime.datetime] = None, archived: bool = False)

Parent dataclass

Parent(type: notionsci.connections.notion.structures.content.ParentType, database_id: types.Undefinable_str = None, page_id: types.Undefinable_str = None, workspace: types.Undefinable_bool = None)

ParentType

An enumeration.

properties

DateValue dataclass

DateValue(start: str, end: types.Undefinable_str = None, time_zone: types.Undefinable_str = None)

MultiSelectDef dataclass

SelectDef(options: List[notionsci.connections.notion.structures.properties.SelectValue])

Property dataclass

Property(type: notionsci.connections.notion.structures.properties.PropertyType, id: types.Undefinable_str = None, title: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, rich_text: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.RichText] = None, number: types.Undefinable_int = None, select: types.Undefinable_SelectValue = None, multi_select: types.Undefinable_typing.List[notionsci.connections.notion.structures.properties.SelectValue] = None, date: types.Undefinable_DateValue = None, people: types.Undefinable_typing.List[typing.Dict] = None, files: types.Undefinable_typing.List[notionsci.connections.notion.structures.common.FileObject] = None, checkbox: types.Undefinable_bool = None, url: types.Undefinable_str = None, email: types.Undefinable_str = None, phone_number: types.Undefinable_typing.Dict = None, formula: types.Undefinable_typing.Dict = None, relation: types.Undefinable_typing.List[notionsci.connections.notion.structures.properties.RelationItem] = None, rollup: types.Undefinable_typing.Dict = None, created_time: types.Undefinable_datetime = None, created_by: types.Undefinable_typing.Dict = None, last_edited_time: types.Undefinable_datetime = None, last_edited_by: types.Undefinable_typing.Dict = None)

PropertyDef dataclass

PropertyDef(type: notionsci.connections.notion.structures.properties.PropertyType, id: types.Undefinable_str = None, name: types.Undefinable_str = None, title: types.Undefinable_typing.Dict = None, rich_text: types.Undefinable_typing.Dict = None, number: types.Undefinable_typing.Dict = None, select: types.Undefinable_SelectDef = None, multi_select: types.Undefinable_SelectDef = None, date: types.Undefinable_typing.Dict = None, people: types.Undefinable_typing.List[typing.Dict] = None, files: types.Undefinable_typing.Dict = None, checkbox: types.Undefinable_typing.Dict = None, url: types.Undefinable_typing.Dict = None, email: types.Undefinable_typing.Dict = None, phone_number: types.Undefinable_typing.Dict = None, formula: types.Undefinable_typing.Dict = None, relation: types.Undefinable_RelationDef = None, rollup: types.Undefinable_typing.Dict = None, created_time: types.Undefinable_typing.Dict = None, created_by: types.Undefinable_typing.Dict = None, last_edited_time: types.Undefinable_typing.Dict = None, last_edited_by: types.Undefinable_typing.Dict = None)

PropertyType

An enumeration.

RelationDef dataclass

RelationDef(database_id: str, synced_property_name: Optional[str] = None, synced_property_id: Optional[str] = None)

RelationItem dataclass

RelationItem(id: str)

SelectDef dataclass

SelectDef(options: List[notionsci.connections.notion.structures.properties.SelectValue])

SelectValue dataclass

SelectValue(name: str, id: types.Undefinable_str = None, color: types.Undefinable_str = None)

results

QueryResult dataclass

QueryResult(object: str = 'list', results: List[Union[notionsci.connections.notion.structures.content.Page, notionsci.connections.notion.structures.content.Database, notionsci.connections.notion.structures.blocks.Block]] = , next_cursor: Optional[str] = None, has_more: bool = False)

SortDirection

An enumeration.

SortObject dataclass

SortObject(direction: notionsci.connections.notion.structures.results.SortDirection, timestamp: Optional[notionsci.connections.notion.structures.results.SortTimestamp] = None, property: Optional[str] = None)

SortTimestamp

An enumeration.