publish_subscriptions

publish_subscriptions

Publish subscription routes (summaries, invites, shares, status).

Read-only (GET) routes under /api/publish/v2/.

GET_PublishSubscriptions_Error

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

Bases: RouteError

Raised when a publish subscription GET request returns a non-success response.

Build the error from the failed response.

Parameters:

Name	Type	Description	Default
res	ResponseGetData	The failed response.	required
message	str | None	Optional message overriding the default.	None

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

def __init__(self, res: rgd.ResponseGetData, message: str | None = None) -> None:
    """Build the error from the failed response.

    Args:
        res: The failed response.
        message: Optional message overriding the default.
    """
    super().__init__(res=res, message=message)

count_subscription_invites async

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

Count subscription invites (Postman: Count Invites).

GET /api/publish/v2/subscriptions/invites/counts

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def count_subscription_invites(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Count subscription invites (Postman: Count Invites).

    ``GET /api/publish/v2/subscriptions/invites/counts``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/invites/counts"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

count_subscription_summaries async

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

Count subscription summaries (Postman: Count Summaries).

GET /api/publish/v2/subscriptions/summaries/counts

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def count_subscription_summaries(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Count subscription summaries (Postman: Count Summaries).

    ``GET /api/publish/v2/subscriptions/summaries/counts``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/summaries/counts"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

get_subscription_invite_counts async

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

Count subscription invites (Postman: Get Subscription Invites Counts).

GET /api/publish/v2/subscription/invites/counts

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_invite_counts(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Count subscription invites (Postman: Get Subscription Invites Counts).

    ``GET /api/publish/v2/subscription/invites/counts``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscription/invites/counts"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

get_subscription_share async

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

Get the share of a subscription (Postman: Get Subscription Share).

GET /api/publish/v2/subscriptions/{subscription_id}/share

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
subscription_id	str	Subscription ID.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_share(
    auth: DomoAuth,
    subscription_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the share of a subscription (Postman: Get Subscription Share).

    ``GET /api/publish/v2/subscriptions/{subscription_id}/share``

    Args:
        auth: Authenticated Domo session.
        subscription_id: Subscription ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/{subscription_id}/share"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

get_subscription_share_groups async

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

Get the groups a subscription is shared with (Postman: Get Subscription Share Groups).

GET /api/publish/v2/subscriptions/share/groups/{subscription_id}

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
subscription_id	str	Subscription ID.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_share_groups(
    auth: DomoAuth,
    subscription_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the groups a subscription is shared with (Postman: Get Subscription Share Groups).

    ``GET /api/publish/v2/subscriptions/share/groups/{subscription_id}``

    Args:
        auth: Authenticated Domo session.
        subscription_id: Subscription ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/share/groups/{subscription_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 GET_PublishSubscriptions_Error(res)

    return res

get_subscription_status async

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

Get the status of a subscription to a package publication (Postman: Get Subscription Status).

GET /api/publish/v2/subscriptions/status/{package_publication_id}

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
package_publication_id	str	Package publication ID.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_status(
    auth: DomoAuth,
    package_publication_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get the status of a subscription to a package publication (Postman: Get Subscription Status).

    ``GET /api/publish/v2/subscriptions/status/{package_publication_id}``

    Args:
        auth: Authenticated Domo session.
        package_publication_id: Package publication ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/status/{package_publication_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 GET_PublishSubscriptions_Error(res)

    return res

get_subscription_summaries_by_pub_id async

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

Get subscription summaries for one publication (Postman: Get Subscription Summaries).

GET /api/publish/v2/subscriptions/summaries/{pub_id}

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
pub_id	str	Publication ID.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_summaries_by_pub_id(
    auth: DomoAuth,
    pub_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get subscription summaries for one publication (Postman: Get Subscription Summaries).

    ``GET /api/publish/v2/subscriptions/summaries/{pub_id}``

    Args:
        auth: Authenticated Domo session.
        pub_id: Publication ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/summaries/{pub_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 GET_PublishSubscriptions_Error(res)

    return res

get_subscription_summary_counts async

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

Count subscription summaries (Postman: Search Summaries Count).

GET /api/publish/v2/subscription/summaries/counts

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_summary_counts(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Count subscription summaries (Postman: Search Summaries Count).

    ``GET /api/publish/v2/subscription/summaries/counts``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscription/summaries/counts"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

get_subscription_with_share async

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

Get a subscription together with its share (Postman: Get Subscription With Share).

GET /api/publish/v2/subscription/{subscription_id}/share

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
subscription_id	str	Subscription ID.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_subscription_with_share(
    auth: DomoAuth,
    subscription_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """Get a subscription together with its share (Postman: Get Subscription With Share).

    ``GET /api/publish/v2/subscription/{subscription_id}/share``

    Args:
        auth: Authenticated Domo session.
        subscription_id: Subscription ID.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscription/{subscription_id}/share"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

list_all_subscriptions async

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

List all subscriptions (Postman: List Subscriptions).

GET /api/publish/v2/subscriptions/all

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def list_all_subscriptions(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """List all subscriptions (Postman: List Subscriptions).

    ``GET /api/publish/v2/subscriptions/all``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/all"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

list_public_subscription_invites async

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

List public subscription invites (Postman: Get Public Invites).

GET /api/publish/v2/subscriptions/invites/public

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def list_public_subscription_invites(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """List public subscription invites (Postman: Get Public Invites).

    ``GET /api/publish/v2/subscriptions/invites/public``

    Args:
        auth: Authenticated Domo session.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/invites/public"

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

list_subscription_invites async

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

List subscription invites (Postman: List Invites).

GET /api/publish/v2/subscriptions/invites

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
limit	int | None	Optional page size, sent as the limit query parameter.	None
offset	int | None	Optional offset query parameter.	None
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def list_subscription_invites(
    auth: DomoAuth,
    limit: int | None = None,
    offset: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """List subscription invites (Postman: List Invites).

    ``GET /api/publish/v2/subscriptions/invites``

    Args:
        auth: Authenticated Domo session.
        limit: Optional page size, sent as the ``limit`` query parameter.
        offset: Optional ``offset`` query parameter.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/invites"

    params: dict[str, int] = {}
    if limit is not None:
        params["limit"] = limit
    if offset is not None:
        params["offset"] = offset

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res

list_subscription_summaries async

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

List subscription summaries (Postman: List Summaries).

GET /api/publish/v2/subscriptions/summaries

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Authenticated Domo session.	required
limit	int | None	Optional page size, sent as the limit query parameter.	None
offset	int | None	Optional offset query parameter.	None
return_raw	bool	If True, return the response without raising on failure.	False
context	RouteContext | None	Optional pre-built route context.	None
**context_kwargs	Any	Extra context overrides consumed by route_function.	{}

Returns:

Type	Description
ResponseGetData	The API response.

Raises:

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

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

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def list_subscription_summaries(
    auth: DomoAuth,
    limit: int | None = None,
    offset: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """List subscription summaries (Postman: List Summaries).

    ``GET /api/publish/v2/subscriptions/summaries``

    Args:
        auth: Authenticated Domo session.
        limit: Optional page size, sent as the ``limit`` query parameter.
        offset: Optional ``offset`` query parameter.
        return_raw: If True, return the response without raising on failure.
        context: Optional pre-built route context.
        **context_kwargs: Extra context overrides consumed by ``route_function``.

    Returns:
        The API response.

    Raises:
        GET_PublishSubscriptions_Error: If the response is not successful and ``return_raw`` is False.
    """
    url = (
        f"https://{auth.domo_instance}.domo.com/api/publish/v2/subscriptions/summaries"
    )

    params: dict[str, int] = {}
    if limit is not None:
        params["limit"] = limit
    if offset is not None:
        params["offset"] = offset

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

    if return_raw:
        return res

    if not res.is_success:
        raise GET_PublishSubscriptions_Error(res)

    return res