Skip to content

Commit 8e9cdae

Browse files
pranavdeshpranavdesh
authored
Fixed typos, updated descriptions
1 parent 89aed9c commit 8e9cdae

File tree

1 file changed

+35
-31
lines changed

1 file changed

+35
-31
lines changed

‎README.md‎

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ _Assistants_
5353
* [`twilio autopilot:list`](#twilio-autopilotlist)
5454
* [`twilio autopilot:update`](#twilio-autopilotupdate)
5555

56-
_Fields and Field Types
56+
_Fields and Field Types_
5757

5858
* [`twilio autopilot:fields:create`](#twilio-autopilotfieldscreate)
5959
* [`twilio autopilot:fields:delete`](#twilio-autopilotfieldsdelete)
@@ -77,7 +77,7 @@ _Import bots from other platforms_
7777

7878
* [`twilio autopilot:import [TYPE]`](#twilio-autopilotimport-type)
7979

80-
_Webhooks
80+
_Webhooks_
8181

8282
* [`twilio autopilot:webhooks:create`](#twilio-autopilotwebhookscreate)
8383
* [`twilio autopilot:webhooks:delete`](#twilio-autopilotwebhooksdelete)
@@ -103,7 +103,7 @@ USAGE
103103
104104
OPTIONS
105105
-p, --profile=profile Shorthand identifier for your profile.
106-
-s, --schema=schema (required) [default: templates] schema path
106+
-s, --schema=schema (required) [default: templates] path to schema file
107107
```
108108

109109
_See code: [src/commands/autopilot/create.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/create.js)_
@@ -150,7 +150,8 @@ USAGE
150150
151151
OPTIONS
152152
-p, --profile=profile Shorthand identifier for your profile.
153-
--properties=properties [default: sid, uniqueName, friendlyName] The Autopilot Assistant List
153+
--properties=properties [default: sid, uniqueName, friendlyName] assistant properties to list -
154+
https://www.twilio.com/docs/autopilot/api/assistant#assistant-properties
154155
```
155156

156157
_See code: [src/commands/autopilot/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/list.js)_
@@ -165,7 +166,7 @@ USAGE
165166
166167
OPTIONS
167168
-p, --profile=profile Shorthand identifier for your profile.
168-
-s, --schema=schema (required) schema path
169+
-s, --schema=schema (required) path to schema file to use for the update
169170
--unique-name=unique-name assistant unique name
170171
```
171172

@@ -181,9 +182,9 @@ USAGE
181182
182183
OPTIONS
183184
-p, --profile=profile Shorthand identifier for your profile.
184-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
185+
-s, --assistant-sid=assistant-sid (required) assistant sid
185186
186-
--field-type-sid=field-type-sid The Field Type of the new field. Can be: a [Built-in
187+
--field-type-sid=field-type-sid The sid of the new field type. Can be: a [Built-in
187188
FieldType](https://www.twilio.com/docs/assistant/api/built-in-field-types ), the
188189
`unique_name`, or the `sid` of a custom Field Type.
189190
@@ -204,11 +205,9 @@ USAGE
204205
205206
OPTIONS
206207
-p, --profile=profile Shorthand identifier for your profile.
207-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
208+
-s, --assistant-sid=assistant-sid (required) assistant sid
208209
209-
--field-sid=field-sid The Field Type of the new field. Can be: a [Built-in
210-
FieldType](https://www.twilio.com/docs/assistant/api/built-in-field-types ), the
211-
`unique_name`, or the `sid` of a custom Field Type.
210+
--field-sid=field-sid sid of the field to delete
212211
213212
--task-sid=task-sid task sid
214213
```
@@ -225,8 +224,9 @@ USAGE
225224
226225
OPTIONS
227226
-p, --profile=profile Shorthand identifier for your profile.
228-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
229-
--properties=properties [default: sid, uniqueName, fieldType] The Autopilot Assistant Task List
227+
-s, --assistant-sid=assistant-sid (required) assistant sid
228+
--properties=properties [default: sid, uniqueName, fieldType] field properties to list -
229+
https://www.twilio.com/docs/autopilot/api/task-field#field-properties
230230
--task-sid=task-sid task sid
231231
```
232232

@@ -259,8 +259,9 @@ USAGE
259259
260260
OPTIONS
261261
-p, --profile=profile Shorthand identifier for your profile.
262-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
263-
--properties=properties [default: sid, uniqueName] The Autopilot Assistant FieldType List
262+
-s, --assistant-sid=assistant-sid (required) assistant sid
263+
--properties=properties [default: sid, uniqueName] field type properties to list -
264+
https://www.twilio.com/docs/autopilot/api/field-type#fieldtype-properties
264265
```
265266

266267
_See code: [src/commands/autopilot/fieldtypes/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/fieldtypes/list.js)_
@@ -275,7 +276,7 @@ USAGE
275276
276277
OPTIONS
277278
-p, --profile=profile Shorthand identifier for your profile.
278-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
279+
-s, --assistant-sid=assistant-sid (required) assistant sid
279280
--field-type-sid=field-type-sid (required) field type sid
280281
--friendly-name=friendly-name field type friendly name to update
281282
--unique-name=unique-name field unique name
@@ -293,7 +294,7 @@ USAGE
293294
294295
OPTIONS
295296
-p, --profile=profile Shorthand identifier for your profile.
296-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
297+
-s, --assistant-sid=assistant-sid (required) assistant sid
297298
--field-type-sid=field-type-sid field type SID
298299
--file-name=file-name (required) a CSV file of field values (one on each row with synonyms in columns)
299300
```
@@ -310,7 +311,7 @@ USAGE
310311
311312
OPTIONS
312313
-p, --profile=profile Shorthand identifier for your profile.
313-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
314+
-s, --assistant-sid=assistant-sid (required) assistant sid
314315
--friendly-name=friendly-name friendly name for task
315316
--unique-name=unique-name (required) unique name for task
316317
```
@@ -327,7 +328,7 @@ USAGE
327328
328329
OPTIONS
329330
-p, --profile=profile Shorthand identifier for your profile.
330-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
331+
-s, --assistant-sid=assistant-sid (required) assistant sid
331332
--task-sid=task-sid task sid
332333
```
333334

@@ -343,8 +344,9 @@ USAGE
343344
344345
OPTIONS
345346
-p, --profile=profile Shorthand identifier for your profile.
346-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
347-
--properties=properties [default: sid, uniqueName, friendlyName] The Autopilot Assistant Task List
347+
-s, --assistant-sid=assistant-sid (required) assistant sid
348+
--properties=properties [default: sid, uniqueName, friendlyName] task properties to list -
349+
https://www.twilio.com/docs/autopilot/api/task#task-properties
348350
```
349351

350352
_See code: [src/commands/autopilot/tasks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/tasks/list.js)_
@@ -359,7 +361,7 @@ USAGE
359361
360362
OPTIONS
361363
-p, --profile=profile Shorthand identifier for your profile.
362-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
364+
-s, --assistant-sid=assistant-sid (required) assistant sid
363365
--friendly-name=friendly-name task friendly name to update
364366
--task-sid=task-sid task sid
365367
--unique-name=unique-name task unique name to update
@@ -377,7 +379,7 @@ USAGE
377379
378380
OPTIONS
379381
-p, --profile=profile Shorthand identifier for your profile.
380-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
382+
-s, --assistant-sid=assistant-sid (required) assistant sid
381383
--file-name=file-name (required) a CSV file of samples
382384
--task-sid=task-sid task sid
383385
```
@@ -423,7 +425,7 @@ OPTIONS
423425
-e, --events=events (required) list of space-separated webhook events
424426
-m, --method=method which HTTP method to use
425427
-p, --profile=profile Shorthand identifier for your profile.
426-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
428+
-s, --assistant-sid=assistant-sid (required) assistant sid
427429
-u, --webhookURL=webhookURL (required) the URL to send events to
428430
-w, --webhook-unique-name=webhook-unique-name (required) unique name for webhook
429431
```
@@ -440,7 +442,7 @@ USAGE
440442
441443
OPTIONS
442444
-p, --profile=profile Shorthand identifier for your profile.
443-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
445+
-s, --assistant-sid=assistant-sid (required) assistant sid
444446
--webhook-sid=webhook-sid SID of the webhook to delete
445447
```
446448

@@ -456,10 +458,12 @@ USAGE
456458
457459
OPTIONS
458460
-p, --profile=profile Shorthand identifier for your profile.
459-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
461+
-s, --assistant-sid=assistant-sid (required) assistant sid
460462
461463
--properties=properties [default: sid, uniqueName, webhookUrl, events, dateCreated, dateUpdated,
462-
webhookMethod] The Autopilot Assistant Webhooks List
464+
webhookMethod] webhook properties to list -
465+
https://www.twilio.com/docs/autopilot/api/event-webhooks#webhook-properties
466+
463467
```
464468

465469
_See code: [src/commands/autopilot/webhooks/list.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/webhooks/list.js)_
@@ -476,7 +480,7 @@ OPTIONS
476480
-e, --events=events list of space-separated webhook events to update
477481
-m, --method=method which HTTP method to use to update
478482
-p, --profile=profile Shorthand identifier for your profile.
479-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
483+
-s, --assistant-sid=assistant-sid (required) assistant sid
480484
-u, --webhookURL=webhookURL the URL to send events to update
481485
-w, --webhook-unique-name=webhook-unique-name unique name for webhook to update
482486
--webhook-sid=webhook-sid SID of the webhook to update
@@ -494,7 +498,7 @@ USAGE
494498
495499
OPTIONS
496500
-p, --profile=profile Shorthand identifier for your profile.
497-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
501+
-s, --assistant-sid=assistant-sid (required) assistant sid
498502
-u, --callbackURL=callbackURL URL to get notified of model build status
499503
```
500504

@@ -527,7 +531,7 @@ USAGE
527531
OPTIONS
528532
-p, --profile=profile Shorthand identifier for your profile.
529533
-q, --quantity=quantity (required) number of queries to retrieve
530-
-s, --assistant-sid=assistant-sid (required) assistant that owns the task
534+
-s, --assistant-sid=assistant-sid (required) assistant sid
531535
```
532536

533537
_See code: [src/commands/autopilot/queries/export.js](https://github.com/tingiris/twilio-cli-autopilot-plugin/blob/v1.0.0-beta.20/src/commands/autopilot/queries/export.js)_
@@ -548,4 +552,4 @@ OPTIONS
548552
```
549553

550554
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_
551-
<!-- commandsstop -->
555+
<!-- commandsstop -->

0 commit comments

Comments
 (0)