@fonoster/ctl 0.4.7 → 0.7.37

package/README.md

@@ -1,676 +1,419 @@
-# ctl
+voice
+=================
 
-Command-Line for for Fonoster
+[![Voice](https://img.shields.io/badge/voice-api-brightgreen.svg)](https://fonoster.com)
+[![Version](https://img.shields.io/npm/v/@fonoster/voice.svg)](https://npmjs.org/package/@fonoster/voice)
+[![Downloads/week](https://img.shields.io/npm/dw/@fonoster/voice.svg)](https://npmjs.org/package/@fonoster/voice)
+[![License](https://img.shields.io/npm/l/@fonoster/voice.svg)](https://github.com/fonoster/fonoster/blob/main/package.json)
 
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/ctl.svg)](https://npmjs.org/package/ctl)
-[![Downloads/week](https://img.shields.io/npm/dw/ctl.svg)](https://npmjs.org/package/ctl)
-[![License](https://img.shields.io/npm/l/ctl.svg)](https://github.com/fonoster/fonoster/blob/main/package.json)
+The Voice module is a library for creating voice applications using the Fonoster API. It provides a simple way to create voice applications that can interact with the calling party using DTMF or speech recognition combined with simple verbs.
 
-<!-- toc -->
-* [ctl](#ctl)
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
+* [Installation](#installation)
+* [Example](#example)
+* [Voice Response](#VoiceResponse)
 
-# Usage
+## Installation
 
-<!-- usage -->
 ```sh-session
-$ npm install -g @fonoster/ctl
-$ fonoster COMMAND
-running command...
-$ fonoster (-v|--version|version)
-@fonoster/ctl/0.4.0 darwin-x64 node-v16.18.1
-$ fonoster --help [COMMAND]
-USAGE
-  $ fonoster COMMAND
-...
+$ npm install --save @fonoster/voice
 ```
-<!-- usagestop -->
-
-# Commands
-
-<!-- commands -->
-* [`fonoster agents:create`](#fonoster-agentscreate)
-* [`fonoster agents:delete [REF]`](#fonoster-agentsdelete-ref)
-* [`fonoster agents:get [REF]`](#fonoster-agentsget-ref)
-* [`fonoster agents:list`](#fonoster-agentslist)
-* [`fonoster agents:update [REF]`](#fonoster-agentsupdate-ref)
-* [`fonoster auth:login`](#fonoster-authlogin)
-* [`fonoster auth:logout`](#fonoster-authlogout)
-* [`fonoster bug`](#fonoster-bug)
-* [`fonoster domains:create`](#fonoster-domainscreate)
-* [`fonoster domains:delete [REF]`](#fonoster-domainsdelete-ref)
-* [`fonoster domains:get [REF]`](#fonoster-domainsget-ref)
-* [`fonoster domains:list`](#fonoster-domainslist)
-* [`fonoster domains:update [REF]`](#fonoster-domainsupdate-ref)
-* [`fonoster feedback`](#fonoster-feedback)
-* [`fonoster help [COMMAND]`](#fonoster-help-command)
-* [`fonoster numbers:create`](#fonoster-numberscreate)
-* [`fonoster numbers:delete [REF]`](#fonoster-numbersdelete-ref)
-* [`fonoster numbers:get [REF]`](#fonoster-numbersget-ref)
-* [`fonoster numbers:list`](#fonoster-numberslist)
-* [`fonoster numbers:update [REF]`](#fonoster-numbersupdate-ref)
-* [`fonoster plugins`](#fonoster-plugins)
-* [`fonoster plugins:inspect PLUGIN...`](#fonoster-pluginsinspect-plugin)
-* [`fonoster plugins:install PLUGIN...`](#fonoster-pluginsinstall-plugin)
-* [`fonoster plugins:link PLUGIN`](#fonoster-pluginslink-plugin)
-* [`fonoster plugins:uninstall PLUGIN...`](#fonoster-pluginsuninstall-plugin)
-* [`fonoster plugins:update`](#fonoster-pluginsupdate)
-* [`fonoster projects:create`](#fonoster-projectscreate)
-* [`fonoster projects:delete [REF]`](#fonoster-projectsdelete-ref)
-* [`fonoster projects:get [REF]`](#fonoster-projectsget-ref)
-* [`fonoster projects:list`](#fonoster-projectslist)
-* [`fonoster projects:renew [REF]`](#fonoster-projectsrenew-ref)
-* [`fonoster projects:use [REF]`](#fonoster-projectsuse-ref)
-* [`fonoster providers:create`](#fonoster-providerscreate)
-* [`fonoster providers:delete [REF]`](#fonoster-providersdelete-ref)
-* [`fonoster providers:get [REF]`](#fonoster-providersget-ref)
-* [`fonoster providers:list`](#fonoster-providerslist)
-* [`fonoster providers:update [REF]`](#fonoster-providersupdate-ref)
-
-## `fonoster agents:create`
-
-create a new Fonoster Agent
 
-```
-USAGE
-  $ fonoster agents:create
-
-DESCRIPTION
-  ...
-     Create a new Fonoster Agent
-```
-
-_See code: [dist/commands/agents/create.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/agents/create.js)_
-
-## `fonoster agents:delete [REF]`
-
-delete a Fonoster Agent
-
-```
-USAGE
-  $ fonoster agents:delete [REF]
-
-ALIASES
-  $ fonoster agents:del
-  $ fonoster agents:rm
-```
-
-_See code: [dist/commands/agents/delete.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/agents/delete.js)_
-
-## `fonoster agents:get [REF]`
-
-get a Fonoster Agent
-
-```
-USAGE
-  $ fonoster agents:get [REF]
-```
-
-_See code: [dist/commands/agents/get.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/agents/get.js)_
-
-## `fonoster agents:list`
-
-list all Fonoster Agents you have access to
-
-```
-USAGE
-  $ fonoster agents:list
-
-OPTIONS
-  -s, --size=size  [default: 25] agent of result per page
-
-DESCRIPTION
-  ...
-     List all Fonoster Agents you have access to
-
-ALIASES
-  $ fonoster agents:ls
-```
-
-_See code: [dist/commands/agents/list.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/agents/list.js)_
-
-## `fonoster agents:update [REF]`
-
-update a Fonoster Agent
-
-```
-USAGE
-  $ fonoster agents:update [REF]
-
-DESCRIPTION
-  ...
-     Update a Fonoster Agent
-```
-
-_See code: [dist/commands/agents/update.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/agents/update.js)_
-
-## `fonoster auth:login`
-
-log in to a Fonoster deployment
-
-```
-USAGE
-  $ fonoster auth:login
-```
-
-_See code: [dist/commands/auth/login.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/auth/login.js)_
-
-## `fonoster auth:logout`
-
-log out from a fonoster deployment
-
-```
-USAGE
-  $ fonoster auth:logout
-```
-
-_See code: [dist/commands/auth/logout.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/auth/logout.js)_
-
-## `fonoster bug`
-
-start a bug report 🐞
-
-```
-USAGE
-  $ fonoster bug
-
-DESCRIPTION
-  ...
-     Opens github issues with a predefine bug template
-```
-
-_See code: [dist/commands/bug.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/bug.js)_
-
-## `fonoster domains:create`
-
-create a new Fonoster Domain
-
-```
-USAGE
-  $ fonoster domains:create
-
-DESCRIPTION
-  ...
-     Create a new Fonoster Domain
-```
-
-_See code: [dist/commands/domains/create.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/domains/create.js)_
-
-## `fonoster domains:delete [REF]`
-
-delete a Fonoster Domain
-
-```
-USAGE
-  $ fonoster domains:delete [REF]
-
-ALIASES
-  $ fonoster domains:del
-  $ fonoster domains:rm
-```
-
-_See code: [dist/commands/domains/delete.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/domains/delete.js)_
-
-## `fonoster domains:get [REF]`
-
-get a Fonoster Domain
-
-```
-USAGE
-  $ fonoster domains:get [REF]
-```
-
-_See code: [dist/commands/domains/get.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/domains/get.js)_
-
-## `fonoster domains:list`
-
-list all Fonoster Domains you have access to
-
-```
-USAGE
-  $ fonoster domains:list
-
-OPTIONS
-  -s, --size=size  [default: 25] number of result per page
-
-DESCRIPTION
-  ...
-     List all Fonoster Domains you have access to
-
-ALIASES
-  $ fonoster domains:ls
-```
-
-_See code: [dist/commands/domains/list.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/domains/list.js)_
-
-## `fonoster domains:update [REF]`
-
-update a Fonoster Domain
-
-```
-USAGE
-  $ fonoster domains:update [REF]
-
-DESCRIPTION
-  ...
-     Update a Fonoster Domain
-```
-
-_See code: [dist/commands/domains/update.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/domains/update.js)_
-
-## `fonoster feedback`
-
-let us know how we're doing
-
-```
-USAGE
-  $ fonoster feedback
-
-DESCRIPTION
-  ...
-     Help us improve by providing some feedback
-```
-
-_See code: [dist/commands/feedback.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/feedback.js)_
-
-## `fonoster help [COMMAND]`
-
-display help for fonoster
-
-```
-USAGE
-  $ fonoster help [COMMAND]
-
-ARGUMENTS
-  COMMAND  command to show help for
-
-OPTIONS
-  --all  see all commands in CLI
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
-
-## `fonoster numbers:create`
-
-create a new Fonoster Number
-
-```
-USAGE
-  $ fonoster numbers:create
-
-DESCRIPTION
-  ...
-     Create a new Fonoster Number
-```
-
-_See code: [dist/commands/numbers/create.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/numbers/create.js)_
-
-## `fonoster numbers:delete [REF]`
-
-delete a Fonoster Number
-
-```
-USAGE
-  $ fonoster numbers:delete [REF]
-
-ALIASES
-  $ fonoster numbers:del
-  $ fonoster numbers:rm
-```
-
-_See code: [dist/commands/numbers/delete.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/numbers/delete.js)_
-
-## `fonoster numbers:get [REF]`
-
-get a Fonoster Number
-
-```
-USAGE
-  $ fonoster numbers:get [REF]
-```
-
-_See code: [dist/commands/numbers/get.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/numbers/get.js)_
-
-## `fonoster numbers:list`
-
-list all Fonoster Numbers you have access to
-
-```
-USAGE
-  $ fonoster numbers:list
-
-OPTIONS
-  -s, --size=size  [default: 25] number of result per page
-
-DESCRIPTION
-  ...
-     List all Fonoster Numbers you have access to
-
-ALIASES
-  $ fonoster numbers:ls
-```
-
-_See code: [dist/commands/numbers/list.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/numbers/list.js)_
-
-## `fonoster numbers:update [REF]`
-
-update a Fonoster Number
-
-```
-USAGE
-  $ fonoster numbers:update [REF]
-
-DESCRIPTION
-  ...
-     Update a Fonoster Number
-```
-
-_See code: [dist/commands/numbers/update.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/numbers/update.js)_
-
-## `fonoster plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ fonoster plugins
-
-OPTIONS
-  --core  Show core plugins.
-
-EXAMPLE
-  $ fonoster plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
-
-## `fonoster plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ fonoster plugins:inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN  [default: .] Plugin to inspect.
-
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-EXAMPLE
-  $ fonoster plugins:inspect myplugin
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/inspect.ts)_
-
-## `fonoster plugins:install PLUGIN...`
-
-Installs a plugin into the CLI.
-
-```
-USAGE
-  $ fonoster plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN  Plugin to install.
+## Example
 
-OPTIONS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -v, --verbose
+A Voice Application is a server that controls a call's flow. A Voice Application can use any combination of the following verbs:
 
-DESCRIPTION
-  Can be installed from npm or a git url.
+- `Answer` - Accepts an incoming call
+- `Dial` - Passes the call to an Agent or a Number at the PSTN
+- `Hangup` - Closes the call
+- `Play` - Takes a URL or file and streams the sound back to the calling party
+- `Say` - Takes a text, synthesizes the text into audio, and streams back the result
+- `Gather` - Waits for DTMF or speech events and returns back the result
+- `SGather` - Returns a stream for future DTMF and speech results
+- `Stream` - Starts a stream to read and write audio into the call
+- `Record` - It records the voice of the calling party and saves the audio on the Storage sub-system
+- `Mute` - It tells the channel to stop sending media, effectively muting the channel
+- `Unmute` - It tells the channel to allow media flow
 
-  Installation of a user-installed plugin will override a core plugin.
+Voice Application Example:
 
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
-  the CLI without the need to patch and update the whole CLI.
+```typescript
+const VoiceServer = require("@fonoster/voice").default;
+const { 
+  GatherSource, 
+  VoiceRequest, 
+  VoiceResponse 
+} = require("@fonoster/voice");
 
-ALIASES
-  $ fonoster plugins:add
+new VoiceServer().listen(async (req: VoiceRequest, voice: VoiceResponse) => {
+  const { ingressNumber, sessionRef, appRef } = req;
 
-EXAMPLES
-  $ fonoster plugins:install myplugin 
-  $ fonoster plugins:install https://github.com/someuser/someplugin
-  $ fonoster plugins:install someuser/someplugin
-```
+  await voice.answer();
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/install.ts)_
+  await voice.say("Hi there! What's your name?");
 
-## `fonoster plugins:link PLUGIN`
+  const { speech: name } = await res.gather({
+    source: GatherSource.SPEECH
+  });
 
-Links a plugin into the CLI for development.
+  await voice.say("Nice to meet you " + name + "!");
 
-```
-USAGE
-  $ fonoster plugins:link PLUGIN
+  await voice.say("Please enter your 4 digit pin.");
 
-ARGUMENTS
-  PATH  [default: .] path to plugin
+  const { digits } = await voice.gather({
+    maxDigits: 4,
+    finishOnKey: "#"
+  });
 
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
+  await voice.say("Your pin is " + digits);
 
-DESCRIPTION
-  Installation of a linked plugin will override a user-installed or core plugin.
+  await voice.hangup();
+});
 
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
-  command will override the user-installed or core plugin implementation. This is useful for development work.
-
-EXAMPLE
-  $ fonoster plugins:link myplugin
+// Your app will live at tcp://127.0.0.1:50061 
+// and you can easily publish it to the Internet with:
+// ngrok tcp 50061
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/link.ts)_
-
-## `fonoster plugins:uninstall PLUGIN...`
+<a name="VoiceResponse"></a>
 
-Removes a plugin from the CLI.
+## VoiceResponse ⇐ <code>Verb</code>
+Use the VoiceResponse object, to construct advance Interactive
+Voice Response (IVR) applications.
 
-```
-USAGE
-  $ fonoster plugins:uninstall PLUGIN...
+**Kind**: global class  
+**Extends**: <code>Verb</code>  
+**See**: module:core:APIClient  
 
-ARGUMENTS
-  PLUGIN  plugin to uninstall
+* [VoiceResponse](#VoiceResponse) ⇐ <code>Verb</code>
+    * [new VoiceResponse(request, voice)](#new_VoiceResponse_new)
+    * [.answer()](#VoiceResponse+answer)
+    * [.hangup()](#VoiceResponse+hangup)
+    * [.play(url, options)](#VoiceResponse+play)
+    * [.playDtmf(digits)](#VoiceResponse+playDtmf)
+    * [.playbackControl(playbackRef, action)](#VoiceResponse+playbackControl)
+    * [.gather(options)](#VoiceResponse+gather)
+    * [.say(text, options)](#VoiceResponse+say)
+    * [.record(options)](#VoiceResponse+record) ⇒ <code>RecordResponse</code>
+    * [.dial(destination, options)](#VoiceResponse+dial) ⇒ <code>Promise.&lt;DialStatusStream&gt;</code>
+    * [.stream(options)](#VoiceResponse+stream) ⇒ <code>Promise.&lt;Stream&gt;</code>
+    * [.sgather(options)](#VoiceResponse+sgather) ⇒ <code>Promise.&lt;StreamGatherStream&gt;</code>
+    * [.mute(options)](#VoiceResponse+mute)
+    * [.unmute(options)](#VoiceResponse+unmute)
+    * [.on(event, listener)](#VoiceResponse+on)
 
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
+<a name="new_VoiceResponse_new"></a>
 
-ALIASES
-  $ fonoster plugins:unlink
-  $ fonoster plugins:remove
-```
+### new VoiceResponse(request, voice)
+Constructs a new VoiceResponse object.
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/uninstall.ts)_
 
-## `fonoster plugins:update`
+| Param | Type | Description |
+| --- | --- | --- |
+| request | <code>VoiceRequest</code> | Options to indicate the objects endpoint |
+| voice | <code>VoiceSessionStream</code> | The voice session stream |
 
-Update installed plugins.
+**Example**  
+```js
+import { VoiceServer } from "@fonoster/voice";
 
-```
-USAGE
-  $ fonoster plugins:update
+async function handler (request, response) {
+  await response.answer();
+  await response.play("https://soundsserver:9000/sounds/hello-world.wav");
+}
 
-OPTIONS
-  -h, --help     Show CLI help.
-  -v, --verbose
+new VoiceServer().listen(handler, { port: 3000 })
 ```
+<a name="VoiceResponse+answer"></a>
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/update.ts)_
-
-## `fonoster projects:create`
-
-create a new Fonoster Project
+### voiceResponse.answer()
+Answer the call. Before running any other verb you
+must run the anwer command.
 
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+}
 ```
-USAGE
-  $ fonoster projects:create
-
-DESCRIPTION
-  ...
-     Create a new Fonoster Project
-```
-
-_See code: [dist/commands/projects/create.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/create.js)_
+<a name="VoiceResponse+hangup"></a>
 
-## `fonoster projects:delete [REF]`
+### voiceResponse.hangup()
+Hangup the call.
 
-delete a Fonoster Project
-
-```
-USAGE
-  $ fonoster projects:delete [REF]
-
-ALIASES
-  $ fonoster projects:del
-  $ fonoster projects:rm
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Example**  
+```js
+async function handler (request, response) {
+ await response.hangup();
+}
 ```
+<a name="VoiceResponse+play"></a>
 
-_See code: [dist/commands/projects/delete.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/delete.js)_
+### voiceResponse.play(url, options)
+Play an audio in the call.
 
-## `fonoster projects:get [REF]`
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**See**: Playback  
 
-get a Fonoster Project
+| Param | Type | Description |
+| --- | --- | --- |
+| url | <code>string</code> | The URL of the media to play |
+| options | <code>PlayOptions</code> | Options to control the playback |
+| options.playbackRef | <code>string</code> | Playback identifier to use in Playback operations |
 
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  await response.play("https://soundsserver:9000/sounds/hello-world.wav");
+}
 ```
-USAGE
-  $ fonoster projects:get [REF]
-```
+<a name="VoiceResponse+playDtmf"></a>
+
+### voiceResponse.playDtmf(digits)
+Play a series of DTMF digits in a call.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| digits | <code>string</code> | The DTMF digits to play (0-9, #, or *) |
+
+**Example**  
+```js
+async function handler (request, response) {
+ await response.answer();
+ await response.playDtmf("1234");
+}
+```
+<a name="VoiceResponse+playbackControl"></a>
+
+### voiceResponse.playbackControl(playbackRef, action)
+Control the playback of the currently playing media.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**See**: play  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| playbackRef | <code>string</code> | The playback identifier |
+| action | <code>PlaybackControlAction</code> | The action to perform (STOP, RESTART, PAUSE, UNPAUSE, FORWARD) |
 
-_See code: [dist/commands/projects/get.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/get.js)_
-
-## `fonoster projects:list`
-
-list all Fonoster Projects you have access to
+**Example**  
+```js
+async function handler (request, response) {
+   await response.answer();
+   await response.play("https://s3.fonoster.io/uuid/hello-world.wav", { playbackRef: "playback-01" });
 
+   // Pause the media
+   await response.playbackControl("playback-01", PlaybackControlAction.PAUSE);
+}
+```
+<a name="VoiceResponse+gather"></a>
+
+### voiceResponse.gather(options)
+Waits for data entry from the user's keypad or from a speech provider.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Note**: When including `SPEECH` the default timeout is 10000 (10s).  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>GatherOptions</code> | Options to select the maximum number of digits, final character, and timeout |
+| options.maxDigits | <code>number</code> | Maximum number of digits to collect. Defaults to 1 |
+| options.timeout | <code>number</code> | Milliseconds to wait before timeout. Defaults to 4000. Use zero for no timeout. |
+| options.finishOnKey | <code>string</code> | Optional last character to wait for. Defaults to '#'. It will not be included in the returned digits |
+| options.source | <code>GatherSource</code> | Where to listen as input source. This option accepts `DTMF` and `SPEECH`. A speech provider must be configure when including the `SPEECH` source. You might inclue both with `SPEECH_AND_DTMF`. Defaults to `SPEECH_AND_DTMF` |
+
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  const speech = await response.gather({ source: GatherSource.SPEECH, numDigits: 3 });
+  console.log("speech: " + speech);
+  await response.hangup();
+}
 ```
-USAGE
-  $ fonoster projects:list
+<a name="VoiceResponse+say"></a>
+
+### voiceResponse.say(text, options)
+Send a text for a TTS engine to convert to speech.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**See**: Say  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | The text to convert to speech |
+| options | <code>SayOptions</code> | Options to control the TTS engine |
+| options.playbackRef | <code>string</code> | Playback identifier to use in Playback operations |
+| options.ttsOptions | <code>TTSOptions</code> | Options to control the TTS engine (specific to the TTS engine) |
+
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  const playbackRef = await response.say("Hello World");
+
+  // Like the play verb, you can control the playback
+  await response.playbackControl(playbackRef, PlaybackControlAction.STOP);
+}
+```
+<a name="VoiceResponse+record"></a>
+
+### voiceResponse.record(options) ⇒ <code>RecordResponse</code>
+Record the audio of the call.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Returns**: <code>RecordResponse</code> - The record response  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>RecordOptions</code> | Options to control the record operation |
+| options.maxDuration | <code>number</code> | The maximum duration of the recording in seconds. Default is 60 |
+| options.maxSilence | <code>number</code> | The maximum duration of silence in seconds. Default is 5 |
+| options.beep | <code>boolean</code> | Play a beep before recording. Default is true |
+| options.finishOnKey | <code>string</code> | Stop recording when a DTMF digit is received. Default is '#' |
+
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  const record = await response.record();
+  console.log("Recording: %s", record.name);
+}
+```
+<a name="VoiceResponse+dial"></a>
+
+### voiceResponse.dial(destination, options) ⇒ <code>Promise.&lt;DialStatusStream&gt;</code>
+Dials a destination and returns a stream of status.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Returns**: <code>Promise.&lt;DialStatusStream&gt;</code> - The dial status stream  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| destination | <code>string</code> | The destination to dial |
+| options | <code>DialOptions</code> | Options to control the dial operation |
+| options.timeout | <code>number</code> | The timeout in seconds. Default is 60 |
+| options.recordDirection | <code>RecordDirection</code> | The direction to record the call (IN, OUT, BOTH). Default is BOTH |
+
+<a name="VoiceResponse+stream"></a>
+
+### voiceResponse.stream(options) ⇒ <code>Promise.&lt;Stream&gt;</code>
+Starts a bidirectional audio stream between the call and the application.
+
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Returns**: <code>Promise.&lt;Stream&gt;</code> - The stream object  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>StreamOptions</code> | Options to control the stream operation |
+| options.direction | <code>StreamDirection</code> | The direction to stream the audio (IN, OUT, BOTH). Default is BOTH |
+| options.format | <code>StreamAudioFormat</code> | The audio format to stream (WAV). Default is WAV |
+
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+
+  const stream = await response.stream({
+    direction: StreamDirection.BOTH
+  });
+
+  stream.onPayload((payload) => {
+    // Use the payload
+  });
+
+  // Or write to the stream
+  // stream.write({ type: StreamMessageType.AUDIO_OUT, payload: "\x00\x01\x02" });
+}
+```
+<a name="VoiceResponse+sgather"></a>
 
-DESCRIPTION
-  ...
-     List all Fonoster Projects you have access to
+### voiceResponse.sgather(options) ⇒ <code>Promise.&lt;StreamGatherStream&gt;</code>
+Starts a server-side stream gather operation which sends transcription data to the voice server.
 
-ALIASES
-  $ fonoster projects:ls
-```
-
-_See code: [dist/commands/projects/list.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/list.js)_
-
-## `fonoster projects:renew [REF]`
-
-renew the credentials of a Fonoster Project
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**Returns**: <code>Promise.&lt;StreamGatherStream&gt;</code> - The stream gather object  
+**See**: Gather  
 
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>StreamGatherOptions</code> | Options to control the stream gather operation |
+| options.source | <code>StreamGatherSource</code> | The source to gather data from (DTMF, SPEECH, SPEECH_AND_DTMF). Default is SPEECH |
+
+**Example**  
+```js
+async function handler (request, response) {
+ await response.answer();
+ const sGather = await response.streamGather({ source: StreamGatherSource.SPEECH });
+ sGather.onPayload((payload) => {
+   console.log("Payload: %s", payload);
+ });
+}
 ```
-USAGE
-  $ fonoster projects:renew [REF]
+<a name="VoiceResponse+mute"></a>
 
-DESCRIPTION
-  ...
-     Renew the credentials of a Fonoster Project
-```
-
-_See code: [dist/commands/projects/renew.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/renew.js)_
+### voiceResponse.mute(options)
+Mutes a call.
 
-## `fonoster projects:use [REF]`
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**See**: unmute  
 
-set a default Fonoster Project
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>MuteOptions</code> | Options to control the mute operation |
+| options.direction | <code>MuteDirection</code> | The direction to mute the channel (IN, OUT, BOTH). Default is BOTH |
 
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  await response.mute();       // Will mute both directions
+}
 ```
-USAGE
-  $ fonoster projects:use [REF]
+<a name="VoiceResponse+unmute"></a>
 
-DESCRIPTION
-  ...
-     Set a default Fonoster Project
-```
+### voiceResponse.unmute(options)
+Unmutes a call.
 
-_See code: [dist/commands/projects/use.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/projects/use.js)_
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
+**See**: mute  
 
-## `fonoster providers:create`
-
-create a new Fonoster Provider (trunk)
-
-```
-USAGE
-  $ fonoster providers:create
-
-DESCRIPTION
-  ...
-     Create a new Fonoster Provider
-```
-
-_See code: [dist/commands/providers/create.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/providers/create.js)_
-
-## `fonoster providers:delete [REF]`
-
-delete a Fonoster Provider
-
-```
-USAGE
-  $ fonoster providers:delete [REF]
-
-ALIASES
-  $ fonoster providers:del
-  $ fonoster providers:rm
-```
-
-_See code: [dist/commands/providers/delete.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/providers/delete.js)_
-
-## `fonoster providers:get [REF]`
-
-get a Fonoster Provider
+| Param | Type | Description |
+| --- | --- | --- |
+| options | <code>MuteOptions</code> | Options to control the unmute operation |
+| options.direction | <code>MuteDirection</code> | The direction to unmute the call (IN, OUT, BOTH). Default is BOTH |
 
+**Example**  
+```js
+async function handler (request, response) {
+  await response.answer();
+  await response.unmute();     // Will unmute both directions
+}
 ```
-USAGE
-  $ fonoster providers:get [REF]
-```
-
-_See code: [dist/commands/providers/get.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/providers/get.js)_
+<a name="VoiceResponse+on"></a>
 
-## `fonoster providers:list`
-
-list all Fonoster Providers you have access to
-
-```
-USAGE
-  $ fonoster providers:list
+### voiceResponse.on(event, listener)
+Register a listener for the given event.
 
-OPTIONS
-  -s, --size=size  [default: 25] provider of result per page
+**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
 
-DESCRIPTION
-  ...
-     List all Fonoster Providers you have access to
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>StreamEvent</code> | The event to listen for |
+| listener | <code>function</code> | The callback function |
 
-ALIASES
-  $ fonoster providers:ls
-```
-
-_See code: [dist/commands/providers/list.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/providers/list.js)_
-
-## `fonoster providers:update [REF]`
-
-update a Fonoster Provider
-
-```
-USAGE
-  $ fonoster providers:update [REF]
+**Example**  
+```js
+async function handler (request, response) {
+ ...
 
-DESCRIPTION
-  ...
-     Update a Fonoster Provider
+ response.on(StreamEvent.END, () => {
+  console.log("Call ended");
+ });
+}
 ```
 
-_See code: [dist/commands/providers/update.js](https://github.com/fonoster/fonoster/blob/v0.4.0/dist/commands/providers/update.js)_
-<!-- commandsstop -->