@wildix/wilma-copilot-sessions-client 1.0.2
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/WilmaCopilotSessions.js +15 -0
- package/dist-cjs/WilmaCopilotSessionsClient.js +49 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
- package/dist-cjs/commands/GetCopilotSessionEventsCommand.js +20 -0
- package/dist-cjs/commands/StreamCopilotSessionEventsCommand.js +20 -0
- package/dist-cjs/commands/index.js +5 -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/WilmaCopilotSessionsServiceException.js +12 -0
- package/dist-cjs/models/enums.js +130 -0
- package/dist-cjs/models/errors.js +43 -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 +42 -0
- package/dist-cjs/runtimeExtensions.js +12 -0
- package/dist-cjs/schemas/schemas_0.js +424 -0
- package/dist-es/WilmaCopilotSessions.js +11 -0
- package/dist-es/WilmaCopilotSessionsClient.js +45 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
- package/dist-es/commands/GetCopilotSessionEventsCommand.js +16 -0
- package/dist-es/commands/StreamCopilotSessionEventsCommand.js +16 -0
- package/dist-es/commands/index.js +2 -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/WilmaCopilotSessionsServiceException.js +8 -0
- package/dist-es/models/enums.js +127 -0
- package/dist-es/models/errors.js +37 -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 +38 -0
- package/dist-es/runtimeExtensions.js +8 -0
- package/dist-es/schemas/schemas_0.js +421 -0
- package/dist-types/WilmaCopilotSessions.d.ts +33 -0
- package/dist-types/WilmaCopilotSessionsClient.d.ts +178 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
- package/dist-types/commands/GetCopilotSessionEventsCommand.d.ts +379 -0
- package/dist-types/commands/StreamCopilotSessionEventsCommand.d.ts +88 -0
- package/dist-types/commands/index.d.ts +2 -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 +25 -0
- package/dist-types/models/WilmaCopilotSessionsServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +275 -0
- package/dist-types/models/errors.d.ts +35 -0
- package/dist-types/models/models_0.d.ts +757 -0
- package/dist-types/runtimeConfig.browser.d.ts +56 -0
- package/dist-types/runtimeConfig.d.ts +56 -0
- package/dist-types/runtimeConfig.native.d.ts +55 -0
- package/dist-types/runtimeConfig.shared.d.ts +33 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +50 -0
- package/package.json +57 -0
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { type HandlerExecutionContext, type HttpAuthScheme, type HttpAuthSchemeParameters, type HttpAuthSchemeParametersProvider, type HttpAuthSchemeProvider, type Provider, TokenIdentity, TokenIdentityProvider } from "@smithy/types";
|
|
2
|
+
import type { WilmaCopilotSessionsClientResolvedConfig } from "../WilmaCopilotSessionsClient";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface WilmaCopilotSessionsHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
export interface WilmaCopilotSessionsHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<WilmaCopilotSessionsClientResolvedConfig, HandlerExecutionContext, WilmaCopilotSessionsHttpAuthSchemeParameters, object> {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare const defaultWilmaCopilotSessionsHttpAuthSchemeParametersProvider: (config: WilmaCopilotSessionsClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<WilmaCopilotSessionsHttpAuthSchemeParameters>;
|
|
17
|
+
/**
|
|
18
|
+
* @internal
|
|
19
|
+
*/
|
|
20
|
+
export interface WilmaCopilotSessionsHttpAuthSchemeProvider extends HttpAuthSchemeProvider<WilmaCopilotSessionsHttpAuthSchemeParameters> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare const defaultWilmaCopilotSessionsHttpAuthSchemeProvider: WilmaCopilotSessionsHttpAuthSchemeProvider;
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export interface HttpAuthSchemeInputConfig {
|
|
30
|
+
/**
|
|
31
|
+
* A comma-separated list of case-sensitive auth scheme names.
|
|
32
|
+
* An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
|
|
33
|
+
* For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
authSchemePreference?: string[] | Provider<string[]>;
|
|
37
|
+
/**
|
|
38
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
httpAuthSchemes?: HttpAuthScheme[];
|
|
42
|
+
/**
|
|
43
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
httpAuthSchemeProvider?: WilmaCopilotSessionsHttpAuthSchemeProvider;
|
|
47
|
+
/**
|
|
48
|
+
* The token used to authenticate requests.
|
|
49
|
+
*/
|
|
50
|
+
token?: TokenIdentity | TokenIdentityProvider;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* @internal
|
|
54
|
+
*/
|
|
55
|
+
export interface HttpAuthSchemeResolvedConfig {
|
|
56
|
+
/**
|
|
57
|
+
* A comma-separated list of case-sensitive auth scheme names.
|
|
58
|
+
* An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed.
|
|
59
|
+
* For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
readonly authSchemePreference: Provider<string[]>;
|
|
63
|
+
/**
|
|
64
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
readonly httpAuthSchemes: HttpAuthScheme[];
|
|
68
|
+
/**
|
|
69
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
readonly httpAuthSchemeProvider: WilmaCopilotSessionsHttpAuthSchemeProvider;
|
|
73
|
+
/**
|
|
74
|
+
* The token used to authenticate requests.
|
|
75
|
+
*/
|
|
76
|
+
readonly token?: TokenIdentityProvider;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig) => T & HttpAuthSchemeResolvedConfig;
|
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { GetCopilotSessionEventsInput, GetCopilotSessionEventsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotSessionsClientResolvedConfig } from "../WilmaCopilotSessionsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCopilotSessionEventsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCopilotSessionEventsCommandInput extends GetCopilotSessionEventsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCopilotSessionEventsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCopilotSessionEventsCommandOutput extends GetCopilotSessionEventsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCopilotSessionEventsCommand_base: {
|
|
25
|
+
new (input: GetCopilotSessionEventsCommandInput): import("@smithy/core/client").CommandImpl<GetCopilotSessionEventsCommandInput, GetCopilotSessionEventsCommandOutput, WilmaCopilotSessionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetCopilotSessionEventsCommandInput): import("@smithy/core/client").CommandImpl<GetCopilotSessionEventsCommandInput, GetCopilotSessionEventsCommandOutput, WilmaCopilotSessionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Returns recorded copilot session events as a plain JSON page, without streaming. Use it to inspect past sessions or to catch up before subscribing to StreamCopilotSessionEvents.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WilmaCopilotSessionsClient, GetCopilotSessionEventsCommand } from "@wildix/wilma-copilot-sessions-client"; // ES Modules import
|
|
35
|
+
* // const { WilmaCopilotSessionsClient, GetCopilotSessionEventsCommand } = require("@wildix/wilma-copilot-sessions-client"); // CommonJS import
|
|
36
|
+
* // import type { WilmaCopilotSessionsClientConfig } from "@wildix/wilma-copilot-sessions-client";
|
|
37
|
+
* const config = {}; // type is WilmaCopilotSessionsClientConfig
|
|
38
|
+
* const client = new WilmaCopilotSessionsClient(config);
|
|
39
|
+
* const input = { // GetCopilotSessionEventsInput
|
|
40
|
+
* sessionId: "STRING_VALUE", // required
|
|
41
|
+
* startIndex: Number("int"),
|
|
42
|
+
* limit: Number("int"),
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetCopilotSessionEventsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetCopilotSessionEventsOutput
|
|
47
|
+
* // events: [ // CopilotSessionEvents // required
|
|
48
|
+
* // { // CopilotSessionEvent Union: only one key present
|
|
49
|
+
* // lifecycle: { // CopilotLifecycleEvent
|
|
50
|
+
* // index: Number("int"), // required
|
|
51
|
+
* // timestamp: "STRING_VALUE", // required
|
|
52
|
+
* // sessionId: "STRING_VALUE", // required
|
|
53
|
+
* // status: "active" || "ended" || "stopped" || "failed", // required
|
|
54
|
+
* // },
|
|
55
|
+
* // transcript: { // CopilotTranscriptionEvent
|
|
56
|
+
* // index: Number("int"), // required
|
|
57
|
+
* // timestamp: "STRING_VALUE", // required
|
|
58
|
+
* // data: { // CopilotTranscriptionData Union: only one key present
|
|
59
|
+
* // call: { // CallAnalyticsLiveTranscriptionEvent
|
|
60
|
+
* // id: "STRING_VALUE", // required
|
|
61
|
+
* // pbx: "STRING_VALUE", // required
|
|
62
|
+
* // time: Number("long"), // required
|
|
63
|
+
* // company: "STRING_VALUE", // required
|
|
64
|
+
* // licenses: [ // LicensesList // required
|
|
65
|
+
* // "x-bees" || "uc",
|
|
66
|
+
* // ],
|
|
67
|
+
* // 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_agent_status" || "service_call" || "service_call_complete", // required
|
|
68
|
+
* // flowIndex: Number("int"), // required
|
|
69
|
+
* // flowStartTime: Number("long"), // required
|
|
70
|
+
* // callStartTime: Number("long"), // required
|
|
71
|
+
* // chunk: { // CallTranscriptionChunk
|
|
72
|
+
* // id: "STRING_VALUE", // required
|
|
73
|
+
* // time: Number("long"), // required
|
|
74
|
+
* // speaker: "callee" || "caller", // required
|
|
75
|
+
* // text: "STRING_VALUE", // required
|
|
76
|
+
* // language: "STRING_VALUE",
|
|
77
|
+
* // isFinal: true || false, // required
|
|
78
|
+
* // start: Number("long"), // required
|
|
79
|
+
* // end: Number("long"), // required
|
|
80
|
+
* // confidence: Number("double"),
|
|
81
|
+
* // sentiment: "POSITIVE" || "NEGATIVE" || "MIXED" || "NEUTRAL",
|
|
82
|
+
* // },
|
|
83
|
+
* // participant: { // CallParticipant
|
|
84
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
85
|
+
* // phone: "STRING_VALUE",
|
|
86
|
+
* // name: "STRING_VALUE",
|
|
87
|
+
* // company: "STRING_VALUE",
|
|
88
|
+
* // email: "STRING_VALUE",
|
|
89
|
+
* // userId: "STRING_VALUE",
|
|
90
|
+
* // userExtension: "STRING_VALUE",
|
|
91
|
+
* // userDepartment: "STRING_VALUE",
|
|
92
|
+
* // groupId: "STRING_VALUE",
|
|
93
|
+
* // groupName: "STRING_VALUE",
|
|
94
|
+
* // userAgent: "STRING_VALUE",
|
|
95
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN" || "COLLABORATION7_WEB" || "COLLABORATION7_IOS" || "COLLABORATION7_ANDROID" || "XHOPPERS_WEB" || "XHOPPERS_IOS" || "XHOPPERS_ANDROID" || "TEAMS4WILDIX",
|
|
96
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
97
|
+
* // license: "STRING_VALUE",
|
|
98
|
+
* // sipCallId: "STRING_VALUE",
|
|
99
|
+
* // publicAddress: "STRING_VALUE",
|
|
100
|
+
* // privateAddress: "STRING_VALUE",
|
|
101
|
+
* // location: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // },
|
|
104
|
+
* // chat: { // ChatAnalyticsLiveTranscriptionEvent
|
|
105
|
+
* // id: "STRING_VALUE",
|
|
106
|
+
* // chatId: "STRING_VALUE",
|
|
107
|
+
* // time: Number("long"), // required
|
|
108
|
+
* // company: "STRING_VALUE", // required
|
|
109
|
+
* // 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_agent_status" || "service_call" || "service_call_complete", // required
|
|
110
|
+
* // message: { // Message
|
|
111
|
+
* // text: "STRING_VALUE",
|
|
112
|
+
* // elements: [ // ElementsList
|
|
113
|
+
* // { // Element Union: only one key present
|
|
114
|
+
* // template: { // MessageTemplateConfig
|
|
115
|
+
* // whatsapp: { // TemplateWithParameters
|
|
116
|
+
* // name: "STRING_VALUE", // required
|
|
117
|
+
* // parameters: [ // ListTemplateParameter
|
|
118
|
+
* // { // TemplateParameter
|
|
119
|
+
* // name: "STRING_VALUE", // required
|
|
120
|
+
* // value: "STRING_VALUE", // required
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // actions: [ // ActionsElementsList
|
|
126
|
+
* // { // ActionElement Union: only one key present
|
|
127
|
+
* // button: { // ButtonElement
|
|
128
|
+
* // text: "STRING_VALUE", // required
|
|
129
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
130
|
+
* // link: { // ButtonLinkHandler
|
|
131
|
+
* // url: "STRING_VALUE", // required
|
|
132
|
+
* // },
|
|
133
|
+
* // reply: { // ButtonReplyHandler
|
|
134
|
+
* // text: "STRING_VALUE",
|
|
135
|
+
* // },
|
|
136
|
+
* // action: { // ButtonActionHandler
|
|
137
|
+
* // id: "STRING_VALUE", // required
|
|
138
|
+
* // },
|
|
139
|
+
* // },
|
|
140
|
+
* // variant: "contained" || "outlined",
|
|
141
|
+
* // disabled: true || false,
|
|
142
|
+
* // },
|
|
143
|
+
* // },
|
|
144
|
+
* // ],
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // attachments: [ // MessageAttachmentList
|
|
148
|
+
* // { // MessageAttachment
|
|
149
|
+
* // id: "STRING_VALUE", // required
|
|
150
|
+
* // fsId: "STRING_VALUE", // required
|
|
151
|
+
* // mime: "STRING_VALUE",
|
|
152
|
+
* // name: "STRING_VALUE", // required
|
|
153
|
+
* // size: Number("int"), // required
|
|
154
|
+
* // width: Number("int"),
|
|
155
|
+
* // height: Number("int"),
|
|
156
|
+
* // thumbnail: "STRING_VALUE",
|
|
157
|
+
* // },
|
|
158
|
+
* // ],
|
|
159
|
+
* // quote: { // MessageQuote
|
|
160
|
+
* // messageId: "STRING_VALUE", // required
|
|
161
|
+
* // channelId: "STRING_VALUE", // required
|
|
162
|
+
* // user: { // User
|
|
163
|
+
* // id: "STRING_VALUE", // required
|
|
164
|
+
* // name: "STRING_VALUE",
|
|
165
|
+
* // email: "STRING_VALUE",
|
|
166
|
+
* // phone: "STRING_VALUE",
|
|
167
|
+
* // picture: "STRING_VALUE",
|
|
168
|
+
* // locale: "STRING_VALUE",
|
|
169
|
+
* // timeZone: "STRING_VALUE",
|
|
170
|
+
* // company: "STRING_VALUE",
|
|
171
|
+
* // bot: true || false,
|
|
172
|
+
* // pbxDomain: "STRING_VALUE",
|
|
173
|
+
* // pbxPort: "STRING_VALUE",
|
|
174
|
+
* // pbxExtension: "STRING_VALUE",
|
|
175
|
+
* // pbxSerial: "STRING_VALUE",
|
|
176
|
+
* // pbxUserId: "STRING_VALUE",
|
|
177
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
178
|
+
* // createdAt: "STRING_VALUE",
|
|
179
|
+
* // updatedAt: "STRING_VALUE",
|
|
180
|
+
* // },
|
|
181
|
+
* // text: "STRING_VALUE",
|
|
182
|
+
* // attachments: [
|
|
183
|
+
* // {
|
|
184
|
+
* // id: "STRING_VALUE", // required
|
|
185
|
+
* // fsId: "STRING_VALUE", // required
|
|
186
|
+
* // mime: "STRING_VALUE",
|
|
187
|
+
* // name: "STRING_VALUE", // required
|
|
188
|
+
* // size: Number("int"), // required
|
|
189
|
+
* // width: Number("int"),
|
|
190
|
+
* // height: Number("int"),
|
|
191
|
+
* // thumbnail: "STRING_VALUE",
|
|
192
|
+
* // },
|
|
193
|
+
* // ],
|
|
194
|
+
* // forward: { // MessageForward
|
|
195
|
+
* // forwardCompany: "STRING_VALUE",
|
|
196
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
197
|
+
* // forwardEmail: "STRING_VALUE",
|
|
198
|
+
* // forwardName: "STRING_VALUE",
|
|
199
|
+
* // messageId: "STRING_VALUE", // required
|
|
200
|
+
* // channelId: "STRING_VALUE", // required
|
|
201
|
+
* // },
|
|
202
|
+
* // mentions: [ // UsersList
|
|
203
|
+
* // {
|
|
204
|
+
* // id: "STRING_VALUE", // required
|
|
205
|
+
* // name: "STRING_VALUE",
|
|
206
|
+
* // email: "STRING_VALUE",
|
|
207
|
+
* // phone: "STRING_VALUE",
|
|
208
|
+
* // picture: "STRING_VALUE",
|
|
209
|
+
* // locale: "STRING_VALUE",
|
|
210
|
+
* // timeZone: "STRING_VALUE",
|
|
211
|
+
* // company: "STRING_VALUE",
|
|
212
|
+
* // bot: true || false,
|
|
213
|
+
* // pbxDomain: "STRING_VALUE",
|
|
214
|
+
* // pbxPort: "STRING_VALUE",
|
|
215
|
+
* // pbxExtension: "STRING_VALUE",
|
|
216
|
+
* // pbxSerial: "STRING_VALUE",
|
|
217
|
+
* // pbxUserId: "STRING_VALUE",
|
|
218
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
219
|
+
* // createdAt: "STRING_VALUE",
|
|
220
|
+
* // updatedAt: "STRING_VALUE",
|
|
221
|
+
* // },
|
|
222
|
+
* // ],
|
|
223
|
+
* // giphy: { // MessageGiphy
|
|
224
|
+
* // id: "STRING_VALUE", // required
|
|
225
|
+
* // size: "STRING_VALUE", // required
|
|
226
|
+
* // url: "STRING_VALUE", // required
|
|
227
|
+
* // height: "STRING_VALUE", // required
|
|
228
|
+
* // width: "STRING_VALUE", // required
|
|
229
|
+
* // },
|
|
230
|
+
* // createdAt: "STRING_VALUE", // required
|
|
231
|
+
* // updatedAt: "STRING_VALUE",
|
|
232
|
+
* // },
|
|
233
|
+
* // forward: {
|
|
234
|
+
* // forwardCompany: "STRING_VALUE",
|
|
235
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
236
|
+
* // forwardEmail: "STRING_VALUE",
|
|
237
|
+
* // forwardName: "STRING_VALUE",
|
|
238
|
+
* // messageId: "STRING_VALUE", // required
|
|
239
|
+
* // channelId: "STRING_VALUE", // required
|
|
240
|
+
* // },
|
|
241
|
+
* // whatsapp: true || false,
|
|
242
|
+
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
243
|
+
* // sms: true || false,
|
|
244
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
245
|
+
* // markdown: true || false,
|
|
246
|
+
* // type: "regular" || "system" || "deleted", // required
|
|
247
|
+
* // giphy: {
|
|
248
|
+
* // id: "STRING_VALUE", // required
|
|
249
|
+
* // size: "STRING_VALUE", // required
|
|
250
|
+
* // url: "STRING_VALUE", // required
|
|
251
|
+
* // height: "STRING_VALUE", // required
|
|
252
|
+
* // width: "STRING_VALUE", // required
|
|
253
|
+
* // },
|
|
254
|
+
* // silent: true || false,
|
|
255
|
+
* // event: "STRING_VALUE",
|
|
256
|
+
* // messageId: "STRING_VALUE", // required
|
|
257
|
+
* // channelId: "STRING_VALUE", // required
|
|
258
|
+
* // user: "<User>", // required
|
|
259
|
+
* // edit: true || false,
|
|
260
|
+
* // mentions: [
|
|
261
|
+
* // "<User>",
|
|
262
|
+
* // ],
|
|
263
|
+
* // latestReactions: [ // ReactionList
|
|
264
|
+
* // { // Reaction
|
|
265
|
+
* // type: "STRING_VALUE",
|
|
266
|
+
* // userId: "STRING_VALUE",
|
|
267
|
+
* // messageId: "STRING_VALUE",
|
|
268
|
+
* // user: "<User>",
|
|
269
|
+
* // },
|
|
270
|
+
* // ],
|
|
271
|
+
* // reactionCounts: { // ReactionCounts
|
|
272
|
+
* // "<keys>": Number("int"),
|
|
273
|
+
* // },
|
|
274
|
+
* // createdAt: "STRING_VALUE", // required
|
|
275
|
+
* // updatedAt: "STRING_VALUE",
|
|
276
|
+
* // },
|
|
277
|
+
* // },
|
|
278
|
+
* // conference: { // ConferenceAnalyticsLiveTranscriptionEvent
|
|
279
|
+
* // id: "STRING_VALUE", // required
|
|
280
|
+
* // time: Number("long"), // required
|
|
281
|
+
* // company: "STRING_VALUE", // required
|
|
282
|
+
* // 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_agent_status" || "service_call" || "service_call_complete", // required
|
|
283
|
+
* // conferenceStartTime: Number("long"), // required
|
|
284
|
+
* // transcriptionStartTime: Number("long"), // required
|
|
285
|
+
* // chunk: { // ConferenceTranscriptionChunk
|
|
286
|
+
* // id: "STRING_VALUE", // required
|
|
287
|
+
* // time: Number("long"), // required
|
|
288
|
+
* // jid: "STRING_VALUE", // required
|
|
289
|
+
* // text: "STRING_VALUE", // required
|
|
290
|
+
* // language: "STRING_VALUE",
|
|
291
|
+
* // isFinal: true || false, // required
|
|
292
|
+
* // start: Number("long"), // required
|
|
293
|
+
* // end: Number("long"), // required
|
|
294
|
+
* // sentiment: "POSITIVE" || "NEGATIVE" || "MIXED" || "NEUTRAL",
|
|
295
|
+
* // },
|
|
296
|
+
* // participant: { // ConferenceParticipant
|
|
297
|
+
* // type: "EXTERNAL" || "EXTERNAL_DIAL_IN" || "PBX" || "PBX_SIP" || "XBS", // required
|
|
298
|
+
* // role: "CLIENT" || "AGENT",
|
|
299
|
+
* // jid: "STRING_VALUE",
|
|
300
|
+
* // name: "STRING_VALUE",
|
|
301
|
+
* // email: "STRING_VALUE",
|
|
302
|
+
* // phone: "STRING_VALUE",
|
|
303
|
+
* // department: "STRING_VALUE",
|
|
304
|
+
* // company: "STRING_VALUE",
|
|
305
|
+
* // pbxSerial: "STRING_VALUE",
|
|
306
|
+
* // pbxExtension: "STRING_VALUE",
|
|
307
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
308
|
+
* // xbsId: "STRING_VALUE",
|
|
309
|
+
* // license: "basic" || "essential" || "business" || "premium" || "wizyconf",
|
|
310
|
+
* // },
|
|
311
|
+
* // },
|
|
312
|
+
* // },
|
|
313
|
+
* // },
|
|
314
|
+
* // intent: { // CopilotIntentEvent
|
|
315
|
+
* // index: Number("int"), // required
|
|
316
|
+
* // timestamp: "STRING_VALUE", // required
|
|
317
|
+
* // id: "STRING_VALUE", // required
|
|
318
|
+
* // state: "DOCUMENT_VALUE", // required
|
|
319
|
+
* // },
|
|
320
|
+
* // evaluation: { // CopilotEvaluationEvent
|
|
321
|
+
* // index: Number("int"), // required
|
|
322
|
+
* // timestamp: "STRING_VALUE", // required
|
|
323
|
+
* // id: "STRING_VALUE", // required
|
|
324
|
+
* // state: "DOCUMENT_VALUE", // required
|
|
325
|
+
* // },
|
|
326
|
+
* // asset: { // CopilotAssetEvent
|
|
327
|
+
* // index: Number("int"), // required
|
|
328
|
+
* // timestamp: "STRING_VALUE", // required
|
|
329
|
+
* // id: "STRING_VALUE", // required
|
|
330
|
+
* // icon: "info" || "lightbulb" || "shield" || "book_open" || "alert" || "sparkles",
|
|
331
|
+
* // styling: "neutral" || "success" || "warning" || "danger",
|
|
332
|
+
* // sticky: true || false,
|
|
333
|
+
* // content: "STRING_VALUE",
|
|
334
|
+
* // state: "DOCUMENT_VALUE", // required
|
|
335
|
+
* // },
|
|
336
|
+
* // assistant: { // CopilotAssistantEvent
|
|
337
|
+
* // index: Number("int"), // required
|
|
338
|
+
* // timestamp: "STRING_VALUE", // required
|
|
339
|
+
* // id: "STRING_VALUE", // required
|
|
340
|
+
* // state: "DOCUMENT_VALUE", // required
|
|
341
|
+
* // },
|
|
342
|
+
* // },
|
|
343
|
+
* // ],
|
|
344
|
+
* // nextStartIndex: Number("int"),
|
|
345
|
+
* // };
|
|
346
|
+
*
|
|
347
|
+
* ```
|
|
348
|
+
*
|
|
349
|
+
* @param GetCopilotSessionEventsCommandInput - {@link GetCopilotSessionEventsCommandInput}
|
|
350
|
+
* @returns {@link GetCopilotSessionEventsCommandOutput}
|
|
351
|
+
* @see {@link GetCopilotSessionEventsCommandInput} for command's `input` shape.
|
|
352
|
+
* @see {@link GetCopilotSessionEventsCommandOutput} for command's `response` shape.
|
|
353
|
+
* @see {@link WilmaCopilotSessionsClientResolvedConfig | config} for WilmaCopilotSessionsClient's `config` shape.
|
|
354
|
+
*
|
|
355
|
+
* @throws {@link ValidationException} (client fault)
|
|
356
|
+
*
|
|
357
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
358
|
+
*
|
|
359
|
+
* @throws {@link NotFoundException} (client fault)
|
|
360
|
+
*
|
|
361
|
+
* @throws {@link WilmaCopilotSessionsServiceException}
|
|
362
|
+
* <p>Base exception class for all service exceptions from WilmaCopilotSessions service.</p>
|
|
363
|
+
*
|
|
364
|
+
*
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
export declare class GetCopilotSessionEventsCommand extends GetCopilotSessionEventsCommand_base {
|
|
368
|
+
/** @internal type navigation helper, not in runtime. */
|
|
369
|
+
protected static __types: {
|
|
370
|
+
api: {
|
|
371
|
+
input: GetCopilotSessionEventsInput;
|
|
372
|
+
output: GetCopilotSessionEventsOutput;
|
|
373
|
+
};
|
|
374
|
+
sdk: {
|
|
375
|
+
input: GetCopilotSessionEventsCommandInput;
|
|
376
|
+
output: GetCopilotSessionEventsCommandOutput;
|
|
377
|
+
};
|
|
378
|
+
};
|
|
379
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer, StreamingBlobPayloadOutputTypes } from "@smithy/types";
|
|
3
|
+
import type { StreamCopilotSessionEventsInput, StreamCopilotSessionEventsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaCopilotSessionsClientResolvedConfig } from "../WilmaCopilotSessionsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StreamCopilotSessionEventsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StreamCopilotSessionEventsCommandInput extends StreamCopilotSessionEventsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StreamCopilotSessionEventsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StreamCopilotSessionEventsCommandOutput extends Omit<StreamCopilotSessionEventsOutput, "events">, __MetadataBearer {
|
|
23
|
+
events: StreamingBlobPayloadOutputTypes;
|
|
24
|
+
}
|
|
25
|
+
declare const StreamCopilotSessionEventsCommand_base: {
|
|
26
|
+
new (input: StreamCopilotSessionEventsCommandInput): import("@smithy/core/client").CommandImpl<StreamCopilotSessionEventsCommandInput, StreamCopilotSessionEventsCommandOutput, WilmaCopilotSessionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
new (input: StreamCopilotSessionEventsCommandInput): import("@smithy/core/client").CommandImpl<StreamCopilotSessionEventsCommandInput, StreamCopilotSessionEventsCommandOutput, WilmaCopilotSessionsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
28
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Replays and tails copilot session events as Server-Sent Events (`text/event-stream`). Each frame carries one CopilotSessionEvent: `id:` is the event index, `event:` is the union member name, and `data:` is the JSON document of the union value. Reconnect by passing the last seen index + 1 as `startIndex`. The stream ends after a terminal `lifecycle` event (`ended`, `stopped` or `failed`); for finished sessions the recorded events are replayed and the stream closes.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { WilmaCopilotSessionsClient, StreamCopilotSessionEventsCommand } from "@wildix/wilma-copilot-sessions-client"; // ES Modules import
|
|
36
|
+
* // const { WilmaCopilotSessionsClient, StreamCopilotSessionEventsCommand } = require("@wildix/wilma-copilot-sessions-client"); // CommonJS import
|
|
37
|
+
* // import type { WilmaCopilotSessionsClientConfig } from "@wildix/wilma-copilot-sessions-client";
|
|
38
|
+
* const config = {}; // type is WilmaCopilotSessionsClientConfig
|
|
39
|
+
* const client = new WilmaCopilotSessionsClient(config);
|
|
40
|
+
* const input = { // StreamCopilotSessionEventsInput
|
|
41
|
+
* sessionId: "STRING_VALUE", // required
|
|
42
|
+
* startIndex: Number("int"),
|
|
43
|
+
* };
|
|
44
|
+
* const command = new StreamCopilotSessionEventsCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // consume or destroy the stream to free the socket.
|
|
47
|
+
* const bytes = await response.events.transformToByteArray();
|
|
48
|
+
* // const str = await response.events.transformToString();
|
|
49
|
+
* // response.events.destroy(); // only applicable to Node.js Readable streams.
|
|
50
|
+
*
|
|
51
|
+
* // { // StreamCopilotSessionEventsOutput
|
|
52
|
+
* // events: "<SdkStream>", // see \@smithy/types -> StreamingBlobPayloadOutputTypes // required
|
|
53
|
+
* // contentType: "STRING_VALUE", // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param StreamCopilotSessionEventsCommandInput - {@link StreamCopilotSessionEventsCommandInput}
|
|
59
|
+
* @returns {@link StreamCopilotSessionEventsCommandOutput}
|
|
60
|
+
* @see {@link StreamCopilotSessionEventsCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link StreamCopilotSessionEventsCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link WilmaCopilotSessionsClientResolvedConfig | config} for WilmaCopilotSessionsClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link NotFoundException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link WilmaCopilotSessionsServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from WilmaCopilotSessions service.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class StreamCopilotSessionEventsCommand extends StreamCopilotSessionEventsCommand_base {
|
|
77
|
+
/** @internal type navigation helper, not in runtime. */
|
|
78
|
+
protected static __types: {
|
|
79
|
+
api: {
|
|
80
|
+
input: StreamCopilotSessionEventsInput;
|
|
81
|
+
output: StreamCopilotSessionEventsOutput;
|
|
82
|
+
};
|
|
83
|
+
sdk: {
|
|
84
|
+
input: StreamCopilotSessionEventsCommandInput;
|
|
85
|
+
output: StreamCopilotSessionEventsCommandOutput;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
}
|
|
@@ -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 WilmaCopilotSessionsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
|
|
8
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runtime for Wilma Copilot: copilot assisting live conversations. A session is created
|
|
3
|
+
* automatically when a matching voice call or chat starts. Published profiles whose conditions
|
|
4
|
+
* match run in an event-driven pipeline — on each event it detects intents, runs evaluations,
|
|
5
|
+
* updates a mutable session state and, when conditions match, shows assets and triggers
|
|
6
|
+
* automations.
|
|
7
|
+
*
|
|
8
|
+
* Each session keeps a monotonic, replayable event log. Clients page recorded events and tail
|
|
9
|
+
* live events over SSE to reconstruct session state. Profile and library-resource configuration
|
|
10
|
+
* lives in the companion wilma-copilot service; this service applies the published profile
|
|
11
|
+
* versions and streams what copilot detects and shows.
|
|
12
|
+
*
|
|
13
|
+
* @packageDocumentation
|
|
14
|
+
*/
|
|
15
|
+
export * from "./WilmaCopilotSessionsClient";
|
|
16
|
+
export * from "./WilmaCopilotSessions";
|
|
17
|
+
export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
18
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
19
|
+
export type { WilmaCopilotSessionsExtensionConfiguration } from "./extensionConfiguration";
|
|
20
|
+
export * from "./commands";
|
|
21
|
+
export * from "./schemas/schemas_0";
|
|
22
|
+
export * from "./models/enums";
|
|
23
|
+
export * from "./models/errors";
|
|
24
|
+
export * from "./models/models_0";
|
|
25
|
+
export { WilmaCopilotSessionsServiceException } from "./models/WilmaCopilotSessionsServiceException";
|