toggle

toggle

ToggleConfig_CRUD_Error

ToggleConfig_CRUD_Error(
    res: ResponseGetData, message: str | None = None
)

Bases: Config_CRUD_Error

Raised when a toggle configuration update operation fails.

This exception is used for failures during PUT operations on toggle features, including API errors and unexpected response formats.

Source code in src/crew_dcs/routes/instance_config/toggle.py

def __init__(self, res: rgd.ResponseGetData, message: str | None = None):
    super().__init__(res=res, message=message)

get_is_invite_social_users_enabled async

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

GET /api/content/v3/customers/{customer_id}/features/free-invite - Retrieve social user invite setting.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
customer_id	str	Customer ID for the instance.	required
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed configuration.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object with response field containing a dict with "name"
ResponseGetData	and "is_enabled" keys when return_raw is False, or raw API response
ResponseGetData	when return_raw is True.

Raises:

Type	Description
Config_GET_Error	If the API request fails or returns an error status.

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_is_invite_social_users_enabled(
    auth: DomoAuth,
    customer_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v3/customers/{customer_id}/features/free-invite - Retrieve social user invite setting.

    Args:
        auth: Authentication object containing Domo credentials.
        customer_id: Customer ID for the instance.
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed configuration.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object with response field containing a dict with "name"
        and "is_enabled" keys when return_raw is False, or raw API response
        when return_raw is True.

    Raises:
        Config_GET_Error: If the API request fails or returns an error status.
    """
    # must pass the customer as the short form API endpoint (without customer_id) does not support a GET request
    # url = f"https://{auth.domo_instance}.domo.com/api/content/v3/customers/features/free-invite"

    url = f"https://{auth.domo_instance}.domo.com/api/content/v3/customers/{customer_id}/features/free-invite"

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

    if return_raw:
        return res

    if not res.is_success:
        raise Config_GET_Error(
            res=res,
        )

    res.response = {"name": "free-invite", "is_enabled": res.response["enabled"]}

    return res

get_is_left_nav_enabled async

get_is_left_nav_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

2025-09-15 current version of leftnav enabled

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_is_left_nav_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """
    2025-09-15 current version of leftnav enabled
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/nav/v1/leftnav/enabled"

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

    if return_raw:
        return res

    if not res.is_success:
        raise Config_GET_Error(res=res)

    res.response = {
        "is_enabled": res.response or False,
        "feature": "use-left-nav",
    }

    return res

get_is_user_invite_notifications_enabled async

get_is_user_invite_notifications_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/customer/v1/properties/user.invite.email.enabled - Retrieve user invite notification setting.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed configuration.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object with response field containing a dict with "name"
ResponseGetData	and "is_enabled" keys when return_raw is False. The "is_enabled" value is
ResponseGetData	converted from the API's string representation via convert_string_to_bool,
ResponseGetData	defaulting to False if the response is not a dict or value is missing.
ResponseGetData	Raw API response is returned when return_raw is True.

Raises:

Type	Description
Config_GET_Error	If the API request fails or returns an error status.

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_is_user_invite_notifications_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/customer/v1/properties/user.invite.email.enabled - Retrieve user invite notification setting.

    Args:
        auth: Authentication object containing Domo credentials.
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed configuration.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object with response field containing a dict with "name"
        and "is_enabled" keys when return_raw is False. The "is_enabled" value is
        converted from the API's string representation via convert_string_to_bool,
        defaulting to False if the response is not a dict or value is missing.
        Raw API response is returned when return_raw is True.

    Raises:
        Config_GET_Error: If the API request fails or returns an error status.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/customer/v1/properties/user.invite.email.enabled"

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

    if return_raw:
        return res

    if not res.is_success:
        raise Config_GET_Error(res=res)

    res.response = {
        "name": "user.invite.email.enabled",
        "is_enabled": (
            convert_string_to_bool(res.response.get("value", False))
            if isinstance(res.response, dict)
            else False
        ),
    }

    return res

get_is_weekly_digest_enabled async

get_is_weekly_digest_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v1/customer-states/come-back-to-domo-all-users - Retrieve weekly digest setting.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed configuration.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object with response field containing a dict with "is_enabled"
ResponseGetData	and "feature" keys when return_raw is False. The "is_enabled" value is
ResponseGetData	converted from the API's string representation via convert_string_to_bool.
ResponseGetData	Raw API response is returned when return_raw is True.

Raises:

Type	Description
Config_CRUD_Error	If the API returns a 404 with "Not Found" response, or if the API request fails or returns any other error status.

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_is_weekly_digest_enabled(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v1/customer-states/come-back-to-domo-all-users - Retrieve weekly digest setting.

    Args:
        auth: Authentication object containing Domo credentials.
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed configuration.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object with response field containing a dict with "is_enabled"
        and "feature" keys when return_raw is False. The "is_enabled" value is
        converted from the API's string representation via convert_string_to_bool.
        Raw API response is returned when return_raw is True.

    Raises:
        Config_CRUD_Error: If the API returns a 404 with "Not Found" response,
            or if the API request fails or returns any other error status.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/come-back-to-domo-all-users"

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

    if return_raw:
        return res

    if res.status == 404 and res.response == "Not Found":
        raise Config_CRUD_Error(res=res)

    if not res.is_success:
        raise Config_CRUD_Error(res=res)

    res.response = {
        "is_enabled": convert_string_to_bool(res.response["value"]),
        "feature": "come-back-to-domo-all-users",
    }

    return res

toggle_is_invite_social_users_enabled async

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

Toggle whether social users can be invited to the instance.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object	required
customer_id	str	Customer ID for the instance	required
is_enabled	bool	True to enable social user invites, False to disable	required
return_raw	bool	Return raw response without processing	False

Returns:

Type	Description
ResponseGetData	ResponseGetData with the updated configuration

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def toggle_is_invite_social_users_enabled(
    auth: DomoAuth,
    customer_id: str,
    is_enabled: bool,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Toggle whether social users can be invited to the instance.

    Args:
        auth: Authentication object
        customer_id: Customer ID for the instance
        is_enabled: True to enable social user invites, False to disable
        return_raw: Return raw response without processing

    Returns:
        ResponseGetData with the updated configuration
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/content/v3/customers/{customer_id}/features/free-invite"

    body = {"enabled": is_enabled}

    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 ToggleConfig_CRUD_Error(
            res=res,
            message=f"Failed to toggle social user invites to {is_enabled}",
        )

    res.response = {"name": "free-invite", "is_enabled": is_enabled}

    return res

toggle_is_left_nav_enabled async

toggle_is_left_nav_enabled(
    auth: DomoAuth,
    is_use_left_nav: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
)

2025-09-15 -- switched to new leftnav API

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def toggle_is_left_nav_enabled(
    auth: DomoAuth,
    is_use_left_nav: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
):
    """
    2025-09-15 -- switched to new leftnav API
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/nav/v1/leftnav/customer-settings"

    body = {"enabled": "CUSTOMER"} if is_use_left_nav else {"enabled": "NONE"}

    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 ToggleConfig_CRUD_Error(res=res)

    res.response = {
        "is_enabled": res.response,
        "feature": "use-left-nav",
    }

    return res

toggle_is_user_invite_enabled async

toggle_is_user_invite_enabled(
    auth: DomoAuth,
    is_enabled: bool,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Admin > Company Settings > Notifications

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def toggle_is_user_invite_enabled(
    auth: DomoAuth,
    is_enabled: bool,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Admin > Company Settings > Notifications
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/customer/v1/properties/user.invite.email.enabled"

    body = {"value": is_enabled}

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

    if not res.is_success:
        raise ToggleConfig_CRUD_Error(res=res, message=str(res.response))

    if return_raw:
        return res

    return await get_is_user_invite_notifications_enabled(
        auth=auth,
        context=context,
    )

toggle_is_weekly_digest_enabled async

toggle_is_weekly_digest_enabled(
    auth: DomoAuth,
    is_enabled: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/customer-states/come-back-to-domo-all-users - Toggle weekly digest feature.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing Domo credentials.	required
is_enabled	bool	True to enable weekly digest, False to disable (default: True).	True
return_raw	bool	If True, return the raw ResponseGetData object. If False (default), return parsed configuration.	False
context	RouteContext | None	Optional RouteContext for API request configuration.	None
**context_kwargs	Any	Additional context parameters (session, debug_api, etc.).	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object. When return_raw is False, calls get_is_weekly_digest_enabled
ResponseGetData	and returns its result with the updated configuration. When return_raw is True,
ResponseGetData	returns the raw API response from the PUT operation.

Raises:

Type	Description
Config_CRUD_Error	If the API request fails or returns an error status.

Source code in src/crew_dcs/routes/instance_config/toggle.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def toggle_is_weekly_digest_enabled(
    auth: DomoAuth,
    is_enabled: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/customer-states/come-back-to-domo-all-users - Toggle weekly digest feature.

    Args:
        auth: Authentication object containing Domo credentials.
        is_enabled: True to enable weekly digest, False to disable (default: True).
        return_raw: If True, return the raw ResponseGetData object.
            If False (default), return parsed configuration.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object. When return_raw is False, calls get_is_weekly_digest_enabled
        and returns its result with the updated configuration. When return_raw is True,
        returns the raw API response from the PUT operation.

    Raises:
        Config_CRUD_Error: If the API request fails or returns an error status.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/customer-states/come-back-to-domo-all-users"

    body = {"name": "come-back-to-domo-all-users", "value": is_enabled}

    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 Config_CRUD_Error(res=res)

    return await get_is_weekly_digest_enabled(
        auth=auth,
        context=context,
    )