notion_python_client.models.properties package#

Submodules#

notion_python_client.models.properties.checkbox module#

class notion_python_client.models.properties.checkbox.Checkbox(*, id: str | None = None, type: Literal['checkbox'] = 'checkbox', checkbox: bool)#

Bases: PropertiesBase

checkbox: bool#

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['checkbox']#

notion_python_client.models.properties.created_by module#

class notion_python_client.models.properties.created_by.CreatedBy(*, id: str | None = None, type: Literal['created_by'] = 'created_by', created_by: User)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The created_by property cannot be updated, so it is not included in the created_by object.

created_by: User#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['created_by']#

notion_python_client.models.properties.created_time module#

class notion_python_client.models.properties.created_time.CreatedTime(*, id: str | None = None, type: Literal['created_time'] = 'created_time', created_time: datetime)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The created_time property cannot be updated, so it is not included in the created_time object.

created_time: datetime#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['created_time']#

notion_python_client.models.properties.date module#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

end: datetime | date | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: datetime | date | None#

class notion_python_client.models.properties.date.DateDict(*, id: str | None = None, type: Literal['date'] = 'date', date: Date | None = None)#

Bases: PropertiesDictBase

date: Date | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['date']#

notion_python_client.models.properties.email module#

class notion_python_client.models.properties.email.Email(*, id: str | None = None, type: Literal['email'] = 'email', email: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

email: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['email']#

notion_python_client.models.properties.files module#

class notion_python_client.models.properties.files.Files(*, id: str | None = None, type: Literal['files'] = 'files', files: List[File])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: When updating a file page property value, the value is overwritten by the array of files passed.

files: List[File]#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['files']#

notion_python_client.models.properties.formula module#

Bases: PropertiesBase

boolean: bool | None#

create_object(property_name: str) → Dict#: The formula property cannot be updated, so it is not included in the formula object.

date: datetime | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int | None#

string: str | None#

type: Literal['boolean', 'date', 'number', 'string']#

class notion_python_client.models.properties.formula.FormulaDict(*, id: str | None = None, type: Literal['formula'] = 'formula', formula: Formula)#

Bases: PropertiesDictBase

formula: Formula#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['formula']#

notion_python_client.models.properties.last_edited_by module#

class notion_python_client.models.properties.last_edited_by.LastEditedBy(*, id: str | None = None, type: Literal['last_edited_by'] = 'last_edited_by', last_edited_by: User)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The last_edited_by property cannot be updated, so it is not included in the last_edited_by object.

last_edited_by: User#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['last_edited_by']#

notion_python_client.models.properties.last_edited_time module#

class notion_python_client.models.properties.last_edited_time.LastEditedTime(*, id: str | None = None, type: Literal['last_edited_time'] = 'last_edited_time', last_edited_time: datetime)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The last_edited_time property cannot be updated, so it is not included in the last_edited_time object.

last_edited_time: datetime#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['last_edited_time']#

notion_python_client.models.properties.multi_select module#

class notion_python_client.models.properties.multi_select.MultiSelect(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str | None = None, type: Literal['multi_select'] = 'multi_select', multi_select: List[Select])#

Bases: Select

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the select object.

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multi_select: List[Select]#

type: Literal['multi_select']#

notion_python_client.models.properties.number module#

class notion_python_client.models.properties.number.Number(*, id: str | None = None, type: Literal['number'] = 'number', number: float | int | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int | None#

type: Literal['number']#

notion_python_client.models.properties.people module#

class notion_python_client.models.properties.people.People(*, id: str | None = None, type: Literal['people'] = 'people', people: List[User])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

people: List[User]#

type: Literal['people']#

notion_python_client.models.properties.phone_number module#

class notion_python_client.models.properties.phone_number.PhoneNumber(*, id: str | None = None, type: Literal['phone_number'] = 'phone_number', phone_number: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phone_number: str | None#

type: Literal['phone_number']#

notion_python_client.models.properties.properties_base module#

class notion_python_client.models.properties.properties_base.PatchedModel#

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class notion_python_client.models.properties.properties_base.PropertiesBase(*, id: str | None = None)#

Bases: PatchedModel, ABC

static build_properties(properties: List[Dict] | Dict[str, PropertiesBase | PropertiesDictBase]) → Dict#

Create a properties object from a list of properties that can be used to update a page.

Parameters:

( (properties) –

Union[List[Dict], Dict[str, Union[PropertiesBase, PropertiesDictBase]]] ): List of property dictionaries that were created by the create_object method of the property classes. Or Dict of a property class and a property name. The create_object method of the property class will be called with the property name as argument.

The dict should be of the following form: {

”type”: “external”, “external”: {

”url”: “www.test.de/image.png”

}

}

Returns:

Combined properties dictionary out of a list of properties.

Return type:

Dict

clean_none(d)#

abstract create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.properties.properties_base_dict module#

class notion_python_client.models.properties.properties_base_dict.PropertiesDictBase(*, id: str | None = None)#

Bases: BaseModel

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

notion_python_client.models.properties.relation module#

class notion_python_client.models.properties.relation.Relation(*, id: str | None = None, type: Literal['relation'] = 'relation', has_more: bool = False, relation: List[PageReference])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

has_more: bool#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

relation: List[PageReference]#

type: Literal['relation']#

notion_python_client.models.properties.rich_text module#

class notion_python_client.models.properties.rich_text.RichTextProp(*, id: str | None = None, type: Literal['rich_text'] = 'rich_text', rich_text: List[RichText])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rich_text: List[RichText]#

type: Literal['rich_text']#

notion_python_client.models.properties.select module#

class notion_python_client.models.properties.select.Select(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str | None = None)#

Bases: PropertiesBase

property color#

color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None#

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the select object.

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None#

class notion_python_client.models.properties.select.SelectDict(*, id: str | None = None, type: Literal['select'] = 'select', select: Select | None = None)#

Bases: PropertiesDictBase

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

select: Select | None#

type: Literal['select']#

notion_python_client.models.properties.status module#

class notion_python_client.models.properties.status.Status(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str)#

Bases: PropertiesBase

Status property

Parameters:

color (_type_, optional) – The color of the status badge. Defaults to “default”.
id (str, optional) – The id of the status. Defaults to None.
name (str) – The name of the option as it appears in Notion.

property color#

color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None#

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the status object.

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str#

class notion_python_client.models.properties.status.StatusDict(*, id: str | None = None, type: Literal['status'] = 'status', status: Status)#

Bases: PropertiesDictBase

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: Status#

type: Literal['status']#

notion_python_client.models.properties.title module#

class notion_python_client.models.properties.title.Title(title: str | List[RichText], *, id: str | None = None, type: Literal['title'] = 'title', title_: List[RichText])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property title#

title_: List[RichText]#

type: Literal['title']#

notion_python_client.models.properties.unique_id module#

class notion_python_client.models.properties.unique_id.UniqueId(*, id: str | None = None, number: float | int, prefix: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int#

prefix: str | None#

class notion_python_client.models.properties.unique_id.UniqueIdDict(*, id: str | None = None, type: Literal['unique_id'] = 'unique_id', unique_id: UniqueId)#

Bases: PropertiesDictBase

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['unique_id']#

unique_id: UniqueId#

notion_python_client.models.properties.url module#

class notion_python_client.models.properties.url.URL(*, id: str | None = None, type: Literal['url'] = 'url', url: str | None = None)#

Bases: PropertiesDictBase, PropertiesBase

create_object(property_name: str) → Dict#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['url']#

url: str | None#

Module contents#

class notion_python_client.models.properties.Checkbox(*, id: str | None = None, type: Literal['checkbox'] = 'checkbox', checkbox: bool)#

Bases: PropertiesBase

checkbox: bool#

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['checkbox']#

class notion_python_client.models.properties.CreatedBy(*, id: str | None = None, type: Literal['created_by'] = 'created_by', created_by: User)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The created_by property cannot be updated, so it is not included in the created_by object.

created_by: User#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['created_by']#

class notion_python_client.models.properties.CreatedTime(*, id: str | None = None, type: Literal['created_time'] = 'created_time', created_time: datetime)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The created_time property cannot be updated, so it is not included in the created_time object.

created_time: datetime#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['created_time']#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

end: datetime | date | None#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start: datetime | date | None#

class notion_python_client.models.properties.DateDict(*, id: str | None = None, type: Literal['date'] = 'date', date: Date | None = None)#

Bases: PropertiesDictBase

date: Date | None#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['date']#

class notion_python_client.models.properties.Email(*, id: str | None = None, type: Literal['email'] = 'email', email: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

email: str | None#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['email']#

class notion_python_client.models.properties.Files(*, id: str | None = None, type: Literal['files'] = 'files', files: List[File])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: When updating a file page property value, the value is overwritten by the array of files passed.

files: List[File]#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['files']#

Bases: PropertiesBase

boolean: bool | None#

create_object(property_name: str) → Dict#: The formula property cannot be updated, so it is not included in the formula object.

date: datetime | None#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int | None#

string: str | None#

type: Literal['boolean', 'date', 'number', 'string']#

class notion_python_client.models.properties.FormulaDict(*, id: str | None = None, type: Literal['formula'] = 'formula', formula: Formula)#

Bases: PropertiesDictBase

formula: Formula#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['formula']#

class notion_python_client.models.properties.LastEditedBy(*, id: str | None = None, type: Literal['last_edited_by'] = 'last_edited_by', last_edited_by: User)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The last_edited_by property cannot be updated, so it is not included in the last_edited_by object.

id: str | None#

last_edited_by: User#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['last_edited_by']#

class notion_python_client.models.properties.LastEditedTime(*, id: str | None = None, type: Literal['last_edited_time'] = 'last_edited_time', last_edited_time: datetime)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#: The last_edited_time property cannot be updated, so it is not included in the last_edited_time object.

id: str | None#

last_edited_time: datetime#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['last_edited_time']#

class notion_python_client.models.properties.MultiSelect(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str | None = None, type: Literal['multi_select'] = 'multi_select', multi_select: List[Select])#

Bases: Select

color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None#

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the select object.

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multi_select: List[Select]#

name: str | None#

type: Literal['multi_select']#

class notion_python_client.models.properties.Number(*, id: str | None = None, type: Literal['number'] = 'number', number: float | int | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int | None#

type: Literal['number']#

class notion_python_client.models.properties.People(*, id: str | None = None, type: Literal['people'] = 'people', people: List[User])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

people: List[User]#

type: Literal['people']#

class notion_python_client.models.properties.PhoneNumber(*, id: str | None = None, type: Literal['phone_number'] = 'phone_number', phone_number: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

phone_number: str | None#

type: Literal['phone_number']#

class notion_python_client.models.properties.PropertiesBase(*, id: str | None = None)#

Bases: PatchedModel, ABC

static build_properties(properties: List[Dict] | Dict[str, PropertiesBase | PropertiesDictBase]) → Dict#

Create a properties object from a list of properties that can be used to update a page.

Parameters:

( (properties) –

The dict should be of the following form: {

”type”: “external”, “external”: {

”url”: “www.test.de/image.png”

}

}

Returns:

Combined properties dictionary out of a list of properties.

Return type:

Dict

clean_none(d)#

abstract create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class notion_python_client.models.properties.PropertiesDictBase(*, id: str | None = None)#

Bases: BaseModel

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class notion_python_client.models.properties.Relation(*, id: str | None = None, type: Literal['relation'] = 'relation', has_more: bool = False, relation: List[PageReference])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

has_more: bool#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

relation: List[PageReference]#

type: Literal['relation']#

class notion_python_client.models.properties.RichTextProp(*, id: str | None = None, type: Literal['rich_text'] = 'rich_text', rich_text: List[RichText])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rich_text: List[RichText]#

type: Literal['rich_text']#

class notion_python_client.models.properties.RollupDict(*, id: str | None = None, type: Literal['rollup'] = 'rollup', rollup: Rollup)#

Bases: PropertiesDictBase

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rollup: Rollup#

type: Literal['rollup']#

class notion_python_client.models.properties.Select(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str | None = None)#

Bases: PropertiesBase

property color#

color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None#

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the select object.

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None#

class notion_python_client.models.properties.SelectDict(*, id: str | None = None, type: Literal['select'] = 'select', select: Select | None = None)#

Bases: PropertiesDictBase

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

select: Select | None#

type: Literal['select']#

class notion_python_client.models.properties.Status(*, id: str | None = None, color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None = 'default', name: str)#

Bases: PropertiesBase

Status property

Parameters:

color (_type_, optional) – The color of the status badge. Defaults to “default”.
id (str, optional) – The id of the status. Defaults to None.
name (str) – The name of the option as it appears in Notion.

property color#

color_: Literal['blue', 'brown', 'default', 'gray', 'green', 'orange', 'pink', 'purple', 'red', 'yellow'] | None#

create_object(property_name: str) → Dict#: Color cannot be updated, so it is not included in the status object.

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str#

class notion_python_client.models.properties.StatusDict(*, id: str | None = None, type: Literal['status'] = 'status', status: Status)#

Bases: PropertiesDictBase

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: Status#

type: Literal['status']#

class notion_python_client.models.properties.Title(title: str | List[RichText], *, id: str | None = None, type: Literal['title'] = 'title', title_: List[RichText])#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property title#

title_: List[RichText]#

type: Literal['title']#

class notion_python_client.models.properties.URL(*, id: str | None = None, type: Literal['url'] = 'url', url: str | None = None)#

Bases: PropertiesDictBase, PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['url']#

url: str | None#

class notion_python_client.models.properties.UniqueId(*, id: str | None = None, number: float | int, prefix: str | None = None)#

Bases: PropertiesBase

create_object(property_name: str) → Dict#

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number: float | int#

prefix: str | None#

class notion_python_client.models.properties.UniqueIdDict(*, id: str | None = None, type: Literal['unique_id'] = 'unique_id', unique_id: UniqueId)#

Bases: PropertiesDictBase

id: str | None#

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['unique_id']#

unique_id: UniqueId#