core

core

get_alert async

get_alert(
    auth: DomoAuth,
    alert_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a single alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert to retrieve	required
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the alert

Raises:

Type	Description
Alert_GET_Error	If alert retrieval fails

Source code in src/crew_dcs/routes/alerts/core.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_alert(
    auth: DomoAuth,
    alert_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Retrieve a single alert.

    Args:
        auth: Authentication object for API requests
        alert_id: ID of the alert to retrieve
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the alert

    Raises:
        Alert_GET_Error: If alert retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v4/alerts/{alert_id}"

    res = await gd.get_data(auth=auth, url=url, method="GET", context=context)

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_GET_Error(alert_id=str(alert_id), res=res)
    return res

get_alert_evaluations async

get_alert_evaluations(
    auth: DomoAuth,
    alert_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve evaluations for an alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert	required
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the alert's evaluations

Raises:

Type	Description
Alert_GET_Error	If evaluation retrieval fails

Source code in src/crew_dcs/routes/alerts/core.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_alert_evaluations(
    auth: DomoAuth,
    alert_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Retrieve evaluations for an alert.

    Args:
        auth: Authentication object for API requests
        alert_id: ID of the alert
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the alert's evaluations

    Raises:
        Alert_GET_Error: If evaluation retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v4/alerts/{alert_id}/evaluations"

    res = await gd.get_data(auth=auth, url=url, method="GET", context=context)

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_GET_Error(alert_id=str(alert_id), res=res)
    return res

list_alerts async

list_alerts(
    auth: DomoAuth,
    all: bool = True,
    fields: str = "all",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List alerts.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
all	bool	Whether to return all alerts	True
fields	str	Which fields to include in the response (e.g. "all")	'all'
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing matching alerts

Raises:

Type	Description
Alert_GET_Error	If alert listing fails

Source code in src/crew_dcs/routes/alerts/core.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def list_alerts(
    auth: DomoAuth,
    all: bool = True,
    fields: str = "all",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List alerts.

    Args:
        auth: Authentication object for API requests
        all: Whether to return all alerts
        fields: Which fields to include in the response (e.g. "all")
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing matching alerts

    Raises:
        Alert_GET_Error: If alert listing fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v4/alerts"
    params = {"all": all, "fields": fields}

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_GET_Error(res=res)
    return res