From d537f4e2692547899d76b9deaa5855683315d566 Mon Sep 17 00:00:00 2001 From: GitHub Bot Date: Tue, 10 Feb 2026 14:00:05 +0000 Subject: [PATCH] docs(v1.8.3): update markdown docs --- docs/stream-cli_chat.md | 1 - docs/stream-cli_chat_delete-user.md | 59 --------------------- docs/stream-cli_chat_upload-import.md | 7 +-- docs/stream-cli_chat_upsert-pushprovider.md | 6 +-- 4 files changed, 7 insertions(+), 66 deletions(-) delete mode 100644 docs/stream-cli_chat_delete-user.md diff --git a/docs/stream-cli_chat.md b/docs/stream-cli_chat.md index 37b6e7e2..783af2d7 100644 --- a/docs/stream-cli_chat.md +++ b/docs/stream-cli_chat.md @@ -77,6 +77,5 @@ Allows you to interact with your Chat applications * [stream-cli chat upload-import](stream-cli_chat_upload-import.md) - Upload an import * [stream-cli chat upsert-pushprovider](stream-cli_chat_upsert-pushprovider.md) - Create or updates a push provider * [stream-cli chat upsert-user](stream-cli_chat_upsert-user.md) - Upsert a user -* [stream-cli chat validate-import](stream-cli_chat_validate-import.md) - Validate import file * [stream-cli chat watch](stream-cli_chat_watch.md) - Wait for an async task to complete diff --git a/docs/stream-cli_chat_delete-user.md b/docs/stream-cli_chat_delete-user.md deleted file mode 100644 index 4e76c254..00000000 --- a/docs/stream-cli_chat_delete-user.md +++ /dev/null @@ -1,59 +0,0 @@ -## stream-cli chat delete-user - -Delete a user - -### Synopsis - -This command deletes a user. If not flags are provided, user and messages will be soft deleted. - -There are 3 additional options that you can provide: - ---hard-delete: If set to true, hard deletes everything related to this user, channels, messages and everything related to it. ---mark-messages-deleted: If set to true, hard deletes all messages related to this user. ---delete-conversations: If set to true, hard deletes all conversations related to this user. - -User deletion is an async operation in the backend. -Once it succeeded, you'll need to use the 'watch' command to see the async task's result. - - -``` -stream-cli chat delete-user --user [user-id] --hard-delete [true|false] --mark-messages-deleted [true|false] --delete-conversations [true|false] [flags] -``` - -### Examples - -``` -# Soft delete a user with id 'my-user-1' -$ stream-cli chat delete-user --user my-user-1 - -# Hard delete a user with id 'my-user-2' -$ stream-cli chat delete-user --user my-user-2 --hard-delete -> Successfully initiated user deletion. Task id: 8d011daa-cbcd-4cba-ad16-701de599873a - -# Watch the async task's result -$ stream-cli chat watch 8d011daa-cbcd-4cba-ad16-701de599873a -> Async operation completed successfully. - -``` - -### Options - -``` - --delete-conversations [optional] Hard delete all conversations related to the user - --hard-delete [optional] Hard delete everything related to this user - -h, --help help for delete-user - --mark-messages-deleted [optional] Hard delete all messages related to the user - -u, --user string [required] Id of the user to delete -``` - -### Options inherited from parent commands - -``` - --app string [optional] Application name to use as it's defined in the configuration file - --config string [optional] Explicit config file path -``` - -### SEE ALSO - -* [stream-cli chat](stream-cli_chat.md) - Allows you to interact with your Chat applications - diff --git a/docs/stream-cli_chat_upload-import.md b/docs/stream-cli_chat_upload-import.md index ca75e024..76bdab24 100644 --- a/docs/stream-cli_chat_upload-import.md +++ b/docs/stream-cli_chat_upload-import.md @@ -20,9 +20,10 @@ $ stream-cli chat upload-import data.json --mode insert --output-format tree ### Options ``` - -h, --help help for upload-import - -m, --mode string [optional] Import mode. Canbe upsert or insert (default "upsert") - -o, --output-format string [optional] Output format. Can be json or tree (default "json") + -h, --help help for upload-import + --lighter-validation-id [optional] allows to pass ! in channel ID + -m, --mode string [optional] Import mode. Canbe upsert or insert (default "upsert") + -o, --output-format string [optional] Output format. Can be json or tree (default "json") ``` ### Options inherited from parent commands diff --git a/docs/stream-cli_chat_upsert-pushprovider.md b/docs/stream-cli_chat_upsert-pushprovider.md index 523784ce..ec9f937f 100644 --- a/docs/stream-cli_chat_upsert-pushprovider.md +++ b/docs/stream-cli_chat_upsert-pushprovider.md @@ -14,7 +14,7 @@ Create or updates a push provider description disabled_at disabled_reason - + apn_auth_key apn_key_id apn_team_id @@ -23,10 +23,10 @@ Create or updates a push provider firebase_notification_template firebase_apn_template firebase_credentials - + huawei_app_id huawei_app_secret - + xiaomi_package_name xiaomi_app_secret