crud

crud

create_alert async

create_alert(
    auth: DomoAuth,
    body: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Create a new alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
body	dict	Alert creation payload	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 created alert

Raises:

Type	Description
Alert_CRUD_Error	If alert creation fails

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def create_alert(
    auth: DomoAuth,
    body: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Create a new alert.

    Args:
        auth: Authentication object for API requests
        body: Alert creation payload
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the created alert

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

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

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

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(operation="create", res=res)
    return res

delete_alert async

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

Delete an alert.

Parameters:

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

Returns:

Type	Description
ResponseGetData	ResponseGetData object confirming deletion

Raises:

Type	Description
Alert_CRUD_Error	If alert deletion fails

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

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

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

    Returns:
        ResponseGetData object confirming deletion

    Raises:
        Alert_CRUD_Error: If alert deletion 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="DELETE", context=context)

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(operation="delete", alert_id=str(alert_id), res=res)
    return res

share_alert async

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

Share an alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert to share	required
body	dict	Share payload (e.g. recipient user/group ids)	required
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object confirming the share

Raises:

Type	Description
Alert_CRUD_Error	If sharing fails

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

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

    Args:
        auth: Authentication object for API requests
        alert_id: ID of the alert to share
        body: Share payload (e.g. recipient user/group ids)
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object confirming the share

    Raises:
        Alert_CRUD_Error: If sharing fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

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

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

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(operation="share", alert_id=str(alert_id), res=res)
    return res

update_alert async

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

Update an existing alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert to update	required
body	dict	Updated alert payload	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 updated alert

Raises:

Type	Description
Alert_CRUD_Error	If alert update fails

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

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

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

    Returns:
        ResponseGetData object containing the updated alert

    Raises:
        Alert_CRUD_Error: If alert update 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="PATCH", body=body, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(operation="update", alert_id=str(alert_id), res=res)
    return res

update_alert_message_template async

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

Replace the message template for an alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert to update	required
body	dict	Updated message template payload	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 updated alert

Raises:

Type	Description
Alert_CRUD_Error	If message template update fails

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def update_alert_message_template(
    auth: DomoAuth,
    alert_id: str,
    body: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Replace the message template for an alert.

    Args:
        auth: Authentication object for API requests
        alert_id: ID of the alert to update
        body: Updated message template payload
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the updated alert

    Raises:
        Alert_CRUD_Error: If message template update fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

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

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

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(
            operation="update message template", alert_id=str(alert_id), res=res
        )
    return res

update_alert_rules async

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

Replace the rules for an alert.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
alert_id	str	ID of the alert to update	required
body	dict	Updated alert rules payload	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 updated alert

Raises:

Type	Description
Alert_CRUD_Error	If rule update fails

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

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

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

    Returns:
        ResponseGetData object containing the updated alert

    Raises:
        Alert_CRUD_Error: If rule update 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="PUT", body=body, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Alert_CRUD_Error(
            operation="update rules", alert_id=str(alert_id), res=res
        )
    return res