prefect_hightouch.api_client.api.default.trigger_run_custom

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

Trigger Sync From ID or Slug

Trigger a new run globally based on sync id or sync slug

If a run is already in progress, this queues a sync run that will get executed immediately after the current run completes.

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
json_body	TriggerRunCustomInput	The input of a trigger action to run syncs based on sync ID, slug or other filters	required

Returns:

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

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

async def asyncio(
    client: AuthenticatedClient,
    json_body: TriggerRunCustomInput,
) -> Optional[
    Union[Any, Union[TriggerRunOutput, ValidateErrorJSON], ValidateErrorJSON]
]:
    """Trigger Sync From ID or Slug

     Trigger a new run globally based on sync id or sync slug

    If a run is already in progress, this queues a sync run that will get
    executed immediately after the current run completes.

    Args:
        client: An authenticated client.
        json_body (TriggerRunCustomInput): The input of a trigger action to run syncs based on
            sync ID, slug or other filters

    Returns:
        The parsed response.
    """

    return (
        await asyncio_detailed(
            client=client,
            json_body=json_body,
        )
    ).parsed

asyncio_detailed async

Trigger Sync From ID or Slug

Trigger a new run globally based on sync id or sync slug

If a run is already in progress, this queues a sync run that will get executed immediately after the current run completes.

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
json_body	TriggerRunCustomInput	The input of a trigger action to run syncs based on sync ID, slug or other filters	required

Returns:

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

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

async def asyncio_detailed(
    client: AuthenticatedClient,
    json_body: TriggerRunCustomInput,
) -> Response[
    Union[Any, Union[TriggerRunOutput, ValidateErrorJSON], ValidateErrorJSON]
]:
    """Trigger Sync From ID or Slug

     Trigger a new run globally based on sync id or sync slug

    If a run is already in progress, this queues a sync run that will get
    executed immediately after the current run completes.

    Args:
        client: An authenticated client.
        json_body (TriggerRunCustomInput): The input of a trigger action to run syncs based on
            sync ID, slug or other filters

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        client=client,
        json_body=json_body,
    )

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

    return _build_response(response=response)

sync

Trigger Sync From ID or Slug

Trigger a new run globally based on sync id or sync slug

If a run is already in progress, this queues a sync run that will get executed immediately after the current run completes.

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
json_body	TriggerRunCustomInput	The input of a trigger action to run syncs based on sync ID, slug or other filters	required

Returns:

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

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

def sync(
    client: AuthenticatedClient,
    json_body: TriggerRunCustomInput,
) -> Optional[
    Union[Any, Union[TriggerRunOutput, ValidateErrorJSON], ValidateErrorJSON]
]:
    """Trigger Sync From ID or Slug

     Trigger a new run globally based on sync id or sync slug

    If a run is already in progress, this queues a sync run that will get
    executed immediately after the current run completes.

    Args:
        client: An authenticated client.
        json_body (TriggerRunCustomInput): The input of a trigger action to run syncs based on
            sync ID, slug or other filters

    Returns:
        The parsed response.
    """

    return sync_detailed(
        client=client,
        json_body=json_body,
    ).parsed

sync_detailed

Trigger Sync From ID or Slug

Trigger a new run globally based on sync id or sync slug

If a run is already in progress, this queues a sync run that will get executed immediately after the current run completes.

Parameters:

Name	Type	Description	Default
client	AuthenticatedClient	An authenticated client.	required
json_body	TriggerRunCustomInput	The input of a trigger action to run syncs based on sync ID, slug or other filters	required

Returns:

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

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

def sync_detailed(
    client: AuthenticatedClient,
    json_body: TriggerRunCustomInput,
) -> Response[
    Union[Any, Union[TriggerRunOutput, ValidateErrorJSON], ValidateErrorJSON]
]:
    """Trigger Sync From ID or Slug

     Trigger a new run globally based on sync id or sync slug

    If a run is already in progress, this queues a sync run that will get
    executed immediately after the current run completes.

    Args:
        client: An authenticated client.
        json_body (TriggerRunCustomInput): The input of a trigger action to run syncs based on
            sync ID, slug or other filters

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        client=client,
        json_body=json_body,
    )

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

    return _build_response(response=response)