@dabblelab/plugin-autopilot
v1.0.6
Published
Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Bot
Downloads
81
Readme
Twilio Autopilot Plugin for the Twilio CLI
A plugin for the Twilio CLI that merges and extends functionality from the Autopilot CLI.
Requirements
Install the Twilio CLI
Via npm
or yarn
:
$ npm install -g twilio-cli
$ yarn global add twilio-cli
Via homebrew
:
$ brew tap twilio/brew && brew install twilio
Usage
$ twilio plugins:install @dabblelab/plugin-autopilot
$ twilio --help autopilot
USAGE
$ twilio autopilot
...
Commands
Assistants
twilio autopilot:create
twilio autopilot:delete
twilio autopilot:export
twilio autopilot:list
twilio autopilot:update
twilio autopilot:init
twilio autopilot:deploy
Fields and Field Types
twilio autopilot:fields:create
twilio autopilot:fields:delete
twilio autopilot:fields:list
twilio autopilot:fieldtypes:create
twilio autopilot:fieldtypes:list
twilio autopilot:fieldtypes:update
twilio autopilot:fieldvalues:upload
Tasks and Samples
twilio autopilot:tasks:create
twilio autopilot:tasks:delete
twilio autopilot:tasks:list
twilio autopilot:tasks:update
twilio autopilot:samples:upload
Import bots from other platforms
Webhooks
twilio autopilot:webhooks:create
twilio autopilot:webhooks:delete
twilio autopilot:webhooks:list
twilio autopilot:webhooks:update
Other commands
twilio autopilot:modelbuilds:create
twilio autopilot:simulate
twilio autopilot:queries:export
twilio help [COMMAND]
Usage
twilio autopilot:create
Create an assistant
USAGE
$ twilio autopilot:create
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --schema=schema (required) [default: templates] path to schema file
See code: src/commands/autopilot/create.js
twilio autopilot:delete
Delete an assistant
USAGE
$ twilio autopilot:delete
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--unique-name=unique-name assistant unique name
See code: src/commands/autopilot/delete.js
twilio autopilot:export
Export an assistant
USAGE
$ twilio autopilot:export
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid assistant sid
--unique-name=unique-name assistant unique name
See code: src/commands/autopilot/export.js
twilio autopilot:list
List all autopilot assistant
USAGE
$ twilio autopilot:list
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
--properties=properties [default: sid, uniqueName, friendlyName] assistant properties to list -
https://www.twilio.com/docs/autopilot/api/assistant#assistant-properties
See code: src/commands/autopilot/list.js
twilio autopilot:update
Update an assistant
USAGE
$ twilio autopilot:update
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --schema=schema (required) path to schema file to use for the update
--unique-name=unique-name assistant unique name
See code: src/commands/autopilot/update.js
twilio autopilot:init
Create new bot project based on chosen template
USAGE
$ twilio autopilot:init
OPTIONS
-n, --bot-name=bot-name create new bot project with bot name
-p, --profile=profile Shorthand identifier for your profile.
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise
--url=url the url to the template list or the git repo
See code: src/commands/autopilot/init.js
twilio autopilot:deploy
Deploy bot project
USAGE
$ twilio autopilot:deploy
OPTIONS
-c, --config=config [default: .twilio-functions] Location of the config file. Absolute path or relative to current working directory (cwd).
-l, --logLevel=logLevel [default: info] Level of logging messages.
-p, --profile=profile Shorthand identifier for your profile.
-t, --target=all|function|model [default: all] deploy function, model or all of them. Options can only be "all", "function" or "model".
-u, --account-sid=account-sid A specific account SID to be used for deployment. Uses fields in .env otherwise.
--auth-token=auth-token Use a specific auth token for deployment. Uses fields from .env otherwise.
--override-existing-project Deploys Serverless project to existing service if a naming conflict has been found.
See code: src/commands/autopilot/deploy.js
twilio autopilot:fields:create
Create field of a task
USAGE
$ twilio autopilot:fields:create
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--field-type-sid=field-type-sid The sid of the new field type. Can be: a [Built-in
FieldType](https://www.twilio.com/docs/assistant/api/built-in-field-types ), the
`unique_name`, or the `sid` of a custom Field Type.
--task-sid=task-sid task sid
--unique-name=unique-name (required) field unique name
See code: src/commands/autopilot/fields/create.js
twilio autopilot:fields:delete
Delete a field of a task
USAGE
$ twilio autopilot:fields:delete
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--field-sid=field-sid sid of the field to delete
--task-sid=task-sid task sid
See code: src/commands/autopilot/fields/delete.js
twilio autopilot:fields:list
List all fields of a task
USAGE
$ twilio autopilot:fields:list
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--properties=properties [default: sid, uniqueName, fieldType] field properties to list -
https://www.twilio.com/docs/autopilot/api/task-field#field-properties
--task-sid=task-sid task sid
See code: src/commands/autopilot/fields/list.js
twilio autopilot:fieldtypes:create
Create a field type of an assistant
USAGE
$ twilio autopilot:fieldtypes:create
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--friendly-name=friendly-name friendly name for field type
--unique-name=unique-name (required) unique name for the field type
See code: src/commands/autopilot/fieldtypes/create.js
twilio autopilot:fieldtypes:list
List all FieldTypes of an assistant
USAGE
$ twilio autopilot:fieldtypes:list
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--properties=properties [default: sid, uniqueName] field type properties to list -
https://www.twilio.com/docs/autopilot/api/field-type#fieldtype-properties
See code: src/commands/autopilot/fieldtypes/list.js
twilio autopilot:fieldtypes:update
Update a fieldtype of an assistant
USAGE
$ twilio autopilot:fieldtypes:update
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--field-type-sid=field-type-sid (required) field type sid
--friendly-name=friendly-name field type friendly name to update
--unique-name=unique-name field unique name
See code: src/commands/autopilot/fieldtypes/update.js
twilio autopilot:fieldvalues:upload
Upload FieldValues
USAGE
$ twilio autopilot:fieldvalues:upload
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--field-type-sid=field-type-sid field type SID
--file-name=file-name (required) a CSV file of field values (one on each row with synonyms in columns)
See code: src/commands/autopilot/fieldvalues/upload.js
twilio autopilot:tasks:create
Create a Task of an assistant
USAGE
$ twilio autopilot:tasks:create
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--friendly-name=friendly-name friendly name for task
--unique-name=unique-name (required) unique name for task
See code: src/commands/autopilot/tasks/create.js
twilio autopilot:tasks:delete
Delete a Task of an assistant
USAGE
$ twilio autopilot:tasks:delete
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--task-sid=task-sid task sid
See code: src/commands/autopilot/tasks/delete.js
twilio autopilot:tasks:list
List all tasks of an assistant
USAGE
$ twilio autopilot:tasks:list
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--properties=properties [default: sid, uniqueName, friendlyName] task properties to list -
https://www.twilio.com/docs/autopilot/api/task#task-properties
See code: src/commands/autopilot/tasks/list.js
twilio autopilot:tasks:update
Update a Task of an assistant
USAGE
$ twilio autopilot:tasks:update
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--friendly-name=friendly-name task friendly name to update
--task-sid=task-sid task sid
--unique-name=unique-name task unique name to update
See code: src/commands/autopilot/tasks/update.js
twilio autopilot:samples:upload
Upload task samples
USAGE
$ twilio autopilot:samples:upload
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--file-name=file-name (required) a CSV file of samples
--task-sid=task-sid task sid
See code: src/commands/autopilot/samples/upload.js
twilio autopilot:import [TYPE]
Import a DialogFlow Agent/Alexa Interaction Model
USAGE
$ twilio autopilot:import [TYPE]
ARGUMENTS
TYPE (dialogflow|alexa) [default: dialogflow] Type of import DialogFlow/Alexa
OPTIONS
-a, --dfagent=dfagent Dialogflow Agent Name
-b, --dfbackup=dfbackup Dialogflow Agent Backup Zip File Local Path
-m, --model=model Alexa Interaction Model File Path
-p, --profile=profile Shorthand identifier for your profile.
-r, --redirectURL=redirectURL [default: https://inquisitive-stretch-2083.twil.io/generic] Alexa Back-End Hanlder URL
to send back the response
DESCRIPTION
-> twilio autopilot:import dialogflow --dfbackup <dialogflow-backup-zip-file> --dfagent <dialogflow-agent-name>
-> twilio autopilot:import alexa --model <alexa-interaction-model-file> [--redirectURL <alexa-back-end-hanlder-url>]
See code: src/commands/autopilot/import.js
twilio autopilot:webhooks:create
Create Assistant Webhooks
USAGE
$ twilio autopilot:webhooks:create
OPTIONS
-e, --events=events (required) list of space-separated webhook events
-m, --method=method which HTTP method to use
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
-u, --webhookURL=webhookURL (required) the URL to send events to
-w, --webhook-unique-name=webhook-unique-name (required) unique name for webhook
See code: src/commands/autopilot/webhooks/create.js
twilio autopilot:webhooks:delete
Delete Assistant Webhooks
USAGE
$ twilio autopilot:webhooks:delete
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--webhook-sid=webhook-sid SID of the webhook to delete
See code: src/commands/autopilot/webhooks/delete.js
twilio autopilot:webhooks:list
List all webhooks of an assistant
USAGE
$ twilio autopilot:webhooks:list
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
--properties=properties [default: sid, uniqueName, webhookUrl, events, dateCreated, dateUpdated,
webhookMethod] webhook properties to list -
https://www.twilio.com/docs/autopilot/api/event-webhooks#webhook-properties
See code: src/commands/autopilot/webhooks/list.js
twilio autopilot:webhooks:update
Update Assistant Webhooks
USAGE
$ twilio autopilot:webhooks:update
OPTIONS
-e, --events=events list of space-separated webhook events to update
-m, --method=method which HTTP method to use to update
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
-u, --webhookURL=webhookURL the URL to send events to update
-w, --webhook-unique-name=webhook-unique-name unique name for webhook to update
--webhook-sid=webhook-sid SID of the webhook to update
See code: src/commands/autopilot/webhooks/update.js
twilio autopilot:modelbuilds:create
Create Model Builds
USAGE
$ twilio autopilot:modelbuilds:create
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
-u, --callbackURL=callbackURL URL to get notified of model build status
See code: src/commands/autopilot/modelbuilds/create.js
twilio autopilot:simulate
Simulate an assistant
USAGE
$ twilio autopilot:simulate
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-s, --assistant-sid=assistant-sid (required) assistant sid
-t, --text=text (required) User text input
See code: src/commands/autopilot/simulate.js
twilio autopilot:queries:export
Export queries of an assistant
USAGE
$ twilio autopilot:queries:export
OPTIONS
-p, --profile=profile Shorthand identifier for your profile.
-q, --quantity=quantity (required) number of queries to retrieve
-s, --assistant-sid=assistant-sid (required) assistant sid
See code: src/commands/autopilot/queries/export.js
twilio help [COMMAND]
display help for twilio
USAGE
$ twilio help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help