Skip to content

Commit 590ee99

Browse files
fix: update descriptions of the user deletion endpoint (box/box-openapi#562) (#1549)
1 parent 6af720a commit 590ee99

File tree

4 files changed

+20
-13
lines changed

4 files changed

+20
-13
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": "10.1.0" }
1+
{ "engineHash": "7c94f4f", "specHash": "a646ae6", "version": "10.1.0" }

docs/users.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,9 @@ Returns the updated user object.
196196

197197
## Delete user
198198

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

204204
This operation is performed by calling function `deleteUserById`.

src/main/java/com/box/sdkgen/managers/users/DeleteUserByIdQueryParams.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ public class DeleteUserByIdQueryParams {
55
/** Whether the user will receive email notification of the deletion. */
66
public Boolean notify;
77

8-
/** Whether the user should be deleted even if this user still own files. */
8+
/**
9+
* Specifies whether to delete the user even if they still own files, were recently active, or
10+
* recently joined the enterprise from a free account.
11+
*/
912
public Boolean force;
1013

1114
public DeleteUserByIdQueryParams() {}

src/main/java/com/box/sdkgen/managers/users/UsersManager.java

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -477,8 +477,9 @@ public UserFull updateUserById(
477477
}
478478

479479
/**
480-
* Deletes a user. By default this will fail if the user still owns any content. Move their owned
481-
* content first before proceeding, or use the `force` field to delete the user and their files.
480+
* Deletes a user. By default, this operation fails if the user still owns any content, was
481+
* recently active, or recently joined the enterprise from a free account. To proceed, move their
482+
* owned content first, or use the `force` parameter to delete the user and their files.
482483
*
483484
* @param userId The ID of the user. Example: "12345"
484485
*/
@@ -487,8 +488,9 @@ public void deleteUserById(String userId) {
487488
}
488489

489490
/**
490-
* Deletes a user. By default this will fail if the user still owns any content. Move their owned
491-
* content first before proceeding, or use the `force` field to delete the user and their files.
491+
* Deletes a user. By default, this operation fails if the user still owns any content, was
492+
* recently active, or recently joined the enterprise from a free account. To proceed, move their
493+
* owned content first, or use the `force` parameter to delete the user and their files.
492494
*
493495
* @param userId The ID of the user. Example: "12345"
494496
* @param queryParams Query parameters of deleteUserById method
@@ -498,8 +500,9 @@ public void deleteUserById(String userId, DeleteUserByIdQueryParams queryParams)
498500
}
499501

500502
/**
501-
* Deletes a user. By default this will fail if the user still owns any content. Move their owned
502-
* content first before proceeding, or use the `force` field to delete the user and their files.
503+
* Deletes a user. By default, this operation fails if the user still owns any content, was
504+
* recently active, or recently joined the enterprise from a free account. To proceed, move their
505+
* owned content first, or use the `force` parameter to delete the user and their files.
503506
*
504507
* @param userId The ID of the user. Example: "12345"
505508
* @param headers Headers of deleteUserById method
@@ -509,8 +512,9 @@ public void deleteUserById(String userId, DeleteUserByIdHeaders headers) {
509512
}
510513

511514
/**
512-
* Deletes a user. By default this will fail if the user still owns any content. Move their owned
513-
* content first before proceeding, or use the `force` field to delete the user and their files.
515+
* Deletes a user. By default, this operation fails if the user still owns any content, was
516+
* recently active, or recently joined the enterprise from a free account. To proceed, move their
517+
* owned content first, or use the `force` parameter to delete the user and their files.
514518
*
515519
* @param userId The ID of the user. Example: "12345"
516520
* @param queryParams Query parameters of deleteUserById method

0 commit comments

Comments
 (0)