@vonage/cli-plugin-conversations

• @vonage/cli-plugin-conversations
• Usage
• Commands

Usage

$ npm install -g @vonage/cli-plugin-conversations
$ @vonage/cli-plugin-conversations COMMAND
running command...
$ @vonage/cli-plugin-conversations (--version)
@vonage/cli-plugin-conversations/1.0.1 darwin-arm64 node-v16.18.1
$ @vonage/cli-plugin-conversations --help [COMMAND]
USAGE
  $ @vonage/cli-plugin-conversations COMMAND
...

Commands

• @vonage/cli-plugin-conversations apps:conversations
• @vonage/cli-plugin-conversations apps:conversations:create [NAME]
• @vonage/cli-plugin-conversations apps:conversations:delete [CONVERSATIONID]
• @vonage/cli-plugin-conversations apps:conversations:members [CONVERSATIONID]
• @vonage/cli-plugin-conversations apps:conversations:members:add [CONVERSATIONID] [USERID]
• @vonage/cli-plugin-conversations apps:conversations:members:remove [CONVERSATIONID] [MEMBERID]
• @vonage/cli-plugin-conversations apps:conversations:members:show [CONVERSATIONID] [MEMBERID]
• @vonage/cli-plugin-conversations apps:conversations:show [CONVERSATIONID]
• @vonage/cli-plugin-conversations apps:conversations:update [CONVERSATIONID]
• @vonage/cli-plugin-conversations apps:users:conversations [USERID]

@vonage/cli-plugin-conversations apps:conversations

Show all conversations

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations [--apiKey <value> --apiSecret <value>] [--appId <value>
    --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Show all conversations

See code: dist/commands/apps/conversations/index.js

@vonage/cli-plugin-conversations apps:conversations:create [NAME]

Create conversations

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:create [NAME] [--apiKey <value> --apiSecret <value>] [--appId <value>
    --keyFile <value>] [--display_name <value>] [--image_url <value>] [--ttl <value>]

FLAGS
  --display_name=<value>
  --image_url=<value>
  --ttl=<value>

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Create conversations

See code: dist/commands/apps/conversations/create.js

@vonage/cli-plugin-conversations apps:conversations:delete [CONVERSATIONID]

Delete a conversation

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:delete [CONVERSATIONID] [--apiKey <value> --apiSecret <value>] [--appId
    <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Delete a conversation

See code: dist/commands/apps/conversations/delete.js

@vonage/cli-plugin-conversations apps:conversations:members [CONVERSATIONID]

View all members in a conversation

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:members [CONVERSATIONID] [--apiKey <value> --apiSecret <value>] [--appId
    <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  View all members in a conversation

See code: dist/commands/apps/conversations/members/index.js

@vonage/cli-plugin-conversations apps:conversations:members:add [CONVERSATIONID] [USERID]

Add user to conversation

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:members:add [CONVERSATIONID] [USERID] [--apiKey <value> --apiSecret <value>]
    [--appId <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Add user to conversation

See code: dist/commands/apps/conversations/members/add.js

@vonage/cli-plugin-conversations apps:conversations:members:remove [CONVERSATIONID] [MEMBERID]

Remove a user from a conversation

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:members:remove [CONVERSATIONID] [MEMBERID] [--apiKey <value> --apiSecret
    <value>] [--appId <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Remove a user from a conversation

See code: dist/commands/apps/conversations/members/remove.js

@vonage/cli-plugin-conversations apps:conversations:members:show [CONVERSATIONID] [MEMBERID]

Show specific member

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:members:show [CONVERSATIONID] [MEMBERID] [--apiKey <value> --apiSecret
    <value>] [--appId <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Show specific member

See code: dist/commands/apps/conversations/members/show.js

@vonage/cli-plugin-conversations apps:conversations:show [CONVERSATIONID]

Show conversation details

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:show [CONVERSATIONID] [--apiKey <value> --apiSecret <value>] [--appId
    <value> --keyFile <value>]

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Show conversation details

See code: dist/commands/apps/conversations/show.js

@vonage/cli-plugin-conversations apps:conversations:update [CONVERSATIONID]

Modify a conversation

USAGE
  $ @vonage/cli-plugin-conversations apps:conversations:update [CONVERSATIONID] [--apiKey <value> --apiSecret <value>] [--appId
    <value> --keyFile <value>] [--name <value>] [--display_name <value>] [--image_url <value>] [--ttl <value>]

FLAGS
  --display_name=<value>
  --image_url=<value>
  --name=<value>
  --ttl=<value>

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

DESCRIPTION
  Modify a conversation

See code: dist/commands/apps/conversations/update.js

@vonage/cli-plugin-conversations apps:users:conversations [USERID]

USAGE
  $ @vonage/cli-plugin-conversations apps:users:conversations [USERID] [--apiKey <value> --apiSecret <value>] [--appId <value>
    --keyFile <value>] [--date_start <value>] [--date_end <value>] [--page_size <value>] [--order <value>] [--cursor
    <value>]

FLAGS
  --cursor=<value>
  --date_end=<value>
  --date_start=<value>
  --order=<value>
  --page_size=<value>

VONAGE API FLAGS FLAGS
  --apiKey=<value>
  --apiSecret=<value>

VONAGE APPLICATION FLAGS FLAGS
  --appId=<value>
  --keyFile=<value>

See code: dist/commands/apps/users/conversations.js