qcrboxapiclient.api.commands.invoke_command

async qcrboxapiclient.api.commands.invoke_command.asyncio(*, client, body)

Invoke a command with arguments

Create an interactive session with the provided arguments.

Parameters:

  • body (InvokeCommandParameters)

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

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseInvokeCommandResponse]

async qcrboxapiclient.api.commands.invoke_command.asyncio_detailed(*, client, body)

Invoke a command with arguments

Create an interactive session with the provided arguments.

Parameters:

  • body (InvokeCommandParameters)

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

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseInvokeCommandResponse]]

qcrboxapiclient.api.commands.invoke_command.sync(*, client, body)

Invoke a command with arguments

Create an interactive session with the provided arguments.

Parameters:

  • body (InvokeCommandParameters)

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

Returns:

Union[QCrBoxErrorResponse, QCrBoxResponseInvokeCommandResponse]

qcrboxapiclient.api.commands.invoke_command.sync_detailed(*, client, body)

Invoke a command with arguments

Create an interactive session with the provided arguments.

Parameters:

  • body (InvokeCommandParameters)

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

Returns:

Response[Union[QCrBoxErrorResponse, QCrBoxResponseInvokeCommandResponse]]