Skip to content

Commit 73fdcd7

Browse files
fix: update descriptions of the user deletion endpoint (box/box-openapi#562) (#1234)
1 parent 3b2f1da commit 73fdcd7

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
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.0.1" }
1+
{ "engineHash": "7c94f4f", "specHash": "a646ae6", "version": "10.0.1" }

BoxSdkGen/Sources/Managers/Users/DeleteUserByIdQueryParams.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ public class DeleteUserByIdQueryParams {
55
/// the deletion.
66
public let notify: Bool?
77

8-
/// Whether the user should be deleted even if this user
9-
/// still own files.
8+
/// Specifies whether to delete the user even if they still own files,
9+
/// were recently active, or recently joined the enterprise from a free account.
1010
public let force: Bool?
1111

1212
/// Initializer for a DeleteUserByIdQueryParams.
1313
///
1414
/// - Parameters:
1515
/// - notify: Whether the user will receive email notification of
1616
/// the deletion.
17-
/// - force: Whether the user should be deleted even if this user
18-
/// still own files.
17+
/// - force: Specifies whether to delete the user even if they still own files,
18+
/// were recently active, or recently joined the enterprise from a free account.
1919
public init(notify: Bool? = nil, force: Bool? = nil) {
2020
self.notify = notify
2121
self.force = force

BoxSdkGen/Sources/Managers/Users/UsersManager.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ public class UsersManager {
114114
return try UserFull.deserialize(from: response.data!)
115115
}
116116

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

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`.

0 commit comments

Comments
 (0)