cyphermed.api.groups.delete_group_by_id

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

Delete Group By Id

Delete a group by ID

Args: group_id (str): permanent (Union[Unset, bool]): If true, the group will be permanently deleted 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( group_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = None, force: Optional[bool] = None) -> Optional[cyphermed.models.success.Success]:

Delete Group By Id

Delete a group by ID

Args: group_id (str): permanent (Union[Unset, bool]): If true, the group will be permanently deleted 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( group_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = None, force: Optional[bool] = None) -> cyphermed.types.Response[cyphermed.models.success.Success]:

Delete Group By Id

Delete a group by ID

Args: group_id (str): permanent (Union[Unset, bool]): If true, the group will be permanently deleted 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( group_id: str, *, client: cyphermed.client.AuthenticatedClient, permanent: Optional[bool] = None, force: Optional[bool] = None) -> Optional[cyphermed.models.success.Success]:

Delete Group By Id

Delete a group by ID

Args: group_id (str): permanent (Union[Unset, bool]): If true, the group will be permanently deleted 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