@wildix/wda-stream-client 1.0.6 → 1.0.8

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.
@@ -31,6 +31,277 @@ export interface ConsumeEventCommandOutput extends ConsumeEventOutput, __Metadat
31
31
  * const client = new WdaStreamClient(config);
32
32
  * const input = { // ConsumeEventInput
33
33
  * event: { // ConsumeEventInputEvent Union: only one key present
34
+ * callStart: { // CallStartConsumeEvent
35
+ * id: "STRING_VALUE", // required
36
+ * time: Number("long"), // required
37
+ * pbx: "STRING_VALUE", // required
38
+ * company: "STRING_VALUE", // required
39
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
40
+ * data: { // CallStartConsumeEventData
41
+ * caller: { // CallFlowConsumeParticipant
42
+ * phone: "STRING_VALUE",
43
+ * name: "STRING_VALUE",
44
+ * email: "STRING_VALUE",
45
+ * company: "STRING_VALUE",
46
+ * userId: "STRING_VALUE",
47
+ * userExtension: "STRING_VALUE",
48
+ * userDepartment: "STRING_VALUE",
49
+ * userLicense: "STRING_VALUE",
50
+ * groupId: "STRING_VALUE",
51
+ * groupName: "STRING_VALUE",
52
+ * device: "STRING_VALUE",
53
+ * },
54
+ * callee: {
55
+ * phone: "STRING_VALUE",
56
+ * name: "STRING_VALUE",
57
+ * email: "STRING_VALUE",
58
+ * company: "STRING_VALUE",
59
+ * userId: "STRING_VALUE",
60
+ * userExtension: "STRING_VALUE",
61
+ * userDepartment: "STRING_VALUE",
62
+ * userLicense: "STRING_VALUE",
63
+ * groupId: "STRING_VALUE",
64
+ * groupName: "STRING_VALUE",
65
+ * device: "STRING_VALUE",
66
+ * },
67
+ * status: "connecting" || "talking" || "hold",
68
+ * destination: "STRING_VALUE",
69
+ * service: "STRING_VALUE",
70
+ * serviceNumber: "STRING_VALUE",
71
+ * trunk: { // CallFlowConsumeTrunk
72
+ * direction: "STRING_VALUE", // required
73
+ * name: "STRING_VALUE", // required
74
+ * },
75
+ * queue: { // CallFlowConsumeQueue
76
+ * id: "STRING_VALUE", // required
77
+ * name: "STRING_VALUE", // required
78
+ * },
79
+ * tags: [ // CallFlowTags
80
+ * "STRING_VALUE",
81
+ * ],
82
+ * flags: [ // CallFlowFlags
83
+ * "STRING_VALUE",
84
+ * ],
85
+ * licenses: [ // LicensesList
86
+ * "x-bees",
87
+ * ],
88
+ * },
89
+ * },
90
+ * callUpdate: { // CallUpdateConsumeEvent
91
+ * id: "STRING_VALUE", // required
92
+ * time: Number("long"), // required
93
+ * pbx: "STRING_VALUE", // required
94
+ * company: "STRING_VALUE", // required
95
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
96
+ * data: { // CallUpdateConsumeEventData
97
+ * caller: {
98
+ * phone: "STRING_VALUE",
99
+ * name: "STRING_VALUE",
100
+ * email: "STRING_VALUE",
101
+ * company: "STRING_VALUE",
102
+ * userId: "STRING_VALUE",
103
+ * userExtension: "STRING_VALUE",
104
+ * userDepartment: "STRING_VALUE",
105
+ * userLicense: "STRING_VALUE",
106
+ * groupId: "STRING_VALUE",
107
+ * groupName: "STRING_VALUE",
108
+ * device: "STRING_VALUE",
109
+ * },
110
+ * callee: {
111
+ * phone: "STRING_VALUE",
112
+ * name: "STRING_VALUE",
113
+ * email: "STRING_VALUE",
114
+ * company: "STRING_VALUE",
115
+ * userId: "STRING_VALUE",
116
+ * userExtension: "STRING_VALUE",
117
+ * userDepartment: "STRING_VALUE",
118
+ * userLicense: "STRING_VALUE",
119
+ * groupId: "STRING_VALUE",
120
+ * groupName: "STRING_VALUE",
121
+ * device: "STRING_VALUE",
122
+ * },
123
+ * status: "connecting" || "talking" || "hold",
124
+ * destination: "STRING_VALUE",
125
+ * service: "STRING_VALUE",
126
+ * serviceNumber: "STRING_VALUE",
127
+ * trunk: {
128
+ * direction: "STRING_VALUE", // required
129
+ * name: "STRING_VALUE", // required
130
+ * },
131
+ * queue: {
132
+ * id: "STRING_VALUE", // required
133
+ * name: "STRING_VALUE", // required
134
+ * },
135
+ * tags: [
136
+ * "STRING_VALUE",
137
+ * ],
138
+ * flags: [
139
+ * "STRING_VALUE",
140
+ * ],
141
+ * mos: { // CallMosData
142
+ * caller: "STRING_VALUE",
143
+ * callee: "STRING_VALUE",
144
+ * },
145
+ * },
146
+ * },
147
+ * callSplit: { // CallSplitConsumeEvent
148
+ * id: "STRING_VALUE", // required
149
+ * time: Number("long"), // required
150
+ * pbx: "STRING_VALUE", // required
151
+ * company: "STRING_VALUE", // required
152
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
153
+ * data: { // CallSplitConsumeEventData
154
+ * caller: {
155
+ * phone: "STRING_VALUE",
156
+ * name: "STRING_VALUE",
157
+ * email: "STRING_VALUE",
158
+ * company: "STRING_VALUE",
159
+ * userId: "STRING_VALUE",
160
+ * userExtension: "STRING_VALUE",
161
+ * userDepartment: "STRING_VALUE",
162
+ * userLicense: "STRING_VALUE",
163
+ * groupId: "STRING_VALUE",
164
+ * groupName: "STRING_VALUE",
165
+ * device: "STRING_VALUE",
166
+ * },
167
+ * callee: "<CallFlowConsumeParticipant>",
168
+ * status: "connecting" || "talking" || "hold",
169
+ * destination: "STRING_VALUE",
170
+ * service: "STRING_VALUE",
171
+ * serviceNumber: "STRING_VALUE",
172
+ * trunk: {
173
+ * direction: "STRING_VALUE", // required
174
+ * name: "STRING_VALUE", // required
175
+ * },
176
+ * queue: {
177
+ * id: "STRING_VALUE", // required
178
+ * name: "STRING_VALUE", // required
179
+ * },
180
+ * tags: [
181
+ * "STRING_VALUE",
182
+ * ],
183
+ * flags: [
184
+ * "STRING_VALUE",
185
+ * ],
186
+ * mos: {
187
+ * caller: "STRING_VALUE",
188
+ * callee: "STRING_VALUE",
189
+ * },
190
+ * reason: "STRING_VALUE",
191
+ * transferType: "STRING_VALUE",
192
+ * mergeWith: "STRING_VALUE",
193
+ * },
194
+ * },
195
+ * callLive: { // CallLiveConsumeEvent
196
+ * id: "STRING_VALUE", // required
197
+ * time: Number("long"), // required
198
+ * pbx: "STRING_VALUE", // required
199
+ * company: "STRING_VALUE", // required
200
+ * },
201
+ * callAgentsStart: { // CallAgentsStartConsumeEvent
202
+ * id: "STRING_VALUE", // required
203
+ * time: Number("long"), // required
204
+ * pbx: "STRING_VALUE", // required
205
+ * company: "STRING_VALUE", // required
206
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
207
+ * data: { // CallAgentsStartOrEndConsumeEventData
208
+ * agents: [ // CallAgentsItemConsumeItemList // required
209
+ * { // CallAgentsItemConsumeItem
210
+ * agent: "STRING_VALUE",
211
+ * info: "<CallFlowConsumeParticipant>",
212
+ * },
213
+ * ],
214
+ * },
215
+ * },
216
+ * callAgentsCancel: { // CallAgentsCancelConsumeEvent
217
+ * id: "STRING_VALUE", // required
218
+ * time: Number("long"), // required
219
+ * pbx: "STRING_VALUE", // required
220
+ * company: "STRING_VALUE", // required
221
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
222
+ * data: {
223
+ * agents: [ // required
224
+ * {
225
+ * agent: "STRING_VALUE",
226
+ * info: "<CallFlowConsumeParticipant>",
227
+ * },
228
+ * ],
229
+ * },
230
+ * },
231
+ * callEnd: { // CallEndConsumeEvent
232
+ * id: "STRING_VALUE", // required
233
+ * time: Number("long"), // required
234
+ * pbx: "STRING_VALUE", // required
235
+ * company: "STRING_VALUE", // required
236
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
237
+ * data: { // CallEndConsumeEventData
238
+ * mos: {
239
+ * caller: "STRING_VALUE",
240
+ * callee: "STRING_VALUE",
241
+ * },
242
+ * cause: "STRING_VALUE",
243
+ * causeStr: "STRING_VALUE",
244
+ * who: "caller" || "callee",
245
+ * },
246
+ * },
247
+ * callRecordStart: { // CallRecordStartConsumeEvent
248
+ * id: "STRING_VALUE", // required
249
+ * time: Number("long"), // required
250
+ * pbx: "STRING_VALUE", // required
251
+ * company: "STRING_VALUE", // required
252
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
253
+ * data: { // CallRecordStartOrStopConsumeEventData
254
+ * fileName: "STRING_VALUE", // required
255
+ * },
256
+ * },
257
+ * callRecordStop: { // CallRecordStopConsumeEvent
258
+ * id: "STRING_VALUE", // required
259
+ * time: Number("long"), // required
260
+ * pbx: "STRING_VALUE", // required
261
+ * company: "STRING_VALUE", // required
262
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
263
+ * data: {
264
+ * fileName: "STRING_VALUE", // required
265
+ * },
266
+ * },
267
+ * callAttachment: { // CallAttachmentConsumeEvent
268
+ * id: "STRING_VALUE", // required
269
+ * time: Number("long"), // required
270
+ * pbx: "STRING_VALUE", // required
271
+ * company: "STRING_VALUE", // required
272
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
273
+ * data: { // CallAttachmentConsumeEventData
274
+ * type: "voicemail" || "fax", // required
275
+ * url: "STRING_VALUE", // required
276
+ * destinations: [ // CallFlowAttachmentDestinationList
277
+ * { // CallFlowAttachmentDestination
278
+ * phone: "STRING_VALUE",
279
+ * name: "STRING_VALUE",
280
+ * email: "STRING_VALUE",
281
+ * userId: "STRING_VALUE",
282
+ * userExtension: "STRING_VALUE",
283
+ * userDepartment: "STRING_VALUE",
284
+ * groupId: "STRING_VALUE",
285
+ * groupName: "STRING_VALUE",
286
+ * },
287
+ * ],
288
+ * },
289
+ * },
290
+ * callTranscription: { // CallTranscribeConsumeEvent
291
+ * id: "STRING_VALUE", // required
292
+ * time: Number("long"), // required
293
+ * pbx: "STRING_VALUE", // required
294
+ * company: "STRING_VALUE", // required
295
+ * type: "CALL.START" || "CALL.UPDATE" || "CALL.SPLIT" || "CALL.LIVE" || "CALL.AGENTS_START" || "CALL.AGENTS_CANCEL" || "CALL.END" || "CALL.RECORD_START" || "CALL.RECORD_STOP" || "CALL.ATTACHMENT" || "CALL.TRANSCRIPTION", // required
296
+ * data: { // CallTranscribeConsumeEventData
297
+ * flowId: Number("int"), // required
298
+ * id: "STRING_VALUE", // required
299
+ * role: "callee" || "caller", // required
300
+ * text: "STRING_VALUE", // required
301
+ * language: "STRING_VALUE", // required
302
+ * final: true || false, // required
303
+ * },
304
+ * },
34
305
  * chatNew: { // ChatNewConsumeEvent
35
306
  * type: "CHAT.NEW" || "CHAT.UPDATE", // required
36
307
  * company: "STRING_VALUE", // required
@@ -194,6 +465,8 @@ export interface ConsumeEventCommandOutput extends ConsumeEventOutput, __Metadat
194
465
  *
195
466
  * @throws {@link ValidationException} (client fault)
196
467
  *
468
+ * @throws {@link ForbiddenException} (client fault)
469
+ *
197
470
  * @throws {@link WdaStreamServiceException}
198
471
  * <p>Base exception class for all service exceptions from WdaStream service.</p>
199
472
  *
@@ -0,0 +1,78 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
2
+ import { GetConferenceIdInput, GetConferenceIdOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link GetConferenceIdCommand}.
13
+ */
14
+ export interface GetConferenceIdCommandInput extends GetConferenceIdInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link GetConferenceIdCommand}.
20
+ */
21
+ export interface GetConferenceIdCommandOutput extends GetConferenceIdOutput, __MetadataBearer {
22
+ }
23
+ /**
24
+ * @public
25
+ * Retrieves ID for ongoing conference using a room token.
26
+ * @example
27
+ * Use a bare-bones client and the command you need to make an API call.
28
+ * ```javascript
29
+ * import { WdaStreamClient, GetConferenceIdCommand } from "@wildix/wda-stream-client"; // ES Modules import
30
+ * // const { WdaStreamClient, GetConferenceIdCommand } = require("@wildix/wda-stream-client"); // CommonJS import
31
+ * const client = new WdaStreamClient(config);
32
+ * const input = { // GetConferenceIdInput
33
+ * company: "STRING_VALUE",
34
+ * channelId: "STRING_VALUE", // required
35
+ * };
36
+ * const command = new GetConferenceIdCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // GetConferenceIdOutput
39
+ * // id: "STRING_VALUE", // required
40
+ * // };
41
+ *
42
+ * ```
43
+ *
44
+ * @param GetConferenceIdCommandInput - {@link GetConferenceIdCommandInput}
45
+ * @returns {@link GetConferenceIdCommandOutput}
46
+ * @see {@link GetConferenceIdCommandInput} for command's `input` shape.
47
+ * @see {@link GetConferenceIdCommandOutput} for command's `response` shape.
48
+ * @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
49
+ *
50
+ * @throws {@link ForbiddenException} (client fault)
51
+ *
52
+ * @throws {@link MatchNotFoundException} (client fault)
53
+ *
54
+ * @throws {@link ValidationException} (client fault)
55
+ *
56
+ * @throws {@link WdaStreamServiceException}
57
+ * <p>Base exception class for all service exceptions from WdaStream service.</p>
58
+ *
59
+ */
60
+ export declare class GetConferenceIdCommand extends $Command<GetConferenceIdCommandInput, GetConferenceIdCommandOutput, WdaStreamClientResolvedConfig> {
61
+ readonly input: GetConferenceIdCommandInput;
62
+ /**
63
+ * @public
64
+ */
65
+ constructor(input: GetConferenceIdCommandInput);
66
+ /**
67
+ * @internal
68
+ */
69
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WdaStreamClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConferenceIdCommandInput, GetConferenceIdCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
73
+ private serialize;
74
+ /**
75
+ * @internal
76
+ */
77
+ private deserialize;
78
+ }
@@ -1,3 +1,4 @@
1
1
  export * from "./ConsumeEventCommand";
2
2
  export * from "./DescribeEventCommand";
3
+ export * from "./GetConferenceIdCommand";
3
4
  export * from "./GetConversationsCommand";