UNPKG

21.6 kBJSONView Raw
1{"version":"0.0.34","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},"url":{"name":"url","type":"option","char":"u","description":"API base URL 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":"0cb153ca-74ec-4406-9014-35785104bb81"},"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},"data_template":{"name":"data_template","type":"option","char":"d","description":"JSON data 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},"firebase_data_template":{"name":"firebase_data_template","type":"option","char":"d","description":"Firebase data 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":true},"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:user:unban":{"id":"chat:user:unban","pluginName":"getstream-cli","pluginType":"core","aliases":[],"flags":{"user":{"name":"user","type":"option","char":"u","description":"The unique identifier of the user to unban.","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: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