diff --git a/README.md b/README.md index 475aad4..9a33b22 100644 --- a/README.md +++ b/README.md @@ -106,7 +106,7 @@ $ npm install -g getstream-cli $ stream COMMAND running command... $ stream (-v|--version|version) -getstream-cli/0.0.22 darwin-x64 node-v12.11.1 +getstream-cli/0.0.23 darwin-x64 node-v12.11.1 $ stream --help [COMMAND] USAGE $ stream COMMAND diff --git a/docs/autocomplete.md b/docs/autocomplete.md deleted file mode 100644 index ca30e7c..0000000 --- a/docs/autocomplete.md +++ /dev/null @@ -1,29 +0,0 @@ -`stream autocomplete` -===================== - -display autocomplete installation instructions - -* [`stream autocomplete [SHELL]`](#stream-autocomplete-shell) - -## `stream autocomplete [SHELL]` - -display autocomplete installation instructions - -``` -USAGE - $ stream autocomplete [SHELL] - -ARGUMENTS - SHELL shell type - -OPTIONS - -r, --refresh-cache Refresh cache (ignores displaying instructions) - -EXAMPLES - $ stream autocomplete - $ stream autocomplete bash - $ stream autocomplete zsh - $ stream autocomplete --refresh-cache -``` - -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.4/src/commands/autocomplete/index.ts)_ diff --git a/docs/chat.md b/docs/chat.md deleted file mode 100644 index f52916a..0000000 --- a/docs/chat.md +++ /dev/null @@ -1,434 +0,0 @@ -`stream chat` -============= - -configure and manage all things related to chat - -* [`stream chat:channel:create`](#stream-chatchannelcreate) -* [`stream chat:channel:get`](#stream-chatchannelget) -* [`stream chat:channel:list`](#stream-chatchannellist) -* [`stream chat:channel:query`](#stream-chatchannelquery) -* [`stream chat:channel:update`](#stream-chatchannelupdate) -* [`stream chat:log`](#stream-chatlog) -* [`stream chat:message:create`](#stream-chatmessagecreate) -* [`stream chat:message:flag`](#stream-chatmessageflag) -* [`stream chat:message:list`](#stream-chatmessagelist) -* [`stream chat:message:remove`](#stream-chatmessageremove) -* [`stream chat:message:update`](#stream-chatmessageupdate) -* [`stream chat:push:apn`](#stream-chatpushapn) -* [`stream chat:push:device:add`](#stream-chatpushdeviceadd) -* [`stream chat:push:device:delete`](#stream-chatpushdevicedelete) -* [`stream chat:push:device:get`](#stream-chatpushdeviceget) -* [`stream chat:push:firebase`](#stream-chatpushfirebase) -* [`stream chat:push:get`](#stream-chatpushget) -* [`stream chat:push:test`](#stream-chatpushtest) -* [`stream chat:push:webhook`](#stream-chatpushwebhook) -* [`stream chat:reaction:create`](#stream-chatreactioncreate) -* [`stream chat:reaction:remove`](#stream-chatreactionremove) -* [`stream chat:user:ban`](#stream-chatuserban) -* [`stream chat:user:create`](#stream-chatusercreate) -* [`stream chat:user:flag`](#stream-chatuserflag) -* [`stream chat:user:get`](#stream-chatuserget) -* [`stream chat:user:mute`](#stream-chatusermute) -* [`stream chat:user:query`](#stream-chatuserquery) -* [`stream chat:user:remove`](#stream-chatuserremove) -* [`stream chat:user:set`](#stream-chatuserset) - -## `stream chat:channel:create` - -``` -USAGE - $ stream chat:channel:create - -OPTIONS - -c, --channel=channel [default: 0fefb4d1-897d-4692-aa51-f59f69656ca0] A unique ID for the channel you wish to create. - -d, --data=data Additional data as JSON. - -i, --image=image URL to channel image. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -n, --name=name Name of the channel room. - -t, --type=type Type of channel. -``` - -## `stream chat:channel:get` - -``` -USAGE - $ stream chat:channel:get - -OPTIONS - -c, --channel=channel The channel ID you wish to retrieve. - -t, --type=type Type of channel. -``` - -## `stream chat:channel:list` - -``` -USAGE - $ stream chat:channel:list - -OPTIONS - -l, --limit=limit (required) Channel list limit. - -o, --offset=offset (required) Channel list offset. -``` - -## `stream chat:channel:query` - -``` -USAGE - $ stream chat:channel:query - -OPTIONS - -c, --channel=channel The unique indentifier for the channel you want to query. - -f, --filter=filter Filters to apply to the query. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -s, --sort=sort Sort to apply to the query. - -t, --type=type Type of channel. -``` - -## `stream chat:channel:update` - -``` -USAGE - $ stream chat:channel:update - -OPTIONS - -c, --channel=channel The ID of the channel you wish to update. - -d, --description=description Description for the channel. - -i, --image=image URL to the channel image. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -n, --name=name Name of the channel room. - -r, --reason=reason Reason for changing channel. - -t, --type=type Type of channel. -``` - -## `stream chat:log` - -``` -USAGE - $ stream chat:log - -OPTIONS - -c, --channel=channel - The channel ID you wish to log. - - -e, - --event=all|user.status.changed|user.watching.start|user.watching.stop|user.updated|typing.start|typing.stop|message.n - ew|message.updated|message.deleted|message.seen|message.reaction|member.added|member.removed|channel.updated|health.ch - eck|connection.changed|connection.recovered - The type of event you want to listen on. - - -j, --json - Output results in JSON. When not specified, returns output in a human friendly format. - - -t, --type=type - The type of channel. -``` - -## `stream chat:message:create` - -``` -USAGE - $ stream chat:message:create - -OPTIONS - -c, --channel=channel The ID of the channel that you would like to send a message to. - -i, --image=image Absolute URL for an avatar of the user sending the message. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -m, --message=message The message you would like to send as plaintext. - -n, --name=name The name of the user sending the message. - -t, --type=type The type of channel. - -u, --user=user The ID of the user sending the message. -``` - -## `stream chat:message:flag` - -``` -USAGE - $ stream chat:message:flag - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -m, --message=message The unique identifier of the message you want to flag. -``` - -## `stream chat:message:list` - -``` -USAGE - $ stream chat:message:list - -OPTIONS - -c, --channel=channel The ID of the channel that you would like to send a message to. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -t, --type=type The type of channel. -``` - -## `stream chat:message:remove` - -``` -USAGE - $ stream chat:message:remove - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -m, --message=message The unique identifier of the message you would like to remove. -``` - -## `stream chat:message:update` - -``` -USAGE - $ stream chat:message:update - -OPTIONS - -a, --attachments=attachments A JSON payload of attachments to send along with a message. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -m, --message=message The unique identifier for the message. - -t, --text=text The message you would like to send as text. -``` - -## `stream chat:push:apn` - -``` -USAGE - $ stream chat:push:apn - -OPTIONS - -a, --auth_key=auth_key Absolute path to .p8 auth key. - -b, --bundle_id=bundle_id Bundle identifier (e.g. com.apple.test). - -c, --p12_cert=p12_cert Absolute path to .p12 file. - -d, --development Use development endpoint - - -j, --json Output results in JSON. When not specified, returns output in a - human friendly format. - - -k, --key_id=key_id Key ID. - - -n, --notification_template=notification_template JSON template for notifications. - - -t, --team_id=team_id Team ID. - - --disable Disable APN push notifications and clear config. -``` - -## `stream chat:push:device:add` - -``` -USAGE - $ stream chat:push:device:add - -OPTIONS - -d, --device_id=device_id Device id or token. - -p, --provider=provider Push provider - -u, --user_id=user_id User ID -``` - -## `stream chat:push:device:delete` - -``` -USAGE - $ stream chat:push:device:delete - -OPTIONS - -d, --device_id=device_id Device id or token. - -u, --user_id=user_id User ID -``` - -## `stream chat:push:device:get` - -``` -USAGE - $ stream chat:push:device:get - -OPTIONS - -u, --user_id=user_id User ID -``` - -## `stream chat:push:firebase` - -``` -USAGE - $ stream chat:push:firebase - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a - human friendly format. - - -k, --key=key Server key for Firebase. - - -n, --notification_template=notification_template JSON notification template. - - --disable Disable Firebase push notifications and clear config. -``` - -## `stream chat:push:get` - -``` -USAGE - $ stream chat:push:get - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. -``` - -## `stream chat:push:test` - -``` -USAGE - $ stream chat:push:test - -OPTIONS - -a, --apn_notification_template=apn_notification_template APN notification template - -f, --firebase_notification_template=firebase_notification_template Firebase notification template - - -j, --json Output results in JSON. When not specified, - returns output in a human friendly format. - - -m, --message_id=message_id Message ID. - - -u, --user_id=user_id User ID -``` - -## `stream chat:push:webhook` - -``` -USAGE - $ stream chat:push:webhook - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -u, --url=url Fully qualified URL for webhook support. -``` - -## `stream chat:reaction:create` - -``` -USAGE - $ stream chat:reaction:create - -OPTIONS - -c, --channel=channel The unique identifier for the channel. - -c, --message=message The unique identifier for the message. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -r, --reaction=reaction A reaction for the message (e.g. love). - -t, --type=type The type of channel. -``` - -## `stream chat:reaction:remove` - -``` -USAGE - $ stream chat:reaction:remove - -OPTIONS - -c, --channel=channel The unique identifier for the channel. - -c, --message=message The unique identifier for the message. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -r, --reaction=reaction The unique identifier for the reaction. - -t, --type=type The type of channel. -``` - -## `stream chat:user:ban` - -``` -USAGE - $ stream chat:user:ban - -OPTIONS - -d, --duration=duration [default: 60] Duration of timeout in minutes. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -r, --reason=reason A reason for adding a timeout. - -u, --type=type Type of ban to perform (e.g. global or channel). - -u, --user=user The unique identifier of the user to ban. -``` - -## `stream chat:user:create` - -``` -USAGE - $ stream chat:user:create - -OPTIONS - -c, --channel=channel Channel identifier. - - -j, --json Output results in JSON. When not specified, returns - output in a human friendly format. - - -r, --role=admin|guest|channel_member|channel_owner|message_owner The role to assign to the user. - - -t, --type=type The type of channel. - - -u, --user=user Comma separated list of users to add. -``` - -## `stream chat:user:flag` - -``` -USAGE - $ stream chat:user:flag - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -u, --user=user The ID of the offending user. -``` - -## `stream chat:user:get` - -``` -USAGE - $ stream chat:user:get - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -p, --presence=presence Display the current status of the user. - -u, --user=user The unique identifier of the user to get. -``` - -## `stream chat:user:mute` - -``` -USAGE - $ stream chat:user:mute - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -u, --user=user The unique identifier of the user to mute. -``` - -## `stream chat:user:query` - -``` -USAGE - $ stream chat:user:query - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -l, --limit=limit The limit to apply to the query. - -o, --offset=offset The offset to apply to the query. - -q, --query=query The query you would like to perform. - -s, --sort=sort Display the current status of the user. -``` - -## `stream chat:user:remove` - -``` -USAGE - $ stream chat:user:remove - -OPTIONS - -c, --channel=channel Channel name. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -m, --moderators=moderators (required) Comma separated list of moderators to remove. - -t, --type=type Channel type. -``` - -## `stream chat:user:set` - -``` -USAGE - $ stream chat:user:set - -OPTIONS - -i, --id=id The unique identifier for the user. - -m, --image=image URL to the image of the user. - -n, --name=name Name of the user. -``` diff --git a/docs/commands.md b/docs/commands.md deleted file mode 100644 index a419171..0000000 --- a/docs/commands.md +++ /dev/null @@ -1,22 +0,0 @@ -`stream commands` -================= - -list all the commands - -* [`stream commands`](#stream-commands) - -## `stream commands` - -list all the commands - -``` -USAGE - $ stream commands - -OPTIONS - -h, --help show CLI help - -j, --json output in json format - --hidden also show hidden commands -``` - -_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v1.2.3/src/commands/commands.ts)_ diff --git a/docs/config.md b/docs/config.md deleted file mode 100644 index 70b68a3..0000000 --- a/docs/config.md +++ /dev/null @@ -1,42 +0,0 @@ -`stream config` -=============== - -manage configuration variables - -* [`stream config:destroy`](#stream-configdestroy) -* [`stream config:get`](#stream-configget) -* [`stream config:set`](#stream-configset) - -## `stream config:destroy` - -``` -USAGE - $ stream config:destroy - -OPTIONS - -f, --force Force remove Stream configuration from cache. -``` - -## `stream config:get` - -``` -USAGE - $ stream config:get - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. -``` - -## `stream config:set` - -``` -USAGE - $ stream config:set - -OPTIONS - -e, --email=email Email for configuration. - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -k, --key=key API key for configuration. - -n, --name=name Full name for configuration. - -s, --secret=secret API secret for configuration. -``` diff --git a/docs/debug.md b/docs/debug.md deleted file mode 100644 index 8f3e32c..0000000 --- a/docs/debug.md +++ /dev/null @@ -1,17 +0,0 @@ -`stream debug` -============== - -debugging tools - -* [`stream debug:token`](#stream-debugtoken) - -## `stream debug:token` - -``` -USAGE - $ stream debug:token - -OPTIONS - -j, --json Output results in JSON. When not specified, returns output in a human friendly format. - -t, --token=token The Stream token you are trying to debug. -``` diff --git a/docs/help.md b/docs/help.md deleted file mode 100644 index d4338d0..0000000 --- a/docs/help.md +++ /dev/null @@ -1,23 +0,0 @@ -`stream help` -============= - -display help for stream - -* [`stream help [COMMAND]`](#stream-help-command) - -## `stream help [COMMAND]` - -display help for stream - -``` -USAGE - $ stream help [COMMAND] - -ARGUMENTS - COMMAND command to show help for - -OPTIONS - --all see all commands in CLI -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_ diff --git a/docs/settings.md b/docs/settings.md deleted file mode 100644 index abc4e76..0000000 --- a/docs/settings.md +++ /dev/null @@ -1,29 +0,0 @@ -`stream settings` -================= - -manage account settings - -* [`stream settings:get`](#stream-settingsget) -* [`stream settings:set`](#stream-settingsset) - -## `stream settings:get` - -``` -USAGE - $ stream settings:get -``` - -_See code: [src/commands/settings/get.js](https://github.com/getstream/stream-cli/blob/v0.0.1-beta.23/src/commands/settings/get.js)_ - -## `stream settings:set` - -``` -USAGE - $ stream settings:set - -OPTIONS - -n, --name=name Full name for settings. - -p, --p12=p12 A .p12 file for push notifications. -``` - -_See code: [src/commands/settings/set.js](https://github.com/getstream/stream-cli/blob/v0.0.1-beta.23/src/commands/settings/set.js)_ diff --git a/oclif.manifest.json b/oclif.manifest.json deleted file mode 100644 index c5b91d0..0000000 --- a/oclif.manifest.json +++ /dev/null @@ -1 +0,0 @@ -{"version":"0.0.22","commands":{"config:destroy":{"id":"config:destroy","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Force remove Stream configuration from cache.","required":false,"allowNo":false}},"args":[]},"config:get":{"id":"config:get","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"config:set":{"id":"config:set","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"name":{"name":"name","type":"option","char":"n","description":"Full name for configuration.","required":false},"email":{"name":"email","type":"option","char":"e","description":"Email for configuration.","required":false},"key":{"name":"key","type":"option","char":"k","description":"API key for configuration.","required":false},"secret":{"name":"secret","type":"option","char":"s","description":"API secret for configuration.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"debug:token":{"id":"debug:token","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"token":{"name":"token","type":"option","char":"t","description":"The Stream token you are trying to debug.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:channel:create":{"id":"chat:channel:create","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"A unique ID for the channel you wish to create.","required":false,"default":"0fefb4d1-897d-4692-aa51-f59f69656ca0"},"type":{"name":"type","type":"option","char":"t","description":"Type of channel.","required":false},"name":{"name":"name","type":"option","char":"n","description":"Name of the channel room.","required":false},"image":{"name":"image","type":"option","char":"i","description":"URL to channel image.","required":false},"data":{"name":"data","type":"option","char":"d","description":"Additional data as JSON.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:channel:get":{"id":"chat:channel:get","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The channel ID you wish to retrieve.","required":false},"type":{"name":"type","type":"option","char":"t","description":"Type of channel.","required":false}},"args":[]},"chat:channel:list":{"id":"chat:channel:list","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"limit":{"name":"limit","type":"option","char":"l","description":"Channel list limit.","required":true},"offset":{"name":"offset","type":"option","char":"o","description":"Channel list offset.","required":true}},"args":[]},"chat:channel:query":{"id":"chat:channel:query","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The unique indentifier for the channel you want to query.","required":false},"type":{"name":"type","type":"option","char":"t","description":"Type of channel.","required":false},"filter":{"name":"filter","type":"option","char":"f","description":"Filters to apply to the query.","required":false},"sort":{"name":"sort","type":"option","char":"s","description":"Sort to apply to the query.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:channel:update":{"id":"chat:channel:update","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The ID of the channel you wish to update.","required":false},"type":{"name":"type","type":"option","char":"t","description":"Type of channel.","required":false},"name":{"name":"name","type":"option","char":"n","description":"Name of the channel room.","required":false},"image":{"name":"image","type":"option","char":"i","description":"URL to the channel image.","required":false},"description":{"name":"description","type":"option","char":"d","description":"Description for the channel.","required":false},"reason":{"name":"reason","type":"option","char":"r","description":"Reason for changing channel.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:log":{"id":"chat:log","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The channel ID you wish to log.","required":false},"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"event":{"name":"event","type":"option","char":"e","description":"The type of event you want to listen on.","required":false,"options":["all","user.status.changed","user.watching.start","user.watching.stop","user.updated","typing.start","typing.stop","message.new","message.updated","message.deleted","message.seen","message.reaction","member.added","member.removed","channel.updated","health.check","connection.changed","connection.recovered"]},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:message:create":{"id":"chat:message:create","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user":{"name":"user","type":"option","char":"u","description":"The ID of the user sending the message.","required":false},"name":{"name":"name","type":"option","char":"n","description":"The name of the user sending the message.","required":false},"image":{"name":"image","type":"option","char":"i","description":"Absolute URL for an avatar of the user sending the message.","required":false},"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"channel":{"name":"channel","type":"option","char":"c","description":"The ID of the channel that you would like to send a message to.","required":false},"message":{"name":"message","type":"option","char":"m","description":"The message you would like to send as plaintext.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:message:flag":{"id":"chat:message:flag","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"message":{"name":"message","type":"option","char":"m","description":"The unique identifier of the message you want to flag.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:message:list":{"id":"chat:message:list","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"channel":{"name":"channel","type":"option","char":"c","description":"The ID of the channel that you would like to send a message to.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:message:remove":{"id":"chat:message:remove","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"message":{"name":"message","type":"option","char":"message","description":"The unique identifier of the message you would like to remove.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:message:update":{"id":"chat:message:update","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"message":{"name":"message","type":"option","char":"m","description":"The unique identifier for the message.","required":false},"text":{"name":"text","type":"option","char":"t","description":"The message you would like to send as text.","required":false},"attachments":{"name":"attachments","type":"option","char":"a","description":"A JSON payload of attachments to send along with a message.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:push:apn":{"id":"chat:push:apn","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"auth_key":{"name":"auth_key","type":"option","char":"a","description":"Absolute path to .p8 auth key.","required":false},"key_id":{"name":"key_id","type":"option","char":"k","description":"Key ID.","required":false},"bundle_id":{"name":"bundle_id","type":"option","char":"b","description":"Bundle identifier (e.g. com.apple.test).","required":false},"team_id":{"name":"team_id","type":"option","char":"t","description":"Team ID.","required":false},"development":{"name":"development","type":"boolean","char":"d","description":"Use development endpoint","required":false,"allowNo":false},"p12_cert":{"name":"p12_cert","type":"option","char":"c","description":"Absolute path to .p12 file.","required":false},"notification_template":{"name":"notification_template","type":"option","char":"n","description":"JSON template for notifications.","required":false},"disable":{"name":"disable","type":"boolean","description":"Disable APN push notifications and clear config.","required":false,"allowNo":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:push:firebase":{"id":"chat:push:firebase","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"key":{"name":"key","type":"option","char":"k","description":"Server key for Firebase.","required":false},"notification_template":{"name":"notification_template","type":"option","char":"n","description":"JSON notification template.","required":false},"disable":{"name":"disable","type":"boolean","description":"Disable Firebase push notifications and clear config.","required":false,"allowNo":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:push:get":{"id":"chat:push:get","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:push:test":{"id":"chat:push:test","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user_id":{"name":"user_id","type":"option","char":"u","description":"User ID","required":false},"message_id":{"name":"message_id","type":"option","char":"m","description":"Message ID.","required":false},"apn_notification_template":{"name":"apn_notification_template","type":"option","char":"a","description":"APN notification template","required":false},"firebase_notification_template":{"name":"firebase_notification_template","type":"option","char":"f","description":"Firebase notification template","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:push:webhook":{"id":"chat:push:webhook","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"url":{"name":"url","type":"option","char":"u","description":"Fully qualified URL for webhook support.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:reaction:create":{"id":"chat:reaction:create","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The unique identifier for the channel.","required":false},"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"message":{"name":"message","type":"option","char":"c","description":"The unique identifier for the message.","required":false},"reaction":{"name":"reaction","type":"option","char":"r","description":"A reaction for the message (e.g. love).","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:reaction:remove":{"id":"chat:reaction:remove","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"The unique identifier for the channel.","required":false},"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"message":{"name":"message","type":"option","char":"c","description":"The unique identifier for the message.","required":false},"reaction":{"name":"reaction","type":"option","char":"r","description":"The unique identifier for the reaction.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:ban":{"id":"chat:user:ban","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"type":{"name":"type","type":"option","char":"u","description":"Type of ban to perform (e.g. global or channel).","required":false},"user":{"name":"user","type":"option","char":"u","description":"The unique identifier of the user to ban.","required":false},"reason":{"name":"reason","type":"option","char":"r","description":"A reason for adding a timeout.","required":false},"duration":{"name":"duration","type":"option","char":"d","description":"Duration of timeout in minutes.","required":false,"default":"60"},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:create":{"id":"chat:user:create","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"Channel identifier.","required":false},"type":{"name":"type","type":"option","char":"t","description":"The type of channel.","required":false},"user":{"name":"user","type":"option","char":"u","description":"Comma separated list of users to add.","required":false},"role":{"name":"role","type":"option","char":"r","description":"The role to assign to the user.","required":false,"options":["admin","guest","channel_member","channel_owner","message_owner"]},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:flag":{"id":"chat:user:flag","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user":{"name":"user","type":"option","char":"u","description":"The ID of the offending user.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:get":{"id":"chat:user:get","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user":{"name":"user","type":"option","char":"u","description":"The unique identifier of the user to get.","required":false},"presence":{"name":"presence","type":"option","char":"p","description":"Display the current status of the user.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:mute":{"id":"chat:user:mute","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user":{"name":"user","type":"option","char":"u","description":"The unique identifier of the user to mute.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:query":{"id":"chat:user:query","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"query":{"name":"query","type":"option","char":"q","description":"The query you would like to perform.","required":false},"sort":{"name":"sort","type":"option","char":"s","description":"Display the current status of the user.","required":false},"limit":{"name":"limit","type":"option","char":"l","description":"The limit to apply to the query.","required":false},"offset":{"name":"offset","type":"option","char":"o","description":"The offset to apply to the query.","required":false},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:remove":{"id":"chat:user:remove","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"channel":{"name":"channel","type":"option","char":"c","description":"Channel name.","required":false},"type":{"name":"type","type":"option","char":"t","description":"Channel type.","required":false},"moderators":{"name":"moderators","type":"option","char":"m","description":"Comma separated list of moderators to remove.","required":true},"json":{"name":"json","type":"boolean","char":"j","description":"Output results in JSON. When not specified, returns output in a human friendly format.","required":false,"allowNo":false}},"args":[]},"chat:user:set":{"id":"chat:user:set","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"id":{"name":"id","type":"option","char":"i","description":"The unique identifier for the user.","required":false},"name":{"name":"name","type":"option","char":"n","description":"Name of the user.","required":false},"image":{"name":"image","type":"option","char":"m","description":"URL to the image of the user.","required":false}},"args":[]},"chat:push:device:add":{"id":"chat:push:device:add","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user_id":{"name":"user_id","type":"option","char":"u","description":"User ID","required":false},"device_id":{"name":"device_id","type":"option","char":"d","description":"Device id or token.","required":false},"provider":{"name":"provider","type":"option","char":"p","description":"Push provider","required":false}},"args":[]},"chat:push:device:delete":{"id":"chat:push:device:delete","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user_id":{"name":"user_id","type":"option","char":"u","description":"User ID","required":false},"device_id":{"name":"device_id","type":"option","char":"d","description":"Device id or token.","required":false}},"args":[]},"chat:push:device:get":{"id":"chat:push:device:get","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user_id":{"name":"user_id","type":"option","char":"u","description":"User ID","required":false}},"args":[]}}} \ No newline at end of file diff --git a/package.json b/package.json index 0488f2a..fd0ffd6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "getstream-cli", "description": "Configure & manage Stream applications from the command line. 🚀", - "version": "0.0.22", + "version": "0.0.23", "bin": { "stream": "./bin/run" },