prefect_hightouch.api_client.api.default.list_destination

This is a module containing functions, auto-generated from the REST schema, but note these are not Prefect tasks.

Example usage shown below; be sure to replace endpoint_fn with the desired endpoint function.

from prefect_hightouch.credentials import HightouchCredentials
from prefect_hightouch.api_client.api.default import endpoint_fn

credentials = HightouchCredentials(token="my-service-token")
client = credentials.get_client()
result = endpoint_fn.sync(client=client)

The functions are described below:

• asyncio: Non-blocking request that returns parsed data (if successful) or None. Any calls must be awaited.
• asyncio_detailed: Non-blocking request that always returns a Request, optionally with parsed set if the request was successful. Any calls must be awaited.
• sync: Blocking request that returns parsed data (if successful) or None.
• sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.

asyncio async

List Destinations

List the destinations in the user's workspace

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
name	Union[Unset, None, str]		UNSET
slug	Union[Unset, None, str]		UNSET
limit	Union[Unset, None, float]		UNSET
order_by	Union[Unset, None, ListDestinationOrderBy]	ListDestinationOrderBy.ID.	ID

Returns:

Type	Description
Optional[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]	The parsed response.

Source code in prefect_hightouch/api_client/api/default/list_destination.py

async def asyncio(
    client: AuthenticatedClient,
    name: Union[Unset, None, str] = UNSET,
    slug: Union[Unset, None, str] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListDestinationOrderBy] = ListDestinationOrderBy.ID,
) -> Optional[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]:
    """List Destinations

     List the destinations in the user's workspace

    Args:
        client: An authenticated client.
        name (Union[Unset, None, str]):
        slug (Union[Unset, None, str]):
        limit (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListDestinationOrderBy]):  Default:
            ListDestinationOrderBy.ID.

    Returns:
        The parsed response.
    """

    return (
        await asyncio_detailed(
            client=client,
            name=name,
            slug=slug,
            limit=limit,
            order_by=order_by,
        )
    ).parsed

asyncio_detailed async

List Destinations

List the destinations in the user's workspace

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
name	Union[Unset, None, str]		UNSET
slug	Union[Unset, None, str]		UNSET
limit	Union[Unset, None, float]		UNSET
order_by	Union[Unset, None, ListDestinationOrderBy]	ListDestinationOrderBy.ID.	ID

Returns:

Type	Description
Response[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]	The response.

Source code in prefect_hightouch/api_client/api/default/list_destination.py

async def asyncio_detailed(
    client: AuthenticatedClient,
    name: Union[Unset, None, str] = UNSET,
    slug: Union[Unset, None, str] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListDestinationOrderBy] = ListDestinationOrderBy.ID,
) -> Response[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]:
    """List Destinations

     List the destinations in the user's workspace

    Args:
        client: An authenticated client.
        name (Union[Unset, None, str]):
        slug (Union[Unset, None, str]):
        limit (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListDestinationOrderBy]):  Default:
            ListDestinationOrderBy.ID.

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        client=client,
        name=name,
        slug=slug,
        limit=limit,
        order_by=order_by,
    )

    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
        response = await _client.request(**kwargs)

    return _build_response(response=response)

sync

List Destinations

List the destinations in the user's workspace

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
name	Union[Unset, None, str]		UNSET
slug	Union[Unset, None, str]		UNSET
limit	Union[Unset, None, float]		UNSET
order_by	Union[Unset, None, ListDestinationOrderBy]	ListDestinationOrderBy.ID.	ID

Returns:

Type	Description
Optional[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]	The parsed response.

Source code in prefect_hightouch/api_client/api/default/list_destination.py

def sync(
    client: AuthenticatedClient,
    name: Union[Unset, None, str] = UNSET,
    slug: Union[Unset, None, str] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListDestinationOrderBy] = ListDestinationOrderBy.ID,
) -> Optional[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]:
    """List Destinations

     List the destinations in the user's workspace

    Args:
        client: An authenticated client.
        name (Union[Unset, None, str]):
        slug (Union[Unset, None, str]):
        limit (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListDestinationOrderBy]):  Default:
            ListDestinationOrderBy.ID.

    Returns:
        The parsed response.
    """

    return sync_detailed(
        client=client,
        name=name,
        slug=slug,
        limit=limit,
        order_by=order_by,
    ).parsed

sync_detailed

List Destinations

List the destinations in the user's workspace

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
name	Union[Unset, None, str]		UNSET
slug	Union[Unset, None, str]		UNSET
limit	Union[Unset, None, float]		UNSET
order_by	Union[Unset, None, ListDestinationOrderBy]	ListDestinationOrderBy.ID.	ID

Returns:

Type	Description
Response[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]	The response.

Source code in prefect_hightouch/api_client/api/default/list_destination.py

def sync_detailed(
    client: AuthenticatedClient,
    name: Union[Unset, None, str] = UNSET,
    slug: Union[Unset, None, str] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListDestinationOrderBy] = ListDestinationOrderBy.ID,
) -> Response[Union[Any, ListDestinationResponse200, ValidateErrorJSON]]:
    """List Destinations

     List the destinations in the user's workspace

    Args:
        client: An authenticated client.
        name (Union[Unset, None, str]):
        slug (Union[Unset, None, str]):
        limit (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListDestinationOrderBy]):  Default:
            ListDestinationOrderBy.ID.

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        client=client,
        name=name,
        slug=slug,
        limit=limit,
        order_by=order_by,
    )

    response = httpx.request(
        verify=client.verify_ssl,
        **kwargs,
    )

    return _build_response(response=response)