Skip to content

incident_io_client.api.escalations_v2.escalations_v2_show_path

asyncio async

asyncio(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Optional[EscalationsV2ShowPathResponseBody]

ShowPath Escalations V2

Show an escalation path.

We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.

Parameters:

Name Type Description Default
id str
required

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[EscalationsV2ShowPathResponseBody]

EscalationsV2ShowPathResponseBody

Source code in incident_io_client/api/escalations_v2/escalations_v2_show_path.py
async def asyncio(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[EscalationsV2ShowPathResponseBody]:
    """ShowPath Escalations V2

     Show an escalation path.

    We recommend you create escalation paths in the incident.io dashboard where our path
    builder makes it easy to use conditions and visualise the path.

    Args:
        id (str):

    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:
        EscalationsV2ShowPathResponseBody
    """

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

asyncio_detailed async

asyncio_detailed(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Response[EscalationsV2ShowPathResponseBody]

ShowPath Escalations V2

Show an escalation path.

We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.

Parameters:

Name Type Description Default
id str
required

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[EscalationsV2ShowPathResponseBody]

Response[EscalationsV2ShowPathResponseBody]

Source code in incident_io_client/api/escalations_v2/escalations_v2_show_path.py
async def asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[EscalationsV2ShowPathResponseBody]:
    """ShowPath Escalations V2

     Show an escalation path.

    We recommend you create escalation paths in the incident.io dashboard where our path
    builder makes it easy to use conditions and visualise the path.

    Args:
        id (str):

    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[EscalationsV2ShowPathResponseBody]
    """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)

sync

sync(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Optional[EscalationsV2ShowPathResponseBody]

ShowPath Escalations V2

Show an escalation path.

We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.

Parameters:

Name Type Description Default
id str
required

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[EscalationsV2ShowPathResponseBody]

EscalationsV2ShowPathResponseBody

Source code in incident_io_client/api/escalations_v2/escalations_v2_show_path.py
def sync(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[EscalationsV2ShowPathResponseBody]:
    """ShowPath Escalations V2

     Show an escalation path.

    We recommend you create escalation paths in the incident.io dashboard where our path
    builder makes it easy to use conditions and visualise the path.

    Args:
        id (str):

    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:
        EscalationsV2ShowPathResponseBody
    """

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

sync_detailed

sync_detailed(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Response[EscalationsV2ShowPathResponseBody]

ShowPath Escalations V2

Show an escalation path.

We recommend you create escalation paths in the incident.io dashboard where our path builder makes it easy to use conditions and visualise the path.

Parameters:

Name Type Description Default
id str
required

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[EscalationsV2ShowPathResponseBody]

Response[EscalationsV2ShowPathResponseBody]

Source code in incident_io_client/api/escalations_v2/escalations_v2_show_path.py
def sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[EscalationsV2ShowPathResponseBody]:
    """ShowPath Escalations V2

     Show an escalation path.

    We recommend you create escalation paths in the incident.io dashboard where our path
    builder makes it easy to use conditions and visualise the path.

    Args:
        id (str):

    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[EscalationsV2ShowPathResponseBody]
    """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)