Skip to content

Commit 4be73a9

Browse files
fix(boxsdkgen): update descriptions of the user deletion endpoint (box/box-openapi#562) (#1170)
1 parent 32d6437 commit 4be73a9

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "8cdcb1b", "specHash": "1715587", "version": "4.0.0" }
1+
{ "engineHash": "7c94f4f", "specHash": "a646ae6", "version": "4.0.0" }

box_sdk_gen/managers/users.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -653,12 +653,12 @@ def delete_user_by_id(
653653
extra_headers: Optional[Dict[str, Optional[str]]] = None
654654
) -> None:
655655
"""
656-
Deletes a user. By default this will fail if the user
656+
Deletes a user. By default, this operation fails if the user
657657
658-
still owns any content. Move their owned content first
658+
still owns any content, was recently active, or recently joined the enterprise from a free account.
659659
660660
661-
before proceeding, or use the `force` field to delete
661+
To proceed, move their owned content first, or use the `force` parameter to delete
662662
663663
664664
the user and their files.
@@ -669,8 +669,8 @@ def delete_user_by_id(
669669
:param notify: Whether the user will receive email notification of
670670
the deletion., defaults to None
671671
:type notify: Optional[bool], optional
672-
:param force: Whether the user should be deleted even if this user
673-
still own files., defaults to None
672+
:param force: Specifies whether to delete the user even if they still own files,
673+
were recently active, or recently joined the enterprise from a free account., defaults to None
674674
:type force: Optional[bool], optional
675675
:param extra_headers: Extra headers that will be included in the HTTP request., defaults to None
676676
:type extra_headers: Optional[Dict[str, Optional[str]]], optional

docs/box_sdk_gen/users.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,9 +278,9 @@ Returns the updated user object.
278278

279279
## Delete user
280280

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

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

0 commit comments

Comments
 (0)