qcrboxapiclient.api.commands.get_command_by_id

async qcrboxapiclient.api.commands.get_command_by_id.asyncio(id, *, client)

Get command by ID

Retrieve a command of the given ID.

Parameters:

  • id (int)

  • 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, QCrBoxResponseCommandsResponse, None]

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseCommandsResponse]

async qcrboxapiclient.api.commands.get_command_by_id.asyncio_detailed(id, *, client)

Get command by ID

Retrieve a command of the given ID.

Parameters:

  • id (int)

  • 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, QCrBoxResponseCommandsResponse]]

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseCommandsResponse]]

qcrboxapiclient.api.commands.get_command_by_id.sync(id, *, client)

Get command by ID

Retrieve a command of the given ID.

Parameters:

  • id (int)

  • 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, QCrBoxResponseCommandsResponse, None]

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseCommandsResponse]

qcrboxapiclient.api.commands.get_command_by_id.sync_detailed(id, *, client)

Get command by ID

Retrieve a command of the given ID.

Parameters:

  • id (int)

  • 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, QCrBoxResponseCommandsResponse]]

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseCommandsResponse]]