@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.
- package/dist-cjs/WilmaVoice.js +23 -0
- package/dist-cjs/WilmaVoiceClient.js +49 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
- package/dist-cjs/commands/DescribeVoiceProtocolCommand.js +20 -0
- package/dist-cjs/commands/SendHangupCommand.js +20 -0
- package/dist-cjs/commands/SendPlayCommand.js +20 -0
- package/dist-cjs/commands/SendSayCommand.js +20 -0
- package/dist-cjs/commands/SendStopCommand.js +20 -0
- package/dist-cjs/commands/SendTransferCommand.js +20 -0
- package/dist-cjs/commands/index.js +9 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/bdd.js +28 -0
- package/dist-cjs/endpoint/endpointResolver.js +16 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +13 -0
- package/dist-cjs/models/WilmaVoiceServiceException.js +12 -0
- package/dist-cjs/models/enums.js +37 -0
- package/dist-cjs/models/errors.js +45 -0
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +41 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-cjs/runtimeExtensions.js +12 -0
- package/dist-cjs/schemas/schemas_0.js +404 -0
- package/dist-es/WilmaVoice.js +19 -0
- package/dist-es/WilmaVoiceClient.js +45 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
- package/dist-es/commands/DescribeVoiceProtocolCommand.js +16 -0
- package/dist-es/commands/SendHangupCommand.js +16 -0
- package/dist-es/commands/SendPlayCommand.js +16 -0
- package/dist-es/commands/SendSayCommand.js +16 -0
- package/dist-es/commands/SendStopCommand.js +16 -0
- package/dist-es/commands/SendTransferCommand.js +16 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/bdd.js +25 -0
- package/dist-es/endpoint/endpointResolver.js +12 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +8 -0
- package/dist-es/models/WilmaVoiceServiceException.js +8 -0
- package/dist-es/models/enums.js +34 -0
- package/dist-es/models/errors.js +39 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +36 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +8 -0
- package/dist-es/schemas/schemas_0.js +400 -0
- package/dist-types/WilmaVoice.d.ts +70 -0
- package/dist-types/WilmaVoiceClient.d.ts +185 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
- package/dist-types/commands/DescribeVoiceProtocolCommand.d.ts +252 -0
- package/dist-types/commands/SendHangupCommand.d.ts +79 -0
- package/dist-types/commands/SendPlayCommand.d.ts +81 -0
- package/dist-types/commands/SendSayCommand.d.ts +85 -0
- package/dist-types/commands/SendStopCommand.d.ts +78 -0
- package/dist-types/commands/SendTransferCommand.d.ts +80 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +41 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +33 -0
- package/dist-types/models/WilmaVoiceServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +101 -0
- package/dist-types/models/errors.d.ts +36 -0
- package/dist-types/models/models_0.d.ts +805 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +32 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +63 -0
- package/package.json +57 -0
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SendHangupInput, SendHangupOutput } 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 SendHangupCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendHangupCommandInput extends SendHangupInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendHangupCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendHangupCommandOutput extends SendHangupOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendHangupCommand_base: {
|
|
25
|
+
new (input: SendHangupCommandInput): import("@smithy/core/client").CommandImpl<SendHangupCommandInput, SendHangupCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SendHangupCommandInput): import("@smithy/core/client").CommandImpl<SendHangupCommandInput, SendHangupCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Terminates the voice session and the call.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaVoiceClient, SendHangupCommand } from "@wildix/wilma-voice-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaVoiceClient, SendHangupCommand } = 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 = { // SendHangupInput
|
|
40
|
+
* reason: "STRING_VALUE",
|
|
41
|
+
* sessionId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new SendHangupCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param SendHangupCommandInput - {@link SendHangupCommandInput}
|
|
50
|
+
* @returns {@link SendHangupCommandOutput}
|
|
51
|
+
* @see {@link SendHangupCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link SendHangupCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link VoiceSessionNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ValidationException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link WilmaVoiceServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from WilmaVoice service.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export declare class SendHangupCommand extends SendHangupCommand_base {
|
|
68
|
+
/** @internal type navigation helper, not in runtime. */
|
|
69
|
+
protected static __types: {
|
|
70
|
+
api: {
|
|
71
|
+
input: SendHangupInput;
|
|
72
|
+
output: {};
|
|
73
|
+
};
|
|
74
|
+
sdk: {
|
|
75
|
+
input: SendHangupCommandInput;
|
|
76
|
+
output: SendHangupCommandOutput;
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SendPlayInput, SendPlayOutput } 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 SendPlayCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendPlayCommandInput extends SendPlayInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendPlayCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendPlayCommandOutput extends SendPlayOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendPlayCommand_base: {
|
|
25
|
+
new (input: SendPlayCommandInput): import("@smithy/core/client").CommandImpl<SendPlayCommandInput, SendPlayCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SendPlayCommandInput): import("@smithy/core/client").CommandImpl<SendPlayCommandInput, SendPlayCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Plays the specified audio chunk through the audio stream of the voice session.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaVoiceClient, SendPlayCommand } from "@wildix/wilma-voice-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaVoiceClient, SendPlayCommand } = 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 = { // SendPlayInput
|
|
40
|
+
* replyId: "STRING_VALUE", // required
|
|
41
|
+
* streamId: "STRING_VALUE", // required
|
|
42
|
+
* data: "STRING_VALUE", // required
|
|
43
|
+
* sessionId: "STRING_VALUE", // required
|
|
44
|
+
* };
|
|
45
|
+
* const command = new SendPlayCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param SendPlayCommandInput - {@link SendPlayCommandInput}
|
|
52
|
+
* @returns {@link SendPlayCommandOutput}
|
|
53
|
+
* @see {@link SendPlayCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link SendPlayCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link VoiceSessionNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link WilmaVoiceServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from WilmaVoice service.</p>
|
|
65
|
+
*
|
|
66
|
+
*
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export declare class SendPlayCommand extends SendPlayCommand_base {
|
|
70
|
+
/** @internal type navigation helper, not in runtime. */
|
|
71
|
+
protected static __types: {
|
|
72
|
+
api: {
|
|
73
|
+
input: SendPlayInput;
|
|
74
|
+
output: {};
|
|
75
|
+
};
|
|
76
|
+
sdk: {
|
|
77
|
+
input: SendPlayCommandInput;
|
|
78
|
+
output: SendPlayCommandOutput;
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SendSayInput, SendSayOutput } 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 SendSayCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendSayCommandInput extends SendSayInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendSayCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendSayCommandOutput extends SendSayOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendSayCommand_base: {
|
|
25
|
+
new (input: SendSayCommandInput): import("@smithy/core/client").CommandImpl<SendSayCommandInput, SendSayCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SendSayCommandInput): import("@smithy/core/client").CommandImpl<SendSayCommandInput, SendSayCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Generates and plays the specified text through the audio stream of the voice session.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaVoiceClient, SendSayCommand } from "@wildix/wilma-voice-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaVoiceClient, SendSayCommand } = 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 = { // SendSayInput
|
|
40
|
+
* text: "STRING_VALUE", // required
|
|
41
|
+
* replyId: "STRING_VALUE", // required
|
|
42
|
+
* interruptible: true || false,
|
|
43
|
+
* audio: { // SayCommandAudioOptions
|
|
44
|
+
* streamId: "STRING_VALUE", // required
|
|
45
|
+
* sampleRate: Number("int"), // required
|
|
46
|
+
* },
|
|
47
|
+
* sessionId: "STRING_VALUE", // required
|
|
48
|
+
* };
|
|
49
|
+
* const command = new SendSayCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param SendSayCommandInput - {@link SendSayCommandInput}
|
|
56
|
+
* @returns {@link SendSayCommandOutput}
|
|
57
|
+
* @see {@link SendSayCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link SendSayCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link VoiceSessionNotFoundException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link WilmaVoiceServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from WilmaVoice service.</p>
|
|
69
|
+
*
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
export declare class SendSayCommand extends SendSayCommand_base {
|
|
74
|
+
/** @internal type navigation helper, not in runtime. */
|
|
75
|
+
protected static __types: {
|
|
76
|
+
api: {
|
|
77
|
+
input: SendSayInput;
|
|
78
|
+
output: {};
|
|
79
|
+
};
|
|
80
|
+
sdk: {
|
|
81
|
+
input: SendSayCommandInput;
|
|
82
|
+
output: SendSayCommandOutput;
|
|
83
|
+
};
|
|
84
|
+
};
|
|
85
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SendStopInput, SendStopOutput } 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 SendStopCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendStopCommandInput extends SendStopInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendStopCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendStopCommandOutput extends SendStopOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendStopCommand_base: {
|
|
25
|
+
new (input: SendStopCommandInput): import("@smithy/core/client").CommandImpl<SendStopCommandInput, SendStopCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SendStopCommandInput): import("@smithy/core/client").CommandImpl<SendStopCommandInput, SendStopCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Stops any audio currently being played by the voice session.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaVoiceClient, SendStopCommand } from "@wildix/wilma-voice-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaVoiceClient, SendStopCommand } = 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 = { // SendStopInput
|
|
40
|
+
* sessionId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new SendStopCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param SendStopCommandInput - {@link SendStopCommandInput}
|
|
49
|
+
* @returns {@link SendStopCommandOutput}
|
|
50
|
+
* @see {@link SendStopCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link SendStopCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link VoiceSessionNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ValidationException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link WilmaVoiceServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from WilmaVoice service.</p>
|
|
62
|
+
*
|
|
63
|
+
*
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class SendStopCommand extends SendStopCommand_base {
|
|
67
|
+
/** @internal type navigation helper, not in runtime. */
|
|
68
|
+
protected static __types: {
|
|
69
|
+
api: {
|
|
70
|
+
input: SendStopInput;
|
|
71
|
+
output: {};
|
|
72
|
+
};
|
|
73
|
+
sdk: {
|
|
74
|
+
input: SendStopCommandInput;
|
|
75
|
+
output: SendStopCommandOutput;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SendTransferInput, SendTransferOutput } 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 SendTransferCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendTransferCommandInput extends SendTransferInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendTransferCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendTransferCommandOutput extends SendTransferOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendTransferCommand_base: {
|
|
25
|
+
new (input: SendTransferCommandInput): import("@smithy/core/client").CommandImpl<SendTransferCommandInput, SendTransferCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SendTransferCommandInput): import("@smithy/core/client").CommandImpl<SendTransferCommandInput, SendTransferCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Transfers the call to the specified context and extension, and terminates the voice session.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaVoiceClient, SendTransferCommand } from "@wildix/wilma-voice-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaVoiceClient, SendTransferCommand } = 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 = { // SendTransferInput
|
|
40
|
+
* context: "STRING_VALUE", // required
|
|
41
|
+
* extension: "STRING_VALUE", // required
|
|
42
|
+
* sessionId: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new SendTransferCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // {};
|
|
47
|
+
*
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
50
|
+
* @param SendTransferCommandInput - {@link SendTransferCommandInput}
|
|
51
|
+
* @returns {@link SendTransferCommandOutput}
|
|
52
|
+
* @see {@link SendTransferCommandInput} for command's `input` shape.
|
|
53
|
+
* @see {@link SendTransferCommandOutput} for command's `response` shape.
|
|
54
|
+
* @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link VoiceSessionNotFoundException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ValidationException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link WilmaVoiceServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from WilmaVoice service.</p>
|
|
64
|
+
*
|
|
65
|
+
*
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export declare class SendTransferCommand extends SendTransferCommand_base {
|
|
69
|
+
/** @internal type navigation helper, not in runtime. */
|
|
70
|
+
protected static __types: {
|
|
71
|
+
api: {
|
|
72
|
+
input: SendTransferInput;
|
|
73
|
+
output: {};
|
|
74
|
+
};
|
|
75
|
+
sdk: {
|
|
76
|
+
input: SendTransferCommandInput;
|
|
77
|
+
output: SendTransferCommandOutput;
|
|
78
|
+
};
|
|
79
|
+
};
|
|
80
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ClientInputEndpointParameters {
|
|
6
|
+
clientContextParams?: {
|
|
7
|
+
env?: string | undefined | Provider<string | undefined>;
|
|
8
|
+
};
|
|
9
|
+
env?: string | undefined | Provider<string | undefined>;
|
|
10
|
+
endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
|
|
16
|
+
defaultSigningName: string;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
*/
|
|
21
|
+
export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare const commonParams: {
|
|
26
|
+
readonly env: {
|
|
27
|
+
readonly type: "clientContextParams";
|
|
28
|
+
readonly name: "env";
|
|
29
|
+
};
|
|
30
|
+
readonly endpoint: {
|
|
31
|
+
readonly type: "builtInParams";
|
|
32
|
+
readonly name: "endpoint";
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* @internal
|
|
37
|
+
*/
|
|
38
|
+
export interface EndpointParameters extends __EndpointParameters {
|
|
39
|
+
env?: string | undefined;
|
|
40
|
+
endpoint?: string | undefined;
|
|
41
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { EndpointV2, Logger } from "@smithy/types";
|
|
2
|
+
import type { EndpointParameters } from "./EndpointParameters";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
|
|
7
|
+
logger?: Logger;
|
|
8
|
+
}) => EndpointV2;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
|
|
2
|
+
import type { DefaultExtensionConfiguration } from "@smithy/types";
|
|
3
|
+
import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
|
|
4
|
+
/**
|
|
5
|
+
* @internal
|
|
6
|
+
*/
|
|
7
|
+
export interface WilmaVoiceExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
|
|
8
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Voice-session runtime for the Wilma agent platform. Runs a wilma-agents agent on the voice
|
|
3
|
+
* channel over a live WebSocket: it greets, listens, replies via TTS, transfers, hangs up, runs
|
|
4
|
+
* tools and looks up knowledge — driven entirely by the agent definition resolved at connect
|
|
5
|
+
* (engine, instructions, capabilities and channels.voice settings). This is a runtime only: there
|
|
6
|
+
* is no agent/bot CRUD here — agents are authored and versioned in wilma-agents.
|
|
7
|
+
*
|
|
8
|
+
* The WebSocket (transport host `wilma-voice-ws.wildix.com`) preserves the wim-voicebots message
|
|
9
|
+
* protocol so existing PBX clients work unchanged: the PBX transcribes caller speech and sends
|
|
10
|
+
* `transcription` / `reply` text, and the service returns `say` / `play` / `stop` / `hangup` /
|
|
11
|
+
* `transfer`. In addition, web/app clients connect with inputMode=AUDIO and push raw caller `audio`
|
|
12
|
+
* chunks, which the service transcribes server-side. Every WebSocket message shape (connect params,
|
|
13
|
+
* events and commands) is declared as a structure and enumerated by DescribeVoiceProtocol so the
|
|
14
|
+
* generated SDKs carry the types and (de)serializers; the WebSocket transport itself is hand-coded,
|
|
15
|
+
* as in wim-voicebots. The HTTP Send* operations push the same commands into a live session
|
|
16
|
+
* out-of-band.
|
|
17
|
+
*
|
|
18
|
+
* Session observability and history are recorded in wilma-traces; this service does not expose
|
|
19
|
+
* bot configuration, traces or listing.
|
|
20
|
+
*
|
|
21
|
+
* @packageDocumentation
|
|
22
|
+
*/
|
|
23
|
+
export * from "./WilmaVoiceClient";
|
|
24
|
+
export * from "./WilmaVoice";
|
|
25
|
+
export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
26
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
27
|
+
export type { WilmaVoiceExtensionConfiguration } from "./extensionConfiguration";
|
|
28
|
+
export * from "./commands";
|
|
29
|
+
export * from "./schemas/schemas_0";
|
|
30
|
+
export * from "./models/enums";
|
|
31
|
+
export * from "./models/errors";
|
|
32
|
+
export * from "./models/models_0";
|
|
33
|
+
export { WilmaVoiceServiceException } from "./models/WilmaVoiceServiceException";
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
|
|
2
|
+
export type { __ServiceExceptionOptions };
|
|
3
|
+
export { __ServiceException };
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*
|
|
7
|
+
* Base exception class for all service exceptions from WilmaVoice service.
|
|
8
|
+
*/
|
|
9
|
+
export declare class WilmaVoiceServiceException extends __ServiceException {
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(options: __ServiceExceptionOptions);
|
|
14
|
+
}
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @public
|
|
3
|
+
* @enum
|
|
4
|
+
*/
|
|
5
|
+
export declare const VoiceEventType: {
|
|
6
|
+
readonly AUDIO: "audio";
|
|
7
|
+
readonly COMPLETE: "complete";
|
|
8
|
+
readonly CONTROL: "control";
|
|
9
|
+
readonly ENDED: "ended";
|
|
10
|
+
readonly ERROR: "error";
|
|
11
|
+
readonly INTERRUPTION: "interruption";
|
|
12
|
+
readonly PLAYBACK: "playback";
|
|
13
|
+
readonly REPLY: "reply";
|
|
14
|
+
readonly STARTED: "started";
|
|
15
|
+
readonly TRANSCRIPTION: "transcription";
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export type VoiceEventType = (typeof VoiceEventType)[keyof typeof VoiceEventType];
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* @enum
|
|
24
|
+
*/
|
|
25
|
+
export declare const VoiceControlAction: {
|
|
26
|
+
/**
|
|
27
|
+
* Discard buffered caller audio and cancel the in-progress input turn.
|
|
28
|
+
*/
|
|
29
|
+
readonly CLEAR: "clear";
|
|
30
|
+
/**
|
|
31
|
+
* Push-to-talk: the caller finished the current utterance; transcribe and run the agent now.
|
|
32
|
+
*/
|
|
33
|
+
readonly END_OF_TURN: "end_of_turn";
|
|
34
|
+
/**
|
|
35
|
+
* Application-level keepalive.
|
|
36
|
+
*/
|
|
37
|
+
readonly KEEPALIVE: "keepalive";
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
export type VoiceControlAction = (typeof VoiceControlAction)[keyof typeof VoiceControlAction];
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
* @enum
|
|
46
|
+
*/
|
|
47
|
+
export declare const VoiceAudioEncoding: {
|
|
48
|
+
/**
|
|
49
|
+
* G.711 A-law.
|
|
50
|
+
*/
|
|
51
|
+
readonly ALAW: "alaw";
|
|
52
|
+
/**
|
|
53
|
+
* G.711 μ-law.
|
|
54
|
+
*/
|
|
55
|
+
readonly MULAW: "mulaw";
|
|
56
|
+
/**
|
|
57
|
+
* Opus.
|
|
58
|
+
*/
|
|
59
|
+
readonly OPUS: "opus";
|
|
60
|
+
/**
|
|
61
|
+
* 16-bit signed little-endian linear PCM.
|
|
62
|
+
*/
|
|
63
|
+
readonly PCM_S16LE: "pcm_s16le";
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export type VoiceAudioEncoding = (typeof VoiceAudioEncoding)[keyof typeof VoiceAudioEncoding];
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* @enum
|
|
72
|
+
*/
|
|
73
|
+
export declare const VoiceInputMode: {
|
|
74
|
+
/**
|
|
75
|
+
* The client pushes raw caller `audio` chunks and the service transcribes them server-side (web/app clients).
|
|
76
|
+
*/
|
|
77
|
+
readonly AUDIO: "audio";
|
|
78
|
+
/**
|
|
79
|
+
* The client sends `transcription` / `reply` text events; it performs speech-to-text itself (PBX behaviour, same as wim-voicebots).
|
|
80
|
+
*/
|
|
81
|
+
readonly TRANSCRIPTION: "transcription";
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export type VoiceInputMode = (typeof VoiceInputMode)[keyof typeof VoiceInputMode];
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
* @enum
|
|
90
|
+
*/
|
|
91
|
+
export declare const VoiceCommandType: {
|
|
92
|
+
readonly HANGUP: "hangup";
|
|
93
|
+
readonly PLAY: "play";
|
|
94
|
+
readonly SAY: "say";
|
|
95
|
+
readonly STOP: "stop";
|
|
96
|
+
readonly TRANSFER: "transfer";
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export type VoiceCommandType = (typeof VoiceCommandType)[keyof typeof VoiceCommandType];
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
|
|
2
|
+
import { WilmaVoiceServiceException as __BaseException } from "./WilmaVoiceServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare class ForbiddenException extends __BaseException {
|
|
7
|
+
readonly name: "ForbiddenException";
|
|
8
|
+
readonly $fault: "client";
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export declare class ValidationException extends __BaseException {
|
|
18
|
+
readonly name: "ValidationException";
|
|
19
|
+
readonly $fault: "client";
|
|
20
|
+
/**
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export declare class VoiceSessionNotFoundException extends __BaseException {
|
|
29
|
+
readonly name: "VoiceSessionNotFoundException";
|
|
30
|
+
readonly $fault: "client";
|
|
31
|
+
type?: string | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
constructor(opts: __ExceptionOptionType<VoiceSessionNotFoundException, __BaseException>);
|
|
36
|
+
}
|