variable¶

class whispertrades.variable.BaseVariable(*, number: str, name: str, value: str | None, free_text_value: str | None = None, last_updated_at: datetime | None = None)[source]¶

Bases: BaseModel

free_text_value : str | None¶

last_updated_at : datetime | None¶

name : str¶

number : str¶

value : str | None¶

class whispertrades.variable.Condition(*, condition: str, value: str)[source]¶

Bases: BaseModel

condition : str¶

value : str¶

class whispertrades.variable.Variable(data: VariableResponse, client: WTClient, auto_refresh: bool)[source]¶

Bases: object

auto_refresh : bool¶

auto_refresh toggle inherited from WTClient

bot : str | None¶

Bot associated with the variable

client : WTClient¶

the WTClient object that created this instance

conditions : List[Condition | None]¶

Conditions associated with the variable

free_text_value : str | None¶

Free text value of the variable

last_updated_at : datetime | None¶

Last updated at

name : str¶

Variable name

number : str¶

Variable number

update(name: str = None, value: str = None) → str[source]¶

Change this variable name or free text value Auth Required: Write Variables

Parameters:¶

name: str = None¶

new name of the variable

value: str = None¶

New free text value for the variable. This is only valid if the variable is a “Free Text” type that is not associated with a bot

Returns:¶

message from Whispertrades API

value : str | None¶

Variable value

class whispertrades.variable.VariableResponse(*, number: str, name: str, value: str | None, free_text_value: str | None = None, last_updated_at: datetime | None = None, bot: str | None, conditions: list[Condition | None])[source]¶

Bases: BaseVariable

bot : str | None¶

conditions : list[Condition | None]¶