brandkit

brandkit

BrandKit_CRUD_Error

BrandKit_CRUD_Error(
    operation: str,
    palette_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when color palette create, update, or delete operations fail.

This exception is used for failures during modification operations on color palettes, including creation, activation, and deletion.

Source code in src/crew_dcs/routes/brandkit.py

def __init__(
    self,
    operation: str,
    palette_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message:
        if palette_id:
            message = f"Color palette {operation} failed for palette {palette_id}"
        else:
            message = f"Color palette {operation} failed"

    super().__init__(message=message, entity_id=palette_id, res=res, **kwargs)

BrandKit_GET_Error

BrandKit_GET_Error(
    palette_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when color palette retrieval operations fail.

This exception is used for failures during GET operations on color palettes, including API errors and unexpected response formats.

Source code in src/crew_dcs/routes/brandkit.py

def __init__(
    self,
    palette_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message:
        if palette_id:
            message = f"Failed to retrieve color palette {palette_id}"
        else:
            message = "Failed to retrieve color palettes"

    super().__init__(message=message, entity_id=palette_id, res=res, **kwargs)

create_color_palette async

create_color_palette(
    auth: DomoAuth,
    name: str,
    palette_config: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Create a new custom color palette in the Brand Kit.

Creates a custom color palette with specified settings, color ranges, and rules. The palette configuration should include settings, colorRanges, colorRules, selector, gradients, lineColors, popColors, and nameColorMap.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
name	str	Display name for the color palette	required
palette_config	dict	Dictionary containing palette configuration with keys: - settings: General palette settings - colorRanges: Color range definitions - colorRules: Rules for color application - selector: Color selection configuration - gradients: Gradient definitions - lineColors: Line chart color assignments - popColors: Popup/highlight colors - nameColorMap: Mapping of names to specific colors	required
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the created palette with ID

Raises:

Type	Description
ValueError	If palette_config is missing required keys
BrandKit_CRUD_Error	If palette creation fails

Example

palette_config = { ... "settings": {...}, ... "colorRanges": [...], ... "colorRules": {...}, ... "selector": {...}, ... "gradients": {...}, ... "lineColors": [...], ... "popColors": [...], ... "nameColorMap": {...} ... } result = await create_color_palette(auth, "My Palette", palette_config) palette_id = result.response["id"]

Source code in src/crew_dcs/routes/brandkit.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def create_color_palette(
    auth: DomoAuth,
    name: str,
    palette_config: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Create a new custom color palette in the Brand Kit.

    Creates a custom color palette with specified settings, color ranges, and rules.
    The palette configuration should include settings, colorRanges, colorRules,
    selector, gradients, lineColors, popColors, and nameColorMap.

    Args:
        auth: Authentication object containing instance and credentials
        name: Display name for the color palette
        palette_config: Dictionary containing palette configuration with keys:
            - settings: General palette settings
            - colorRanges: Color range definitions
            - colorRules: Rules for color application
            - selector: Color selection configuration
            - gradients: Gradient definitions
            - lineColors: Line chart color assignments
            - popColors: Popup/highlight colors
            - nameColorMap: Mapping of names to specific colors
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing the created palette with ID

    Raises:
        ValueError: If palette_config is missing required keys
        BrandKit_CRUD_Error: If palette creation fails

    Example:
        >>> palette_config = {
        ...     "settings": {...},
        ...     "colorRanges": [...],
        ...     "colorRules": {...},
        ...     "selector": {...},
        ...     "gradients": {...},
        ...     "lineColors": [...],
        ...     "popColors": [...],
        ...     "nameColorMap": {...}
        ... }
        >>> result = await create_color_palette(auth, "My Palette", palette_config)
        >>> palette_id = result.response["id"]
    """
    # Validate palette_config has required keys
    required_keys = {
        "settings",
        "colorRanges",
        "colorRules",
        "selector",
        "gradients",
        "lineColors",
        "popColors",
        "nameColorMap",
    }
    missing_keys = required_keys - set(palette_config.keys())
    if missing_keys:
        raise ValueError(f"palette_config missing required keys: {missing_keys}")

    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/brandkit/v1/chartColorPalettes"

    body = {"name": name, "palette": json.dumps(palette_config)}

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

    if return_raw:
        return res

    if not res.is_success:
        raise BrandKit_CRUD_Error(operation="create", res=res)

    return res

delete_color_palette async

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

Delete a color palette.

Removes a custom color palette from the instance. Default palettes cannot be deleted.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
palette_id	str	Unique identifier for the color palette to delete	required
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object confirming deletion

Raises:

Type	Description
BrandKit_CRUD_Error	If palette deletion fails

Example

result = await delete_color_palette(auth, "palette-123") print(f"Palette deleted: {result.is_success}")

Source code in src/crew_dcs/routes/brandkit.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def delete_color_palette(
    auth: DomoAuth,
    palette_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Delete a color palette.

    Removes a custom color palette from the instance. Default palettes cannot be deleted.

    Args:
        auth: Authentication object containing instance and credentials
        palette_id: Unique identifier for the color palette to delete
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object confirming deletion

    Raises:
        BrandKit_CRUD_Error: If palette deletion fails

    Example:
        >>> result = await delete_color_palette(auth, "palette-123")
        >>> print(f"Palette deleted: {result.is_success}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/brandkit/v1/chartColorPalettes/{palette_id}"

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

    if return_raw:
        return res

    if not res.is_success:
        raise BrandKit_CRUD_Error(operation="delete", palette_id=palette_id, res=res)

    return res

get_color_palette_by_id async

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

Retrieve a specific color palette by ID.

Fetches the complete configuration and metadata for a specific color palette.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
palette_id	str	Unique identifier for the color palette	required
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing the palette configuration

Raises:

Type	Description
BrandKit_GET_Error	If palette retrieval fails

Example

result = await get_color_palette_by_id(auth, "palette-123") palette_name = result.response["name"]

Source code in src/crew_dcs/routes/brandkit.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_color_palette_by_id(
    auth: DomoAuth,
    palette_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a specific color palette by ID.

    Fetches the complete configuration and metadata for a specific color palette.

    Args:
        auth: Authentication object containing instance and credentials
        palette_id: Unique identifier for the color palette
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing the palette configuration

    Raises:
        BrandKit_GET_Error: If palette retrieval fails

    Example:
        >>> result = await get_color_palette_by_id(auth, "palette-123")
        >>> palette_name = result.response["name"]
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/brandkit/v1/chartColorPalettes/{palette_id}"

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

    if return_raw:
        return res

    if not res.is_success:
        raise BrandKit_GET_Error(palette_id=palette_id, res=res)

    return res

list_color_palettes async

list_color_palettes(
    auth: DomoAuth,
    limit: int = 50,
    offset: int = 0,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List all color palettes in the instance.

Retrieves a paginated list of all color palettes available in the Domo instance, including both default and custom palettes.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
limit	int	Maximum number of palettes to return per request	50
offset	int	Number of palettes to skip (for pagination)	0
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing list of color palettes

Raises:

Type	Description
BrandKit_GET_Error	If palette listing fails

Example

result = await list_color_palettes(auth, limit=100) for palette in result.response: ... print(f"Palette: {palette['name']}, ID: {palette['id']}")

Source code in src/crew_dcs/routes/brandkit.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def list_color_palettes(
    auth: DomoAuth,
    limit: int = 50,
    offset: int = 0,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    List all color palettes in the instance.

    Retrieves a paginated list of all color palettes available in the Domo instance,
    including both default and custom palettes.

    Args:
        auth: Authentication object containing instance and credentials
        limit: Maximum number of palettes to return per request
        offset: Number of palettes to skip (for pagination)
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of color palettes

    Raises:
        BrandKit_GET_Error: If palette listing fails

    Example:
        >>> result = await list_color_palettes(auth, limit=100)
        >>> for palette in result.response:
        ...     print(f"Palette: {palette['name']}, ID: {palette['id']}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/brandkit/v1/chartColorPalettes"

    params = {"limit": limit, "offset": offset}

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

    if return_raw:
        return res

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

    return res

set_active_color_palette async

set_active_color_palette(
    auth: DomoAuth,
    palette_id: str,
    palette_type: str = "CUSTOMER",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Set a color palette as the active instance default.

Sets the specified color palette as the active default for the Domo instance. This palette will be used for new cards and visualizations.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object containing instance and credentials	required
palette_id	str	Unique identifier for the color palette to activate	required
palette_type	str	Type of palette, typically "CUSTOMER" for custom palettes	'CUSTOMER'
return_raw	bool	Return raw API response without processing	False
context	RouteContext | None	Optional RouteContext for request configuration	None
**context_kwargs		Additional context parameters (session, debug_api, etc.)	{}

Returns:

Type	Description
ResponseGetData	ResponseGetData object confirming palette activation

Raises:

Type	Description
BrandKit_CRUD_Error	If palette activation fails

Example

result = await set_active_color_palette(auth, "palette-123") print(f"Palette activated: {result.is_success}")

Source code in src/crew_dcs/routes/brandkit.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def set_active_color_palette(
    auth: DomoAuth,
    palette_id: str,
    palette_type: str = "CUSTOMER",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Set a color palette as the active instance default.

    Sets the specified color palette as the active default for the Domo instance.
    This palette will be used for new cards and visualizations.

    Args:
        auth: Authentication object containing instance and credentials
        palette_id: Unique identifier for the color palette to activate
        palette_type: Type of palette, typically "CUSTOMER" for custom palettes
        return_raw: Return raw API response without processing
        context: Optional RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object confirming palette activation

    Raises:
        BrandKit_CRUD_Error: If palette activation fails

    Example:
        >>> result = await set_active_color_palette(auth, "palette-123")
        >>> print(f"Palette activated: {result.is_success}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/brandkit/v1/activeChartPalette"

    body = {"id": palette_id, "type": palette_type}

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

    if return_raw:
        return res

    if not res.is_success:
        raise BrandKit_CRUD_Error(
            operation="set_active", palette_id=palette_id, res=res
        )

    return res