tags

tags

create_category async

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

Create a new objective tag category.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
name	str | None	Name for the new tag category	None
payload	dict | None	Pre-built payload (overrides name)	None
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 tag category

Raises:

Type	Description
Category_CRUD_Error	If category creation fails

Source code in src/crew_dcs/routes/objectives/tags.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def create_category(
    auth: DomoAuth,
    name: str | None = None,
    payload: dict | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Create a new objective tag category.

    Args:
        auth: Authentication object for API requests
        name: Name for the new tag category
        payload: Pre-built payload (overrides name)
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the created tag category

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

    payload = payload or generate_create_category_body(name=name)
    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/categories"

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

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

create_tag async

create_tag(
    auth: DomoAuth,
    name: str | None = None,
    category_id: int | None = None,
    category_name: str | None = None,
    payload: dict | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Create a new objective tag.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
name	str | None	Name for the new tag	None
category_id	int | None	Optional category ID to assign the tag to	None
category_name	str | None	Optional category name to assign the tag to	None
payload	dict | None	Pre-built payload (overrides name/category_id/category_name)	None
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 tag

Raises:

Type	Description
Tag_CRUD_Error	If tag creation fails

Source code in src/crew_dcs/routes/objectives/tags.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def create_tag(
    auth: DomoAuth,
    name: str | None = None,
    category_id: int | None = None,
    category_name: str | None = None,
    payload: dict | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Create a new objective tag.

    Args:
        auth: Authentication object for API requests
        name: Name for the new tag
        category_id: Optional category ID to assign the tag to
        category_name: Optional category name to assign the tag to
        payload: Pre-built payload (overrides name/category_id/category_name)
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the created tag

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

    payload = payload or generate_create_tag_body(
        name=name, category_id=category_id, category_name=category_name
    )
    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags"

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

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

delete_category async

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

Delete an objective tag category.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
category_id	int | str	ID of the tag category 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
Category_CRUD_Error	If category deletion fails

Source code in src/crew_dcs/routes/objectives/tags.py

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

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

    Returns:
        ResponseGetData object confirming deletion

    Raises:
        Category_CRUD_Error: If category deletion fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/categories/{category_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 Category_CRUD_Error(
            operation="delete", category_id=str(category_id), res=res
        )
    return res

delete_tag async

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

Delete an objective tag.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
tag_id	int | str	ID of the tag 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
Tag_CRUD_Error	If tag deletion fails

Source code in src/crew_dcs/routes/objectives/tags.py

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

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

    Returns:
        ResponseGetData object confirming deletion

    Raises:
        Tag_CRUD_Error: If tag deletion fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/{tag_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 Tag_CRUD_Error(operation="delete", tag_id=str(tag_id), res=res)
    return res

generate_create_category_body

generate_create_category_body(name: str) -> dict

Generate payload for objective tag category creation.

Source code in src/crew_dcs/routes/objectives/tags.py

def generate_create_category_body(name: str) -> dict:
    """Generate payload for objective tag category creation."""
    return {"name": name}

generate_create_tag_body

generate_create_tag_body(
    name: str,
    category_id: int | None = None,
    category_name: str | None = None,
) -> dict

Generate payload for objective tag creation.

Source code in src/crew_dcs/routes/objectives/tags.py

def generate_create_tag_body(
    name: str,
    category_id: int | None = None,
    category_name: str | None = None,
) -> dict:
    """Generate payload for objective tag creation."""
    payload = {"name": name}
    if category_id is not None or category_name is not None:
        payload["category"] = {"id": category_id, "name": category_name}
    return payload

get_tag_categories async

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

List objective tag categories.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
all	bool	Whether to return all tag categories	True
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing objective tag categories

Raises:

Type	Description
Objectives_GET_Error	If category retrieval fails

Source code in src/crew_dcs/routes/objectives/tags.py

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

    Args:
        auth: Authentication object for API requests
        all: Whether to return all tag categories
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objective tag categories

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

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/categories"
    params = {"all": all}

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

get_tags async

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

List objective tags.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
all	bool	Whether to return all tags	True
return_raw	bool	Return raw response without processing	False
context	RouteContext | None	RouteContext for request configuration	None

Returns:

Type	Description
ResponseGetData	ResponseGetData object containing objective tags

Raises:

Type	Description
Objectives_GET_Error	If tag retrieval fails

Source code in src/crew_dcs/routes/objectives/tags.py

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

    Args:
        auth: Authentication object for API requests
        all: Whether to return all tags
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objective tags

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

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags"
    params = {"all": all}

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

update_category async

update_category(
    auth: DomoAuth,
    category_id: int | str,
    payload: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Update an existing objective tag category.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authentication object for API requests	required
category_id	int | str	ID of the tag category to update	required
payload	dict	Updated tag category 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 tag category

Raises:

Type	Description
Category_CRUD_Error	If category update fails

Source code in src/crew_dcs/routes/objectives/tags.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def update_category(
    auth: DomoAuth,
    category_id: int | str,
    payload: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Update an existing objective tag category.

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

    Returns:
        ResponseGetData object containing the updated tag category

    Raises:
        Category_CRUD_Error: If category update fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/categories/{category_id}"

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

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

update_tag async

update_tag(
    auth: DomoAuth,
    tag_id: int | str,
    payload: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Update an existing objective tag.

Parameters:

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

Raises:

Type	Description
Tag_CRUD_Error	If tag update fails

Source code in src/crew_dcs/routes/objectives/tags.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def update_tag(
    auth: DomoAuth,
    tag_id: int | str,
    payload: dict,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Update an existing objective tag.

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

    Returns:
        ResponseGetData object containing the updated tag

    Raises:
        Tag_CRUD_Error: If tag update fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/tags/{tag_id}"
    )

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

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