investfly.models.common

Common utility classes and types

@dataclass
class DatedValue:

Data Container class to hold Time,Value for timed numeric values

DatedValue(date: datetime.datetime, value: float | int)
date: datetime.datetime
value: float | int
def toJsonDict(self) -> Dict[str, Any]:
@staticmethod
def fromDict( json_dict: Dict[str, Any]) -> DatedValue:
@dataclass
class TimeDelta:

TimeDelta container class similar to python timedelta

TimeDelta(value: int, unit: TimeUnit)
value: int
unit: TimeUnit
def toPyTimeDelta(self) -> datetime.timedelta:
def toDict(self) -> Dict[str, Any]:
@staticmethod
def fromDict(json_dict: Dict[str, Any]) -> TimeDelta:
class TimeUnit(builtins.str, enum.Enum):

TimeUnit Enum (MINUTES, HOURS, DAYS)

MINUTES = MINUTES
HOURS = HOURS
DAYS = DAYS
@dataclass
class Message:
Message(type: MessageType, message: str)
type: MessageType
message: str
def toDict(self) -> Dict[str, Any]:
@staticmethod
def fromDict(json_dict: Dict[str, Any]) -> Message:
class MessageType(builtins.str, enum.Enum):

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ERROR = <MessageType.ERROR: 'ERROR'>
SUCCESS = <MessageType.SUCCESS: 'SUCCESS'>
WARN = <MessageType.WARN: 'WARN'>
@dataclass
class Session:

Class that represents logged in user session with the Investfly server

Session(username: str, clientId: str, clientToken: str)
username: str
clientId: str
clientToken: str
@staticmethod
def fromJsonDict(json_dict: Dict[str, Any]) -> Session:
class ModelUtils:
est_zone = zoneinfo.ZoneInfo(key='US/Eastern')
@staticmethod
def convertoToEst(dt: datetime.datetime) -> datetime.datetime:
@staticmethod
def localizeDateTime(dt: datetime.datetime) -> datetime.datetime:
@staticmethod
def parseDatetime(date_str: str) -> datetime.datetime:
@staticmethod
def formatDatetime(dt: datetime.datetime) -> str:
@staticmethod
def formatDateTimeNoMillisecs(dt: datetime.datetime) -> str:
@staticmethod
def parseZonedDatetime(date_str: str) -> datetime.datetime:
@staticmethod
def formatZonedDatetime(dt: datetime.datetime) -> str:
class NoDataException(builtins.Exception):

Common base class for all non-exit exceptions.

NoDataException(dataParams: Dict[str, Any])
dataParams
message
class Visibility(builtins.str, enum.Enum):

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

PRIVATE = <Visibility.PRIVATE: 'PRIVATE'>
PUBLIC = <Visibility.PUBLIC: 'PUBLIC'>