Source code for pydelfini.delfini_core.api.auth.auth_signout
"""Displays the built-in/unbranded sign out page."""
from http import HTTPStatus
from typing import Any
from typing import Dict
from typing import Union
import httpx
from ... import errors
from ...client import AuthenticatedClient
from ...client import Client
from ...models.auth_signout_no_data import AuthSignoutNoData
from ...models.server_error import ServerError
from ...types import Response
def _get_kwargs() -> Dict[str, Any]:
_kwargs: Dict[str, Any] = {
"method": "post",
"url": "/auth/signout",
}
return _kwargs
def _parse_response(
*, client: Union[AuthenticatedClient, Client], response: httpx.Response
) -> Union[AuthSignoutNoData, ServerError]:
if response.status_code == HTTPStatus.OK:
response_200 = AuthSignoutNoData.from_dict(response.json())
return response_200
if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
response_500 = ServerError.from_dict(response.json())
return response_500
raise errors.UnexpectedStatus(response.status_code, response.content)
def _build_response(
*, client: Union[AuthenticatedClient, Client], response: httpx.Response
) -> Response[Union[AuthSignoutNoData, ServerError]]:
return Response(
status_code=HTTPStatus(response.status_code),
content=response.content,
headers=response.headers,
parsed=_parse_response(client=client, response=response),
)
[docs]
def sync_detailed(
*,
client: AuthenticatedClient,
) -> Response[Union[AuthSignoutNoData, ServerError]]:
"""Displays the built-in/unbranded sign out page.
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[Union[AuthSignoutNoData, ServerError]]
"""
kwargs = _get_kwargs()
response = client.get_httpx_client().request(
**kwargs,
)
return _build_response(client=client, response=response)
[docs]
def sync(
*,
client: AuthenticatedClient,
) -> Union[AuthSignoutNoData]:
"""Displays the built-in/unbranded sign out page.
Raises:
errors.UnexpectedStatus: If the server returns a status code greater than or equal to 300.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Union[AuthSignoutNoData]
"""
response = sync_detailed(
client=client,
)
if isinstance(response.parsed, ServerError):
raise errors.UnexpectedStatus(response.status_code, response.content)
return response.parsed
[docs]
async def asyncio_detailed(
*,
client: AuthenticatedClient,
) -> Response[Union[AuthSignoutNoData, ServerError]]:
"""Displays the built-in/unbranded sign out page.
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[Union[AuthSignoutNoData, ServerError]]
"""
kwargs = _get_kwargs()
response = await client.get_async_httpx_client().request(**kwargs)
return _build_response(client=client, response=response)
[docs]
async def asyncio(
*,
client: AuthenticatedClient,
) -> Union[AuthSignoutNoData]:
"""Displays the built-in/unbranded sign out page.
Raises:
errors.UnexpectedStatus: If the server returns a status code greater than or equal to 300.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Union[AuthSignoutNoData]
"""
response = await asyncio_detailed(
client=client,
)
if isinstance(response.parsed, ServerError):
raise errors.UnexpectedStatus(response.status_code, response.content)
return response.parsed