key_result

key_result

DomoKeyResult dataclass

DomoKeyResult(
    id: int,
    name: str = None,
    description: str = None,
    state: str = None,
    status: str = None,
    owner_id: int = None,
    owner_type: str = None,
    owners: list[Any] = None,
    resource_id: str = None,
    resource_type: str = None,
    measurement: str = None,
    start_value: float = None,
    current_value: float = None,
    target_value: float = None,
    color_value: str = None,
    operator: str = None,
    raw: dict = None,
)

Represents a single key result belonging to an objective.

DomoKeyResults dataclass

DomoKeyResults(
    parent: DomoEntity,
    key_results: list[DomoKeyResult] = list(),
)

Bases: DomoSubEntity

Sub-entity for managing an objective's key results.

create async

create(
    name: str,
    owner_id: int,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoKeyResult

Create a new key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def create(
    self,
    name: str,
    owner_id: int,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoKeyResult:
    """Create a new key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await objectives_routes.create_key_result(
        auth=self.auth,
        name=name,
        owner_id=owner_id,
        context=context,
    )

    if return_raw:
        return res

    key_result = DomoKeyResult.from_dict(res.response)
    self.key_results.append(key_result)
    return key_result

delete async

delete(
    key_result_id: int | str,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Delete a key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def delete(
    self,
    key_result_id: int | str,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Delete a key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await objectives_routes.delete_key_result(
        auth=self.auth,
        key_result_id=key_result_id,
        context=context,
    )

    self.key_results = [
        kr for kr in self.key_results if str(kr.id) != str(key_result_id)
    ]
    return res

get async

get(
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> list[DomoKeyResult]

Populate key results from the parent objective's raw data.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def get(
    self,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> list[DomoKeyResult]:
    """Populate key results from the parent objective's raw data."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    raw = getattr(self.parent, "raw", None) or {}
    self.key_results = [
        DomoKeyResult.from_dict(obj) for obj in raw.get("keyResults", [])
    ]
    return self.key_results

get_chart async

get_chart(
    key_result_id: int | str,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Get chart data for a key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def get_chart(
    self,
    key_result_id: int | str,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Get chart data for a key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    return await objectives_routes.get_key_result_chart(
        auth=self.auth,
        key_result_id=key_result_id,
        context=context,
    )

get_values async

get_values(
    key_result_id: int | str,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Get historical values for a key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def get_values(
    self,
    key_result_id: int | str,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Get historical values for a key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    return await objectives_routes.get_key_result_values(
        auth=self.auth,
        key_result_id=key_result_id,
        context=context,
    )

update async

update(
    key_result_id: int | str,
    payload: dict,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> DomoKeyResult

Update an existing key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def update(
    self,
    key_result_id: int | str,
    payload: dict,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> DomoKeyResult:
    """Update an existing key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    res = await objectives_routes.update_key_result(
        auth=self.auth,
        key_result_id=key_result_id,
        payload=payload,
        context=context,
    )

    return DomoKeyResult.from_dict(res.response)

update_tags async

update_tags(
    key_result_id: int | str,
    tag_ids: list[int],
    period_id: int | None = None,
    debug_api: bool = False,
    session: AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

Replace the tags assigned to a key result.

Source code in src/crew_dcs/classes/DomoObjective/key_result.py

async def update_tags(
    self,
    key_result_id: int | str,
    tag_ids: list[int],
    period_id: int | None = None,
    debug_api: bool = False,
    session: httpx.AsyncClient | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """Replace the tags assigned to a key result."""
    context = RouteContext.build_context(
        context=context,
        session=session,
        debug_api=debug_api,
        **context_kwargs,
    )

    return await objectives_routes.update_key_result_tags(
        auth=self.auth,
        key_result_id=key_result_id,
        tag_ids=tag_ids,
        period_id=period_id,
        context=context,
    )