cyphermed.api.devices.delete_device_by_id

def sync_detailed( device_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = False, force: Optional[bool] = None) -> cyphermed.types.Response[cyphermed.models.success.Success]:

Delete Device By Id

Delete a device by ID

Args: device_id (str): permanent (Union[Unset, bool]): Permanently deletes the device instead of just deactivating Default: False. force (Union[Unset, bool]): (Admin only) Delete even if it is protected

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

def sync( device_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = False, force: Optional[bool] = None) -> Optional[cyphermed.models.success.Success]:

Delete Device By Id

Delete a device by ID

Args: device_id (str): permanent (Union[Unset, bool]): Permanently deletes the device instead of just deactivating Default: False. force (Union[Unset, bool]): (Admin only) Delete even if it is protected

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: Success

async def asyncio_detailed( device_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = False, force: Optional[bool] = None) -> cyphermed.types.Response[cyphermed.models.success.Success]:

Delete Device By Id

Delete a device by ID

Args: device_id (str): permanent (Union[Unset, bool]): Permanently deletes the device instead of just deactivating Default: False. force (Union[Unset, bool]): (Admin only) Delete even if it is protected

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

async def asyncio( device_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = False, force: Optional[bool] = None) -> Optional[cyphermed.models.success.Success]:

Delete Device By Id

Delete a device by ID

Args: device_id (str): permanent (Union[Unset, bool]): Permanently deletes the device instead of just deactivating Default: False. force (Union[Unset, bool]): (Admin only) Delete even if it is protected

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: Success