@fonoster/ctl 0.7.42 → 0.7.43

package/README.md

@@ -1,419 +1,17 @@
-voice
+ctl
 =================
 
-[![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)
-
-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.
-
-* [Installation](#installation)
-* [Example](#example)
-* [Voice Response](#VoiceResponse)
+[![command-line tool](https://img.shields.io/badge/ctl-oclif-brightgreen.svg)](https://fonoster.com)
+[![Version](https://img.shields.io/npm/v/@fonoster/ctl.svg)](https://npmjs.org/package/@fonoster/voice)
+[![Downloads/week](https://img.shields.io/npm/dw/@fonoster/ctl.svg)](https://npmjs.org/package/@fonoster/voice)
+[![License](https://img.shields.io/npm/l/@fonoster/ctl.svg)](https://github.com/fonoster/fonoster/blob/main/package.json)
 
 ## Installation
 
 ```sh-session
-$ npm install --save @fonoster/voice
-```
-
-## Example
-
-A Voice Application is a server that controls a call's flow. A Voice Application can use any combination of the following verbs:
-
-- `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
-
-Voice Application Example:
-
-```typescript
-const VoiceServer = require("@fonoster/voice").default;
-const { 
-  GatherSource, 
-  VoiceRequest, 
-  VoiceResponse 
-} = require("@fonoster/voice");
-
-new VoiceServer().listen(async (req: VoiceRequest, voice: VoiceResponse) => {
-  const { ingressNumber, sessionRef, appRef } = req;
-
-  await voice.answer();
-
-  await voice.say("Hi there! What's your name?");
-
-  const { speech: name } = await res.gather({
-    source: GatherSource.SPEECH
-  });
-
-  await voice.say("Nice to meet you " + name + "!");
-
-  await voice.say("Please enter your 4 digit pin.");
-
-  const { digits } = await voice.gather({
-    maxDigits: 4,
-    finishOnKey: "#"
-  });
-
-  await voice.say("Your pin is " + digits);
-
-  await voice.hangup();
-});
-
-// Your app will live at tcp://127.0.0.1:50061 
-// and you can easily publish it to the Internet with:
-// ngrok tcp 50061
-```
-
-<a name="VoiceResponse"></a>
-
-## VoiceResponse ⇐ <code>Verb</code>
-Use the VoiceResponse object, to construct advance Interactive
-Voice Response (IVR) applications.
-
-**Kind**: global class  
-**Extends**: <code>Verb</code>  
-**See**: module:core:APIClient  
-
-* [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)
-
-<a name="new_VoiceResponse_new"></a>
-
-### new VoiceResponse(request, voice)
-Constructs a new VoiceResponse object.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| request | <code>VoiceRequest</code> | Options to indicate the objects endpoint |
-| voice | <code>VoiceSessionStream</code> | The voice session stream |
-
-**Example**  
-```js
-import { VoiceServer } from "@fonoster/voice";
-
-async function handler (request, response) {
-  await response.answer();
-  await response.play("https://soundsserver:9000/sounds/hello-world.wav");
-}
-
-new VoiceServer().listen(handler, { port: 3000 })
-```
-<a name="VoiceResponse+answer"></a>
-
-### 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();
-}
-```
-<a name="VoiceResponse+hangup"></a>
-
-### voiceResponse.hangup()
-Hangup the call.
-
-**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
-**Example**  
-```js
-async function handler (request, response) {
- await response.hangup();
-}
-```
-<a name="VoiceResponse+play"></a>
-
-### voiceResponse.play(url, options)
-Play an audio in the call.
-
-**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
-**See**: Playback  
-
-| 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");
-}
-```
-<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) |
-
-**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();
-}
-```
-<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" });
-}
+$ npm install --save @fonoster/ctl@next
 ```
-<a name="VoiceResponse+sgather"></a>
-
-### voiceResponse.sgather(options) ⇒ <code>Promise.&lt;StreamGatherStream&gt;</code>
-Starts a server-side stream gather operation which sends transcription data to the voice server.
-
-**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);
- });
-}
-```
-<a name="VoiceResponse+mute"></a>
-
-### voiceResponse.mute(options)
-Mutes a call.
-
-**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
-**See**: unmute  
-
-| 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
-}
-```
-<a name="VoiceResponse+unmute"></a>
-
-### voiceResponse.unmute(options)
-Unmutes a call.
-
-**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
-**See**: mute  
-
-| 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
-}
-```
-<a name="VoiceResponse+on"></a>
-
-### voiceResponse.on(event, listener)
-Register a listener for the given event.
-
-**Kind**: instance method of [<code>VoiceResponse</code>](#VoiceResponse)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| event | <code>StreamEvent</code> | The event to listen for |
-| listener | <code>function</code> | The callback function |
-
-**Example**  
-```js
-async function handler (request, response) {
- ...
-
- response.on(StreamEvent.END, () => {
-  console.log("Call ended");
- });
-}
-```
+## Usage
 
+Check the docs [here](https://github.com/fonoster/fonoster/blob/main/docs/early-access/link-twilio-number.md) for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fonoster/ctl",
-  "version": "0.7.42",
+  "version": "0.7.43",
   "description": "Fonoster Control Tool",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/fonoster#readme",
@@ -30,7 +30,7 @@
   "bugs": {
     "url": "https://github.com/fonoster/fonoster/issues"
   },
-  "gitHead": "50867fa36ff09aedbbf44529d50c73c967defc78",
+  "gitHead": "b78418a8b177646715e56524c84200895646fb5e",
   "bin": {
     "fonoster": "./bin/run.js"
   },
@@ -42,7 +42,7 @@
     "helpClass": "./dist/help"
   },
   "dependencies": {
-    "@fonoster/sdk": "^0.7.42",
+    "@fonoster/sdk": "^0.7.43",
     "@inquirer/prompts": "^7.1.0",
     "@oclif/core": "^4.0.34",
     "cliui": "^8.0.1",