Skip to content

Commit 03791f3

Browse files
committed
documentation updates
1 parent c725952 commit 03791f3

File tree

34 files changed

+92
-92
lines changed

34 files changed

+92
-92
lines changed

package.json

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "@dabblelab/plugin-autopilot",
3-
"description": "Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Assistant",
3+
"description": "Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Bot",
44
"version": "1.0.4",
5-
"author": "Steve Tingiris",
6-
"bugs": "https://github.com/tingiris/twilio-cli-autopilot-plugin/issues",
5+
"author": "Dabble Lab",
6+
"bugs": "https://github.com/dabblelab/twilio-cli-autopilot-plugin/issues",
77
"dependencies": {
88
"@dabblelab/autopilot-core": "^1.0.0",
99
"@oclif/command": "^1.5.19",
@@ -62,49 +62,49 @@
6262
],
6363
"topics": {
6464
"autopilot": {
65-
"description": "Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Assistant"
65+
"description": "Create, Update, Delete, List, Simulate, Import and Export Twilio Autopilot Bot"
6666
},
6767
"autopilot:create": {
68-
"description": "Create an assistant"
68+
"description": "Create a bot"
6969
},
7070
"autopilot:list": {
71-
"description": "List all autopilot assistant"
71+
"description": "List all autopilot bots"
7272
},
7373
"autopilot:update": {
74-
"description": "Update an assistant"
74+
"description": "Update a bot"
7575
},
7676
"autopilot:delete": {
77-
"description": "Delete an assistant"
77+
"description": "Delete a bot"
7878
},
7979
"autopilot:export": {
80-
"description": "Export an assistant"
80+
"description": "Export a bot"
8181
},
8282
"autopilot:simulate": {
83-
"description": "Simulate an assistant"
83+
"description": "Simulate a bot"
8484
},
8585
"autopilot:import": {
86-
"description": "Import a DialogFlow Agent/Alexa Interaction Model"
86+
"description": "Import a DialogFlow Agent or an Alexa Interaction Model"
8787
},
8888
"autopilot:tasks": {
89-
"description": "Create, Update, Delete, and List Twilio Autopilot Assistant Tasks"
89+
"description": "Create, Update, Delete, and List Twilio Autopilot Bot Tasks"
9090
},
9191
"autopilot:tasks:list": {
92-
"description": "List all tasks of an assistant"
92+
"description": "List all tasks for a bot"
9393
},
9494
"autopilot:tasks:create": {
95-
"description": "Create a task of an assistant"
95+
"description": "Create a task for a bot"
9696
},
9797
"autopilot:tasks:update": {
98-
"description": "Update a task of an assistant"
98+
"description": "Update a task for a bot"
9999
},
100100
"autopilot:tasks:delete": {
101-
"description": "Delete a task of an assistant"
101+
"description": "Delete a task for a bot"
102102
},
103103
"autopilot:samples:upload": {
104104
"description": "Upload task samples"
105105
},
106106
"autopilot:fields": {
107-
"description": "Create, Update, Delete, and List Fields of a Task"
107+
"description": "Create, Update, Delete, and List Fields for a Task"
108108
},
109109
"autopilot:fields:create": {
110110
"description": "Create task field"
@@ -116,53 +116,53 @@
116116
"description": "Delete task field"
117117
},
118118
"autopilot:fieldtypes": {
119-
"description": "Create, Update, and List fieldTypes of an assistant"
119+
"description": "Create, Update, and List fieldTypes for a bot"
120120
},
121121
"autopilot:fieldtypes:create": {
122-
"description": "Create assistant fieldType"
122+
"description": "Create bot fieldType"
123123
},
124124
"autopilot:fieldtypes:list": {
125-
"description": "List Assistant fieldTypes"
125+
"description": "List bot fieldTypes"
126126
},
127127
"autopilot:fieldtypes:update": {
128-
"description": "Update Assistant fieldType"
128+
"description": "Update a bot fieldType"
129129
},
130130
"autopilot:fieldvalues:upload": {
131131
"description": "Upload FieldValues"
132132
},
133133
"autopilot:queries:export": {
134-
"description": "Export Assistant Queries"
134+
"description": "Export Bot Queries"
135135
},
136136
"autopilot:webhooks": {
137-
"description": "Create, Update, List, and Delete webhooks of an assistant"
137+
"description": "Create, Update, List, and Delete webhooks for a bot"
138138
},
139139
"autopilot:webhooks:list": {
140-
"description": "List Assistant Webhooks"
140+
"description": "List Bot Webhooks"
141141
},
142142
"autopilot:webhooks:create": {
143-
"description": "Create Assistant Webhooks"
143+
"description": "Create Bot Webhooks"
144144
},
145145
"autopilot:webhooks:update": {
146-
"description": "Update Assistant Webhooks"
146+
"description": "Update Bot Webhooks"
147147
},
148148
"autopilot:webhooks:delete": {
149-
"description": "Delete Assistant Webhooks"
149+
"description": "Delete Bot Webhooks"
150150
},
151151
"autopilot:modelbuilds:create": {
152152
"description": "Create Model Builds"
153153
},
154154
"autopilot:deploy": {
155-
"description": "deploy function, model or all of them. Options can only be 'all', 'function' or 'model'."
155+
"description": "deploy function, model, or both. Options can be 'all', 'function', or 'model'."
156156
},
157157
"autopilot:init": {
158-
"description": "Initialize autopilot bot template."
158+
"description": "Initialize a new bot project from a template."
159159
}
160160
}
161161
},
162162
"publishConfig": {
163163
"access": "public"
164164
},
165-
"repository": "tingiris/twilio-cli-autopilot-plugin",
165+
"repository": "https://github.com/dabblelab/twilio-cli-autopilot-plugin",
166166
"scripts": {
167167
"postpack": "rm -f oclif.manifest.json",
168168
"posttest": "eslint --ignore-path .gitignore . && npm audit",

src/commands/autopilot/create.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,22 @@ class CreateAssistant extends TwilioClientCommand {
2121
clonedAssistant = '';
2222

2323
if(schema == 'templates'){
24-
24+
//TODO: the templates.json url should not be hard coded
2525
let url = 'https://raw.githubusercontent.com/twilio/autopilot-templates/master/Assistants/templates.json';
2626

2727
clonedAssistant = await AutopilotCore.cloneTemplate(url, false);
2828

2929
schema = path.join(clonedAssistant, 'schema.json');
3030

3131
}
32-
spinner.start('Creating assistant...');
32+
spinner.start('Creating bot...');
3333
let fullPath = `${path.resolve()}/${schema}`
3434

3535
const assistant = await AutopilotCore.createAssistant(fullPath, this.twilioClient);
3636

3737
spinner.stop()
3838

39-
console.log(`Assistant "${assistant.uniqueName}" was created`);
39+
console.log(`Bot "${assistant.uniqueName}" was created`);
4040
}catch(err){
4141

4242
spinner.stop()

src/commands/autopilot/export.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class ExportAssistants extends TwilioClientCommand {
3232
{
3333
type: 'list',
3434
name: 'assistantName',
35-
message: 'Choose your assistant: ',
35+
message: 'Choose your bot: ',
3636
choices: choices
3737
}
3838
]);
@@ -41,15 +41,15 @@ class ExportAssistants extends TwilioClientCommand {
4141
}
4242
else{
4343

44-
console.log('no assistants.');
44+
console.log('no bots.');
4545
return;
4646
}
4747
}
4848

49-
spinner.start(`Exporting assistant...`);
49+
spinner.start(`Exporting bot...`);
5050
const assistant = await AutopilotCore.exportAssistant(seletedAssistant, this.twilioClient);
5151
spinner.stop();
52-
console.log(`File exported in "${assistant.filename}"`);
52+
console.log(`Bot schema file exported to "${assistant.filename}"`);
5353
}catch(err){
5454

5555
spinner.stop();

src/commands/autopilot/fieldtypes/list.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ListAssistantFieldTypes extends TwilioClientCommand {
1717
return;
1818
}
1919

20-
const spinner = ora().start('Getting Assistant FieldTypes...\n');
20+
const spinner = ora().start('Getting Bot FieldTypes...\n');
2121
try{
2222

2323
const {assistantSid} = flags;

src/commands/autopilot/import.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class ImportAssistant extends TwilioClientCommand {
5050
name = flags.dfagent,
5151
dfFullPath = `${path.resolve()}/${dfbackup}`;
5252

53-
spinner.start('Importing assistant...');
53+
spinner.start('Importing bot...');
5454

5555
filename = await AutopilotCore.importDialogFlowAgent(dfFullPath, name);
5656
}
@@ -66,7 +66,7 @@ class ImportAssistant extends TwilioClientCommand {
6666
}
6767

6868
spinner.stop()
69-
console.log(`Assistant "${assistant.uniqueName}" was imported`);
69+
console.log(`Bot "${assistant.uniqueName}" was imported`);
7070
}catch(err){
7171

7272
spinner.stop()

src/commands/autopilot/queries/export.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ class ExportAssistantQueries extends TwilioClientCommand {
2222
return;
2323
}
2424

25-
const spinner = ora().start('Exporting assistant queries...\n');
25+
const spinner = ora().start('Exporting bot queries...\n');
2626
try{
2727

2828
const {assistantSid, quantity} = flags;
2929

3030
await AutopilotCore.exportAssistantQueries(this.twilioClient, assistantSid, quantity);
3131
spinner.stop();
32-
console.log(`File exported in "${assistantSid}"`);
32+
console.log(`Bot queries exported to "${assistantSid}"`);
3333
}catch(err){
3434

3535
spinner.stop();

src/commands/autopilot/tasks/create.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class CreateAssistantTask extends TwilioClientCommand {
2222
return;
2323
}
2424

25-
const spinner = ora().start('Creating assistant task...\n');
25+
const spinner = ora().start('Creating bot task...\n');
2626
try{
2727

2828
const {assistantSid, uniqueName, friendlyName} = flags,

src/commands/autopilot/tasks/delete.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class DeleteAssistantTask extends TwilioClientCommand {
4949

5050
}
5151

52-
spinner.start('Deleting assistant task...\n');
52+
spinner.start('Deleting bot task...\n');
5353
const task = await AutopilotCore.tasks.remove(this.twilioClient, assistantSid, tSid);
5454
spinner.stop();
5555
console.log(`Task "${task.uniqueName}" was deleted`);

src/commands/autopilot/tasks/list.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class ListAssistantTasks extends TwilioClientCommand {
1616
console.log(`The '--assistant-sid' is required`);
1717
return;
1818
}
19-
const spinner = ora().start('Getting assistant tasks...\n');
19+
const spinner = ora().start('Getting bot tasks...\n');
2020
try{
2121

2222
const fullData = await AutopilotCore.tasks.list(this.twilioClient, flags.assistantSid);

src/commands/autopilot/update.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ class UpdateAssistant extends TwilioClientCommand {
2323

2424
let schema = flags.schema;
2525

26-
spinner.start('Updating assistant...');
26+
spinner.start('Updating bot...');
2727
let fullPath = `${path.resolve()}/${schema}`,
2828
assistantUniqueName = flags.uniqueName || false;
2929

3030
const assistant = await AutopilotCore.updateAssistant(fullPath, this.twilioClient, assistantUniqueName);
3131

3232
spinner.stop()
3333

34-
console.log(`Assistant "${assistant.uniqueName}" was updated`)
34+
console.log(`Bot "${assistant.uniqueName}" was updated`)
3535

3636
}catch(err){
3737

0 commit comments

Comments
 (0)