@wildix/wilma-voice-client 0.0.39 → 0.0.41

package/dist-types/WilmaVoice.d.ts

@@ -1,5 +1,6 @@
 import type { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
 import { type DescribeVoiceProtocolCommandInput, type DescribeVoiceProtocolCommandOutput } from "./commands/DescribeVoiceProtocolCommand";
+import { type GetVoiceDefaultsCommandInput, type GetVoiceDefaultsCommandOutput } from "./commands/GetVoiceDefaultsCommand";
 import { type ListVoicesCommandInput, type ListVoicesCommandOutput } from "./commands/ListVoicesCommand";
 import { type SendHangupCommandInput, type SendHangupCommandOutput } from "./commands/SendHangupCommand";
 import { type SendPlayCommandInput, type SendPlayCommandOutput } from "./commands/SendPlayCommand";
@@ -17,6 +18,13 @@ export interface WilmaVoice {
     describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVoiceProtocolCommandOutput>;
     describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, cb: (err: any, data?: DescribeVoiceProtocolCommandOutput) => void): void;
     describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVoiceProtocolCommandOutput) => void): void;
+    /**
+     * @see {@link GetVoiceDefaultsCommand}
+     */
+    getVoiceDefaults(): Promise<GetVoiceDefaultsCommandOutput>;
+    getVoiceDefaults(args: GetVoiceDefaultsCommandInput, options?: __HttpHandlerOptions): Promise<GetVoiceDefaultsCommandOutput>;
+    getVoiceDefaults(args: GetVoiceDefaultsCommandInput, cb: (err: any, data?: GetVoiceDefaultsCommandOutput) => void): void;
+    getVoiceDefaults(args: GetVoiceDefaultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVoiceDefaultsCommandOutput) => void): void;
     /**
      * @see {@link ListVoicesCommand}
      */
@@ -76,11 +84,13 @@ export interface WilmaVoice {
  *     On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
  *     speech themselves and send `transcription` / `reply` text, while web/app clients connect with
  *     inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
- *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
- *     shape (connect params, events and commands) is declared as a structure and enumerated by
- *     DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
- *     transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
- *     session out-of-band.
+ *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. On the PBX media socket
+ *     (`/v2/voice/media/ws`, subprotocol `wilma-media-v2`), the PBX sends raw caller audio and the
+ *     service answers with audio and the text frames listed under DescribeVoiceProtocol `media`.
+ *     Every WebSocket message shape (connect params, events and commands) is declared as a structure
+ *     and enumerated by DescribeVoiceProtocol so the generated SDKs carry the types and
+ *     (de)serializers; the WebSocket transport itself is hand-coded. The HTTP Send* operations push
+ *     the same commands into a live session out-of-band.
  *
  *     Session observability and history are recorded in wilma-traces; this service does not expose
  *     bot configuration, traces or listing.

package/dist-types/WilmaVoiceClient.d.ts

@@ -6,6 +6,7 @@ import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/re
 import type { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, SdkStreamMixinInjector as __SdkStreamMixinInjector, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
 import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
 import type { DescribeVoiceProtocolCommandInput, DescribeVoiceProtocolCommandOutput } from "./commands/DescribeVoiceProtocolCommand";
+import type { GetVoiceDefaultsCommandInput, GetVoiceDefaultsCommandOutput } from "./commands/GetVoiceDefaultsCommand";
 import type { ListVoicesCommandInput, ListVoicesCommandOutput } from "./commands/ListVoicesCommand";
 import type { SendHangupCommandInput, SendHangupCommandOutput } from "./commands/SendHangupCommand";
 import type { SendPlayCommandInput, SendPlayCommandOutput } from "./commands/SendPlayCommand";
@@ -20,11 +21,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = DescribeVoiceProtocolCommandInput | ListVoicesCommandInput | SendHangupCommandInput | SendPlayCommandInput | SendSayCommandInput | SendStopCommandInput | SendTransferCommandInput | StreamCallEventsCommandInput | TextToSpeechCommandInput;
+export type ServiceInputTypes = DescribeVoiceProtocolCommandInput | GetVoiceDefaultsCommandInput | ListVoicesCommandInput | SendHangupCommandInput | SendPlayCommandInput | SendSayCommandInput | SendStopCommandInput | SendTransferCommandInput | StreamCallEventsCommandInput | TextToSpeechCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = DescribeVoiceProtocolCommandOutput | ListVoicesCommandOutput | SendHangupCommandOutput | SendPlayCommandOutput | SendSayCommandOutput | SendStopCommandOutput | SendTransferCommandOutput | StreamCallEventsCommandOutput | TextToSpeechCommandOutput;
+export type ServiceOutputTypes = DescribeVoiceProtocolCommandOutput | GetVoiceDefaultsCommandOutput | ListVoicesCommandOutput | SendHangupCommandOutput | SendPlayCommandOutput | SendSayCommandOutput | SendStopCommandOutput | SendTransferCommandOutput | StreamCallEventsCommandOutput | TextToSpeechCommandOutput;
 /**
  * @public
  */
@@ -167,11 +168,13 @@ export interface WilmaVoiceClientResolvedConfig extends WilmaVoiceClientResolved
  *     On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
  *     speech themselves and send `transcription` / `reply` text, while web/app clients connect with
  *     inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
- *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
- *     shape (connect params, events and commands) is declared as a structure and enumerated by
- *     DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
- *     transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
- *     session out-of-band.
+ *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. On the PBX media socket
+ *     (`/v2/voice/media/ws`, subprotocol `wilma-media-v2`), the PBX sends raw caller audio and the
+ *     service answers with audio and the text frames listed under DescribeVoiceProtocol `media`.
+ *     Every WebSocket message shape (connect params, events and commands) is declared as a structure
+ *     and enumerated by DescribeVoiceProtocol so the generated SDKs carry the types and
+ *     (de)serializers; the WebSocket transport itself is hand-coded. The HTTP Send* operations push
+ *     the same commands into a live session out-of-band.
  *
  *     Session observability and history are recorded in wilma-traces; this service does not expose
  *     bot configuration, traces or listing.

package/dist-types/commands/DescribeVoiceProtocolCommand.d.ts

@@ -27,7 +27,7 @@ declare const DescribeVoiceProtocolCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * Describes the WebSocket connect parameters, events and commands of the voice protocol. Utility method; the generated shapes are the source of truth for building a WebSocket client or server by hand.
+ * Describes the WebSocket connect parameters, events and commands of the voice protocol, and the messages of the PBX media socket. Utility method; the generated shapes are the source of truth for building a WebSocket client or server by hand.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -297,19 +297,146 @@ declare const DescribeVoiceProtocolCommand_base: {
  * //       phase: "started" || "finished", // required
  * //       startMessage: "STRING_VALUE",
  * //     },
- * //     backend: { // VoiceCallBackendEvent
- * //       transport: "webhook" || "sqs", // required
- * //       event: "STRING_VALUE", // required
- * //       delivered: true || false, // required
- * //       status: Number("int"),
- * //       durationMs: Number("int"),
- * //       error: "STRING_VALUE",
- * //     },
  * //     ended: { // VoiceCallEndedEvent
  * //       sessionId: "STRING_VALUE", // required
  * //       reason: "hangup" || "transfer" || "timeout" || "error" || "complete", // required
  * //     },
  * //   },
+ * //   media: { // MediaProtocolFrames
+ * //     pbx: { // MediaPbxFrames
+ * //       start: { // MediaStartFrame
+ * //         type: "start", // required
+ * //         purpose: "agent" || "transcription", // required
+ * //         callId: "STRING_VALUE", // required
+ * //         flowIndex: Number("int"), // required
+ * //         sessionId: "STRING_VALUE", // required
+ * //         resume: true || false, // required
+ * //         resumeAtMs: Number("int"), // required
+ * //         audio: { // MediaAudioFormat
+ * //           encoding: "pcm_s16le", // required
+ * //           sampleRate: Number("int"), // required
+ * //           channels: Number("int"), // required
+ * //         },
+ * //         agent: { // MediaStartAgent
+ * //           id: "STRING_VALUE", // required
+ * //           draft: true || false,
+ * //           version: Number("int"),
+ * //         },
+ * //         languages: [ // MediaStartLanguageList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         preferredLanguage: "STRING_VALUE",
+ * //         autoDetect: true || false,
+ * //         caller: { // MediaStartCaller
+ * //           name: "STRING_VALUE",
+ * //           number: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //         },
+ * //         dialedNumber: "STRING_VALUE",
+ * //         variables: "STRING_VALUE",
+ * //       },
+ * //       audio: new Uint8Array(),
+ * //       vad: { // MediaVadFrame
+ * //         type: "vad", // required
+ * //         party: "caller" || "callee", // required
+ * //         speaking: true || false, // required
+ * //         energyDb: Number("double"), // required
+ * //         atMs: Number("int"), // required
+ * //       },
+ * //       dtmf: { // MediaDtmfFrame
+ * //         type: "dtmf", // required
+ * //         id: "STRING_VALUE", // required
+ * //         digits: "STRING_VALUE", // required
+ * //       },
+ * //       playback: { // MediaPlaybackFrame
+ * //         type: "playback", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         event: "started" || "finished" || "stopped", // required
+ * //         atMs: Number("int"), // required
+ * //         playedMs: Number("int"),
+ * //         cause: "cloud" || "caller" || "drop",
+ * //       },
+ * //       finish: { // MediaFinishFrame
+ * //         type: "finish", // required
+ * //         reason: "caller-hangup" || "callee-hangup" || "agent-hangup" || "agent-transfer" || "timeout", // required
+ * //       },
+ * //     },
+ * //     cloud: { // MediaCloudFrames
+ * //       started: { // MediaStartedFrame
+ * //         type: "started", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         agent: { // MediaStartedAgent
+ * //           name: "STRING_VALUE", // required
+ * //         },
+ * //         groupId: "STRING_VALUE",
+ * //         backgroundSound: "STRING_VALUE",
+ * //         voiceDetection: { // MediaVoiceDetection
+ * //           silenceMs: Number("int"), // required
+ * //           silenceLevelDb: Number("int"), // required
+ * //           speechLevelDb: Number("int"), // required
+ * //         },
+ * //       },
+ * //       transcription: { // MediaTranscriptionFrame
+ * //         type: "transcription", // required
+ * //         party: "caller" || "callee", // required
+ * //         id: "STRING_VALUE", // required
+ * //         final: true || false, // required
+ * //         text: "STRING_VALUE", // required
+ * //         startMs: Number("int"), // required
+ * //         endMs: Number("int"), // required
+ * //         language: "STRING_VALUE", // required
+ * //         confidence: Number("double"),
+ * //       },
+ * //       audioBegin: { // MediaAudioBeginFrame
+ * //         type: "audio.begin", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         sampleRate: Number("int"), // required
+ * //       },
+ * //       audio: new Uint8Array(),
+ * //       audioEnd: { // MediaAudioEndFrame
+ * //         type: "audio.end", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //       },
+ * //       stop: { // MediaStopFrame
+ * //         type: "stop", // required
+ * //       },
+ * //       duck: { // MediaDuckFrame
+ * //         type: "duck", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         volumeDb: Number("int"), // required
+ * //         rampMs: Number("int"), // required
+ * //       },
+ * //       restore: { // MediaRestoreFrame
+ * //         type: "restore", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         rampMs: Number("int"), // required
+ * //       },
+ * //       language: { // MediaLanguageFrame
+ * //         type: "language", // required
+ * //         language: "STRING_VALUE", // required
+ * //       },
+ * //       transfer: { // MediaTransferFrame
+ * //         type: "transfer", // required
+ * //         context: "STRING_VALUE", // required
+ * //         extension: "STRING_VALUE", // required
+ * //       },
+ * //       hangup: { // MediaHangupFrame
+ * //         type: "hangup", // required
+ * //       },
+ * //       error: { // MediaErrorFrame
+ * //         type: "error", // required
+ * //         code: "STRING_VALUE", // required
+ * //         retryable: true || false, // required
+ * //         message: "STRING_VALUE", // required
+ * //       },
+ * //       finished: { // MediaFinishedFrame
+ * //         type: "finished", // required
+ * //       },
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/GetVoiceDefaultsCommand.d.ts

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetVoiceDefaultsInput, GetVoiceDefaultsOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaVoiceClientResolvedConfig } from "../WilmaVoiceClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVoiceDefaultsCommand}.
+ */
+export interface GetVoiceDefaultsCommandInput extends GetVoiceDefaultsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetVoiceDefaultsCommand}.
+ */
+export interface GetVoiceDefaultsCommandOutput extends GetVoiceDefaultsOutput, __MetadataBearer {
+}
+declare const GetVoiceDefaultsCommand_base: {
+    new (input: GetVoiceDefaultsCommandInput): import("@smithy/core/client").CommandImpl<GetVoiceDefaultsCommandInput, GetVoiceDefaultsCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetVoiceDefaultsCommandInput]): import("@smithy/core/client").CommandImpl<GetVoiceDefaultsCommandInput, GetVoiceDefaultsCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Returns the voice channel tuning that applies to a call when the agent sets no value. The values can change without an agent change.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaVoiceClient, GetVoiceDefaultsCommand } from "@wildix/wilma-voice-client"; // ES Modules import
+ * // const { WilmaVoiceClient, GetVoiceDefaultsCommand } = require("@wildix/wilma-voice-client"); // CommonJS import
+ * // import type { WilmaVoiceClientConfig } from "@wildix/wilma-voice-client";
+ * const config = {}; // type is WilmaVoiceClientConfig
+ * const client = new WilmaVoiceClient(config);
+ * const input = {};
+ * const command = new GetVoiceDefaultsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVoiceDefaultsOutput
+ * //   voiceDetection: { // VoiceDetectionDefaults
+ * //     silenceMs: Number("int"), // required
+ * //     silenceLevelDb: Number("int"), // required
+ * //     speechLevelDb: Number("int"), // required
+ * //   },
+ * //   interruptions: { // VoiceInterruptionDefaults
+ * //     minWords: Number("int"), // required
+ * //     minConfidence: Number("double"), // required
+ * //     duckAfterMs: Number("int"), // required
+ * //     duckVolumeDb: Number("int"), // required
+ * //     restoreAfterMs: Number("int"), // required
+ * //   },
+ * //   turnEnd: { // VoiceTurnEndDefaults
+ * //     holdMs: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetVoiceDefaultsCommandInput - {@link GetVoiceDefaultsCommandInput}
+ * @returns {@link GetVoiceDefaultsCommandOutput}
+ * @see {@link GetVoiceDefaultsCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceDefaultsCommandOutput} for command's `response` shape.
+ * @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link WilmaVoiceServiceException}
+ * <p>Base exception class for all service exceptions from WilmaVoice service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetVoiceDefaultsCommand extends GetVoiceDefaultsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: {};
+            output: GetVoiceDefaultsOutput;
+        };
+        sdk: {
+            input: GetVoiceDefaultsCommandInput;
+            output: GetVoiceDefaultsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./DescribeVoiceProtocolCommand";
+export * from "./GetVoiceDefaultsCommand";
 export * from "./ListVoicesCommand";
 export * from "./SendHangupCommand";
 export * from "./SendPlayCommand";

package/dist-types/index.d.ts

@@ -8,11 +8,13 @@
  *     On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
  *     speech themselves and send `transcription` / `reply` text, while web/app clients connect with
  *     inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
- *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
- *     shape (connect params, events and commands) is declared as a structure and enumerated by
- *     DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
- *     transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
- *     session out-of-band.
+ *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. On the PBX media socket
+ *     (`/v2/voice/media/ws`, subprotocol `wilma-media-v2`), the PBX sends raw caller audio and the
+ *     service answers with audio and the text frames listed under DescribeVoiceProtocol `media`.
+ *     Every WebSocket message shape (connect params, events and commands) is declared as a structure
+ *     and enumerated by DescribeVoiceProtocol so the generated SDKs carry the types and
+ *     (de)serializers; the WebSocket transport itself is hand-coded. The HTTP Send* operations push
+ *     the same commands into a live session out-of-band.
  *
  *     Session observability and history are recorded in wilma-traces; this service does not expose
  *     bot configuration, traces or listing.