@wildix/wda-stream-client 1.1.56 → 1.1.57

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 (37) hide show
  1. package/dist-cjs/WdaStream.js +6 -0
  2. package/dist-cjs/commands/GetOngoingCallAnnotationsCommand.js +21 -0
  3. package/dist-cjs/commands/GetOngoingChatAnnotationsCommand.js +21 -0
  4. package/dist-cjs/commands/GetOngoingConferenceAnnotationsCommand.js +21 -0
  5. package/dist-cjs/commands/index.js +3 -0
  6. package/dist-cjs/models/models_0.js +64 -31
  7. package/dist-cjs/models/models_1.js +7 -1
  8. package/dist-cjs/protocols/Aws_restJson1.js +300 -3
  9. package/dist-es/WdaStream.js +6 -0
  10. package/dist-es/commands/GetOngoingCallAnnotationsCommand.js +17 -0
  11. package/dist-es/commands/GetOngoingChatAnnotationsCommand.js +17 -0
  12. package/dist-es/commands/GetOngoingConferenceAnnotationsCommand.js +17 -0
  13. package/dist-es/commands/index.js +3 -0
  14. package/dist-es/models/models_0.js +62 -29
  15. package/dist-es/models/models_1.js +6 -0
  16. package/dist-es/protocols/Aws_restJson1.js +295 -4
  17. package/dist-types/WdaStream.d.ts +21 -0
  18. package/dist-types/WdaStreamClient.d.ts +5 -2
  19. package/dist-types/commands/ConsumeEventCommand.d.ts +146 -88
  20. package/dist-types/commands/DescribeEventCommand.d.ts +303 -195
  21. package/dist-types/commands/GetOngoingCallAnnotationsCommand.d.ts +286 -0
  22. package/dist-types/commands/GetOngoingCallCommand.d.ts +1 -1
  23. package/dist-types/commands/GetOngoingCallTranscriptionCommand.d.ts +2 -2
  24. package/dist-types/commands/GetOngoingChatAnnotationsCommand.d.ts +190 -0
  25. package/dist-types/commands/GetOngoingConferenceAnnotationsCommand.d.ts +134 -0
  26. package/dist-types/commands/GetOngoingConferenceCommand.d.ts +2 -1
  27. package/dist-types/commands/GetOngoingConferenceTranscriptionCommand.d.ts +3 -2
  28. package/dist-types/commands/ListServicesCommand.d.ts +0 -1
  29. package/dist-types/commands/QueryConversationsCommand.d.ts +6 -4
  30. package/dist-types/commands/index.d.ts +3 -0
  31. package/dist-types/models/models_0.d.ts +675 -705
  32. package/dist-types/models/models_1.d.ts +254 -18
  33. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  34. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  35. package/dist-types/runtimeConfig.d.ts +1 -1
  36. package/dist-types/runtimeConfig.native.d.ts +1 -1
  37. package/package.json +1 -1
@@ -0,0 +1,286 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
2
+ import { GetOngoingCallAnnotationsInput, GetOngoingCallAnnotationsOutput } from "../models/models_1";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetOngoingCallAnnotationsCommand}.
14
+ */
15
+ export interface GetOngoingCallAnnotationsCommandInput extends GetOngoingCallAnnotationsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetOngoingCallAnnotationsCommand}.
21
+ */
22
+ export interface GetOngoingCallAnnotationsCommandOutput extends GetOngoingCallAnnotationsOutput, __MetadataBearer {
23
+ }
24
+ declare const GetOngoingCallAnnotationsCommand_base: {
25
+ new (input: GetOngoingCallAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallAnnotationsCommandInput, GetOngoingCallAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetOngoingCallAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallAnnotationsCommandInput, GetOngoingCallAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves information and annotations for ongoing call.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { WdaStreamClient, GetOngoingCallAnnotationsCommand } from "@wildix/wda-stream-client"; // ES Modules import
35
+ * // const { WdaStreamClient, GetOngoingCallAnnotationsCommand } = require("@wildix/wda-stream-client"); // CommonJS import
36
+ * const client = new WdaStreamClient(config);
37
+ * const input = { // GetOngoingCallAnnotationsInput
38
+ * company: "STRING_VALUE",
39
+ * callId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetOngoingCallAnnotationsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetOngoingCallAnnotationsOutput
44
+ * // company: "STRING_VALUE", // required
45
+ * // flows: [ // CallAnalyticsLiveProgressEventFlowList // required
46
+ * // { // CallAnalyticsLiveProgressEventFlow
47
+ * // flowIndex: Number("int"), // required
48
+ * // startTime: Number("long"), // required
49
+ * // endTime: Number("long"), // required
50
+ * // connectTime: Number("long"),
51
+ * // talkTime: Number("long"),
52
+ * // waitTime: Number("long"),
53
+ * // queueTime: Number("long"),
54
+ * // holdTime: Number("long"),
55
+ * // duration: Number("long"), // required
56
+ * // caller: { // CallParticipant
57
+ * // type: "REMOTE" || "LOCAL", // required
58
+ * // phone: "STRING_VALUE",
59
+ * // name: "STRING_VALUE",
60
+ * // company: "STRING_VALUE",
61
+ * // email: "STRING_VALUE",
62
+ * // userId: "STRING_VALUE",
63
+ * // userExtension: "STRING_VALUE",
64
+ * // userDepartment: "STRING_VALUE",
65
+ * // groupId: "STRING_VALUE",
66
+ * // groupName: "STRING_VALUE",
67
+ * // userAgent: "STRING_VALUE",
68
+ * // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
69
+ * // role: "CLIENT" || "AGENT", // required
70
+ * // license: "STRING_VALUE",
71
+ * // sipCallId: "STRING_VALUE",
72
+ * // publicAddress: "STRING_VALUE",
73
+ * // privateAddress: "STRING_VALUE",
74
+ * // location: "STRING_VALUE",
75
+ * // },
76
+ * // callee: {
77
+ * // type: "REMOTE" || "LOCAL", // required
78
+ * // phone: "STRING_VALUE",
79
+ * // name: "STRING_VALUE",
80
+ * // company: "STRING_VALUE",
81
+ * // email: "STRING_VALUE",
82
+ * // userId: "STRING_VALUE",
83
+ * // userExtension: "STRING_VALUE",
84
+ * // userDepartment: "STRING_VALUE",
85
+ * // groupId: "STRING_VALUE",
86
+ * // groupName: "STRING_VALUE",
87
+ * // userAgent: "STRING_VALUE",
88
+ * // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
89
+ * // role: "CLIENT" || "AGENT", // required
90
+ * // license: "STRING_VALUE",
91
+ * // sipCallId: "STRING_VALUE",
92
+ * // publicAddress: "STRING_VALUE",
93
+ * // privateAddress: "STRING_VALUE",
94
+ * // location: "STRING_VALUE",
95
+ * // },
96
+ * // service: "STRING_VALUE",
97
+ * // serviceNumber: "STRING_VALUE",
98
+ * // destination: "STRING_VALUE",
99
+ * // direction: "INTERNAL" || "INBOUND" || "OUTBOUND" || "UNDEFINED",
100
+ * // trunkName: "STRING_VALUE",
101
+ * // trunkDirection: "STRING_VALUE",
102
+ * // queueName: "STRING_VALUE",
103
+ * // queueId: "STRING_VALUE",
104
+ * // tags: [ // CallFlowTags
105
+ * // "STRING_VALUE",
106
+ * // ],
107
+ * // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
108
+ * // flags: [ // CallFlowFlags
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // callerMos: "STRING_VALUE",
112
+ * // calleeMos: "STRING_VALUE",
113
+ * // xhoppersConfId: "STRING_VALUE",
114
+ * // recordings: [ // CallFlowRecordings
115
+ * // "STRING_VALUE",
116
+ * // ],
117
+ * // recordingsData: [ // CallFlowRecordingsData
118
+ * // { // CallFlowRecording
119
+ * // fileName: "STRING_VALUE", // required
120
+ * // start: Number("long"), // required
121
+ * // end: Number("long"), // required
122
+ * // owner: "callee" || "caller" || "system", // required
123
+ * // url: "STRING_VALUE", // required
124
+ * // pauses: [ // CallRecordPausesList // required
125
+ * // { // CallRecordPause
126
+ * // start: Number("long"),
127
+ * // end: Number("long"),
128
+ * // reason: "pause" || "hold",
129
+ * // },
130
+ * // ],
131
+ * // },
132
+ * // ],
133
+ * // mergeWith: "STRING_VALUE",
134
+ * // splitReason: "STRING_VALUE",
135
+ * // splitTransferType: "STRING_VALUE",
136
+ * // remotePhone: "STRING_VALUE",
137
+ * // remotePhoneCountryCode: Number("int"),
138
+ * // remotePhoneCountryCodeStr: "STRING_VALUE",
139
+ * // remotePhoneLocation: "STRING_VALUE",
140
+ * // callStatus: "COMPLETED" || "MISSED",
141
+ * // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE",
142
+ * // transcriptionLanguage: "STRING_VALUE",
143
+ * // transcriptionSeconds: Number("int"),
144
+ * // attachment: "STRING_VALUE",
145
+ * // attachmentType: "VOICEMAIL" || "FAX",
146
+ * // attachmentDestinations: [ // CallFlowAttachmentDestinationList
147
+ * // { // CallFlowAttachmentDestination
148
+ * // phone: "STRING_VALUE",
149
+ * // name: "STRING_VALUE",
150
+ * // email: "STRING_VALUE",
151
+ * // userId: "STRING_VALUE",
152
+ * // userExtension: "STRING_VALUE",
153
+ * // userDepartment: "STRING_VALUE",
154
+ * // groupId: "STRING_VALUE",
155
+ * // groupName: "STRING_VALUE",
156
+ * // },
157
+ * // ],
158
+ * // attachments: [ // CallFlowAttachments
159
+ * // { // CallFlowAttachment Union: only one key present
160
+ * // recording: {
161
+ * // fileName: "STRING_VALUE", // required
162
+ * // start: Number("long"), // required
163
+ * // end: Number("long"), // required
164
+ * // owner: "callee" || "caller" || "system", // required
165
+ * // url: "STRING_VALUE", // required
166
+ * // pauses: [ // required
167
+ * // {
168
+ * // start: Number("long"),
169
+ * // end: Number("long"),
170
+ * // reason: "pause" || "hold",
171
+ * // },
172
+ * // ],
173
+ * // },
174
+ * // fax: { // CallFlowFax
175
+ * // url: "STRING_VALUE", // required
176
+ * // status: "ok" || "error",
177
+ * // destinations: [
178
+ * // {
179
+ * // phone: "STRING_VALUE",
180
+ * // name: "STRING_VALUE",
181
+ * // email: "STRING_VALUE",
182
+ * // userId: "STRING_VALUE",
183
+ * // userExtension: "STRING_VALUE",
184
+ * // userDepartment: "STRING_VALUE",
185
+ * // groupId: "STRING_VALUE",
186
+ * // groupName: "STRING_VALUE",
187
+ * // },
188
+ * // ],
189
+ * // owner: "callee" || "caller" || "system",
190
+ * // error: "STRING_VALUE",
191
+ * // },
192
+ * // voicemail: { // CallFlowVoicemail
193
+ * // url: "STRING_VALUE", // required
194
+ * // destinations: [
195
+ * // {
196
+ * // phone: "STRING_VALUE",
197
+ * // name: "STRING_VALUE",
198
+ * // email: "STRING_VALUE",
199
+ * // userId: "STRING_VALUE",
200
+ * // userExtension: "STRING_VALUE",
201
+ * // userDepartment: "STRING_VALUE",
202
+ * // groupId: "STRING_VALUE",
203
+ * // groupName: "STRING_VALUE",
204
+ * // },
205
+ * // ],
206
+ * // owner: "callee" || "caller" || "system",
207
+ * // },
208
+ * // },
209
+ * // ],
210
+ * // notifications: { // CallFlowNotifications
211
+ * // destinations: "<CallFlowAttachmentDestinationList>",
212
+ * // type: [ // NotificationsType
213
+ * // "STRING_VALUE",
214
+ * // ],
215
+ * // },
216
+ * // status: "CONNECTING" || "TALKING" || "HOLD", // required
217
+ * // statusChangeDate: "STRING_VALUE", // required
218
+ * // },
219
+ * // ],
220
+ * // annotations: [ // CallAnalyticsLiveAnnotationEventList
221
+ * // { // CallAnalyticsLiveAnnotationEvent
222
+ * // id: "STRING_VALUE", // required
223
+ * // pbx: "STRING_VALUE", // required
224
+ * // time: Number("long"), // required
225
+ * // company: "STRING_VALUE", // required
226
+ * // licenses: [ // LicensesList // required
227
+ * // "x-bees" || "uc",
228
+ * // ],
229
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
230
+ * // flowIndex: Number("int"), // required
231
+ * // flowStartTime: Number("long"), // required
232
+ * // callStartTime: Number("long"), // required
233
+ * // annotation: { // Annotation
234
+ * // id: "STRING_VALUE", // required
235
+ * // time: Number("long"), // required
236
+ * // payload: { // AnnotationPayload Union: only one key present
237
+ * // tag: "STRING_VALUE",
238
+ * // text: "STRING_VALUE",
239
+ * // variables: { // AnnotationVariablesValue
240
+ * // value: "DOCUMENT_VALUE", // required
241
+ * // },
242
+ * // result: { // AnnotationResultValue
243
+ * // value: "DOCUMENT_VALUE", // required
244
+ * // },
245
+ * // },
246
+ * // source: { // AnnotationSource
247
+ * // type: "chatbot" || "voicebot" || "user" || "system", // required
248
+ * // id: "STRING_VALUE",
249
+ * // name: "STRING_VALUE",
250
+ * // },
251
+ * // },
252
+ * // },
253
+ * // ],
254
+ * // };
255
+ *
256
+ * ```
257
+ *
258
+ * @param GetOngoingCallAnnotationsCommandInput - {@link GetOngoingCallAnnotationsCommandInput}
259
+ * @returns {@link GetOngoingCallAnnotationsCommandOutput}
260
+ * @see {@link GetOngoingCallAnnotationsCommandInput} for command's `input` shape.
261
+ * @see {@link GetOngoingCallAnnotationsCommandOutput} for command's `response` shape.
262
+ * @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
263
+ *
264
+ * @throws {@link ValidationException} (client fault)
265
+ *
266
+ * @throws {@link MatchNotFoundException} (client fault)
267
+ *
268
+ * @throws {@link WdaStreamServiceException}
269
+ * <p>Base exception class for all service exceptions from WdaStream service.</p>
270
+ *
271
+ *
272
+ * @public
273
+ */
274
+ export declare class GetOngoingCallAnnotationsCommand extends GetOngoingCallAnnotationsCommand_base {
275
+ /** @internal type navigation helper, not in runtime. */
276
+ protected static __types: {
277
+ api: {
278
+ input: GetOngoingCallAnnotationsInput;
279
+ output: GetOngoingCallAnnotationsOutput;
280
+ };
281
+ sdk: {
282
+ input: GetOngoingCallAnnotationsCommandInput;
283
+ output: GetOngoingCallAnnotationsCommandOutput;
284
+ };
285
+ };
286
+ }
@@ -101,10 +101,10 @@ declare const GetOngoingCallCommand_base: {
101
101
  * // trunkDirection: "STRING_VALUE",
102
102
  * // queueName: "STRING_VALUE",
103
103
  * // queueId: "STRING_VALUE",
104
- * // queuePosition: Number("int"),
105
104
  * // tags: [ // CallFlowTags
106
105
  * // "STRING_VALUE",
107
106
  * // ],
107
+ * // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
108
108
  * // flags: [ // CallFlowFlags
109
109
  * // "STRING_VALUE",
110
110
  * // ],
@@ -101,10 +101,10 @@ declare const GetOngoingCallTranscriptionCommand_base: {
101
101
  * // trunkDirection: "STRING_VALUE",
102
102
  * // queueName: "STRING_VALUE",
103
103
  * // queueId: "STRING_VALUE",
104
- * // queuePosition: Number("int"),
105
104
  * // tags: [ // CallFlowTags
106
105
  * // "STRING_VALUE",
107
106
  * // ],
107
+ * // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
108
108
  * // flags: [ // CallFlowFlags
109
109
  * // "STRING_VALUE",
110
110
  * // ],
@@ -226,7 +226,7 @@ declare const GetOngoingCallTranscriptionCommand_base: {
226
226
  * // licenses: [ // LicensesList // required
227
227
  * // "x-bees" || "uc",
228
228
  * // ],
229
- * // event: "chat" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_agent_status" || "service_call" || "service_call_complete", // required
229
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
230
230
  * // flowIndex: Number("int"), // required
231
231
  * // flowStartTime: Number("long"), // required
232
232
  * // callStartTime: Number("long"), // required
@@ -0,0 +1,190 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
2
+ import { GetOngoingChatAnnotationsInput, GetOngoingChatAnnotationsOutput } from "../models/models_1";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetOngoingChatAnnotationsCommand}.
14
+ */
15
+ export interface GetOngoingChatAnnotationsCommandInput extends GetOngoingChatAnnotationsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetOngoingChatAnnotationsCommand}.
21
+ */
22
+ export interface GetOngoingChatAnnotationsCommandOutput extends GetOngoingChatAnnotationsOutput, __MetadataBearer {
23
+ }
24
+ declare const GetOngoingChatAnnotationsCommand_base: {
25
+ new (input: GetOngoingChatAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingChatAnnotationsCommandInput, GetOngoingChatAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetOngoingChatAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingChatAnnotationsCommandInput, GetOngoingChatAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves information and annotations for ongoing chat.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { WdaStreamClient, GetOngoingChatAnnotationsCommand } from "@wildix/wda-stream-client"; // ES Modules import
35
+ * // const { WdaStreamClient, GetOngoingChatAnnotationsCommand } = require("@wildix/wda-stream-client"); // CommonJS import
36
+ * const client = new WdaStreamClient(config);
37
+ * const input = { // GetOngoingChatAnnotationsInput
38
+ * company: "STRING_VALUE",
39
+ * chatId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetOngoingChatAnnotationsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetOngoingChatAnnotationsOutput
44
+ * // chat: { // ChatAnalyticsLiveProgressEvent
45
+ * // id: "STRING_VALUE",
46
+ * // chatId: "STRING_VALUE",
47
+ * // time: Number("long"), // required
48
+ * // company: "STRING_VALUE", // required
49
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
50
+ * // start: "STRING_VALUE", // required
51
+ * // channelId: "STRING_VALUE", // required
52
+ * // channelType: "direct" || "group", // required
53
+ * // subject: "STRING_VALUE", // required
54
+ * // service: "STRING_VALUE",
55
+ * // serviceTitle: "STRING_VALUE",
56
+ * // participants: [ // ChatLiveParticipantsList // required
57
+ * // { // ChatParticipantInfo
58
+ * // id: "STRING_VALUE", // required
59
+ * // name: "STRING_VALUE",
60
+ * // email: "STRING_VALUE",
61
+ * // phone: "STRING_VALUE",
62
+ * // picture: "STRING_VALUE",
63
+ * // locale: "STRING_VALUE",
64
+ * // timeZone: "STRING_VALUE",
65
+ * // company: "STRING_VALUE",
66
+ * // bot: true || false,
67
+ * // pbxDomain: "STRING_VALUE",
68
+ * // pbxPort: "STRING_VALUE",
69
+ * // pbxExtension: "STRING_VALUE",
70
+ * // pbxSerial: "STRING_VALUE",
71
+ * // pbxUserId: "STRING_VALUE",
72
+ * // pbxGroupId: "STRING_VALUE",
73
+ * // createdAt: "STRING_VALUE",
74
+ * // updatedAt: "STRING_VALUE",
75
+ * // type: "REMOTE" || "LOCAL", // required
76
+ * // role: "CLIENT" || "AGENT", // required
77
+ * // },
78
+ * // ],
79
+ * // agents: [ // ChatUserList // required
80
+ * // { // User
81
+ * // id: "STRING_VALUE", // required
82
+ * // name: "STRING_VALUE",
83
+ * // email: "STRING_VALUE",
84
+ * // phone: "STRING_VALUE",
85
+ * // picture: "STRING_VALUE",
86
+ * // locale: "STRING_VALUE",
87
+ * // timeZone: "STRING_VALUE",
88
+ * // company: "STRING_VALUE",
89
+ * // bot: true || false,
90
+ * // pbxDomain: "STRING_VALUE",
91
+ * // pbxPort: "STRING_VALUE",
92
+ * // pbxExtension: "STRING_VALUE",
93
+ * // pbxSerial: "STRING_VALUE",
94
+ * // pbxUserId: "STRING_VALUE",
95
+ * // pbxGroupId: "STRING_VALUE",
96
+ * // createdAt: "STRING_VALUE",
97
+ * // updatedAt: "STRING_VALUE",
98
+ * // },
99
+ * // ],
100
+ * // agentsCount: Number("int"), // required
101
+ * // customers: [ // required
102
+ * // {
103
+ * // id: "STRING_VALUE", // required
104
+ * // name: "STRING_VALUE",
105
+ * // email: "STRING_VALUE",
106
+ * // phone: "STRING_VALUE",
107
+ * // picture: "STRING_VALUE",
108
+ * // locale: "STRING_VALUE",
109
+ * // timeZone: "STRING_VALUE",
110
+ * // company: "STRING_VALUE",
111
+ * // bot: true || false,
112
+ * // pbxDomain: "STRING_VALUE",
113
+ * // pbxPort: "STRING_VALUE",
114
+ * // pbxExtension: "STRING_VALUE",
115
+ * // pbxSerial: "STRING_VALUE",
116
+ * // pbxUserId: "STRING_VALUE",
117
+ * // pbxGroupId: "STRING_VALUE",
118
+ * // createdAt: "STRING_VALUE",
119
+ * // updatedAt: "STRING_VALUE",
120
+ * // },
121
+ * // ],
122
+ * // customersCount: Number("int"), // required
123
+ * // tags: [ // ChatTags
124
+ * // "sms" || "telephony" || "whatsapp",
125
+ * // ],
126
+ * // direction: "INTERNAL" || "INBOUND" || "OUTBOUND", // required
127
+ * // status: "WAITFIRSTREPLY" || "WAITREPLYFROMGUEST" || "WAITREPLYFROMAGENT" || "COMPLETED" || "MISSED", // required
128
+ * // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
129
+ * // },
130
+ * // annotations: [ // ChatAnalyticsLiveAnnotationEventList
131
+ * // { // ChatAnalyticsLiveAnnotationEvent
132
+ * // id: "STRING_VALUE",
133
+ * // chatId: "STRING_VALUE",
134
+ * // time: Number("long"), // required
135
+ * // company: "STRING_VALUE", // required
136
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
137
+ * // annotation: { // Annotation
138
+ * // id: "STRING_VALUE", // required
139
+ * // time: Number("long"), // required
140
+ * // payload: { // AnnotationPayload Union: only one key present
141
+ * // tag: "STRING_VALUE",
142
+ * // text: "STRING_VALUE",
143
+ * // variables: { // AnnotationVariablesValue
144
+ * // value: "DOCUMENT_VALUE", // required
145
+ * // },
146
+ * // result: { // AnnotationResultValue
147
+ * // value: "DOCUMENT_VALUE", // required
148
+ * // },
149
+ * // },
150
+ * // source: { // AnnotationSource
151
+ * // type: "chatbot" || "voicebot" || "user" || "system", // required
152
+ * // id: "STRING_VALUE",
153
+ * // name: "STRING_VALUE",
154
+ * // },
155
+ * // },
156
+ * // },
157
+ * // ],
158
+ * // };
159
+ *
160
+ * ```
161
+ *
162
+ * @param GetOngoingChatAnnotationsCommandInput - {@link GetOngoingChatAnnotationsCommandInput}
163
+ * @returns {@link GetOngoingChatAnnotationsCommandOutput}
164
+ * @see {@link GetOngoingChatAnnotationsCommandInput} for command's `input` shape.
165
+ * @see {@link GetOngoingChatAnnotationsCommandOutput} for command's `response` shape.
166
+ * @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
167
+ *
168
+ * @throws {@link ValidationException} (client fault)
169
+ *
170
+ * @throws {@link MatchNotFoundException} (client fault)
171
+ *
172
+ * @throws {@link WdaStreamServiceException}
173
+ * <p>Base exception class for all service exceptions from WdaStream service.</p>
174
+ *
175
+ *
176
+ * @public
177
+ */
178
+ export declare class GetOngoingChatAnnotationsCommand extends GetOngoingChatAnnotationsCommand_base {
179
+ /** @internal type navigation helper, not in runtime. */
180
+ protected static __types: {
181
+ api: {
182
+ input: GetOngoingChatAnnotationsInput;
183
+ output: GetOngoingChatAnnotationsOutput;
184
+ };
185
+ sdk: {
186
+ input: GetOngoingChatAnnotationsCommandInput;
187
+ output: GetOngoingChatAnnotationsCommandOutput;
188
+ };
189
+ };
190
+ }
@@ -0,0 +1,134 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
2
+ import { GetOngoingConferenceAnnotationsInput, GetOngoingConferenceAnnotationsOutput } from "../models/models_1";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetOngoingConferenceAnnotationsCommand}.
14
+ */
15
+ export interface GetOngoingConferenceAnnotationsCommandInput extends GetOngoingConferenceAnnotationsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetOngoingConferenceAnnotationsCommand}.
21
+ */
22
+ export interface GetOngoingConferenceAnnotationsCommandOutput extends GetOngoingConferenceAnnotationsOutput, __MetadataBearer {
23
+ }
24
+ declare const GetOngoingConferenceAnnotationsCommand_base: {
25
+ new (input: GetOngoingConferenceAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingConferenceAnnotationsCommandInput, GetOngoingConferenceAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetOngoingConferenceAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingConferenceAnnotationsCommandInput, GetOngoingConferenceAnnotationsCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves information and annotations for ongoing conference.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { WdaStreamClient, GetOngoingConferenceAnnotationsCommand } from "@wildix/wda-stream-client"; // ES Modules import
35
+ * // const { WdaStreamClient, GetOngoingConferenceAnnotationsCommand } = require("@wildix/wda-stream-client"); // CommonJS import
36
+ * const client = new WdaStreamClient(config);
37
+ * const input = { // GetOngoingConferenceAnnotationsInput
38
+ * company: "STRING_VALUE",
39
+ * conferenceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetOngoingConferenceAnnotationsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetOngoingConferenceAnnotationsOutput
44
+ * // conference: { // ConferenceAnalyticsLiveProgressEvent
45
+ * // id: "STRING_VALUE", // required
46
+ * // time: Number("long"), // required
47
+ * // company: "STRING_VALUE", // required
48
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
49
+ * // start: "STRING_VALUE", // required
50
+ * // subject: "STRING_VALUE", // required
51
+ * // participants: [ // ConferenceParticipantsList // required
52
+ * // { // ConferenceParticipant
53
+ * // type: "EXTERNAL" || "EXTERNAL_DIAL_IN" || "PBX" || "PBX_SIP" || "XBS", // required
54
+ * // role: "CLIENT" || "AGENT",
55
+ * // jid: "STRING_VALUE",
56
+ * // name: "STRING_VALUE",
57
+ * // email: "STRING_VALUE",
58
+ * // phone: "STRING_VALUE",
59
+ * // department: "STRING_VALUE",
60
+ * // company: "STRING_VALUE",
61
+ * // pbxSerial: "STRING_VALUE",
62
+ * // pbxExtension: "STRING_VALUE",
63
+ * // pbxGroupId: "STRING_VALUE",
64
+ * // xbsId: "STRING_VALUE",
65
+ * // license: "basic" || "essential" || "business" || "premium" || "wizyconf",
66
+ * // },
67
+ * // ],
68
+ * // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE",
69
+ * // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
70
+ * // transcriptionLanguage: "STRING_VALUE",
71
+ * // participantsGroupIds: [ // ConversationParticipantsGroupList
72
+ * // "STRING_VALUE",
73
+ * // ],
74
+ * // },
75
+ * // annotations: [ // ConferenceAnalyticsLiveAnnotationEventList
76
+ * // { // ConferenceAnalyticsLiveAnnotationEvent
77
+ * // id: "STRING_VALUE", // required
78
+ * // time: Number("long"), // required
79
+ * // company: "STRING_VALUE", // required
80
+ * // event: "chat" || "chat_annotation" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_annotation" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_annotation" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
81
+ * // annotation: { // Annotation
82
+ * // id: "STRING_VALUE", // required
83
+ * // time: Number("long"), // required
84
+ * // payload: { // AnnotationPayload Union: only one key present
85
+ * // tag: "STRING_VALUE",
86
+ * // text: "STRING_VALUE",
87
+ * // variables: { // AnnotationVariablesValue
88
+ * // value: "DOCUMENT_VALUE", // required
89
+ * // },
90
+ * // result: { // AnnotationResultValue
91
+ * // value: "DOCUMENT_VALUE", // required
92
+ * // },
93
+ * // },
94
+ * // source: { // AnnotationSource
95
+ * // type: "chatbot" || "voicebot" || "user" || "system", // required
96
+ * // id: "STRING_VALUE",
97
+ * // name: "STRING_VALUE",
98
+ * // },
99
+ * // },
100
+ * // },
101
+ * // ],
102
+ * // };
103
+ *
104
+ * ```
105
+ *
106
+ * @param GetOngoingConferenceAnnotationsCommandInput - {@link GetOngoingConferenceAnnotationsCommandInput}
107
+ * @returns {@link GetOngoingConferenceAnnotationsCommandOutput}
108
+ * @see {@link GetOngoingConferenceAnnotationsCommandInput} for command's `input` shape.
109
+ * @see {@link GetOngoingConferenceAnnotationsCommandOutput} for command's `response` shape.
110
+ * @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
111
+ *
112
+ * @throws {@link ValidationException} (client fault)
113
+ *
114
+ * @throws {@link MatchNotFoundException} (client fault)
115
+ *
116
+ * @throws {@link WdaStreamServiceException}
117
+ * <p>Base exception class for all service exceptions from WdaStream service.</p>
118
+ *
119
+ *
120
+ * @public
121
+ */
122
+ export declare class GetOngoingConferenceAnnotationsCommand extends GetOngoingConferenceAnnotationsCommand_base {
123
+ /** @internal type navigation helper, not in runtime. */
124
+ protected static __types: {
125
+ api: {
126
+ input: GetOngoingConferenceAnnotationsInput;
127
+ output: GetOngoingConferenceAnnotationsOutput;
128
+ };
129
+ sdk: {
130
+ input: GetOngoingConferenceAnnotationsCommandInput;
131
+ output: GetOngoingConferenceAnnotationsCommandOutput;
132
+ };
133
+ };
134
+ }