abacusai.health_source_catalog_entry

Classes

HealthSourceCatalogEntry

One provider the Health Data Sources surface can show — what it is called, how it looks, and how (or

Module Contents

class abacusai.health_source_catalog_entry.HealthSourceCatalogEntry(client, provider=None, name=None, category=None, kind=None, color=None, glyph=None, iconUrl=None, connectMode=None, primaryRank=None, comingSoon=None, deprecating=None, mobileOnlyDetail=None)

Bases: abacusai.return_class.AbstractApiClass

One provider the Health Data Sources surface can show — what it is called, how it looks, and how (or

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • provider (str) – Provider key (oura, fitbit, garmin, …), matching HealthDataSource.provider.

  • name (str) – Brand name, shown as-is (never translated).

  • category (str) – Stable display key the client maps to a translated label (Wearable, Fitness, Smart scale, Nutrition, Medical, CGM).

  • kind (str) – wearable | nutrition | cgm — the ingestion-side data shape, not a user-facing label.

  • color (str) – Hex brand colour for the circular source badge.

  • glyph (str) – One or two characters drawn on that badge when no icon renders.

  • iconUrl (str) – A WHITE monochrome mark on transparency, to be composited over color. One asset works in light and dark, on web and native. Absent for a provider whose mark isn’t published yet — draw glyph instead.

  • connectMode (str) – web_oauth (Terra’s hosted OAuth from a browser) | mobile_app (on-device SDK only — the phone health stores). Derived from the same provider tuple the connect endpoint enforces, so a client that offers what this says can never be refused for offering the wrong thing.

  • primaryRank (int) – Tie-break order when several connected devices report the SAME metric and are otherwise equally good witnesses — lower wins, unranked providers sort last. Served so the insight cards and a client’s metrics view attribute a reading to the same device.

  • comingSoon (bool) – Held back from launch — list it, but offer no way to connect it. Resolved per org from the health_coming_soon_sources flag, so web and app agree on what has shipped.

  • deprecating (bool) – Supported, but the provider is winding the integration down (Google Fit’s REST API in favour of Health Connect) — best-effort.

  • mobileOnlyDetail (str) – Why a browser can’t connect this one, for a web user. Present only when connect_mode is mobile_app.

provider = None
name = None
category = None
kind = None
color = None
glyph = None
icon_url = None
connect_mode = None
primary_rank = None
coming_soon = None
deprecating = None
mobile_only_detail = None
deprecated_keys
__repr__()
to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict