publish_content_pages

publish_content_pages

Read-only (GET) Domo Everywhere routes for publication content and pages.

Sibling of :mod:crew_dcs.routes.publish. Shapes come from the Postman "Domo Everywhere" collection (Associations and Publication Content folders); none of these endpoints take query parameters there, and their response bodies are passed through untouched. Response semantics are not asserted here: no integration proof exists yet for what these endpoints return.

get_email_configs async

get_email_configs(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the email configuration of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/email-configs (Postman: "Get Email Config").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_email_configs(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the email configuration of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/email-configs`` (Postman: "Get Email Config").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/email-configs",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_embed_content async

get_embed_content(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the embed content details of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/embed-content (Postman: "Get Embed Content Details").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_embed_content(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the embed content details of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/embed-content`` (Postman: "Get Embed Content Details").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/embed-content",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_file async

get_file(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get a data file of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/file/{dataFileId} (Postman: "Get File").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
data_file_id	str	ID of the data file.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_file(
    auth: DomoAuth,
    publication_id: str,
    data_file_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get a data file of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/file/{dataFileId}`` (Postman: "Get File").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        data_file_id: ID of the data file.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/file/{data_file_id}",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_file_details async

get_file_details(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the file details of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/file/details (Postman: "Get File Details").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_file_details(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the file details of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/file/details`` (Postman: "Get File Details").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/file/details",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_filter_view async

get_filter_view(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the filter view of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/filter-view (Postman: "Get Publication Filter View").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_filter_view(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the filter view of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/filter-view`` (Postman: "Get Publication Filter View").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/filter-view",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_form_definition async

get_form_definition(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the form definition of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/form (Postman: "Get Form Definition").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_form_definition(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the form definition of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/form`` (Postman: "Get Form Definition").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/form",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_org_templates async

get_org_templates(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the org templates of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/org-templates (Postman: "Get Org Template").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_org_templates(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the org templates of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/org-templates`` (Postman: "Get Org Template").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/org-templates",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_page_associations async

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

Get the page associations for the publisher.

Calls GET /publish/v2/associations/pages (Postman: "Get Page Associations For Publisher").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_page_associations(
    auth: DomoAuth,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the page associations for the publisher.

    Calls ``GET /publish/v2/associations/pages`` (Postman: "Get Page Associations For Publisher").

    Args:
        auth: Authenticated Domo session.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        "/api/publish/v2/associations/pages",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_page_embed async

get_page_embed(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the page embed details of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/page-embed (Postman: "Get Page Embed Details").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_page_embed(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the page embed details of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/page-embed`` (Postman: "Get Page Embed Details").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/page-embed",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_page_navigations async

get_page_navigations(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the page navigations of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/pages/navigations (Postman: "Get Page Navigations").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_page_navigations(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the page navigations of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/pages/navigations`` (Postman: "Get Page Navigations").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/pages/navigations",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_publication_page async

get_publication_page(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the page (with layout) of a publication.

Calls GET /publish/v2/publications/contents/{publicationId}/page (Postman: "Get Publication Page With Layout").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_publication_page(
    auth: DomoAuth,
    publication_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the page (with layout) of a publication.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/page`` (Postman: "Get Publication Page With Layout").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/page",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )

get_variable_definition async

get_variable_definition(
    auth: DomoAuth,
    publication_id: str,
    content_type: str,
    content_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

Get the variable definition of a piece of publication content.

Calls GET /publish/v2/publications/contents/{publicationId}/variables/{contentType}/{contentId} (Postman: "Get Variable Definition").

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
publication_id	str	ID of the publication.	required
content_type	str	Type of the content (path segment).	required
content_id	str	ID of the content.	required
timeout	int	Request timeout in seconds.	10
return_raw	bool	When True, return the response even if it failed.	False
context	RouteContext | None	Optional route context.	None
**context_kwargs	Any	Extra context overrides.	{}

Returns:

Type	Description
ResponseGetData	The response from Domo.

Raises:

Type	Description
GET_Publish_Error	If the response is not successful and return_raw is False.

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_variable_definition(
    auth: DomoAuth,
    publication_id: str,
    content_type: str,
    content_id: str,
    timeout: int = 10,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the variable definition of a piece of publication content.

    Calls ``GET /publish/v2/publications/contents/{publicationId}/variables/{contentType}/{contentId}`` (Postman: "Get Variable Definition").

    Args:
        auth: Authenticated Domo session.
        publication_id: ID of the publication.
        content_type: Type of the content (path segment).
        content_id: ID of the content.
        timeout: Request timeout in seconds.
        return_raw: When True, return the response even if it failed.
        context: Optional route context.
        **context_kwargs: Extra context overrides.

    Returns:
        The response from Domo.

    Raises:
        GET_Publish_Error: If the response is not successful and
            ``return_raw`` is False.
    """
    return await _get_publish_content(
        auth,
        f"/api/publish/v2/publications/contents/{publication_id}/variables/{content_type}/{content_id}",
        return_raw=return_raw,
        timeout=timeout,
        context=context,
    )