notion_python_client.models package

Subpackages

• notion_python_client.models.properties package
  • Submodules
  • notion_python_client.models.properties.checkbox module
    • Checkbox
      • Checkbox.checkbox
      • Checkbox.create_object()
      • Checkbox.model_config
      • Checkbox.type
  • notion_python_client.models.properties.created_by module
    • CreatedBy
      • CreatedBy.create_object()
      • CreatedBy.created_by
      • CreatedBy.model_config
      • CreatedBy.type
  • notion_python_client.models.properties.created_time module
    • CreatedTime
      • CreatedTime.create_object()
      • CreatedTime.created_time
      • CreatedTime.model_config
      • CreatedTime.type
  • notion_python_client.models.properties.date module
    • Date
      • Date.create_object()
      • Date.end
      • Date.model_config
      • Date.start
    • DateDict
      • DateDict.date
      • DateDict.model_config
      • DateDict.type
  • notion_python_client.models.properties.email module
    • Email
      • Email.create_object()
      • Email.email
      • Email.model_config
      • Email.type
  • notion_python_client.models.properties.files module
    • Files
      • Files.create_object()
      • Files.files
      • Files.model_config
      • Files.type
  • notion_python_client.models.properties.formula module
    • Formula
      • Formula.boolean
      • Formula.create_object()
      • Formula.date
      • Formula.model_config
      • Formula.number
      • Formula.string
      • Formula.type
    • FormulaDict
      • FormulaDict.formula
      • FormulaDict.model_config
      • FormulaDict.type
  • notion_python_client.models.properties.last_edited_by module
    • LastEditedBy
      • LastEditedBy.create_object()
      • LastEditedBy.last_edited_by
      • LastEditedBy.model_config
      • LastEditedBy.type
  • notion_python_client.models.properties.last_edited_time module
    • LastEditedTime
      • LastEditedTime.create_object()
      • LastEditedTime.last_edited_time
      • LastEditedTime.model_config
      • LastEditedTime.type
  • notion_python_client.models.properties.multi_select module
    • MultiSelect
      • MultiSelect.create_object()
      • MultiSelect.model_config
      • MultiSelect.multi_select
      • MultiSelect.type
  • notion_python_client.models.properties.number module
    • Number
      • Number.create_object()
      • Number.model_config
      • Number.number
      • Number.type
  • notion_python_client.models.properties.people module
    • People
      • People.create_object()
      • People.model_config
      • People.people
      • People.type
  • notion_python_client.models.properties.phone_number module
    • PhoneNumber
      • PhoneNumber.create_object()
      • PhoneNumber.model_config
      • PhoneNumber.phone_number
      • PhoneNumber.type
  • notion_python_client.models.properties.properties_base module
    • PatchedModel
      • PatchedModel.model_config
    • PropertiesBase
      • PropertiesBase.build_properties()
      • PropertiesBase.clean_none()
      • PropertiesBase.create_object()
      • PropertiesBase.id
      • PropertiesBase.model_config
  • notion_python_client.models.properties.properties_base_dict module
    • PropertiesDictBase
      • PropertiesDictBase.id
      • PropertiesDictBase.model_config
  • notion_python_client.models.properties.relation module
    • Relation
      • Relation.create_object()
      • Relation.has_more
      • Relation.model_config
      • Relation.relation
      • Relation.type
  • notion_python_client.models.properties.rich_text module
    • RichTextProp
      • RichTextProp.create_object()
      • RichTextProp.model_config
      • RichTextProp.rich_text
      • RichTextProp.type
  • notion_python_client.models.properties.select module
    • Select
      • Select.color
      • Select.color_
      • Select.create_object()
      • Select.id
      • Select.model_config
      • Select.name
    • SelectDict
      • SelectDict.model_config
      • SelectDict.select
      • SelectDict.type
  • notion_python_client.models.properties.status module
    • Status
      • Status.color
      • Status.color_
      • Status.create_object()
      • Status.id
      • Status.model_config
      • Status.name
    • StatusDict
      • StatusDict.model_config
      • StatusDict.status
      • StatusDict.type
  • notion_python_client.models.properties.title module
    • Title
      • Title.create_object()
      • Title.model_config
      • Title.title
      • Title.title_
      • Title.type
  • notion_python_client.models.properties.unique_id module
    • UniqueId
      • UniqueId.create_object()
      • UniqueId.model_config
      • UniqueId.number
      • UniqueId.prefix
    • UniqueIdDict
      • UniqueIdDict.model_config
      • UniqueIdDict.type
      • UniqueIdDict.unique_id
  • notion_python_client.models.properties.url module
    • URL
      • URL.create_object()
      • URL.model_config
      • URL.type
      • URL.url
  • Module contents
    • Checkbox
      • Checkbox.checkbox
      • Checkbox.create_object()
      • Checkbox.id
      • Checkbox.model_config
      • Checkbox.type
    • CreatedBy
      • CreatedBy.create_object()
      • CreatedBy.created_by
      • CreatedBy.id
      • CreatedBy.model_config
      • CreatedBy.type
    • CreatedTime
      • CreatedTime.create_object()
      • CreatedTime.created_time
      • CreatedTime.id
      • CreatedTime.model_config
      • CreatedTime.type
    • Date
      • Date.create_object()
      • Date.end
      • Date.id
      • Date.model_config
      • Date.start
    • DateDict
      • DateDict.date
      • DateDict.id
      • DateDict.model_config
      • DateDict.type
    • Email
      • Email.create_object()
      • Email.email
      • Email.id
      • Email.model_config
      • Email.type
    • Files
      • Files.create_object()
      • Files.files
      • Files.id
      • Files.model_config
      • Files.type
    • Formula
      • Formula.boolean
      • Formula.create_object()
      • Formula.date
      • Formula.id
      • Formula.model_config
      • Formula.number
      • Formula.string
      • Formula.type
    • FormulaDict
      • FormulaDict.formula
      • FormulaDict.id
      • FormulaDict.model_config
      • FormulaDict.type
    • LastEditedBy
      • LastEditedBy.create_object()
      • LastEditedBy.id
      • LastEditedBy.last_edited_by
      • LastEditedBy.model_config
      • LastEditedBy.type
    • LastEditedTime
      • LastEditedTime.create_object()
      • LastEditedTime.id
      • LastEditedTime.last_edited_time
      • LastEditedTime.model_config
      • LastEditedTime.type
    • MultiSelect
      • MultiSelect.color_
      • MultiSelect.create_object()
      • MultiSelect.id
      • MultiSelect.model_config
      • MultiSelect.multi_select
      • MultiSelect.name
      • MultiSelect.type
    • Number
      • Number.create_object()
      • Number.id
      • Number.model_config
      • Number.number
      • Number.type
    • People
      • People.create_object()
      • People.id
      • People.model_config
      • People.people
      • People.type
    • PhoneNumber
      • PhoneNumber.create_object()
      • PhoneNumber.id
      • PhoneNumber.model_config
      • PhoneNumber.phone_number
      • PhoneNumber.type
    • PropertiesBase
      • PropertiesBase.build_properties()
      • PropertiesBase.clean_none()
      • PropertiesBase.create_object()
      • PropertiesBase.id
      • PropertiesBase.model_config
    • PropertiesDictBase
      • PropertiesDictBase.id
      • PropertiesDictBase.model_config
    • Relation
      • Relation.create_object()
      • Relation.has_more
      • Relation.id
      • Relation.model_config
      • Relation.relation
      • Relation.type
    • RichTextProp
      • RichTextProp.create_object()
      • RichTextProp.id
      • RichTextProp.model_config
      • RichTextProp.rich_text
      • RichTextProp.type
    • RollupDict
      • RollupDict.model_config
      • RollupDict.rollup
      • RollupDict.type
    • Select
      • Select.color
      • Select.color_
      • Select.create_object()
      • Select.id
      • Select.model_config
      • Select.name
    • SelectDict
      • SelectDict.id
      • SelectDict.model_config
      • SelectDict.select
      • SelectDict.type
    • Status
      • Status.color
      • Status.color_
      • Status.create_object()
      • Status.id
      • Status.model_config
      • Status.name
    • StatusDict
      • StatusDict.id
      • StatusDict.model_config
      • StatusDict.status
      • StatusDict.type
    • Title
      • Title.create_object()
      • Title.id
      • Title.model_config
      • Title.title
      • Title.title_
      • Title.type
    • URL
      • URL.create_object()
      • URL.id
      • URL.model_config
      • URL.type
      • URL.url
    • UniqueId
      • UniqueId.create_object()
      • UniqueId.id
      • UniqueId.model_config
      • UniqueId.number
      • UniqueId.prefix
    • UniqueIdDict
      • UniqueIdDict.id
      • UniqueIdDict.model_config
      • UniqueIdDict.type
      • UniqueIdDict.unique_id

Submodules

notion_python_client.models.annotations module

class notion_python_client.models.annotations.Annotation(*, bold: bool | None, italic: bool | None, strikethrough: bool | None, underline: bool | None, code: bool | None, color: Literal['blue', 'blue_background', 'brown', 'brown_background', 'default', 'gray', 'gray_background', 'green', 'green_background', 'orange', 'orange_background', 'pink', 'pink_background', 'purple', 'purple_background', 'red', 'red_background', 'yellow', 'yellow_background'] | None)

Bases: BaseModel

bold: bool | None

code: bool | None

color: Literal['blue', 'blue_background', 'brown', 'brown_background', 'default', 'gray', 'gray_background', 'green', 'green_background', 'orange', 'orange_background', 'pink', 'pink_background', 'purple', 'purple_background', 'red', 'red_background', 'yellow', 'yellow_background'] | None

italic: bool | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

strikethrough: bool | None

underline: bool | None

notion_python_client.models.database_reference module

class notion_python_client.models.database_reference.DatabaseReference(*, id: UUID)

Bases: BaseModel

id: UUID

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.date module

class notion_python_client.models.date.Date(*, start: datetime | date, end: datetime | None = None)

Bases: BaseModel

end: datetime | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: datetime | date

notion_python_client.models.emoji module

class notion_python_client.models.emoji.Emoji(*, type: str = 'emoji', emoji: str)

Bases: BaseModel

emoji: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: str

notion_python_client.models.equation module

class notion_python_client.models.equation.Equation(*, expression: str)

Bases: BaseModel

expression: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.file module

class notion_python_client.models.file.File(*, name: str | None = None, type: Literal['external', 'file'], file: Dict[str, str | datetime] | None = None, external: Dict | None = None)

Bases: BaseModel

create_object(property_name: str = 'file') → Dict

Create a file object that can be used in the properties of a page.

Parameters:

property_name (str) – The name of the property that should be created (default: “file”)

Returns:

The created file object

Return type:

Dict

external: Dict | None

file: Dict[str, str | datetime] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

type: Literal['external', 'file']

notion_python_client.models.link module

class notion_python_client.models.link.Link(*, url: str)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: str

notion_python_client.models.mention module

class notion_python_client.models.mention.Mention(*, type: Literal['database', 'date', 'link_preview', 'page', 'template_mention', 'user'], database: DatabaseReference | None = None, date: Date | None = None, link_preview: Link | None = None, page: PageReference | None = None, template_mention: TemplateReference | None = None, user: User | None = None)

Bases: BaseModel

database: DatabaseReference | None

date: Date | None

link_preview: Link | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

page: PageReference | None

template_mention: TemplateReference | None

type: Literal['database', 'date', 'link_preview', 'page', 'template_mention', 'user']

user: User | None

notion_python_client.models.page module

class notion_python_client.models.page.Page(*, object: str = 'page', id: str, archived: bool | None = False, parent: Parent, created_time: datetime, last_edited_time: datetime, created_by: User, last_edited_by: User, icon: File | Emoji | None = None, cover: File | None = None, properties: Dict[str, DateDict | StatusDict | Number | SelectDict | MultiSelect | People | Files | Checkbox | Email | PhoneNumber | FormulaDict | Relation | CreatedTime | CreatedBy | LastEditedTime | LastEditedBy | RichTextProp | Title | URL | UniqueIdDict | RollupDict], url: str, public_url: str | None = None)

Bases: BaseModel

archived: bool | None

cover: File | None

created_by: User

created_time: datetime

icon: File | Emoji | None

id: str

last_edited_by: User

last_edited_time: datetime

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

object: str

parent: Parent

properties: Dict[str, DateDict | StatusDict | Number | SelectDict | MultiSelect | People | Files | Checkbox | Email | PhoneNumber | FormulaDict | Relation | CreatedTime | CreatedBy | LastEditedTime | LastEditedBy | RichTextProp | Title | URL | UniqueIdDict | RollupDict]

public_url: str | None

url: str

notion_python_client.models.page_reference module

class notion_python_client.models.page_reference.PageReference(*, id: UUID)

Bases: BaseModel

id: UUID

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.parent module

class notion_python_client.models.parent.Parent(*, type: str = 'database_id', database_id: UUID)

Bases: BaseModel

Note: Currntly only the datbase parent is supported. The page parent is not supported yet.

create_object(property_name: str = 'parent') → Dict

Create a file object that can be used in the properties of a page.

Parameters:

property_name (str) – The name of the property that should be created (default: “parent”)

Returns:

The created file object

Return type:

Dict

database_id: UUID

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: str

notion_python_client.models.rich_text module

class notion_python_client.models.rich_text.RichText(*, id: str | None = None, type: Literal['text', 'mention', 'equation'], text: Text | None = None, mention: Mention | None = None, equation: Equation | None = None, annotations: Annotation = None, plain_text: str | None = None, href: str | None = None)

Bases: PropertiesBase, BaseModel

annotations: Annotation

create_object(property_name: str) → Dict

equation: Equation | None

href: str | None

mention: Mention | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

plain_text: str | None

text: Text | None

type: Literal['text', 'mention', 'equation']

notion_python_client.models.template_reference module

class notion_python_client.models.template_reference.TemplateReference(*, type: Literal['template_mention_date', 'template_mention_uesr'], template_mention_date: Literal['today', 'now'] | None = None, template_mention_user: Literal['me'] | None = None)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

template_mention_date: Literal['today', 'now'] | None

template_mention_user: Literal['me'] | None

type: Literal['template_mention_date', 'template_mention_uesr']

notion_python_client.models.text module

class notion_python_client.models.text.Text(*, content: str, link: Link | None = None)

Bases: BaseModel

content: str

link: Link | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.user module

class notion_python_client.models.user.User(*, object: str = 'user', id: UUID)

Bases: BaseModel

id: UUID

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

object: str

Module contents