docs: update docs (#145)

Author: yaziine

docs/imports.md

@@ -34,7 +34,11 @@ list of JSON objects, representing each item to be imported.
       "role": "user",
       "teams": [
         "A-team"
-      ]
+      ],
+      "push_notifications": {
+        "disabled": true,
+        "disabled_reason": "doesn't want to be disturbed"
+      }
     }
   },
   {
@@ -80,6 +84,15 @@ list of JSON objects, representing each item to be imported.
       "user_id": "murdock",
       "created_at": "2022-01-01T01:01:01Z"
     }
+  },
+  {
+    "type": "device",
+    "item": {
+      "id": "deviceID",
+      "user_id": "hannibal",
+      "created_at": "2022-01-01T01:01:01Z",
+      "push_provider_type": "firebase"
+    }
   }
 ]
 ```

docs/stream-cli_chat.md

@@ -19,6 +19,7 @@ Allows you to interact with your Chat applications
 
 * [stream-cli](stream-cli.md)	 - Stream CLI
 * [stream-cli chat add-members](stream-cli_chat_add-members.md)	 - Add members to a channel
+* [stream-cli chat assign-role](stream-cli_chat_assign-role.md)	 - Assign a role to a user
 * [stream-cli chat ban-user](stream-cli_chat_ban-user.md)	 - Ban a user
 * [stream-cli chat create-channel](stream-cli_chat_create-channel.md)	 - Create a channel
 * [stream-cli chat create-channel-type](stream-cli_chat_create-channel-type.md)	 - Create channel type
@@ -33,7 +34,7 @@ Allows you to interact with your Chat applications
 * [stream-cli chat delete-message](stream-cli_chat_delete-message.md)	 - Delete a message
 * [stream-cli chat delete-pushprovider](stream-cli_chat_delete-pushprovider.md)	 - Delete a push provider
 * [stream-cli chat delete-reaction](stream-cli_chat_delete-reaction.md)	 - Delete a reaction from a message
-* [stream-cli chat delete-user](stream-cli_chat_delete-user.md)	 - Delete a user
+* [stream-cli chat delete-users](stream-cli_chat_delete-users.md)	 - Delete multiple users
 * [stream-cli chat demote-moderators](stream-cli_chat_demote-moderators.md)	 - Demote users from moderator role
 * [stream-cli chat flag-message](stream-cli_chat_flag-message.md)	 - Flag a message
 * [stream-cli chat flag-user](stream-cli_chat_flag-user.md)	 - Flag a user
@@ -50,6 +51,7 @@ Allows you to interact with your Chat applications
 * [stream-cli chat list-devices](stream-cli_chat_list-devices.md)	 - List devices
 * [stream-cli chat list-imports](stream-cli_chat_list-imports.md)	 - List imports
 * [stream-cli chat list-pushproviders](stream-cli_chat_list-pushproviders.md)	 - List all push providers
+* [stream-cli chat listen-events](stream-cli_chat_listen-events.md)	 - Listen to events
 * [stream-cli chat mute-user](stream-cli_chat_mute-user.md)	 - Mute a user
 * [stream-cli chat promote-moderators](stream-cli_chat_promote-moderators.md)	 - Promote users to channel moderator role
 * [stream-cli chat query-users](stream-cli_chat_query-users.md)	 - Query users
@@ -69,6 +71,7 @@ Allows you to interact with your Chat applications
 * [stream-cli chat update-channel-partial](stream-cli_chat_update-channel-partial.md)	 - Update a channel partially
 * [stream-cli chat update-channel-type](stream-cli_chat_update-channel-type.md)	 - Update channel type
 * [stream-cli chat update-message-partial](stream-cli_chat_update-message-partial.md)	 - Partially update a message
+* [stream-cli chat update-user-partial](stream-cli_chat_update-user-partial.md)	 - Partially update a user
 * [stream-cli chat upload-file](stream-cli_chat_upload-file.md)	 - Upload a file
 * [stream-cli chat upload-image](stream-cli_chat_upload-image.md)	 - Upload an image
 * [stream-cli chat upload-import](stream-cli_chat_upload-import.md)	 - Upload an import

docs/stream-cli_chat_add-members.md

@@ -10,7 +10,7 @@ stream-cli chat add-members --type [channel-type] --id [channel-id] [user-id-1]
 
 ```
 # Add members joe, jill and jane to 'red-team' channel
-$ stream-cli chat add-member --type messaging --id red-team joe jill jane
+$ stream-cli chat add-members --type messaging --id red-team joe jill jane
 
 ```
 

docs/stream-cli_chat_assign-role.md

@@ -0,0 +1,37 @@
+## stream-cli chat assign-role
+
+Assign a role to a user
+
+```
+stream-cli chat assign-role --type [channel-type] --id [channel-id] --user-id [user-id] --role [channel-role-name] [flags]
+```
+
+### Examples
+
+```
+# Assign 'channel_moderator' role to user 'joe'
+$ stream-cli chat assign-role --type messaging --id red-team --user-id joe --role channel_moderator
+
+```
+
+### Options
+
+```
+  -h, --help             help for assign-role
+  -i, --id string        [required] Channel id
+  -r, --role string      [required] Channel role name to assign
+  -t, --type string      [required] Channel type such as 'messaging' or 'livestream'
+  -u, --user-id string   [required] User id to assign a role to
+```
+
+### 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
+

docs/stream-cli_chat_create-token.md

@@ -33,7 +33,7 @@ $ stream-cli chat create-token --user joe --expiration 1577880000 --issued-at 15
   -e, --expiration int   [optional] Expiration (exp) of the JWT in epoch timestamp
   -h, --help             help for create-token
   -i, --issued-at int    [optional] Issued at (iat) of the JWT in epoch timestamp
-  -u, --user string      [required] Id of the user to create token for
+  -u, --user string      [required] ID of the user to create token for
 ```
 
 ### Options inherited from parent commands

docs/stream-cli_chat_delete-message.md

@@ -7,7 +7,7 @@ Delete a message
 You can delete a message by calling DeleteMessage and including a message
 with an ID. Messages can be soft deleted or hard deleted. Unless specified
 via the hard parameter, messages are soft deleted. Be aware that deleting
-a message doesn't delete its attachments. 
+a message doesn't delete its attachments.
 
 
 ```

docs/stream-cli_chat_delete-users.md

@@ -0,0 +1,64 @@
+## stream-cli chat delete-users
+
+Delete multiple users
+
+### Synopsis
+
+You can delete up to 100 users and optionally all of their channels and
+messages using this method.  First the users are marked deleted synchronously
+so the user will not be directly visible in the API.  Then the process deletes
+the user and related objects asynchronously by scheduling a task to be handle
+by the task worker.
+
+The delete users response contain a task ID which can be polled using the
+get task endpoint to check the status of the deletions.
+
+Note: when deleting a user with hard delete, it also required hard deletion
+for messages and conversations as well!
+
+
+```
+stream-cli chat delete-users --new-channel-user-id [user-id] --hard-delete-users [true|false] --hard-delete-messages [true|false] --hard-delete-conversations [user-id1] [user-id2] ... [flags]
+```
+
+### Examples
+
+```
+# Soft delete users with ids 'my-user-1' and 'my-user-2'
+$ stream-cli chat delete-users my-user-1 my-user-2
+> Successfully initiated user deletion. Task id: bf1c2d1b-04d6-4e67-873c-5b3ade478b0a
+# Waiting for it to succeed
+$ stream-cli chat watch bf1c2d1b-04d6-4e67-873c-5b3ade478b0a
+> Async operation completed successfully.
+
+# Hard delete users with ids 'my-user-3' and 'my-user-4'
+$ stream-cli chat delete-users --hard-delete-users --hard-delete-messages --hard-delete-conversations my-user-3 my-user-4
+> Successfully initiated user deletion. Task id: 71516d9a-0764-4aa8-b017-8d2a99748e16
+
+# Waiting for it to succeed
+$ stream-cli chat watch 71516d9a-0764-4aa8-b017-8d2a99748e16
+> Async operation completed successfully.
+
+```
+
+### Options
+
+```
+      --hard-delete-conversations     [optional] Hard delete all conversations related to the users
+      --hard-delete-messages          [optional] Hard delete all messages related to the users
+      --hard-delete-users             [optional] Hard delete everything related to the users
+  -h, --help                          help for delete-users
+      --new-channel-owner-id string   [optional] Channels owned by hard-deleted users will be transferred to this userID
+```
+
+### 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
+

docs/stream-cli_chat_get-import.md

@@ -3,7 +3,7 @@
 Get import
 
 ```
-stream-cli chat get-import [import-id] --output-format [json|tree] [flags]
+stream-cli chat get-import [import-id] --output-format [json|tree] --watch [flags]
 ```
 
 ### Examples
@@ -12,8 +12,8 @@ stream-cli chat get-import [import-id] --output-format [json|tree] [flags]
 # Returns an import and prints it as JSON
 $ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272
 
-# Returns an import and prints it as a browsable tree
-$ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --output-format tree
+# Returns an import and prints it as JSON, and wait for it to complete
+$ stream-cli chat get-import dcb6e366-93ec-4e52-af6f-b0c030ad5272 --watch
 
 ```
 

docs/stream-cli_chat_listen-events.md

@@ -0,0 +1,46 @@
+## stream-cli chat listen-events
+
+Listen to events
+
+### Synopsis
+
+The command opens a WebSocket connection to the backend in the name of the user
+and prints the received events to the standard output.
+Press Ctrl+C to exit.
+
+
+```
+stream-cli chat listen-events --user-id [user-id] --timeout [number] [flags]
+```
+
+### Examples
+
+```
+# Listen to events for user with id 'my-user-1'
+$ stream-cli chat listen-events --user-id my-user-1
+
+# Listen to events for user with id 'my-user-2' and keeping the connection open for 120 seconds
+$ stream-cli chat listen-events --user-id my-user-1 --timeout 120
+
+```
+
+### Options
+
+```
+  -h, --help                   help for listen-events
+  -o, --output-format string   [optional] Output format. Can be json or tree (default "json")
+  -t, --timeout int32          [optional] For how many seconds do we keep the connection alive. Default is 60 seconds, max is 300. (default 60)
+  -u, --user-id string         [required] User ID
+```
+
+### 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
+

docs/stream-cli_chat_revoke-all-tokens.md

@@ -4,7 +4,7 @@ Revoke all tokens
 
 ### Synopsis
 
-This command revokes ALL tokens for all users of an application. 
+This command revokes ALL tokens for all users of an application.
 This should be used with caution as it will expire every user’s token,
 regardless of whether the token has an iat claim.