qcrboxapiclient.api.interactive_sessions.close_interactive_session¶
- async qcrboxapiclient.api.interactive_sessions.close_interactive_session.asyncio(id, *, client)¶
Close interactive session
Close, potentially prematurely, an interactive session.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Union[QCrBoxErrorResponse,QCrBoxResponseInteractiveSessionClosedResponse,None]- Returns:
Union[QCrBoxErrorResponse, QCrBoxResponseInteractiveSessionClosedResponse]
- async qcrboxapiclient.api.interactive_sessions.close_interactive_session.asyncio_detailed(id, *, client)¶
Close interactive session
Close, potentially prematurely, an interactive session.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Response[Union[QCrBoxErrorResponse,QCrBoxResponseInteractiveSessionClosedResponse]]- Returns:
Response[Union[QCrBoxErrorResponse, QCrBoxResponseInteractiveSessionClosedResponse]]
- qcrboxapiclient.api.interactive_sessions.close_interactive_session.sync(id, *, client)¶
Close interactive session
Close, potentially prematurely, an interactive session.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Union[QCrBoxErrorResponse,QCrBoxResponseInteractiveSessionClosedResponse,None]- Returns:
Union[QCrBoxErrorResponse, QCrBoxResponseInteractiveSessionClosedResponse]
- qcrboxapiclient.api.interactive_sessions.close_interactive_session.sync_detailed(id, *, client)¶
Close interactive session
Close, potentially prematurely, an interactive session.
- Parameters:
id (str)
client (AuthenticatedClient | Client)
- 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.
- Return type:
Response[Union[QCrBoxErrorResponse,QCrBoxResponseInteractiveSessionClosedResponse]]- Returns:
Response[Union[QCrBoxErrorResponse, QCrBoxResponseInteractiveSessionClosedResponse]]