@wildix/wda-history-client 1.2.21 → 1.2.22
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/WdaHistory.js +6 -0
- package/dist-cjs/commands/GetCallAnnotationsCommand.js +21 -0
- package/dist-cjs/commands/GetChatAnnotationsCommand.js +21 -0
- package/dist-cjs/commands/GetConferenceAnnotationsCommand.js +21 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +86 -13
- package/dist-cjs/protocols/Aws_restJson1.js +258 -2
- package/dist-es/WdaHistory.js +6 -0
- package/dist-es/commands/GetCallAnnotationsCommand.js +17 -0
- package/dist-es/commands/GetChatAnnotationsCommand.js +17 -0
- package/dist-es/commands/GetConferenceAnnotationsCommand.js +17 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +81 -12
- package/dist-es/protocols/Aws_restJson1.js +254 -4
- package/dist-types/WdaHistory.d.ts +21 -0
- package/dist-types/WdaHistoryClient.d.ts +5 -2
- package/dist-types/commands/GetCallAnnotationsCommand.d.ts +115 -0
- package/dist-types/commands/GetCallCommand.d.ts +2 -1
- package/dist-types/commands/GetCallTranscriptionCommand.d.ts +4 -2
- package/dist-types/commands/GetChatAnnotationsCommand.d.ts +108 -0
- package/dist-types/commands/GetChatCommand.d.ts +2 -1
- package/dist-types/commands/GetChatTranscriptionCommand.d.ts +2 -1
- package/dist-types/commands/GetChatTranscriptionTextCommand.d.ts +1 -0
- package/dist-types/commands/GetConferenceAnnotationsCommand.d.ts +107 -0
- package/dist-types/commands/GetConferenceCommand.d.ts +2 -1
- package/dist-types/commands/GetConferenceTranscriptionCommand.d.ts +2 -2
- package/dist-types/commands/QueryConversationsCommand.d.ts +4 -2
- package/dist-types/commands/QueryUserCallsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateCallCommand.d.ts +2 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +324 -30
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaHistoryClientResolvedConfig } from "../WdaHistoryClient";
|
|
2
|
+
import { GetCallAnnotationsInput, GetCallAnnotationsOutput } from "../models/models_0";
|
|
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 GetCallAnnotationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCallAnnotationsCommandInput extends GetCallAnnotationsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCallAnnotationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCallAnnotationsCommandOutput extends GetCallAnnotationsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCallAnnotationsCommand_base: {
|
|
25
|
+
new (input: GetCallAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetCallAnnotationsCommandInput, GetCallAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetCallAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetCallAnnotationsCommandInput, GetCallAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets annotations for a call by callId and flowIndex.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaHistoryClient, GetCallAnnotationsCommand } from "@wildix/wda-history-client"; // ES Modules import
|
|
35
|
+
* // const { WdaHistoryClient, GetCallAnnotationsCommand } = require("@wildix/wda-history-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaHistoryClient(config);
|
|
37
|
+
* const input = { // GetCallAnnotationsInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* callId: "STRING_VALUE", // required
|
|
40
|
+
* flowIndex: Number("int"), // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetCallAnnotationsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetCallAnnotationsOutput
|
|
45
|
+
* // annotations: { // CallAnnotationsRecord
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // pbx: "STRING_VALUE", // required
|
|
48
|
+
* // time: Number("long"), // required
|
|
49
|
+
* // company: "STRING_VALUE", // required
|
|
50
|
+
* // licenses: [ // LicensesList // required
|
|
51
|
+
* // "x-bees" || "uc",
|
|
52
|
+
* // ],
|
|
53
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
54
|
+
* // flowIndex: Number("int"), // required
|
|
55
|
+
* // flowStartTime: Number("long"), // required
|
|
56
|
+
* // callStartTime: Number("long"), // required
|
|
57
|
+
* // annotations: [ // Annotations // required
|
|
58
|
+
* // { // Annotation
|
|
59
|
+
* // id: "STRING_VALUE", // required
|
|
60
|
+
* // time: Number("long"), // required
|
|
61
|
+
* // payload: { // AnnotationPayload Union: only one key present
|
|
62
|
+
* // tag: "STRING_VALUE",
|
|
63
|
+
* // text: "STRING_VALUE",
|
|
64
|
+
* // variables: { // AnnotationVariablesValue
|
|
65
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
66
|
+
* // },
|
|
67
|
+
* // result: { // AnnotationResultValue
|
|
68
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // source: { // AnnotationSource
|
|
72
|
+
* // type: "chatbot" || "voicebot" || "user" || "system", // required
|
|
73
|
+
* // id: "STRING_VALUE",
|
|
74
|
+
* // name: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // },
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param GetCallAnnotationsCommandInput - {@link GetCallAnnotationsCommandInput}
|
|
84
|
+
* @returns {@link GetCallAnnotationsCommandOutput}
|
|
85
|
+
* @see {@link GetCallAnnotationsCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link GetCallAnnotationsCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link WdaHistoryClientResolvedConfig | config} for WdaHistoryClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link CallNotFoundException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CallAnnotationsNotFoundException} (client fault)
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link WdaHistoryServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from WdaHistory service.</p>
|
|
99
|
+
*
|
|
100
|
+
*
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export declare class GetCallAnnotationsCommand extends GetCallAnnotationsCommand_base {
|
|
104
|
+
/** @internal type navigation helper, not in runtime. */
|
|
105
|
+
protected static __types: {
|
|
106
|
+
api: {
|
|
107
|
+
input: GetCallAnnotationsInput;
|
|
108
|
+
output: GetCallAnnotationsOutput;
|
|
109
|
+
};
|
|
110
|
+
sdk: {
|
|
111
|
+
input: GetCallAnnotationsCommandInput;
|
|
112
|
+
output: GetCallAnnotationsCommandOutput;
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
}
|
|
@@ -103,6 +103,7 @@ declare const GetCallCommand_base: {
|
|
|
103
103
|
* // tags: [ // CallFlowTags
|
|
104
104
|
* // "STRING_VALUE",
|
|
105
105
|
* // ],
|
|
106
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
106
107
|
* // flags: [ // CallFlowFlags
|
|
107
108
|
* // "STRING_VALUE",
|
|
108
109
|
* // ],
|
|
@@ -218,7 +219,7 @@ declare const GetCallCommand_base: {
|
|
|
218
219
|
* // licenses: [ // LicensesList // required
|
|
219
220
|
* // "x-bees" || "uc",
|
|
220
221
|
* // ],
|
|
221
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
222
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
222
223
|
* // },
|
|
223
224
|
* // };
|
|
224
225
|
*
|
|
@@ -50,7 +50,7 @@ declare const GetCallTranscriptionCommand_base: {
|
|
|
50
50
|
* // licenses: [ // LicensesList // required
|
|
51
51
|
* // "x-bees" || "uc",
|
|
52
52
|
* // ],
|
|
53
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
53
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
54
54
|
* // flowIndex: Number("int"), // required
|
|
55
55
|
* // flowStartTime: Number("long"), // required
|
|
56
56
|
* // callStartTime: Number("long"), // required
|
|
@@ -64,7 +64,9 @@ declare const GetCallTranscriptionCommand_base: {
|
|
|
64
64
|
* // isFinal: true || false, // required
|
|
65
65
|
* // start: Number("long"), // required
|
|
66
66
|
* // end: Number("long"), // required
|
|
67
|
-
* //
|
|
67
|
+
* // confidence: Number("double"),
|
|
68
|
+
* // sentiment: "POSITIVE" || "NEGATIVE" || "MIXED" || "NEUTRAL",
|
|
69
|
+
* // shouldComputeSentiment: true || false,
|
|
68
70
|
* // },
|
|
69
71
|
* // ],
|
|
70
72
|
* // },
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaHistoryClientResolvedConfig } from "../WdaHistoryClient";
|
|
2
|
+
import { GetChatAnnotationsInput, GetChatAnnotationsOutput } from "../models/models_0";
|
|
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 GetChatAnnotationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetChatAnnotationsCommandInput extends GetChatAnnotationsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetChatAnnotationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetChatAnnotationsCommandOutput extends GetChatAnnotationsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetChatAnnotationsCommand_base: {
|
|
25
|
+
new (input: GetChatAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatAnnotationsCommandInput, GetChatAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetChatAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatAnnotationsCommandInput, GetChatAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets annotations for a chat by chatId.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaHistoryClient, GetChatAnnotationsCommand } from "@wildix/wda-history-client"; // ES Modules import
|
|
35
|
+
* // const { WdaHistoryClient, GetChatAnnotationsCommand } = require("@wildix/wda-history-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaHistoryClient(config);
|
|
37
|
+
* const input = { // GetChatAnnotationsInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* chatId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetChatAnnotationsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetChatAnnotationsOutput
|
|
44
|
+
* // annotations: { // ChatAnnotationsRecord
|
|
45
|
+
* // id: "STRING_VALUE",
|
|
46
|
+
* // chatId: "STRING_VALUE",
|
|
47
|
+
* // time: Number("long"), // required
|
|
48
|
+
* // company: "STRING_VALUE", // required
|
|
49
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
50
|
+
* // annotations: [ // Annotations // required
|
|
51
|
+
* // { // Annotation
|
|
52
|
+
* // id: "STRING_VALUE", // required
|
|
53
|
+
* // time: Number("long"), // required
|
|
54
|
+
* // payload: { // AnnotationPayload Union: only one key present
|
|
55
|
+
* // tag: "STRING_VALUE",
|
|
56
|
+
* // text: "STRING_VALUE",
|
|
57
|
+
* // variables: { // AnnotationVariablesValue
|
|
58
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
59
|
+
* // },
|
|
60
|
+
* // result: { // AnnotationResultValue
|
|
61
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // source: { // AnnotationSource
|
|
65
|
+
* // type: "chatbot" || "voicebot" || "user" || "system", // required
|
|
66
|
+
* // id: "STRING_VALUE",
|
|
67
|
+
* // name: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // },
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param GetChatAnnotationsCommandInput - {@link GetChatAnnotationsCommandInput}
|
|
77
|
+
* @returns {@link GetChatAnnotationsCommandOutput}
|
|
78
|
+
* @see {@link GetChatAnnotationsCommandInput} for command's `input` shape.
|
|
79
|
+
* @see {@link GetChatAnnotationsCommandOutput} for command's `response` shape.
|
|
80
|
+
* @see {@link WdaHistoryClientResolvedConfig | config} for WdaHistoryClient's `config` shape.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationException} (client fault)
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ChatNotFoundException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ChatAnnotationsNotFoundException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link WdaHistoryServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from WdaHistory service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class GetChatAnnotationsCommand extends GetChatAnnotationsCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: GetChatAnnotationsInput;
|
|
101
|
+
output: GetChatAnnotationsOutput;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: GetChatAnnotationsCommandInput;
|
|
105
|
+
output: GetChatAnnotationsCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -160,7 +160,8 @@ declare const GetChatCommand_base: {
|
|
|
160
160
|
* // },
|
|
161
161
|
* // },
|
|
162
162
|
* // ],
|
|
163
|
-
* //
|
|
163
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
164
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
164
165
|
* // },
|
|
165
166
|
* // };
|
|
166
167
|
*
|
|
@@ -46,7 +46,7 @@ declare const GetChatTranscriptionCommand_base: {
|
|
|
46
46
|
* // chatId: "STRING_VALUE",
|
|
47
47
|
* // time: Number("long"), // required
|
|
48
48
|
* // company: "STRING_VALUE", // required
|
|
49
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
49
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
50
50
|
* // messages: [ // ChatTranscriptionMessagesList // required
|
|
51
51
|
* // { // Message
|
|
52
52
|
* // text: "STRING_VALUE",
|
|
@@ -183,6 +183,7 @@ declare const GetChatTranscriptionCommand_base: {
|
|
|
183
183
|
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
184
184
|
* // sms: true || false,
|
|
185
185
|
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
186
|
+
* // markdown: true || false,
|
|
186
187
|
* // type: "regular" || "system" || "deleted", // required
|
|
187
188
|
* // giphy: {
|
|
188
189
|
* // id: "STRING_VALUE", // required
|
|
@@ -179,6 +179,7 @@ declare const GetChatTranscriptionTextCommand_base: {
|
|
|
179
179
|
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
180
180
|
* // sms: true || false,
|
|
181
181
|
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
182
|
+
* // markdown: true || false,
|
|
182
183
|
* // type: "regular" || "system" || "deleted", // required
|
|
183
184
|
* // giphy: {
|
|
184
185
|
* // id: "STRING_VALUE", // required
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaHistoryClientResolvedConfig } from "../WdaHistoryClient";
|
|
2
|
+
import { GetConferenceAnnotationsInput, GetConferenceAnnotationsOutput } from "../models/models_0";
|
|
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 GetConferenceAnnotationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConferenceAnnotationsCommandInput extends GetConferenceAnnotationsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConferenceAnnotationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConferenceAnnotationsCommandOutput extends GetConferenceAnnotationsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetConferenceAnnotationsCommand_base: {
|
|
25
|
+
new (input: GetConferenceAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetConferenceAnnotationsCommandInput, GetConferenceAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetConferenceAnnotationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetConferenceAnnotationsCommandInput, GetConferenceAnnotationsCommandOutput, WdaHistoryClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Gets annotations for a conference by conferenceId.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaHistoryClient, GetConferenceAnnotationsCommand } from "@wildix/wda-history-client"; // ES Modules import
|
|
35
|
+
* // const { WdaHistoryClient, GetConferenceAnnotationsCommand } = require("@wildix/wda-history-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaHistoryClient(config);
|
|
37
|
+
* const input = { // GetConferenceAnnotationsInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* conferenceId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetConferenceAnnotationsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetConferenceAnnotationsOutput
|
|
44
|
+
* // annotations: { // ConferenceAnnotationsRecord
|
|
45
|
+
* // id: "STRING_VALUE", // required
|
|
46
|
+
* // time: Number("long"), // required
|
|
47
|
+
* // company: "STRING_VALUE", // required
|
|
48
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
49
|
+
* // annotations: [ // Annotations // required
|
|
50
|
+
* // { // Annotation
|
|
51
|
+
* // id: "STRING_VALUE", // required
|
|
52
|
+
* // time: Number("long"), // required
|
|
53
|
+
* // payload: { // AnnotationPayload Union: only one key present
|
|
54
|
+
* // tag: "STRING_VALUE",
|
|
55
|
+
* // text: "STRING_VALUE",
|
|
56
|
+
* // variables: { // AnnotationVariablesValue
|
|
57
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // result: { // AnnotationResultValue
|
|
60
|
+
* // value: "DOCUMENT_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // source: { // AnnotationSource
|
|
64
|
+
* // type: "chatbot" || "voicebot" || "user" || "system", // required
|
|
65
|
+
* // id: "STRING_VALUE",
|
|
66
|
+
* // name: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param GetConferenceAnnotationsCommandInput - {@link GetConferenceAnnotationsCommandInput}
|
|
76
|
+
* @returns {@link GetConferenceAnnotationsCommandOutput}
|
|
77
|
+
* @see {@link GetConferenceAnnotationsCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link GetConferenceAnnotationsCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link WdaHistoryClientResolvedConfig | config} for WdaHistoryClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ConferenceNotFoundException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ConferenceAnnotationsNotFoundException} (client fault)
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link WdaHistoryServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from WdaHistory service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class GetConferenceAnnotationsCommand extends GetConferenceAnnotationsCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: GetConferenceAnnotationsInput;
|
|
100
|
+
output: GetConferenceAnnotationsOutput;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: GetConferenceAnnotationsCommandInput;
|
|
104
|
+
output: GetConferenceAnnotationsCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -85,9 +85,10 @@ declare const GetConferenceCommand_base: {
|
|
|
85
85
|
* // },
|
|
86
86
|
* // ],
|
|
87
87
|
* // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE", // required
|
|
88
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
88
89
|
* // transcriptionLanguage: "STRING_VALUE",
|
|
89
90
|
* // transcriptionSeconds: Number("int"),
|
|
90
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
91
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
91
92
|
* // },
|
|
92
93
|
* // };
|
|
93
94
|
*
|
|
@@ -45,7 +45,7 @@ declare const GetConferenceTranscriptionCommand_base: {
|
|
|
45
45
|
* // id: "STRING_VALUE", // required
|
|
46
46
|
* // time: Number("long"), // required
|
|
47
47
|
* // company: "STRING_VALUE", // required
|
|
48
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
48
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
49
49
|
* // transcriptions: [ // ConferenceTranscriptionsList // required
|
|
50
50
|
* // { // ConferenceTranscription
|
|
51
51
|
* // start: Number("long"), // required
|
|
@@ -60,7 +60,7 @@ declare const GetConferenceTranscriptionCommand_base: {
|
|
|
60
60
|
* // isFinal: true || false, // required
|
|
61
61
|
* // start: Number("long"), // required
|
|
62
62
|
* // end: Number("long"), // required
|
|
63
|
-
* // sentiment: "
|
|
63
|
+
* // sentiment: "POSITIVE" || "NEGATIVE" || "MIXED" || "NEUTRAL",
|
|
64
64
|
* // },
|
|
65
65
|
* // ],
|
|
66
66
|
* // },
|
|
@@ -120,6 +120,7 @@ declare const QueryConversationsCommand_base: {
|
|
|
120
120
|
* // tags: [ // CallFlowTags
|
|
121
121
|
* // "STRING_VALUE",
|
|
122
122
|
* // ],
|
|
123
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
123
124
|
* // flags: [ // CallFlowFlags
|
|
124
125
|
* // "STRING_VALUE",
|
|
125
126
|
* // ],
|
|
@@ -235,7 +236,7 @@ declare const QueryConversationsCommand_base: {
|
|
|
235
236
|
* // licenses: [ // LicensesList // required
|
|
236
237
|
* // "x-bees" || "uc",
|
|
237
238
|
* // ],
|
|
238
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
239
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
239
240
|
* // },
|
|
240
241
|
* // conference: { // ConferenceRecord
|
|
241
242
|
* // id: "STRING_VALUE", // required
|
|
@@ -281,9 +282,10 @@ declare const QueryConversationsCommand_base: {
|
|
|
281
282
|
* // },
|
|
282
283
|
* // ],
|
|
283
284
|
* // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE", // required
|
|
285
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
284
286
|
* // transcriptionLanguage: "STRING_VALUE",
|
|
285
287
|
* // transcriptionSeconds: Number("int"),
|
|
286
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
288
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
287
289
|
* // },
|
|
288
290
|
* // },
|
|
289
291
|
* // ],
|
|
@@ -120,6 +120,7 @@ declare const QueryUserCallsCommand_base: {
|
|
|
120
120
|
* // tags: [ // CallFlowTags
|
|
121
121
|
* // "STRING_VALUE",
|
|
122
122
|
* // ],
|
|
123
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
123
124
|
* // flags: [ // CallFlowFlags
|
|
124
125
|
* // "STRING_VALUE",
|
|
125
126
|
* // ],
|
|
@@ -235,7 +236,7 @@ declare const QueryUserCallsCommand_base: {
|
|
|
235
236
|
* // licenses: [ // LicensesList // required
|
|
236
237
|
* // "x-bees" || "uc",
|
|
237
238
|
* // ],
|
|
238
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
239
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
239
240
|
* // },
|
|
240
241
|
* // ],
|
|
241
242
|
* // };
|
|
@@ -106,6 +106,7 @@ declare const UpdateCallCommand_base: {
|
|
|
106
106
|
* // tags: [ // CallFlowTags
|
|
107
107
|
* // "STRING_VALUE",
|
|
108
108
|
* // ],
|
|
109
|
+
* // annotationsStatus: "AVAILABLE" || "UNAVAILABLE",
|
|
109
110
|
* // flags: [ // CallFlowFlags
|
|
110
111
|
* // "STRING_VALUE",
|
|
111
112
|
* // ],
|
|
@@ -221,7 +222,7 @@ declare const UpdateCallCommand_base: {
|
|
|
221
222
|
* // licenses: [ // LicensesList // required
|
|
222
223
|
* // "x-bees" || "uc",
|
|
223
224
|
* // ],
|
|
224
|
-
* // type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
|
|
225
|
+
* // type: "call" || "call_transcription" || "call_annotations" || "conference" || "conference_transcription" || "conference_annotations" || "chat" || "chat_transcription" || "chat_annotations", // required
|
|
225
226
|
* // },
|
|
226
227
|
* // };
|
|
227
228
|
*
|
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
export * from "./GetCallCommand";
|
|
2
|
+
export * from "./GetCallAnnotationsCommand";
|
|
2
3
|
export * from "./GetCallTranscriptionCommand";
|
|
3
4
|
export * from "./GetCallTranscriptionTextCommand";
|
|
4
5
|
export * from "./GetChatCommand";
|
|
6
|
+
export * from "./GetChatAnnotationsCommand";
|
|
5
7
|
export * from "./GetChatTranscriptionCommand";
|
|
6
8
|
export * from "./GetChatTranscriptionTextCommand";
|
|
7
9
|
export * from "./GetConferenceCommand";
|
|
10
|
+
export * from "./GetConferenceAnnotationsCommand";
|
|
8
11
|
export * from "./GetConferenceTranscriptionCommand";
|
|
9
12
|
export * from "./GetConferenceTranscriptionTextCommand";
|
|
10
13
|
export * from "./QueryConversationsCommand";
|