Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .codegen.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "8cdcb1b", "specHash": "1715587", "version": "10.0.1" }
{ "engineHash": "7c94f4f", "specHash": "a646ae6", "version": "10.0.1" }
10 changes: 5 additions & 5 deletions box_sdk_gen/managers/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -653,12 +653,12 @@ def delete_user_by_id(
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> None:
"""
Deletes a user. By default this will fail if the user
Deletes a user. By default, this operation fails if the user

still owns any content. Move their owned content first
still owns any content, was recently active, or recently joined the enterprise from a free account.


before proceeding, or use the `force` field to delete
To proceed, move their owned content first, or use the `force` parameter to delete


the user and their files.
Expand All @@ -669,8 +669,8 @@ def delete_user_by_id(
:param notify: Whether the user will receive email notification of
the deletion., defaults to None
:type notify: Optional[bool], optional
:param force: Whether the user should be deleted even if this user
still own files., defaults to None
:param force: Specifies whether to delete the user even if they still own files,
were recently active, or recently joined the enterprise from a free account., defaults to None
:type force: Optional[bool], optional
:param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
:type extra_headers: Optional[Dict[str, Optional[str]]], optional
Expand Down
8 changes: 4 additions & 4 deletions docs/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,9 +278,9 @@ Returns the updated user object.

## Delete user

Deletes a user. By default this will fail if the user
still owns any content. Move their owned content first
before proceeding, or use the `force` field to delete
Deletes a user. By default, this operation fails if the user
still owns any content, was recently active, or recently joined the enterprise from a free account.
To proceed, move their owned content first, or use the `force` parameter to delete
the user and their files.

This operation is performed by calling function `delete_user_by_id`.
Expand All @@ -301,7 +301,7 @@ client.users.delete_user_by_id(user.id)
- notify `Optional[bool]`
- Whether the user will receive email notification of the deletion.
- force `Optional[bool]`
- Whether the user should be deleted even if this user still own files.
- Specifies whether to delete the user even if they still own files, were recently active, or recently joined the enterprise from a free account.
- extra_headers `Optional[Dict[str, Optional[str]]]`
- Extra headers that will be included in the HTTP request.

Expand Down