Skip to content

incident_io_client.api.incident_roles_v2.incident_roles_v2_delete

asyncio_detailed async

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

Delete Incident Roles V2

Removes an existing role

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

Response[Any]

Source code in incident_io_client/api/incident_roles_v2/incident_roles_v2_delete.py
async def asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete Incident Roles V2

     Removes an existing role

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

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)

sync_detailed

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

Delete Incident Roles V2

Removes an existing role

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

Response[Any]

Source code in incident_io_client/api/incident_roles_v2/incident_roles_v2_delete.py
def sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[Any]:
    """Delete Incident Roles V2

     Removes an existing role

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

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)