Skip to content

incident_io_client.api.follow_ups_v2.follow_ups_v2_list

asyncio async

asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[
        Unset, FollowUpsV2ListIncidentMode
    ] = UNSET
) -> Optional[FollowUpsV2ListResponseBody]

List Follow-ups V2

List all follow-ups for an organisation.

Parameters:

Name Type Description Default
incident_id Union[Unset, str]
UNSET
incident_mode Union[Unset, FollowUpsV2ListIncidentMode]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[FollowUpsV2ListResponseBody]

FollowUpsV2ListResponseBody

Source code in incident_io_client/api/follow_ups_v2/follow_ups_v2_list.py
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[Unset, FollowUpsV2ListIncidentMode] = UNSET,
) -> Optional[FollowUpsV2ListResponseBody]:
    """List Follow-ups V2

     List all follow-ups for an organisation.

    Args:
        incident_id (Union[Unset, str]):
        incident_mode (Union[Unset, FollowUpsV2ListIncidentMode]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        FollowUpsV2ListResponseBody
    """

    return (
        await asyncio_detailed(
            client=client,
            incident_id=incident_id,
            incident_mode=incident_mode,
        )
    ).parsed

asyncio_detailed async

asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[
        Unset, FollowUpsV2ListIncidentMode
    ] = UNSET
) -> Response[FollowUpsV2ListResponseBody]

List Follow-ups V2

List all follow-ups for an organisation.

Parameters:

Name Type Description Default
incident_id Union[Unset, str]
UNSET
incident_mode Union[Unset, FollowUpsV2ListIncidentMode]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[FollowUpsV2ListResponseBody]

Response[FollowUpsV2ListResponseBody]

Source code in incident_io_client/api/follow_ups_v2/follow_ups_v2_list.py
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[Unset, FollowUpsV2ListIncidentMode] = UNSET,
) -> Response[FollowUpsV2ListResponseBody]:
    """List Follow-ups V2

     List all follow-ups for an organisation.

    Args:
        incident_id (Union[Unset, str]):
        incident_mode (Union[Unset, FollowUpsV2ListIncidentMode]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[FollowUpsV2ListResponseBody]
    """

    kwargs = _get_kwargs(
        incident_id=incident_id,
        incident_mode=incident_mode,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync

sync(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[
        Unset, FollowUpsV2ListIncidentMode
    ] = UNSET
) -> Optional[FollowUpsV2ListResponseBody]

List Follow-ups V2

List all follow-ups for an organisation.

Parameters:

Name Type Description Default
incident_id Union[Unset, str]
UNSET
incident_mode Union[Unset, FollowUpsV2ListIncidentMode]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[FollowUpsV2ListResponseBody]

FollowUpsV2ListResponseBody

Source code in incident_io_client/api/follow_ups_v2/follow_ups_v2_list.py
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[Unset, FollowUpsV2ListIncidentMode] = UNSET,
) -> Optional[FollowUpsV2ListResponseBody]:
    """List Follow-ups V2

     List all follow-ups for an organisation.

    Args:
        incident_id (Union[Unset, str]):
        incident_mode (Union[Unset, FollowUpsV2ListIncidentMode]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        FollowUpsV2ListResponseBody
    """

    return sync_detailed(
        client=client,
        incident_id=incident_id,
        incident_mode=incident_mode,
    ).parsed

sync_detailed

sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[
        Unset, FollowUpsV2ListIncidentMode
    ] = UNSET
) -> Response[FollowUpsV2ListResponseBody]

List Follow-ups V2

List all follow-ups for an organisation.

Parameters:

Name Type Description Default
incident_id Union[Unset, str]
UNSET
incident_mode Union[Unset, FollowUpsV2ListIncidentMode]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[FollowUpsV2ListResponseBody]

Response[FollowUpsV2ListResponseBody]

Source code in incident_io_client/api/follow_ups_v2/follow_ups_v2_list.py
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    incident_id: Union[Unset, str] = UNSET,
    incident_mode: Union[Unset, FollowUpsV2ListIncidentMode] = UNSET,
) -> Response[FollowUpsV2ListResponseBody]:
    """List Follow-ups V2

     List all follow-ups for an organisation.

    Args:
        incident_id (Union[Unset, str]):
        incident_mode (Union[Unset, FollowUpsV2ListIncidentMode]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[FollowUpsV2ListResponseBody]
    """

    kwargs = _get_kwargs(
        incident_id=incident_id,
        incident_mode=incident_mode,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)