Skip to content

prefect_hightouch.api_client.api.default.list_sync_runs

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 Sync Runs

List all sync runs under a sync

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

 required
sync_id float
required
run_id Union[Unset, None, float]
UNSET
limit Union[Unset, None, float]
UNSET
offset Union[Unset, None, float]
UNSET
after Union[Unset, None, datetime]
UNSET
before Union[Unset, None, datetime]
UNSET
within Union[Unset, None, float]
UNSET
order_by Union[Unset, None, ListSyncRunsOrderBy]
ID

Returns:

Type Description
Optional[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]

The parsed response.
Source code in prefect_hightouch/api_client/api/default/list_sync_runs.py 
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
async def asyncio(
    client: AuthenticatedClient,
    sync_id: float,
    run_id: Union[Unset, None, float] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    offset: Union[Unset, None, float] = UNSET,
    after: Union[Unset, None, datetime.datetime] = UNSET,
    before: Union[Unset, None, datetime.datetime] = UNSET,
    within: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListSyncRunsOrderBy] = ListSyncRunsOrderBy.ID,
) -> Optional[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]:
    """List Sync Runs

     List all sync runs under a sync

    Args:
        client: An authenticated client.
        sync_id (float):
        run_id (Union[Unset, None, float]):
        limit (Union[Unset, None, float]):
        offset (Union[Unset, None, float]):
        after (Union[Unset, None, datetime.datetime]):
        before (Union[Unset, None, datetime.datetime]):
        within (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListSyncRunsOrderBy]):  Default: ListSyncRunsOrderBy.ID.

    Returns:
        The parsed response.
    """

    return (
        await asyncio_detailed(
            sync_id=sync_id,
            client=client,
            run_id=run_id,
            limit=limit,
            offset=offset,
            after=after,
            before=before,
            within=within,
            order_by=order_by,
        )
    ).parsed

asyncio_detailed async

List Sync Runs

List all sync runs under a sync

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

 required
sync_id float
required
run_id Union[Unset, None, float]
UNSET
limit Union[Unset, None, float]
UNSET
offset Union[Unset, None, float]
UNSET
after Union[Unset, None, datetime]
UNSET
before Union[Unset, None, datetime]
UNSET
within Union[Unset, None, float]
UNSET
order_by Union[Unset, None, ListSyncRunsOrderBy]
ID

Returns:

Type Description
Response[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]

The response.
Source code in prefect_hightouch/api_client/api/default/list_sync_runs.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
async def asyncio_detailed(
    client: AuthenticatedClient,
    sync_id: float,
    run_id: Union[Unset, None, float] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    offset: Union[Unset, None, float] = UNSET,
    after: Union[Unset, None, datetime.datetime] = UNSET,
    before: Union[Unset, None, datetime.datetime] = UNSET,
    within: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListSyncRunsOrderBy] = ListSyncRunsOrderBy.ID,
) -> Response[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]:
    """List Sync Runs

     List all sync runs under a sync

    Args:
        client: An authenticated client.
        sync_id (float):
        run_id (Union[Unset, None, float]):
        limit (Union[Unset, None, float]):
        offset (Union[Unset, None, float]):
        after (Union[Unset, None, datetime.datetime]):
        before (Union[Unset, None, datetime.datetime]):
        within (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListSyncRunsOrderBy]):  Default: ListSyncRunsOrderBy.ID.

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        sync_id=sync_id,
        client=client,
        run_id=run_id,
        limit=limit,
        offset=offset,
        after=after,
        before=before,
        within=within,
        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 Sync Runs

List all sync runs under a sync

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

 required
sync_id float
required
run_id Union[Unset, None, float]
UNSET
limit Union[Unset, None, float]
UNSET
offset Union[Unset, None, float]
UNSET
after Union[Unset, None, datetime]
UNSET
before Union[Unset, None, datetime]
UNSET
within Union[Unset, None, float]
UNSET
order_by Union[Unset, None, ListSyncRunsOrderBy]
ID

Returns:

Type Description
Optional[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]

The parsed response.
Source code in prefect_hightouch/api_client/api/default/list_sync_runs.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def sync(
    client: AuthenticatedClient,
    sync_id: float,
    run_id: Union[Unset, None, float] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    offset: Union[Unset, None, float] = UNSET,
    after: Union[Unset, None, datetime.datetime] = UNSET,
    before: Union[Unset, None, datetime.datetime] = UNSET,
    within: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListSyncRunsOrderBy] = ListSyncRunsOrderBy.ID,
) -> Optional[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]:
    """List Sync Runs

     List all sync runs under a sync

    Args:
        client: An authenticated client.
        sync_id (float):
        run_id (Union[Unset, None, float]):
        limit (Union[Unset, None, float]):
        offset (Union[Unset, None, float]):
        after (Union[Unset, None, datetime.datetime]):
        before (Union[Unset, None, datetime.datetime]):
        within (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListSyncRunsOrderBy]):  Default: ListSyncRunsOrderBy.ID.

    Returns:
        The parsed response.
    """

    return sync_detailed(
        sync_id=sync_id,
        client=client,
        run_id=run_id,
        limit=limit,
        offset=offset,
        after=after,
        before=before,
        within=within,
        order_by=order_by,
    ).parsed

sync_detailed

List Sync Runs

List all sync runs under a sync

Parameters:

Name Type Description Default
client AuthenticatedClient

An authenticated client.

 required
sync_id float
required
run_id Union[Unset, None, float]
UNSET
limit Union[Unset, None, float]
UNSET
offset Union[Unset, None, float]
UNSET
after Union[Unset, None, datetime]
UNSET
before Union[Unset, None, datetime]
UNSET
within Union[Unset, None, float]
UNSET
order_by Union[Unset, None, ListSyncRunsOrderBy]
ID

Returns:

Type Description
Response[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]

The response.
Source code in prefect_hightouch/api_client/api/default/list_sync_runs.py 
129
130
131
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def sync_detailed(
    client: AuthenticatedClient,
    sync_id: float,
    run_id: Union[Unset, None, float] = UNSET,
    limit: Union[Unset, None, float] = UNSET,
    offset: Union[Unset, None, float] = UNSET,
    after: Union[Unset, None, datetime.datetime] = UNSET,
    before: Union[Unset, None, datetime.datetime] = UNSET,
    within: Union[Unset, None, float] = UNSET,
    order_by: Union[Unset, None, ListSyncRunsOrderBy] = ListSyncRunsOrderBy.ID,
) -> Response[Union[Any, ListSyncRunsResponse200, ValidateErrorJSON]]:
    """List Sync Runs

     List all sync runs under a sync

    Args:
        client: An authenticated client.
        sync_id (float):
        run_id (Union[Unset, None, float]):
        limit (Union[Unset, None, float]):
        offset (Union[Unset, None, float]):
        after (Union[Unset, None, datetime.datetime]):
        before (Union[Unset, None, datetime.datetime]):
        within (Union[Unset, None, float]):
        order_by (Union[Unset, None, ListSyncRunsOrderBy]):  Default: ListSyncRunsOrderBy.ID.

    Returns:
        The response.
    """

    kwargs = _get_kwargs(
        sync_id=sync_id,
        client=client,
        run_id=run_id,
        limit=limit,
        offset=offset,
        after=after,
        before=before,
        within=within,
        order_by=order_by,
    )

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

    return _build_response(response=response)