@fonoster/voice 0.27.0 → 0.31.0

package/dist/VoiceResponse.d.ts

@@ -1,304 +0,0 @@
-/**
- * Copyright (C) 2025 by Fonoster Inc (https://fonoster.com)
- * http://github.com/fonoster/fonoster
- *
- * This file is part of Fonoster
- *
- * Licensed under the MIT License (the "License");
- * you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- *    https://opensource.org/licenses/MIT
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { AudioFilterConfig, DialOptions, GatherOptions, GatherResponse, MuteOptions, PlaybackControlAction, PlayOptions, PlayResponse, RecordOptions, RecordResponse, SayOptions, StreamEvent, StreamGatherOptions, StreamOptions, VerbResponse, VoiceRequest, VoiceSessionStreamServer } from "@fonoster/common";
-import { DialStatusStream, Stream, StreamGatherStream } from "./verbs";
-/**
- * @classdesc Use the VoiceResponse object, to construct advance Interactive
- * Voice Response (IVR) applications.
- *
- * @extends Verb
- * @example
- *
- * 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 })
- */
-declare class VoiceResponse {
-    voice: VoiceSessionStreamServer;
-    request: VoiceRequest;
-    /**
-     * Constructs a new VoiceResponse object.
-     *
-     * @param {VoiceRequest} request - Options to indicate the objects endpoint
-     * @param {VoiceSessionStream} voice - The voice session stream
-     * @see module:core:APIClient
-     */
-    constructor(request: VoiceRequest, voice: VoiceSessionStreamServer);
-    /**
-     * Answer the call. Before running any other verb you
-     * must run the answer command.
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     * }
-     */
-    answer(): Promise<VerbResponse>;
-    /**
-     * Hangup the call.
-     * @example
-     *
-     * async function handler (request, response) {
-     *  await response.hangup();
-     * }
-     */
-    hangup(): Promise<VerbResponse>;
-    /**
-     * Play an audio in the call.
-     *
-     * @param {string} url - The URL of the media to play
-     * @param {PlayOptions} options - Options to control the playback
-     * @param {string} options.playbackRef - Playback identifier to use in Playback operations
-     * @see Playback
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.play("https://soundsserver:9000/sounds/hello-world.wav");
-     * }
-     */
-    play(url: string, options?: PlayOptions): Promise<PlayResponse>;
-    /**
-     * Play a series of DTMF digits in a call.
-     *
-     * @param {string} digits -The DTMF digits to play (0-9, #, or *)
-     * @example
-     *
-     * async function handler (request, response) {
-     *  await response.answer();
-     *  await response.playDtmf("1234");
-     * }
-     */
-    playDtmf(digits: string): Promise<void>;
-    /**
-     * Control the playback of the currently playing media.
-     *
-     * @param {string} playbackRef - The playback identifier
-     * @param {PlaybackControlAction} action - The action to perform (STOP, RESTART, PAUSE, UNPAUSE, FORWARD)
-     * @see play
-     * @example
-     *
-     * 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);
-     * }
-     */
-    playbackControl(playbackRef: string, action: PlaybackControlAction): Promise<VerbResponse>;
-    /**
-     * Waits for data entry from the user's keypad or from a speech provider.
-     *
-     * @param {GatherOptions} options - Options to select the maximum number of digits, final character, and timeout
-     * @param {number} options.maxDigits - Maximum number of digits to collect. Defaults to 1
-     * @param {number} options.timeout - Milliseconds to wait before timeout. Defaults to 4000. Use zero for no timeout.
-     * @param {string} options.finishOnKey - Optional last character to wait for. Defaults to '#'. It will not be included in the returned digits
-     * @param {GatherSource} options.source - 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 include both with `SPEECH_AND_DTMF`. Defaults to `SPEECH_AND_DTMF`
-     * @note When including `SPEECH` the default timeout is 10000 (10s).
-     * @example
-     *
-     * 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();
-     * }
-     */
-    gather(options?: GatherOptions): Promise<GatherResponse>;
-    /**
-     * Send a text for a TTS engine to convert to speech.
-     *
-     * @param {string} text - The text to convert to speech
-     * @param {SayOptions} options - Options to control the TTS engine
-     * @param {string} options.playbackRef - Playback identifier to use in Playback operations
-     * @param {TTSOptions} options.ttsOptions - Options to control the TTS engine (specific to the TTS engine)
-     * @see Say
-     * @example
-     *
-     * 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);
-     * }
-     */
-    say(text: string, options?: SayOptions): Promise<VerbResponse>;
-    /**
-     * Stop the current TTS operation.
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *
-     *   // Some async operation
-     *   setTimeout(() => {
-     *     // Will stop the current TTS operation
-     *     response.stopSay();
-     *   }, 10000);
-     *
-     *   await response.say("Long text to say...");
-     * }
-     */
-    stopSay(): Promise<VerbResponse>;
-    /**
-     * Record the audio of the call.
-     *
-     * @param {RecordOptions} options - Options to control the record operation
-     * @param {number} options.maxDuration - The maximum duration of the recording in seconds. Default is 60
-     * @param {number} options.maxSilence - The maximum duration of silence in seconds. Default is 5
-     * @param {boolean} options.beep - Play a beep before recording. Default is true
-     * @param {string} options.finishOnKey - Stop recording when a DTMF digit is received. Default is '#'
-     * @return {RecordResponse} The record response
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   const record = await response.record();
-     *   console.log("Recording: %s", record.name);
-     * }
-     */
-    record(options?: RecordOptions): Promise<RecordResponse>;
-    /**
-     * Dials a destination and returns a stream of status.
-     *
-     * @param {string} destination - The destination to dial
-     * @param {DialOptions} options - Options to control the dial operation
-     * @param {number} options.timeout - The timeout in seconds. Default is 60
-     * @param {RecordDirection} options.recordDirection - The direction to record the call (IN, OUT, BOTH). Default is BOTH
-     * @return {Promise<DialStatusStream>} The dial status stream
-     */
-    dial(destination: string, options?: DialOptions): Promise<DialStatusStream>;
-    /**
-     * Starts a bidirectional audio stream between the call and the application.
-     *
-     * @param {StreamOptions} options - Options to control the stream operation
-     * @param {StreamDirection} options.direction - The direction to stream the audio (IN, OUT, BOTH). Default is BOTH
-     * @param {StreamAudioFormat} options.format - The audio format to stream (WAV). Default is WAV
-     * @return {Promise<Stream>} The stream object
-     * @example
-     *
-     * 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" });
-     * }
-     */
-    stream(options?: StreamOptions): Promise<Stream>;
-    /**
-     * Starts a server-side stream gather operation which sends transcription data to the voice server.
-     *
-     * @param {StreamGatherOptions} options - Options to control the stream gather operation
-     * @param {StreamGatherSource} options.source - The source to gather data from (DTMF, SPEECH, SPEECH_AND_DTMF). Default is SPEECH
-     * @return {Promise<StreamGatherStream>} The stream gather object
-     * @see Gather
-     * @example
-     *
-     * async function handler (request, response) {
-     *  await response.answer();
-     *  const sGather = await response.sgather({ source: StreamGatherSource.SPEECH });
-     *  sGather.onPayload((payload) => {
-     *    console.log("Payload: %s", payload);
-     *  });
-     * }
-     */
-    sgather(options: StreamGatherOptions): Promise<StreamGatherStream>;
-    /**
-     * Sets the audio filters for this session. Filters run in the Media Server,
-     * on the caller's audio, before it reaches speech recognition and the
-     * application's media stream. Call it before answering.
-     *
-     * Sending a new list replaces the previous one; an empty list removes all
-     * filters. If a filter cannot be created — an unknown name, invalid options,
-     * a missing SDK or license — the verb fails and the call continues with
-     * unfiltered audio.
-     *
-     * @param {AudioFilterConfig[]} filters - The filters to run, in order
-     * @return {Promise<void>}
-     * @see aiCoustics
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.setAudioFilters([aiCoustics({ enhancementLevel: 0.8 })]);
-     *   await response.answer();
-     * }
-     */
-    setAudioFilters(filters: AudioFilterConfig[]): Promise<void>;
-    /**
-     * Mutes a call.
-     *
-     * @param {MuteOptions} options - Options to control the mute operation
-     * @param {MuteDirection} options.direction - The direction to mute the channel (IN, OUT, BOTH). Default is BOTH
-     * @see unmute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.mute();       // Will mute both directions
-     * }
-     */
-    mute(options?: MuteOptions): Promise<void>;
-    /**
-     * Unmute a call.
-     *
-     * @param {MuteOptions} options - Options to control the unmute operation
-     * @param {MuteDirection} options.direction - The direction to unmute the call (IN, OUT, BOTH). Default is BOTH
-     * @see mute
-     * @example
-     *
-     * async function handler (request, response) {
-     *   await response.answer();
-     *   await response.unmute();     // Will unmute both directions
-     * }
-     */
-    unmute(options?: MuteOptions): Promise<void>;
-    /**
-     * Register a listener for the given event.
-     *
-     * @param {StreamEvent} event - The event to listen for
-     * @param {Function} listener - The callback function
-     * @example
-     *
-     * async function handler (request, response) {
-     *  ...
-     *
-     *  response.on(StreamEvent.END, () => {
-     *   console.log("Call ended");
-     *  });
-     * }
-     */
-    on(event: StreamEvent, listener: (...args: unknown[]) => void): void;
-}
-export { VoiceResponse };