diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py index 3019942..c13c8ef 100644 --- a/src/webqueue2api/parser/item.py +++ b/src/webqueue2api/parser/item.py @@ -28,23 +28,23 @@ class Item: `item = Item("ce", 100)` Attributes: - queue: The name of the queue the Item is in. - number: The number of the Item. - path: The path to the Item on the filesystem. - last_updated: An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. - headers: A list of dictionaries containing header keys and values. - content: A list of section dictionaries. - is_locked: A boolean showing whether or not a lockfile for the item is present. - user_email: The email address of the person who this item is from. - user_name: The real name of the person who this item is from. - user_alias: The Purdue career account alias of the person this item is from. - assigned_to: The Purdue career account alias of the person this item is assigned to - subject: The subject of the original message for this item. - status: The most recent status update for the item. - priority: The most recent priority for this item. - department: The most recent department for this item. - date_received: The date this item was created. - json_data: A JSON serializable representation of the Item. + queue (string): The name of the queue the Item is in. + number (int): The number of the Item. + path (pathlib.Path): The path to the Item on the filesystem. + last_updated (string): An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem. + headers (list): A list of dictionaries containing header keys and values. + content (list): A list of section dictionaries. + is_locked (Union[str, bool]): A boolean showing whether or not a lockfile for the item is present. + user_email (string): The email address of the person who this item is from. + user_name (string): The real name of the person who this item is from. + user_alias (string): The Purdue career account alias of the person this item is from. + assigned_to (string): The Purdue career account alias of the person this item is assigned to + subject (string): The subject of the original message for this item. + status (string): The most recent status update for the item. + priority (string): The most recent priority for this item. + department (string): The most recent department for this item. + date_received (string): The date this item was created. + json_data (list): A JSON serializable representation of the Item. Raises: ItemDoesNotExistError: If an item does not exist on the filesystem.