qcrboxapiclient.api.commands.list_commands

async qcrboxapiclient.api.commands.list_commands.asyncio(*, client)

List all commands

Retrieve a list of commands, which are registered to applications.

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]

Parameters:

client (AuthenticatedClient | Client)

async qcrboxapiclient.api.commands.list_commands.asyncio_detailed(*, client)

List all commands

Retrieve a list of commands, which are registered to applications.

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

Parameters:

client (AuthenticatedClient | Client)

qcrboxapiclient.api.commands.list_commands.sync(*, client)

List all commands

Retrieve a list of commands, which are registered to applications.

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]

Parameters:

client (AuthenticatedClient | Client)

qcrboxapiclient.api.commands.list_commands.sync_detailed(*, client)

List all commands

Retrieve a list of commands, which are registered to applications.

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

Parameters:

client (AuthenticatedClient | Client)