auth_new_session

Create a new placeholder session ID

Functions

async pydelfini.delfini_core.api.auth.auth_new_session.asyncio(*, client)[source]

Create a new placeholder session ID

This is used to create an empty session that can later be activated using an active session.

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

Parameters:

client (AuthenticatedClient | Client)

Return type:

SessionToken

async pydelfini.delfini_core.api.auth.auth_new_session.asyncio_detailed(*, client)[source]

Create a new placeholder session ID

This is used to create an empty session that can later be activated using an active session.

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[ServerError, SessionToken]]

Parameters:

client (AuthenticatedClient | Client)

Return type:

Response[ServerError | SessionToken]

pydelfini.delfini_core.api.auth.auth_new_session.sync(*, client)[source]

Create a new placeholder session ID

This is used to create an empty session that can later be activated using an active session.

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

Parameters:

client (AuthenticatedClient | Client)

Return type:

SessionToken

pydelfini.delfini_core.api.auth.auth_new_session.sync_detailed(*, client)[source]

Create a new placeholder session ID

This is used to create an empty session that can later be activated using an active session.

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[ServerError, SessionToken]]

Parameters:

client (AuthenticatedClient | Client)

Return type:

Response[ServerError | SessionToken]