Message#

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

Bases: BaseModel

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

Attributes

Name	Type	Description
id	`int`	Unique record ID
uuid	`str`	Unversally 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

truncated_body (`property`)	`Any`	Comment text, truncated

from_user (`LazyProperty`)	`User`	Message sender
to_user (`LazyProperty`)	`User`	Message recipient

Methods

__init__(id=None, uuid=None, user_id=None, thread_id=None, subject=None, body=None, read_at=None, created_at=None, updated_at=None, thread_flags=_Nothing.NOTHING, thread_messages_count=None, from_user=None, to_user=None)#: Method generated by attrs for class Message.

classmethod copy(obj)#

Copy a model object. This is defined as a classmethod to easily initialize a subclass from a parent class instance. For copying an instance to the same type, copy.deepcopy() can be used.

Return type:: BaseModel

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, **kwargs)#

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

Return type:: List[TypeVar(T, bound= BaseModel)]

to_dict(keys=None, recurse=True)#

Convert this object back to dict format

Parameters:

keys (Optional[List[str]]) – Only keep the specified keys (attribute names)
recurse (bool) – Recurse into nested model objects

Return type:

Dict[str, Any]