Charting Settings

Charting Settings

toothfairyai@latest…

Manager for charting settings operations.

This manager provides methods to create, update, and manage charting settings.

Example:

>>> client = ToothFairyClient(api_key="...", workspace_id="...")
>>> charting_settings = client.charting_settings.get(...)

Accessed via client.chartingSettings.

Methods

Method	HTTP	Endpoint
update	POST	POST /charting_settings/update
get	GET	GET /charting_settings/get/{charting_settings_id}

update

Update charting settings.

def update(
    charting_settings_id: str,
    primary_color: Optional[str] = None,
    secondary_color: Optional[str] = None,
    tertiary_color: Optional[str] = None,
    primary_text_color: Optional[str] = None,
    primary_border_color: Optional[str] = None,
    line_color: Optional[str] = None,
    plot_primary_color: Optional[str] = None,
    plot_secondary_color: Optional[str] = None,
    plot_tertiary_color: Optional[str] = None,
    xy_background_color: Optional[str] = None
) -> ChartingSettings

Endpoint: POST /charting_settings/update · API service

Request fields

Python kwarg	Wire field	Type	Required	Description
workspace_id	workspaceid	string	no	Unique workspace identifier (UUID v4)
primary_color	primaryColor	string	no	Primary Color
secondary_color	secondaryColor	string	no	Secondary Color
tertiary_color	tertiaryColor	string	no	Tertiary Color
primary_text_color	primaryTextColor	string	no	Primary text color
primary_border_color	primaryBorderColor	string	no	Primary border color
line_color	lineColor	string	no	Line Color
plot_primary_color	plotPrimaryColor	string	no	Plot Primary Color
plot_secondary_color	plotSecondaryColor	string	no	Plot Secondary Color
plot_tertiary_color	plotTertiaryColor	string	no	Plot Tertiary Color
xy_background_color	xyBackgroundColor	string	no	XY Background Color

Always pass snake_case keyword arguments — the Python kwarg column shows the exact name to use for each wire field (as a named parameter where it appears in the method signature, otherwise via **kwargs). The SDK converts it deterministically to the camelCase wire key the API expects. Passing camelCase directly is deprecated: it emits a warning and converts to the same wire key.

Response fields

Field	Type	Description
workspaceid	string	Unique workspace identifier (UUID v4)
primaryColor	string	Primary Color
secondaryColor	string	Secondary Color
tertiaryColor	string	Tertiary Color
primaryTextColor	string	Primary text color
primaryBorderColor	string	Primary border color
lineColor	string	Line Color
plotPrimaryColor	string	Plot Primary Color
plotSecondaryColor	string	Plot Secondary Color
plotTertiaryColor	string	Plot Tertiary Color
xyBackgroundColor	string	XY Background Color

Example

client.chartingSettings.update(charting_settings_id="agent-id")

get

Get a charting_settings by ID.

def get(charting_settings_id: str) -> ChartingSettings

Endpoint: GET /charting_settings/get/{charting_settings_id} · API service

Response

Returns the ChartingSettings object — fields documented in the update section above.

Example

client.chartingSettings.get(charting_settings_id="agent-id")