Skip to content

Commit e24782e

Browse files
docs: update descriptions of the user deletion endpoint (box/box-openapi#562) (#1170)
1 parent 6fc234c commit e24782e

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
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" }

docs/users.md

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

190190
## Delete user
191191

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

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

package-lock.json

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/managers/users.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -595,8 +595,8 @@ export interface DeleteUserByIdQueryParams {
595595
* the deletion. */
596596
readonly notify?: boolean;
597597
/**
598-
* Whether the user should be deleted even if this user
599-
* still own files. */
598+
* Specifies whether to delete the user even if they still own files,
599+
* were recently active, or recently joined the enterprise from a free account. */
600600
readonly force?: boolean;
601601
}
602602
export class DeleteUserByIdHeaders {
@@ -933,9 +933,9 @@ export class UsersManager {
933933
};
934934
}
935935
/**
936-
* Deletes a user. By default this will fail if the user
937-
* still owns any content. Move their owned content first
938-
* before proceeding, or use the `force` field to delete
936+
* Deletes a user. By default, this operation fails if the user
937+
* still owns any content, was recently active, or recently joined the enterprise from a free account.
938+
* To proceed, move their owned content first, or use the `force` parameter to delete
939939
* the user and their files.
940940
* @param {string} userId The ID of the user.
941941
Example: "12345"

0 commit comments

Comments
 (0)