Message

class pyinaturalist.models.Message(id=None, user_id=None, thread_id=None, subject=None, body=None, read_at=None, created_at=None, updated_at=None, thread_flags=NOTHING, thread_messages_count=None, from_user=None, to_user=None)

Bases: pyinaturalist.models.base.BaseModel

A message from the user’s inbox, based on the schema of GET /messages

Attributes

Name	Type	Description
id	int	Unique record ID
user_id	int	Corresponding user ID
thread_id	int	Message thread ID
subject	str	Message subject
body	str	Message body
read_at	datetime	When the message was read
created_at	datetime	When the message was sent
updated_at	datetime	When the message was last edited
thread_flags	List[str]
thread_messages_count	int	Number of messages in the thread
from_user (LazyProperty)	User	Message sender
to_user (LazyProperty)	User	Message recipient

Methods

__init__(id=None, user_id=None, thread_id=None, subject=None, body=None, read_at=None, created_at=None, updated_at=None, thread_flags=NOTHING, thread_messages_count=None, from_user=None, to_user=None)

Method generated by attrs for class Message.

classmethod from_json(value, **kwargs)

Initialize a single model object from an API response or response result.

Omits any invalid fields and None values, so default factories are used instead (e.g. for empty dicts and lists).

Return type

TypeVar(T, bound= BaseModel)

classmethod from_json_file(value)

Initialize a collection of model objects from a JSON string, file path, or file-like object

Return type

List[TypeVar(T, bound= BaseModel)]

classmethod from_json_list(value)

Initialize a collection of model objects from an API response or response results

Return type

List[TypeVar(T, bound= BaseModel)]

to_json()

Convert this object back to JSON (dict) format

Return type

Dict[str, Any]