Skip to content

prefect_hightouch.api_client.api.default.get_model

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

Get Model

Retrieve models from model ID

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

required
model_id float
required

Returns:

Type Description
Optional[Union[Any, Model]]

The parsed response.

Source code in prefect_hightouch/api_client/api/default/get_model.py
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
async def asyncio(
    client: AuthenticatedClient,
    model_id: float,
) -> Optional[Union[Any, Model]]:
    """Get Model

     Retrieve models from model ID

    Args:
        client: An authenticated client.
        model_id (float):

    Returns:
        The parsed response.
    """

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

asyncio_detailed async

Get Model

Retrieve models from model ID

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

required
model_id float
required

Returns:

Type Description
Response[Union[Any, Model]]

The response.

Source code in prefect_hightouch/api_client/api/default/get_model.py
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
async def asyncio_detailed(
    client: AuthenticatedClient,
    model_id: float,
) -> Response[Union[Any, Model]]:
    """Get Model

     Retrieve models from model ID

    Args:
        client: An authenticated client.
        model_id (float):

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        model_id=model_id,
        client=client,
    )

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

    return _build_response(response=response)

sync

Get Model

Retrieve models from model ID

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

required
model_id float
required

Returns:

Type Description
Optional[Union[Any, Model]]

The parsed response.

Source code in prefect_hightouch/api_client/api/default/get_model.py
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def sync(
    client: AuthenticatedClient,
    model_id: float,
) -> Optional[Union[Any, Model]]:
    """Get Model

     Retrieve models from model ID

    Args:
        client: An authenticated client.
        model_id (float):

    Returns:
        The parsed response.
    """

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

sync_detailed

Get Model

Retrieve models from model ID

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

required
model_id float
required

Returns:

Type Description
Response[Union[Any, Model]]

The response.

Source code in prefect_hightouch/api_client/api/default/get_model.py
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def sync_detailed(
    client: AuthenticatedClient,
    model_id: float,
) -> Response[Union[Any, Model]]:
    """Get Model

     Retrieve models from model ID

    Args:
        client: An authenticated client.
        model_id (float):

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        model_id=model_id,
        client=client,
    )

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

    return _build_response(response=response)