@wildix/wilma-voice-client 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist-cjs/WilmaVoice.js +23 -0
  2. package/dist-cjs/WilmaVoiceClient.js +49 -0
  3. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  4. package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
  5. package/dist-cjs/commands/DescribeVoiceProtocolCommand.js +20 -0
  6. package/dist-cjs/commands/SendHangupCommand.js +20 -0
  7. package/dist-cjs/commands/SendPlayCommand.js +20 -0
  8. package/dist-cjs/commands/SendSayCommand.js +20 -0
  9. package/dist-cjs/commands/SendStopCommand.js +20 -0
  10. package/dist-cjs/commands/SendTransferCommand.js +20 -0
  11. package/dist-cjs/commands/index.js +9 -0
  12. package/dist-cjs/endpoint/EndpointParameters.js +16 -0
  13. package/dist-cjs/endpoint/bdd.js +28 -0
  14. package/dist-cjs/endpoint/endpointResolver.js +16 -0
  15. package/dist-cjs/extensionConfiguration.js +2 -0
  16. package/dist-cjs/index.js +13 -0
  17. package/dist-cjs/models/WilmaVoiceServiceException.js +12 -0
  18. package/dist-cjs/models/enums.js +37 -0
  19. package/dist-cjs/models/errors.js +45 -0
  20. package/dist-cjs/models/models_0.js +2 -0
  21. package/dist-cjs/runtimeConfig.browser.js +32 -0
  22. package/dist-cjs/runtimeConfig.js +41 -0
  23. package/dist-cjs/runtimeConfig.native.js +15 -0
  24. package/dist-cjs/runtimeConfig.shared.js +41 -0
  25. package/dist-cjs/runtimeExtensions.js +12 -0
  26. package/dist-cjs/schemas/schemas_0.js +404 -0
  27. package/dist-es/WilmaVoice.js +19 -0
  28. package/dist-es/WilmaVoiceClient.js +45 -0
  29. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  30. package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
  31. package/dist-es/commands/DescribeVoiceProtocolCommand.js +16 -0
  32. package/dist-es/commands/SendHangupCommand.js +16 -0
  33. package/dist-es/commands/SendPlayCommand.js +16 -0
  34. package/dist-es/commands/SendSayCommand.js +16 -0
  35. package/dist-es/commands/SendStopCommand.js +16 -0
  36. package/dist-es/commands/SendTransferCommand.js +16 -0
  37. package/dist-es/commands/index.js +6 -0
  38. package/dist-es/endpoint/EndpointParameters.js +12 -0
  39. package/dist-es/endpoint/bdd.js +25 -0
  40. package/dist-es/endpoint/endpointResolver.js +12 -0
  41. package/dist-es/extensionConfiguration.js +1 -0
  42. package/dist-es/index.js +8 -0
  43. package/dist-es/models/WilmaVoiceServiceException.js +8 -0
  44. package/dist-es/models/enums.js +34 -0
  45. package/dist-es/models/errors.js +39 -0
  46. package/dist-es/models/models_0.js +1 -0
  47. package/dist-es/runtimeConfig.browser.js +27 -0
  48. package/dist-es/runtimeConfig.js +36 -0
  49. package/dist-es/runtimeConfig.native.js +11 -0
  50. package/dist-es/runtimeConfig.shared.js +37 -0
  51. package/dist-es/runtimeExtensions.js +8 -0
  52. package/dist-es/schemas/schemas_0.js +400 -0
  53. package/dist-types/WilmaVoice.d.ts +70 -0
  54. package/dist-types/WilmaVoiceClient.d.ts +185 -0
  55. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  56. package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
  57. package/dist-types/commands/DescribeVoiceProtocolCommand.d.ts +252 -0
  58. package/dist-types/commands/SendHangupCommand.d.ts +79 -0
  59. package/dist-types/commands/SendPlayCommand.d.ts +81 -0
  60. package/dist-types/commands/SendSayCommand.d.ts +85 -0
  61. package/dist-types/commands/SendStopCommand.d.ts +78 -0
  62. package/dist-types/commands/SendTransferCommand.d.ts +80 -0
  63. package/dist-types/commands/index.d.ts +6 -0
  64. package/dist-types/endpoint/EndpointParameters.d.ts +41 -0
  65. package/dist-types/endpoint/bdd.d.ts +2 -0
  66. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  67. package/dist-types/extensionConfiguration.d.ts +8 -0
  68. package/dist-types/index.d.ts +33 -0
  69. package/dist-types/models/WilmaVoiceServiceException.d.ts +14 -0
  70. package/dist-types/models/enums.d.ts +101 -0
  71. package/dist-types/models/errors.d.ts +36 -0
  72. package/dist-types/models/models_0.d.ts +805 -0
  73. package/dist-types/runtimeConfig.browser.d.ts +55 -0
  74. package/dist-types/runtimeConfig.d.ts +55 -0
  75. package/dist-types/runtimeConfig.native.d.ts +54 -0
  76. package/dist-types/runtimeConfig.shared.d.ts +32 -0
  77. package/dist-types/runtimeExtensions.d.ts +17 -0
  78. package/dist-types/schemas/schemas_0.d.ts +63 -0
  79. package/package.json +57 -0
@@ -0,0 +1,70 @@
1
+ import type { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { type DescribeVoiceProtocolCommandInput, type DescribeVoiceProtocolCommandOutput } from "./commands/DescribeVoiceProtocolCommand";
3
+ import { type SendHangupCommandInput, type SendHangupCommandOutput } from "./commands/SendHangupCommand";
4
+ import { type SendPlayCommandInput, type SendPlayCommandOutput } from "./commands/SendPlayCommand";
5
+ import { type SendSayCommandInput, type SendSayCommandOutput } from "./commands/SendSayCommand";
6
+ import { type SendStopCommandInput, type SendStopCommandOutput } from "./commands/SendStopCommand";
7
+ import { type SendTransferCommandInput, type SendTransferCommandOutput } from "./commands/SendTransferCommand";
8
+ import { WilmaVoiceClient } from "./WilmaVoiceClient";
9
+ export interface WilmaVoice {
10
+ /**
11
+ * @see {@link DescribeVoiceProtocolCommand}
12
+ */
13
+ describeVoiceProtocol(): Promise<DescribeVoiceProtocolCommandOutput>;
14
+ describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVoiceProtocolCommandOutput>;
15
+ describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, cb: (err: any, data?: DescribeVoiceProtocolCommandOutput) => void): void;
16
+ describeVoiceProtocol(args: DescribeVoiceProtocolCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVoiceProtocolCommandOutput) => void): void;
17
+ /**
18
+ * @see {@link SendHangupCommand}
19
+ */
20
+ sendHangup(args: SendHangupCommandInput, options?: __HttpHandlerOptions): Promise<SendHangupCommandOutput>;
21
+ sendHangup(args: SendHangupCommandInput, cb: (err: any, data?: SendHangupCommandOutput) => void): void;
22
+ sendHangup(args: SendHangupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendHangupCommandOutput) => void): void;
23
+ /**
24
+ * @see {@link SendPlayCommand}
25
+ */
26
+ sendPlay(args: SendPlayCommandInput, options?: __HttpHandlerOptions): Promise<SendPlayCommandOutput>;
27
+ sendPlay(args: SendPlayCommandInput, cb: (err: any, data?: SendPlayCommandOutput) => void): void;
28
+ sendPlay(args: SendPlayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendPlayCommandOutput) => void): void;
29
+ /**
30
+ * @see {@link SendSayCommand}
31
+ */
32
+ sendSay(args: SendSayCommandInput, options?: __HttpHandlerOptions): Promise<SendSayCommandOutput>;
33
+ sendSay(args: SendSayCommandInput, cb: (err: any, data?: SendSayCommandOutput) => void): void;
34
+ sendSay(args: SendSayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendSayCommandOutput) => void): void;
35
+ /**
36
+ * @see {@link SendStopCommand}
37
+ */
38
+ sendStop(args: SendStopCommandInput, options?: __HttpHandlerOptions): Promise<SendStopCommandOutput>;
39
+ sendStop(args: SendStopCommandInput, cb: (err: any, data?: SendStopCommandOutput) => void): void;
40
+ sendStop(args: SendStopCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendStopCommandOutput) => void): void;
41
+ /**
42
+ * @see {@link SendTransferCommand}
43
+ */
44
+ sendTransfer(args: SendTransferCommandInput, options?: __HttpHandlerOptions): Promise<SendTransferCommandOutput>;
45
+ sendTransfer(args: SendTransferCommandInput, cb: (err: any, data?: SendTransferCommandOutput) => void): void;
46
+ sendTransfer(args: SendTransferCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendTransferCommandOutput) => void): void;
47
+ }
48
+ /**
49
+ * Voice-session runtime for the Wilma agent platform. Runs a wilma-agents agent on the voice
50
+ * channel over a live WebSocket: it greets, listens, replies via TTS, transfers, hangs up, runs
51
+ * tools and looks up knowledge — driven entirely by the agent definition resolved at connect
52
+ * (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
53
+ * is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
54
+ *
55
+ * The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
56
+ * protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
57
+ * `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
58
+ * `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
59
+ * chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
60
+ * events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
61
+ * generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
62
+ * as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
63
+ * out-of-band.
64
+ *
65
+ * Session observability and history are recorded in wilma-traces; this service does not expose
66
+ * bot configuration, traces or listing.
67
+ * @public
68
+ */
69
+ export declare class WilmaVoice extends WilmaVoiceClient implements WilmaVoice {
70
+ }
@@ -0,0 +1,185 @@
1
+ import { type HostHeaderInputConfig, type HostHeaderResolvedConfig, type UserAgentInputConfig, type UserAgentResolvedConfig } from "@aws-sdk/core/client";
2
+ import { type DefaultsMode as __DefaultsMode, type SmithyConfiguration as __SmithyConfiguration, type SmithyResolvedConfiguration as __SmithyResolvedConfiguration, Client as __Client } from "@smithy/core/client";
3
+ import { type EndpointInputConfig, type EndpointResolvedConfig } from "@smithy/core/endpoints";
4
+ import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/core/protocols";
5
+ import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry";
6
+ 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, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
7
+ import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
8
+ import type { DescribeVoiceProtocolCommandInput, DescribeVoiceProtocolCommandOutput } from "./commands/DescribeVoiceProtocolCommand";
9
+ import type { SendHangupCommandInput, SendHangupCommandOutput } from "./commands/SendHangupCommand";
10
+ import type { SendPlayCommandInput, SendPlayCommandOutput } from "./commands/SendPlayCommand";
11
+ import type { SendSayCommandInput, SendSayCommandOutput } from "./commands/SendSayCommand";
12
+ import type { SendStopCommandInput, SendStopCommandOutput } from "./commands/SendStopCommand";
13
+ import type { SendTransferCommandInput, SendTransferCommandOutput } from "./commands/SendTransferCommand";
14
+ import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
15
+ import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
16
+ export { __Client };
17
+ /**
18
+ * @public
19
+ */
20
+ export type ServiceInputTypes = DescribeVoiceProtocolCommandInput | SendHangupCommandInput | SendPlayCommandInput | SendSayCommandInput | SendStopCommandInput | SendTransferCommandInput;
21
+ /**
22
+ * @public
23
+ */
24
+ export type ServiceOutputTypes = DescribeVoiceProtocolCommandOutput | SendHangupCommandOutput | SendPlayCommandOutput | SendSayCommandOutput | SendStopCommandOutput | SendTransferCommandOutput;
25
+ /**
26
+ * @public
27
+ */
28
+ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
29
+ /**
30
+ * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
31
+ */
32
+ requestHandler?: __HttpHandlerUserInput;
33
+ /**
34
+ * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
35
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
36
+ * @internal
37
+ */
38
+ sha256?: __ChecksumConstructor | __HashConstructor;
39
+ /**
40
+ * The function that will be used to convert strings into HTTP endpoints.
41
+ * @internal
42
+ */
43
+ urlParser?: __UrlParser;
44
+ /**
45
+ * A function that can calculate the length of a request body.
46
+ * @internal
47
+ */
48
+ bodyLengthChecker?: __BodyLengthCalculator;
49
+ /**
50
+ * A function that converts a stream into an array of bytes.
51
+ * @internal
52
+ */
53
+ streamCollector?: __StreamCollector;
54
+ /**
55
+ * The function that will be used to convert a base64-encoded string to a byte array.
56
+ * @internal
57
+ */
58
+ base64Decoder?: __Decoder;
59
+ /**
60
+ * The function that will be used to convert binary data to a base64-encoded string.
61
+ * @internal
62
+ */
63
+ base64Encoder?: __Encoder;
64
+ /**
65
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
66
+ * @internal
67
+ */
68
+ utf8Decoder?: __Decoder;
69
+ /**
70
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
71
+ * @internal
72
+ */
73
+ utf8Encoder?: __Encoder;
74
+ /**
75
+ * The runtime environment.
76
+ * @internal
77
+ */
78
+ runtime?: string;
79
+ /**
80
+ * Disable dynamically changing the endpoint of the client based on the hostPrefix
81
+ * trait of an operation.
82
+ */
83
+ disableHostPrefix?: boolean;
84
+ /**
85
+ * Setting a client profile is similar to setting a value for the
86
+ * AWS_PROFILE environment variable. Setting a profile on a client
87
+ * in code only affects the single client instance, unlike AWS_PROFILE.
88
+ *
89
+ * When set, and only for environments where an AWS configuration
90
+ * file exists, fields configurable by this file will be retrieved
91
+ * from the specified profile within that file.
92
+ * Conflicting code configuration and environment variables will
93
+ * still have higher priority.
94
+ *
95
+ * For client credential resolution that involves checking the AWS
96
+ * configuration file, the client's profile (this value) will be
97
+ * used unless a different profile is set in the credential
98
+ * provider options.
99
+ *
100
+ */
101
+ profile?: string;
102
+ /**
103
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
104
+ * @internal
105
+ */
106
+ defaultUserAgentProvider?: __Provider<__UserAgent>;
107
+ /**
108
+ * Value for how many times a request will be made at most in case of retry.
109
+ */
110
+ maxAttempts?: number | __Provider<number>;
111
+ /**
112
+ * Specifies which retry algorithm to use.
113
+ * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
114
+ *
115
+ */
116
+ retryMode?: string | __Provider<string>;
117
+ /**
118
+ * Optional logger for logging debug/info/warn/error.
119
+ */
120
+ logger?: __Logger;
121
+ /**
122
+ * Optional extensions
123
+ */
124
+ extensions?: RuntimeExtension[];
125
+ /**
126
+ * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
127
+ */
128
+ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
129
+ }
130
+ /**
131
+ * @public
132
+ */
133
+ export type WilmaVoiceClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig & RetryInputConfig & HostHeaderInputConfig & EndpointInputConfig<EndpointParameters> & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
134
+ /**
135
+ * @public
136
+ *
137
+ * The configuration interface of WilmaVoiceClient class constructor that set the region, credentials and other options.
138
+ */
139
+ export interface WilmaVoiceClientConfig extends WilmaVoiceClientConfigType {
140
+ }
141
+ /**
142
+ * @public
143
+ */
144
+ export type WilmaVoiceClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & UserAgentResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & EndpointResolvedConfig<EndpointParameters> & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
145
+ /**
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of WilmaVoiceClient class. This is resolved and normalized from the {@link WilmaVoiceClientConfig | constructor configuration interface}.
149
+ */
150
+ export interface WilmaVoiceClientResolvedConfig extends WilmaVoiceClientResolvedConfigType {
151
+ }
152
+ /**
153
+ * Voice-session runtime for the Wilma agent platform. Runs a wilma-agents agent on the voice
154
+ * channel over a live WebSocket: it greets, listens, replies via TTS, transfers, hangs up, runs
155
+ * tools and looks up knowledge — driven entirely by the agent definition resolved at connect
156
+ * (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
157
+ * is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
158
+ *
159
+ * The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
160
+ * protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
161
+ * `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
162
+ * `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
163
+ * chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
164
+ * events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
165
+ * generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
166
+ * as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
167
+ * out-of-band.
168
+ *
169
+ * Session observability and history are recorded in wilma-traces; this service does not expose
170
+ * bot configuration, traces or listing.
171
+ * @public
172
+ */
173
+ export declare class WilmaVoiceClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WilmaVoiceClientResolvedConfig> {
174
+ /**
175
+ * The resolved configuration of WilmaVoiceClient class. This is resolved and normalized from the {@link WilmaVoiceClientConfig | constructor configuration interface}.
176
+ */
177
+ readonly config: WilmaVoiceClientResolvedConfig;
178
+ constructor(...[configuration]: __CheckOptionalClientConfig<WilmaVoiceClientConfig>);
179
+ /**
180
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
181
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
182
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
183
+ */
184
+ destroy(): void;
185
+ }
@@ -0,0 +1,29 @@
1
+ import { type HttpAuthScheme, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
2
+ import type { WilmaVoiceHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: WilmaVoiceHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): WilmaVoiceHttpAuthSchemeProvider;
11
+ setToken(token: TokenIdentity | TokenIdentityProvider): void;
12
+ token(): TokenIdentity | TokenIdentityProvider | undefined;
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export type HttpAuthRuntimeConfig = Partial<{
18
+ httpAuthSchemes: HttpAuthScheme[];
19
+ httpAuthSchemeProvider: WilmaVoiceHttpAuthSchemeProvider;
20
+ token: TokenIdentity | TokenIdentityProvider;
21
+ }>;
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
26
+ /**
27
+ * @internal
28
+ */
29
+ export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;
@@ -0,0 +1,81 @@
1
+ import { type HandlerExecutionContext, type HttpAuthScheme, type HttpAuthSchemeParameters, type HttpAuthSchemeParametersProvider, type HttpAuthSchemeProvider, type Provider, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
2
+ import type { WilmaVoiceClientResolvedConfig } from "../WilmaVoiceClient";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface WilmaVoiceHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
7
+ }
8
+ /**
9
+ * @internal
10
+ */
11
+ export interface WilmaVoiceHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<WilmaVoiceClientResolvedConfig, HandlerExecutionContext, WilmaVoiceHttpAuthSchemeParameters, object> {
12
+ }
13
+ /**
14
+ * @internal
15
+ */
16
+ export declare const defaultWilmaVoiceHttpAuthSchemeParametersProvider: (config: WilmaVoiceClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<WilmaVoiceHttpAuthSchemeParameters>;
17
+ /**
18
+ * @internal
19
+ */
20
+ export interface WilmaVoiceHttpAuthSchemeProvider extends HttpAuthSchemeProvider<WilmaVoiceHttpAuthSchemeParameters> {
21
+ }
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const defaultWilmaVoiceHttpAuthSchemeProvider: WilmaVoiceHttpAuthSchemeProvider;
26
+ /**
27
+ * @public
28
+ */
29
+ export interface HttpAuthSchemeInputConfig {
30
+ /**
31
+ * A comma-separated list of case-sensitive auth scheme names.
32
+ * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
33
+ * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
34
+ * @public
35
+ */
36
+ authSchemePreference?: string[] | Provider<string[]>;
37
+ /**
38
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
39
+ * @internal
40
+ */
41
+ httpAuthSchemes?: HttpAuthScheme[];
42
+ /**
43
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
44
+ * @internal
45
+ */
46
+ httpAuthSchemeProvider?: WilmaVoiceHttpAuthSchemeProvider;
47
+ /**
48
+ * The token used to authenticate requests.
49
+ */
50
+ token?: TokenIdentity | TokenIdentityProvider;
51
+ }
52
+ /**
53
+ * @internal
54
+ */
55
+ export interface HttpAuthSchemeResolvedConfig {
56
+ /**
57
+ * A comma-separated list of case-sensitive auth scheme names.
58
+ * An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
59
+ * For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
60
+ * @public
61
+ */
62
+ readonly authSchemePreference: Provider<string[]>;
63
+ /**
64
+ * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
65
+ * @internal
66
+ */
67
+ readonly httpAuthSchemes: HttpAuthScheme[];
68
+ /**
69
+ * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
70
+ * @internal
71
+ */
72
+ readonly httpAuthSchemeProvider: WilmaVoiceHttpAuthSchemeProvider;
73
+ /**
74
+ * The token used to authenticate requests.
75
+ */
76
+ readonly token?: TokenIdentityProvider;
77
+ }
78
+ /**
79
+ * @internal
80
+ */
81
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig) => T & HttpAuthSchemeResolvedConfig;
@@ -0,0 +1,252 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { DescribeVoiceProtocolInput, DescribeVoiceProtocolOutput } from "../models/models_0";
4
+ import type { ServiceInputTypes, ServiceOutputTypes, WilmaVoiceClientResolvedConfig } from "../WilmaVoiceClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeVoiceProtocolCommand}.
14
+ */
15
+ export interface DescribeVoiceProtocolCommandInput extends DescribeVoiceProtocolInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeVoiceProtocolCommand}.
21
+ */
22
+ export interface DescribeVoiceProtocolCommandOutput extends DescribeVoiceProtocolOutput, __MetadataBearer {
23
+ }
24
+ declare const DescribeVoiceProtocolCommand_base: {
25
+ new (input: DescribeVoiceProtocolCommandInput): import("@smithy/core/client").CommandImpl<DescribeVoiceProtocolCommandInput, DescribeVoiceProtocolCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [DescribeVoiceProtocolCommandInput]): import("@smithy/core/client").CommandImpl<DescribeVoiceProtocolCommandInput, DescribeVoiceProtocolCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * 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.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { WilmaVoiceClient, DescribeVoiceProtocolCommand } from "@wildix/wilma-voice-client"; // ES Modules import
35
+ * // const { WilmaVoiceClient, DescribeVoiceProtocolCommand } = require("@wildix/wilma-voice-client"); // CommonJS import
36
+ * // import type { WilmaVoiceClientConfig } from "@wildix/wilma-voice-client";
37
+ * const config = {}; // type is WilmaVoiceClientConfig
38
+ * const client = new WilmaVoiceClient(config);
39
+ * const input = {};
40
+ * const command = new DescribeVoiceProtocolCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // DescribeVoiceProtocolOutput
43
+ * // connectParams: { // VoiceConnectParams
44
+ * // protocolVersion: Number("int"),
45
+ * // sessionId: "STRING_VALUE", // required
46
+ * // agentId: "STRING_VALUE", // required
47
+ * // agentDeployment: "STRING_VALUE",
48
+ * // agentVersion: Number("int"),
49
+ * // agentDraft: true || false,
50
+ * // callId: "STRING_VALUE",
51
+ * // language: "STRING_VALUE",
52
+ * // callerName: "STRING_VALUE",
53
+ * // callerNumber: "STRING_VALUE",
54
+ * // callerEmail: "STRING_VALUE",
55
+ * // callerCompany: "STRING_VALUE",
56
+ * // voice: "STRING_VALUE",
57
+ * // initialMessage: "STRING_VALUE",
58
+ * // variables: "STRING_VALUE",
59
+ * // inputMode: "transcription" || "audio",
60
+ * // inputAudio: { // VoiceAudioFormat
61
+ * // encoding: "pcm_s16le" || "mulaw" || "alaw" || "opus", // required
62
+ * // sampleRate: Number("int"), // required
63
+ * // channels: Number("int"),
64
+ * // },
65
+ * // outputAudio: {
66
+ * // encoding: "pcm_s16le" || "mulaw" || "alaw" || "opus", // required
67
+ * // sampleRate: Number("int"), // required
68
+ * // channels: Number("int"),
69
+ * // },
70
+ * // },
71
+ * // audioWebsocketEvent: { // AudioWebsocketEvent
72
+ * // type: "STRING_VALUE", // required
73
+ * // event: { // AudioEvent
74
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
75
+ * // data: "STRING_VALUE", // required
76
+ * // seq: Number("int"),
77
+ * // },
78
+ * // },
79
+ * // transcriptionWebsocketEvent: { // TranscriptionWebsocketEvent
80
+ * // type: "STRING_VALUE", // required
81
+ * // event: { // TranscriptionEvent
82
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
83
+ * // id: "STRING_VALUE", // required
84
+ * // text: "STRING_VALUE", // required
85
+ * // confidence: Number("double"),
86
+ * // final: true || false,
87
+ * // time: Number("long"), // required
88
+ * // },
89
+ * // },
90
+ * // replyWebsocketEvent: { // ReplyWebsocketEvent
91
+ * // type: "STRING_VALUE", // required
92
+ * // event: { // ReplyEvent
93
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
94
+ * // id: "STRING_VALUE", // required
95
+ * // text: "STRING_VALUE", // required
96
+ * // startTime: Number("long"), // required
97
+ * // endTime: Number("long"), // required
98
+ * // },
99
+ * // },
100
+ * // playbackWebsocketEvent: { // PlaybackWebsocketEvent
101
+ * // type: "STRING_VALUE", // required
102
+ * // event: { // PlaybackEvent
103
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
104
+ * // replyId: "STRING_VALUE", // required
105
+ * // text: "STRING_VALUE", // required
106
+ * // complete: true || false, // required
107
+ * // startTime: Number("long"), // required
108
+ * // endTime: Number("long"),
109
+ * // },
110
+ * // },
111
+ * // interruptionWebsocketEvent: { // InterruptionWebsocketEvent
112
+ * // type: "STRING_VALUE", // required
113
+ * // event: { // InterruptionEvent
114
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
115
+ * // replyId: "STRING_VALUE", // required
116
+ * // playedText: "STRING_VALUE", // required
117
+ * // originalText: "STRING_VALUE", // required
118
+ * // time: Number("long"), // required
119
+ * // },
120
+ * // },
121
+ * // completeWebsocketEvent: { // CompleteWebsocketEvent
122
+ * // type: "STRING_VALUE", // required
123
+ * // event: { // CompleteEvent
124
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
125
+ * // reason: "STRING_VALUE", // required
126
+ * // time: Number("long"), // required
127
+ * // },
128
+ * // },
129
+ * // controlWebsocketEvent: { // ControlWebsocketEvent
130
+ * // type: "STRING_VALUE", // required
131
+ * // event: { // ControlEvent
132
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
133
+ * // action: "end_of_turn" || "clear" || "keepalive", // required
134
+ * // },
135
+ * // },
136
+ * // sessionStartedWebsocketEvent: { // SessionStartedWebsocketEvent
137
+ * // type: "STRING_VALUE", // required
138
+ * // event: { // SessionStartedEvent
139
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
140
+ * // time: Number("long"), // required
141
+ * // sessionId: "STRING_VALUE", // required
142
+ * // agentId: "STRING_VALUE", // required
143
+ * // agentVersion: Number("int"),
144
+ * // agentName: "STRING_VALUE",
145
+ * // category: "STRING_VALUE",
146
+ * // groupId: "STRING_VALUE",
147
+ * // inputAudio: {
148
+ * // encoding: "pcm_s16le" || "mulaw" || "alaw" || "opus", // required
149
+ * // sampleRate: Number("int"), // required
150
+ * // channels: Number("int"),
151
+ * // },
152
+ * // outputAudio: {
153
+ * // encoding: "pcm_s16le" || "mulaw" || "alaw" || "opus", // required
154
+ * // sampleRate: Number("int"), // required
155
+ * // channels: Number("int"),
156
+ * // },
157
+ * // },
158
+ * // },
159
+ * // sessionEndedWebsocketEvent: { // SessionEndedWebsocketEvent
160
+ * // type: "STRING_VALUE", // required
161
+ * // event: { // SessionEndedEvent
162
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
163
+ * // reason: "STRING_VALUE",
164
+ * // error: "STRING_VALUE",
165
+ * // time: Number("long"), // required
166
+ * // },
167
+ * // },
168
+ * // errorWebsocketEvent: { // ErrorWebsocketEvent
169
+ * // type: "STRING_VALUE", // required
170
+ * // event: { // VoiceErrorEvent
171
+ * // type: "started" || "ended" || "error" || "audio" || "transcription" || "reply" || "playback" || "interruption" || "complete" || "control", // required
172
+ * // code: "STRING_VALUE", // required
173
+ * // message: "STRING_VALUE", // required
174
+ * // time: Number("long"), // required
175
+ * // },
176
+ * // },
177
+ * // sayWebsocketCommand: { // SayWebsocketCommand
178
+ * // type: "STRING_VALUE", // required
179
+ * // command: { // SayCommandData
180
+ * // text: "STRING_VALUE", // required
181
+ * // replyId: "STRING_VALUE", // required
182
+ * // interruptible: true || false,
183
+ * // audio: { // SayCommandAudioOptions
184
+ * // streamId: "STRING_VALUE", // required
185
+ * // sampleRate: Number("int"), // required
186
+ * // },
187
+ * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
188
+ * // },
189
+ * // },
190
+ * // playWebsocketCommand: { // PlayWebsocketCommand
191
+ * // type: "STRING_VALUE", // required
192
+ * // command: { // PlayCommandData
193
+ * // replyId: "STRING_VALUE", // required
194
+ * // streamId: "STRING_VALUE", // required
195
+ * // data: "STRING_VALUE", // required
196
+ * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
197
+ * // },
198
+ * // },
199
+ * // stopWebsocketCommand: { // StopWebsocketCommand
200
+ * // type: "STRING_VALUE", // required
201
+ * // command: { // StopCommandData
202
+ * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
203
+ * // },
204
+ * // },
205
+ * // hangupWebsocketCommand: { // HangupWebsocketCommand
206
+ * // type: "STRING_VALUE", // required
207
+ * // command: { // HangupCommandData
208
+ * // reason: "STRING_VALUE",
209
+ * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
210
+ * // },
211
+ * // },
212
+ * // transferWebsocketCommand: { // TransferWebsocketCommand
213
+ * // type: "STRING_VALUE", // required
214
+ * // command: { // TransferCommandData
215
+ * // context: "STRING_VALUE", // required
216
+ * // extension: "STRING_VALUE", // required
217
+ * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
218
+ * // },
219
+ * // },
220
+ * // };
221
+ *
222
+ * ```
223
+ *
224
+ * @param DescribeVoiceProtocolCommandInput - {@link DescribeVoiceProtocolCommandInput}
225
+ * @returns {@link DescribeVoiceProtocolCommandOutput}
226
+ * @see {@link DescribeVoiceProtocolCommandInput} for command's `input` shape.
227
+ * @see {@link DescribeVoiceProtocolCommandOutput} for command's `response` shape.
228
+ * @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
229
+ *
230
+ * @throws {@link ValidationException} (client fault)
231
+ *
232
+ * @throws {@link ForbiddenException} (client fault)
233
+ *
234
+ * @throws {@link WilmaVoiceServiceException}
235
+ * <p>Base exception class for all service exceptions from WilmaVoice service.</p>
236
+ *
237
+ *
238
+ * @public
239
+ */
240
+ export declare class DescribeVoiceProtocolCommand extends DescribeVoiceProtocolCommand_base {
241
+ /** @internal type navigation helper, not in runtime. */
242
+ protected static __types: {
243
+ api: {
244
+ input: {};
245
+ output: DescribeVoiceProtocolOutput;
246
+ };
247
+ sdk: {
248
+ input: DescribeVoiceProtocolCommandInput;
249
+ output: DescribeVoiceProtocolCommandOutput;
250
+ };
251
+ };
252
+ }