@aws-sdk/client-connect 3.473.0 → 3.475.0
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/README.md +32 -0
- package/dist-cjs/Connect.js +8 -0
- package/dist-cjs/commands/PauseContactCommand.js +51 -0
- package/dist-cjs/commands/ResumeContactCommand.js +51 -0
- package/dist-cjs/commands/TagContactCommand.js +51 -0
- package/dist-cjs/commands/UntagContactCommand.js +51 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/models/models_0.js +7 -5
- package/dist-cjs/models/models_1.js +19 -6
- package/dist-cjs/models/models_2.js +6 -1
- package/dist-cjs/protocols/Aws_restJson1.js +414 -10
- package/dist-es/Connect.js +8 -0
- package/dist-es/commands/PauseContactCommand.js +47 -0
- package/dist-es/commands/ResumeContactCommand.js +47 -0
- package/dist-es/commands/TagContactCommand.js +47 -0
- package/dist-es/commands/UntagContactCommand.js +47 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +6 -4
- package/dist-es/models/models_1.js +17 -5
- package/dist-es/models/models_2.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +400 -4
- package/dist-types/Connect.d.ts +28 -0
- package/dist-types/ConnectClient.d.ts +6 -2
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +2 -2
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreateRuleCommand.d.ts +30 -2
- package/dist-types/commands/DescribeContactCommand.d.ts +8 -0
- package/dist-types/commands/DescribePromptCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQueueCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRuleCommand.d.ts +30 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListRulesCommand.d.ts +3 -3
- package/dist-types/commands/PauseContactCommand.d.ts +97 -0
- package/dist-types/commands/ResumeContactCommand.d.ts +94 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +9 -0
- package/dist-types/commands/TagContactCommand.d.ts +92 -0
- package/dist-types/commands/UntagContactCommand.d.ts +91 -0
- package/dist-types/commands/UpdateRuleCommand.d.ts +29 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +164 -175
- package/dist-types/models/models_1.d.ts +237 -319
- package/dist-types/models/models_2.d.ts +398 -9
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/Connect.d.ts +68 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/DescribePromptCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/DescribeQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PauseContactCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/ResumeContactCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagContactCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -37
- package/dist-types/ts3.4/models/models_1.d.ts +56 -65
- package/dist-types/ts3.4/models/models_2.d.ts +84 -5
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +4 -4
|
@@ -1,7 +1,313 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { AgentAvailabilityTimer, AgentConfig, AgentStatusState, AllowedCapabilities, Application, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, HoursOfOperationConfig, InstanceAttributeType, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, OutboundCallerConfig,
|
|
4
|
-
import {
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentStatusState, AllowedCapabilities, Application, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, HoursOfOperationConfig, InstanceAttributeType, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, OutboundCallerConfig, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, ViewInputContent, ViewStatus, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
import { ControlPlaneTagFilter, HierarchyGroupMatchType, HoursOfOperationSearchFilter, PromptSearchFilter, QueueSearchFilter, QueueStatus, QuickConnectSearchFilter, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, SignInConfig, StringCondition, TelephonyConfig } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
* <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface HierarchyGroupCondition {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>The value in the hierarchy group condition.</p>
|
|
13
|
+
*/
|
|
14
|
+
Value?: string;
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
* <p>The type of hierarchy group match.</p>
|
|
18
|
+
*/
|
|
19
|
+
HierarchyGroupMatchType?: HierarchyGroupMatchType;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
* <p>Filters to be applied to search results.</p>
|
|
24
|
+
*/
|
|
25
|
+
export interface UserSearchFilter {
|
|
26
|
+
/**
|
|
27
|
+
* @public
|
|
28
|
+
* <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
|
|
29
|
+
* This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Top level list specifies conditions that need to be applied with <code>OR</code>
|
|
33
|
+
* operator</p>
|
|
34
|
+
* </li>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>Inner list specifies conditions that need to be applied with <code>AND</code>
|
|
37
|
+
* operator.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* </ul>
|
|
40
|
+
*/
|
|
41
|
+
TagFilter?: ControlPlaneTagFilter;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
* <p>The user's first name and last name.</p>
|
|
46
|
+
*/
|
|
47
|
+
export interface UserIdentityInfoLite {
|
|
48
|
+
/**
|
|
49
|
+
* @public
|
|
50
|
+
* <p>The user's first name.</p>
|
|
51
|
+
*/
|
|
52
|
+
FirstName?: string;
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
* <p>The user's last name.</p>
|
|
56
|
+
*/
|
|
57
|
+
LastName?: string;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
* <p>Information about the returned users.</p>
|
|
62
|
+
*/
|
|
63
|
+
export interface UserSearchSummary {
|
|
64
|
+
/**
|
|
65
|
+
* @public
|
|
66
|
+
* <p>The Amazon Resource Name (ARN) of the user.</p>
|
|
67
|
+
*/
|
|
68
|
+
Arn?: string;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
* <p>The directory identifier of the user.</p>
|
|
72
|
+
*/
|
|
73
|
+
DirectoryUserId?: string;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* <p>The identifier of the user's hierarchy group.</p>
|
|
77
|
+
*/
|
|
78
|
+
HierarchyGroupId?: string;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
* <p>The identifier of the user's summary.</p>
|
|
82
|
+
*/
|
|
83
|
+
Id?: string;
|
|
84
|
+
/**
|
|
85
|
+
* @public
|
|
86
|
+
* <p>The user's first name and last name.</p>
|
|
87
|
+
*/
|
|
88
|
+
IdentityInfo?: UserIdentityInfoLite;
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
* <p>Contains information about the phone configuration settings for a user.</p>
|
|
92
|
+
*/
|
|
93
|
+
PhoneConfig?: UserPhoneConfig;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
* <p>The identifier of the user's routing profile.</p>
|
|
97
|
+
*/
|
|
98
|
+
RoutingProfileId?: string;
|
|
99
|
+
/**
|
|
100
|
+
* @public
|
|
101
|
+
* <p>The identifiers of the user's security profiles.</p>
|
|
102
|
+
*/
|
|
103
|
+
SecurityProfileIds?: string[];
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
107
|
+
*/
|
|
108
|
+
Tags?: Record<string, string>;
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
* <p>The name of the user.</p>
|
|
112
|
+
*/
|
|
113
|
+
Username?: string;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
export interface SearchUsersResponse {
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
* <p>Information about the users.</p>
|
|
122
|
+
*/
|
|
123
|
+
Users?: UserSearchSummary[];
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
127
|
+
*/
|
|
128
|
+
NextToken?: string;
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
* <p>The total number of users who matched your search query.</p>
|
|
132
|
+
*/
|
|
133
|
+
ApproximateTotalCount?: number;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export interface SearchVocabulariesRequest {
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
142
|
+
*/
|
|
143
|
+
InstanceId: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
* <p>The maximum number of results to return per page.</p>
|
|
147
|
+
*/
|
|
148
|
+
MaxResults?: number;
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
152
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
153
|
+
*/
|
|
154
|
+
NextToken?: string;
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
158
|
+
*/
|
|
159
|
+
State?: VocabularyState;
|
|
160
|
+
/**
|
|
161
|
+
* @public
|
|
162
|
+
* <p>The starting pattern of the name of the vocabulary.</p>
|
|
163
|
+
*/
|
|
164
|
+
NameStartsWith?: string;
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
168
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
169
|
+
* </p>
|
|
170
|
+
*/
|
|
171
|
+
LanguageCode?: VocabularyLanguageCode;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* @public
|
|
175
|
+
* <p>Contains summary information about the custom vocabulary.</p>
|
|
176
|
+
*/
|
|
177
|
+
export interface VocabularySummary {
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
* <p>A unique name of the custom vocabulary.</p>
|
|
181
|
+
*/
|
|
182
|
+
Name: string | undefined;
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
* <p>The identifier of the custom vocabulary.</p>
|
|
186
|
+
*/
|
|
187
|
+
Id: string | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* @public
|
|
190
|
+
* <p>The Amazon Resource Name (ARN) of the custom vocabulary.</p>
|
|
191
|
+
*/
|
|
192
|
+
Arn: string | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
* <p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see
|
|
196
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a>
|
|
197
|
+
* </p>
|
|
198
|
+
*/
|
|
199
|
+
LanguageCode: VocabularyLanguageCode | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* @public
|
|
202
|
+
* <p>The current state of the custom vocabulary.</p>
|
|
203
|
+
*/
|
|
204
|
+
State: VocabularyState | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
* <p>The timestamp when the custom vocabulary was last modified.</p>
|
|
208
|
+
*/
|
|
209
|
+
LastModifiedTime: Date | undefined;
|
|
210
|
+
/**
|
|
211
|
+
* @public
|
|
212
|
+
* <p>The reason why the custom vocabulary was not created.</p>
|
|
213
|
+
*/
|
|
214
|
+
FailureReason?: string;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
export interface SearchVocabulariesResponse {
|
|
220
|
+
/**
|
|
221
|
+
* @public
|
|
222
|
+
* <p>The list of the available custom vocabularies.</p>
|
|
223
|
+
*/
|
|
224
|
+
VocabularySummaryList?: VocabularySummary[];
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
228
|
+
*/
|
|
229
|
+
NextToken?: string;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* @public
|
|
233
|
+
* @enum
|
|
234
|
+
*/
|
|
235
|
+
export declare const ChatEventType: {
|
|
236
|
+
readonly DISCONNECT: "DISCONNECT";
|
|
237
|
+
readonly EVENT: "EVENT";
|
|
238
|
+
readonly MESSAGE: "MESSAGE";
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
export type ChatEventType = (typeof ChatEventType)[keyof typeof ChatEventType];
|
|
244
|
+
/**
|
|
245
|
+
* @public
|
|
246
|
+
* <p>Chat integration event containing payload to perform different chat actions such as:</p>
|
|
247
|
+
* <ul>
|
|
248
|
+
* <li>
|
|
249
|
+
* <p>Sending a chat message</p>
|
|
250
|
+
* </li>
|
|
251
|
+
* <li>
|
|
252
|
+
* <p>Sending a chat event, such as typing</p>
|
|
253
|
+
* </li>
|
|
254
|
+
* <li>
|
|
255
|
+
* <p>Disconnecting from a chat</p>
|
|
256
|
+
* </li>
|
|
257
|
+
* </ul>
|
|
258
|
+
*/
|
|
259
|
+
export interface ChatEvent {
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
* <p>Type of chat integration event. </p>
|
|
263
|
+
*/
|
|
264
|
+
Type: ChatEventType | undefined;
|
|
265
|
+
/**
|
|
266
|
+
* @public
|
|
267
|
+
* <p>Type of content. This is required when <code>Type</code> is <code>MESSAGE</code> or
|
|
268
|
+
* <code>EVENT</code>. </p>
|
|
269
|
+
* <ul>
|
|
270
|
+
* <li>
|
|
271
|
+
* <p>For allowed message content types, see the <code>ContentType</code> parameter in the
|
|
272
|
+
* <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic in the <i>Amazon Connect Participant Service API
|
|
273
|
+
* Reference</i>.</p>
|
|
274
|
+
* </li>
|
|
275
|
+
* <li>
|
|
276
|
+
* <p>For allowed event content types, see the <code>ContentType</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API
|
|
277
|
+
* Reference</i>. </p>
|
|
278
|
+
* </li>
|
|
279
|
+
* </ul>
|
|
280
|
+
*/
|
|
281
|
+
ContentType?: string;
|
|
282
|
+
/**
|
|
283
|
+
* @public
|
|
284
|
+
* <p>Content of the message or event. This is required when <code>Type</code> is
|
|
285
|
+
* <code>MESSAGE</code> and for certain <code>ContentTypes</code> when <code>Type</code> is
|
|
286
|
+
* <code>EVENT</code>.</p>
|
|
287
|
+
* <ul>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>For allowed message content, see the <code>Content</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic in the <i>Amazon Connect Participant Service API
|
|
290
|
+
* Reference</i>.</p>
|
|
291
|
+
* </li>
|
|
292
|
+
* <li>
|
|
293
|
+
* <p>For allowed event content, see the <code>Content</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API
|
|
294
|
+
* Reference</i>. </p>
|
|
295
|
+
* </li>
|
|
296
|
+
* </ul>
|
|
297
|
+
*/
|
|
298
|
+
Content?: string;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
* <p>The customer's details.</p>
|
|
303
|
+
*/
|
|
304
|
+
export interface ParticipantDetails {
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
* <p>Display name of the participant.</p>
|
|
308
|
+
*/
|
|
309
|
+
DisplayName: string | undefined;
|
|
310
|
+
}
|
|
5
311
|
/**
|
|
6
312
|
* @public
|
|
7
313
|
* <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
|
|
@@ -63,8 +369,9 @@ export interface SendChatIntegrationEventRequest {
|
|
|
63
369
|
/**
|
|
64
370
|
* @public
|
|
65
371
|
* <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the
|
|
66
|
-
*
|
|
67
|
-
* number destination of inbound SMS messages represented by an Amazon Pinpoint phone number
|
|
372
|
+
* Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone
|
|
373
|
+
* number destination of inbound SMS messages represented by an Amazon Pinpoint phone number
|
|
374
|
+
* ARN.</p>
|
|
68
375
|
*/
|
|
69
376
|
DestinationId: string | undefined;
|
|
70
377
|
/**
|
|
@@ -276,9 +583,10 @@ export interface StartChatContactRequest {
|
|
|
276
583
|
* <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
|
|
277
584
|
* <note>
|
|
278
585
|
* <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
|
|
279
|
-
*
|
|
280
|
-
* SupportedMessagingContentTypes field of this API in order to set
|
|
281
|
-
* "connect:Subtype": \{"valueString" : "connect:Guide"
|
|
586
|
+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
|
|
587
|
+
* the SupportedMessagingContentTypes field of this API in order to set
|
|
588
|
+
* <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
|
|
589
|
+
* \}\}</code>.</p>
|
|
282
590
|
* </note>
|
|
283
591
|
*/
|
|
284
592
|
SegmentAttributes?: Record<string, SegmentAttributeValue>;
|
|
@@ -516,6 +824,34 @@ export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
|
|
|
516
824
|
* @public
|
|
517
825
|
*/
|
|
518
826
|
export interface StartOutboundVoiceContactRequest {
|
|
827
|
+
/**
|
|
828
|
+
* @public
|
|
829
|
+
* <p>The name of a voice contact that is shown to an agent in the Contact Control Panel
|
|
830
|
+
* (CCP).</p>
|
|
831
|
+
*/
|
|
832
|
+
Name?: string;
|
|
833
|
+
/**
|
|
834
|
+
* @public
|
|
835
|
+
* <p>A description of the voice contact that is shown to an agent in the Contact Control Panel
|
|
836
|
+
* (CCP).</p>
|
|
837
|
+
*/
|
|
838
|
+
Description?: string;
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
* <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can
|
|
842
|
+
* have the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>.
|
|
843
|
+
* <code>ATTACHMENT</code> is not a supported reference type during voice contact creation.</p>
|
|
844
|
+
*/
|
|
845
|
+
References?: Record<string, Reference>;
|
|
846
|
+
/**
|
|
847
|
+
* @public
|
|
848
|
+
* <p>The <code>contactId</code> that is related to this contact. Linking voice, task, or chat by using
|
|
849
|
+
* <code>RelatedContactID</code> copies over contact attributes from the related contact to the new contact. All
|
|
850
|
+
* updates to user-defined attributes in the new contact are limited to the individual contact ID.
|
|
851
|
+
* There are no limits to the number of contacts that can be linked by using <code>RelatedContactId</code>.
|
|
852
|
+
* </p>
|
|
853
|
+
*/
|
|
854
|
+
RelatedContactId?: string;
|
|
519
855
|
/**
|
|
520
856
|
* @public
|
|
521
857
|
* <p>The phone number of the customer, in E.164 format.</p>
|
|
@@ -1102,6 +1438,34 @@ export interface SuspendContactRecordingRequest {
|
|
|
1102
1438
|
*/
|
|
1103
1439
|
export interface SuspendContactRecordingResponse {
|
|
1104
1440
|
}
|
|
1441
|
+
/**
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
export interface TagContactRequest {
|
|
1445
|
+
/**
|
|
1446
|
+
* @public
|
|
1447
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1448
|
+
*/
|
|
1449
|
+
ContactId: string | undefined;
|
|
1450
|
+
/**
|
|
1451
|
+
* @public
|
|
1452
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1453
|
+
*/
|
|
1454
|
+
InstanceId: string | undefined;
|
|
1455
|
+
/**
|
|
1456
|
+
* @public
|
|
1457
|
+
* <p>The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1458
|
+
* <note>
|
|
1459
|
+
* <p>Authorization is not supported by this tag.</p>
|
|
1460
|
+
* </note>
|
|
1461
|
+
*/
|
|
1462
|
+
Tags: Record<string, string> | undefined;
|
|
1463
|
+
}
|
|
1464
|
+
/**
|
|
1465
|
+
* @public
|
|
1466
|
+
*/
|
|
1467
|
+
export interface TagContactResponse {
|
|
1468
|
+
}
|
|
1105
1469
|
/**
|
|
1106
1470
|
* @public
|
|
1107
1471
|
*/
|
|
@@ -1113,7 +1477,7 @@ export interface TagResourceRequest {
|
|
|
1113
1477
|
resourceArn: string | undefined;
|
|
1114
1478
|
/**
|
|
1115
1479
|
* @public
|
|
1116
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "
|
|
1480
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
1117
1481
|
*/
|
|
1118
1482
|
tags: Record<string, string> | undefined;
|
|
1119
1483
|
}
|
|
@@ -1170,6 +1534,31 @@ export interface TransferContactResponse {
|
|
|
1170
1534
|
*/
|
|
1171
1535
|
ContactArn?: string;
|
|
1172
1536
|
}
|
|
1537
|
+
/**
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
export interface UntagContactRequest {
|
|
1541
|
+
/**
|
|
1542
|
+
* @public
|
|
1543
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
1544
|
+
*/
|
|
1545
|
+
ContactId: string | undefined;
|
|
1546
|
+
/**
|
|
1547
|
+
* @public
|
|
1548
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
1549
|
+
*/
|
|
1550
|
+
InstanceId: string | undefined;
|
|
1551
|
+
/**
|
|
1552
|
+
* @public
|
|
1553
|
+
* <p>A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.</p>
|
|
1554
|
+
*/
|
|
1555
|
+
TagKeys: string[] | undefined;
|
|
1556
|
+
}
|
|
1557
|
+
/**
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1560
|
+
export interface UntagContactResponse {
|
|
1561
|
+
}
|
|
1173
1562
|
/**
|
|
1174
1563
|
* @public
|
|
1175
1564
|
*/
|
|
@@ -2831,7 +3220,7 @@ export interface EvaluationForm {
|
|
|
2831
3220
|
LastModifiedBy: string | undefined;
|
|
2832
3221
|
/**
|
|
2833
3222
|
* @public
|
|
2834
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "
|
|
3223
|
+
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
2835
3224
|
*/
|
|
2836
3225
|
Tags?: Record<string, string>;
|
|
2837
3226
|
}
|
|
@@ -154,9 +154,11 @@ import { ListUsersCommandInput, ListUsersCommandOutput } from "../commands/ListU
|
|
|
154
154
|
import { ListViewsCommandInput, ListViewsCommandOutput } from "../commands/ListViewsCommand";
|
|
155
155
|
import { ListViewVersionsCommandInput, ListViewVersionsCommandOutput } from "../commands/ListViewVersionsCommand";
|
|
156
156
|
import { MonitorContactCommandInput, MonitorContactCommandOutput } from "../commands/MonitorContactCommand";
|
|
157
|
+
import { PauseContactCommandInput, PauseContactCommandOutput } from "../commands/PauseContactCommand";
|
|
157
158
|
import { PutUserStatusCommandInput, PutUserStatusCommandOutput } from "../commands/PutUserStatusCommand";
|
|
158
159
|
import { ReleasePhoneNumberCommandInput, ReleasePhoneNumberCommandOutput } from "../commands/ReleasePhoneNumberCommand";
|
|
159
160
|
import { ReplicateInstanceCommandInput, ReplicateInstanceCommandOutput } from "../commands/ReplicateInstanceCommand";
|
|
161
|
+
import { ResumeContactCommandInput, ResumeContactCommandOutput } from "../commands/ResumeContactCommand";
|
|
160
162
|
import { ResumeContactRecordingCommandInput, ResumeContactRecordingCommandOutput } from "../commands/ResumeContactRecordingCommand";
|
|
161
163
|
import { SearchAvailablePhoneNumbersCommandInput, SearchAvailablePhoneNumbersCommandOutput } from "../commands/SearchAvailablePhoneNumbersCommand";
|
|
162
164
|
import { SearchHoursOfOperationsCommandInput, SearchHoursOfOperationsCommandOutput } from "../commands/SearchHoursOfOperationsCommand";
|
|
@@ -181,8 +183,10 @@ import { StopContactRecordingCommandInput, StopContactRecordingCommandOutput } f
|
|
|
181
183
|
import { StopContactStreamingCommandInput, StopContactStreamingCommandOutput } from "../commands/StopContactStreamingCommand";
|
|
182
184
|
import { SubmitContactEvaluationCommandInput, SubmitContactEvaluationCommandOutput } from "../commands/SubmitContactEvaluationCommand";
|
|
183
185
|
import { SuspendContactRecordingCommandInput, SuspendContactRecordingCommandOutput } from "../commands/SuspendContactRecordingCommand";
|
|
186
|
+
import { TagContactCommandInput, TagContactCommandOutput } from "../commands/TagContactCommand";
|
|
184
187
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
185
188
|
import { TransferContactCommandInput, TransferContactCommandOutput } from "../commands/TransferContactCommand";
|
|
189
|
+
import { UntagContactCommandInput, UntagContactCommandOutput } from "../commands/UntagContactCommand";
|
|
186
190
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
187
191
|
import { UpdateAgentStatusCommandInput, UpdateAgentStatusCommandOutput } from "../commands/UpdateAgentStatusCommand";
|
|
188
192
|
import { UpdateContactAttributesCommandInput, UpdateContactAttributesCommandOutput } from "../commands/UpdateContactAttributesCommand";
|
|
@@ -843,6 +847,10 @@ export declare const se_ListViewVersionsCommand: (input: ListViewVersionsCommand
|
|
|
843
847
|
* serializeAws_restJson1MonitorContactCommand
|
|
844
848
|
*/
|
|
845
849
|
export declare const se_MonitorContactCommand: (input: MonitorContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
850
|
+
/**
|
|
851
|
+
* serializeAws_restJson1PauseContactCommand
|
|
852
|
+
*/
|
|
853
|
+
export declare const se_PauseContactCommand: (input: PauseContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
846
854
|
/**
|
|
847
855
|
* serializeAws_restJson1PutUserStatusCommand
|
|
848
856
|
*/
|
|
@@ -855,6 +863,10 @@ export declare const se_ReleasePhoneNumberCommand: (input: ReleasePhoneNumberCom
|
|
|
855
863
|
* serializeAws_restJson1ReplicateInstanceCommand
|
|
856
864
|
*/
|
|
857
865
|
export declare const se_ReplicateInstanceCommand: (input: ReplicateInstanceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
866
|
+
/**
|
|
867
|
+
* serializeAws_restJson1ResumeContactCommand
|
|
868
|
+
*/
|
|
869
|
+
export declare const se_ResumeContactCommand: (input: ResumeContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
858
870
|
/**
|
|
859
871
|
* serializeAws_restJson1ResumeContactRecordingCommand
|
|
860
872
|
*/
|
|
@@ -951,6 +963,10 @@ export declare const se_SubmitContactEvaluationCommand: (input: SubmitContactEva
|
|
|
951
963
|
* serializeAws_restJson1SuspendContactRecordingCommand
|
|
952
964
|
*/
|
|
953
965
|
export declare const se_SuspendContactRecordingCommand: (input: SuspendContactRecordingCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
966
|
+
/**
|
|
967
|
+
* serializeAws_restJson1TagContactCommand
|
|
968
|
+
*/
|
|
969
|
+
export declare const se_TagContactCommand: (input: TagContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
954
970
|
/**
|
|
955
971
|
* serializeAws_restJson1TagResourceCommand
|
|
956
972
|
*/
|
|
@@ -959,6 +975,10 @@ export declare const se_TagResourceCommand: (input: TagResourceCommandInput, con
|
|
|
959
975
|
* serializeAws_restJson1TransferContactCommand
|
|
960
976
|
*/
|
|
961
977
|
export declare const se_TransferContactCommand: (input: TransferContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
978
|
+
/**
|
|
979
|
+
* serializeAws_restJson1UntagContactCommand
|
|
980
|
+
*/
|
|
981
|
+
export declare const se_UntagContactCommand: (input: UntagContactCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
962
982
|
/**
|
|
963
983
|
* serializeAws_restJson1UntagResourceCommand
|
|
964
984
|
*/
|
|
@@ -1751,6 +1771,10 @@ export declare const de_ListViewVersionsCommand: (output: __HttpResponse, contex
|
|
|
1751
1771
|
* deserializeAws_restJson1MonitorContactCommand
|
|
1752
1772
|
*/
|
|
1753
1773
|
export declare const de_MonitorContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<MonitorContactCommandOutput>;
|
|
1774
|
+
/**
|
|
1775
|
+
* deserializeAws_restJson1PauseContactCommand
|
|
1776
|
+
*/
|
|
1777
|
+
export declare const de_PauseContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PauseContactCommandOutput>;
|
|
1754
1778
|
/**
|
|
1755
1779
|
* deserializeAws_restJson1PutUserStatusCommand
|
|
1756
1780
|
*/
|
|
@@ -1763,6 +1787,10 @@ export declare const de_ReleasePhoneNumberCommand: (output: __HttpResponse, cont
|
|
|
1763
1787
|
* deserializeAws_restJson1ReplicateInstanceCommand
|
|
1764
1788
|
*/
|
|
1765
1789
|
export declare const de_ReplicateInstanceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ReplicateInstanceCommandOutput>;
|
|
1790
|
+
/**
|
|
1791
|
+
* deserializeAws_restJson1ResumeContactCommand
|
|
1792
|
+
*/
|
|
1793
|
+
export declare const de_ResumeContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ResumeContactCommandOutput>;
|
|
1766
1794
|
/**
|
|
1767
1795
|
* deserializeAws_restJson1ResumeContactRecordingCommand
|
|
1768
1796
|
*/
|
|
@@ -1859,6 +1887,10 @@ export declare const de_SubmitContactEvaluationCommand: (output: __HttpResponse,
|
|
|
1859
1887
|
* deserializeAws_restJson1SuspendContactRecordingCommand
|
|
1860
1888
|
*/
|
|
1861
1889
|
export declare const de_SuspendContactRecordingCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SuspendContactRecordingCommandOutput>;
|
|
1890
|
+
/**
|
|
1891
|
+
* deserializeAws_restJson1TagContactCommand
|
|
1892
|
+
*/
|
|
1893
|
+
export declare const de_TagContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TagContactCommandOutput>;
|
|
1862
1894
|
/**
|
|
1863
1895
|
* deserializeAws_restJson1TagResourceCommand
|
|
1864
1896
|
*/
|
|
@@ -1867,6 +1899,10 @@ export declare const de_TagResourceCommand: (output: __HttpResponse, context: __
|
|
|
1867
1899
|
* deserializeAws_restJson1TransferContactCommand
|
|
1868
1900
|
*/
|
|
1869
1901
|
export declare const de_TransferContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<TransferContactCommandOutput>;
|
|
1902
|
+
/**
|
|
1903
|
+
* deserializeAws_restJson1UntagContactCommand
|
|
1904
|
+
*/
|
|
1905
|
+
export declare const de_UntagContactCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UntagContactCommandOutput>;
|
|
1870
1906
|
/**
|
|
1871
1907
|
* deserializeAws_restJson1UntagResourceCommand
|
|
1872
1908
|
*/
|
|
@@ -615,6 +615,10 @@ import {
|
|
|
615
615
|
MonitorContactCommandInput,
|
|
616
616
|
MonitorContactCommandOutput,
|
|
617
617
|
} from "./commands/MonitorContactCommand";
|
|
618
|
+
import {
|
|
619
|
+
PauseContactCommandInput,
|
|
620
|
+
PauseContactCommandOutput,
|
|
621
|
+
} from "./commands/PauseContactCommand";
|
|
618
622
|
import {
|
|
619
623
|
PutUserStatusCommandInput,
|
|
620
624
|
PutUserStatusCommandOutput,
|
|
@@ -627,6 +631,10 @@ import {
|
|
|
627
631
|
ReplicateInstanceCommandInput,
|
|
628
632
|
ReplicateInstanceCommandOutput,
|
|
629
633
|
} from "./commands/ReplicateInstanceCommand";
|
|
634
|
+
import {
|
|
635
|
+
ResumeContactCommandInput,
|
|
636
|
+
ResumeContactCommandOutput,
|
|
637
|
+
} from "./commands/ResumeContactCommand";
|
|
630
638
|
import {
|
|
631
639
|
ResumeContactRecordingCommandInput,
|
|
632
640
|
ResumeContactRecordingCommandOutput,
|
|
@@ -723,6 +731,10 @@ import {
|
|
|
723
731
|
SuspendContactRecordingCommandInput,
|
|
724
732
|
SuspendContactRecordingCommandOutput,
|
|
725
733
|
} from "./commands/SuspendContactRecordingCommand";
|
|
734
|
+
import {
|
|
735
|
+
TagContactCommandInput,
|
|
736
|
+
TagContactCommandOutput,
|
|
737
|
+
} from "./commands/TagContactCommand";
|
|
726
738
|
import {
|
|
727
739
|
TagResourceCommandInput,
|
|
728
740
|
TagResourceCommandOutput,
|
|
@@ -731,6 +743,10 @@ import {
|
|
|
731
743
|
TransferContactCommandInput,
|
|
732
744
|
TransferContactCommandOutput,
|
|
733
745
|
} from "./commands/TransferContactCommand";
|
|
746
|
+
import {
|
|
747
|
+
UntagContactCommandInput,
|
|
748
|
+
UntagContactCommandOutput,
|
|
749
|
+
} from "./commands/UntagContactCommand";
|
|
734
750
|
import {
|
|
735
751
|
UntagResourceCommandInput,
|
|
736
752
|
UntagResourceCommandOutput,
|
|
@@ -2959,6 +2975,19 @@ export interface Connect {
|
|
|
2959
2975
|
options: __HttpHandlerOptions,
|
|
2960
2976
|
cb: (err: any, data?: MonitorContactCommandOutput) => void
|
|
2961
2977
|
): void;
|
|
2978
|
+
pauseContact(
|
|
2979
|
+
args: PauseContactCommandInput,
|
|
2980
|
+
options?: __HttpHandlerOptions
|
|
2981
|
+
): Promise<PauseContactCommandOutput>;
|
|
2982
|
+
pauseContact(
|
|
2983
|
+
args: PauseContactCommandInput,
|
|
2984
|
+
cb: (err: any, data?: PauseContactCommandOutput) => void
|
|
2985
|
+
): void;
|
|
2986
|
+
pauseContact(
|
|
2987
|
+
args: PauseContactCommandInput,
|
|
2988
|
+
options: __HttpHandlerOptions,
|
|
2989
|
+
cb: (err: any, data?: PauseContactCommandOutput) => void
|
|
2990
|
+
): void;
|
|
2962
2991
|
putUserStatus(
|
|
2963
2992
|
args: PutUserStatusCommandInput,
|
|
2964
2993
|
options?: __HttpHandlerOptions
|
|
@@ -2998,6 +3027,19 @@ export interface Connect {
|
|
|
2998
3027
|
options: __HttpHandlerOptions,
|
|
2999
3028
|
cb: (err: any, data?: ReplicateInstanceCommandOutput) => void
|
|
3000
3029
|
): void;
|
|
3030
|
+
resumeContact(
|
|
3031
|
+
args: ResumeContactCommandInput,
|
|
3032
|
+
options?: __HttpHandlerOptions
|
|
3033
|
+
): Promise<ResumeContactCommandOutput>;
|
|
3034
|
+
resumeContact(
|
|
3035
|
+
args: ResumeContactCommandInput,
|
|
3036
|
+
cb: (err: any, data?: ResumeContactCommandOutput) => void
|
|
3037
|
+
): void;
|
|
3038
|
+
resumeContact(
|
|
3039
|
+
args: ResumeContactCommandInput,
|
|
3040
|
+
options: __HttpHandlerOptions,
|
|
3041
|
+
cb: (err: any, data?: ResumeContactCommandOutput) => void
|
|
3042
|
+
): void;
|
|
3001
3043
|
resumeContactRecording(
|
|
3002
3044
|
args: ResumeContactRecordingCommandInput,
|
|
3003
3045
|
options?: __HttpHandlerOptions
|
|
@@ -3310,6 +3352,19 @@ export interface Connect {
|
|
|
3310
3352
|
options: __HttpHandlerOptions,
|
|
3311
3353
|
cb: (err: any, data?: SuspendContactRecordingCommandOutput) => void
|
|
3312
3354
|
): void;
|
|
3355
|
+
tagContact(
|
|
3356
|
+
args: TagContactCommandInput,
|
|
3357
|
+
options?: __HttpHandlerOptions
|
|
3358
|
+
): Promise<TagContactCommandOutput>;
|
|
3359
|
+
tagContact(
|
|
3360
|
+
args: TagContactCommandInput,
|
|
3361
|
+
cb: (err: any, data?: TagContactCommandOutput) => void
|
|
3362
|
+
): void;
|
|
3363
|
+
tagContact(
|
|
3364
|
+
args: TagContactCommandInput,
|
|
3365
|
+
options: __HttpHandlerOptions,
|
|
3366
|
+
cb: (err: any, data?: TagContactCommandOutput) => void
|
|
3367
|
+
): void;
|
|
3313
3368
|
tagResource(
|
|
3314
3369
|
args: TagResourceCommandInput,
|
|
3315
3370
|
options?: __HttpHandlerOptions
|
|
@@ -3336,6 +3391,19 @@ export interface Connect {
|
|
|
3336
3391
|
options: __HttpHandlerOptions,
|
|
3337
3392
|
cb: (err: any, data?: TransferContactCommandOutput) => void
|
|
3338
3393
|
): void;
|
|
3394
|
+
untagContact(
|
|
3395
|
+
args: UntagContactCommandInput,
|
|
3396
|
+
options?: __HttpHandlerOptions
|
|
3397
|
+
): Promise<UntagContactCommandOutput>;
|
|
3398
|
+
untagContact(
|
|
3399
|
+
args: UntagContactCommandInput,
|
|
3400
|
+
cb: (err: any, data?: UntagContactCommandOutput) => void
|
|
3401
|
+
): void;
|
|
3402
|
+
untagContact(
|
|
3403
|
+
args: UntagContactCommandInput,
|
|
3404
|
+
options: __HttpHandlerOptions,
|
|
3405
|
+
cb: (err: any, data?: UntagContactCommandOutput) => void
|
|
3406
|
+
): void;
|
|
3339
3407
|
untagResource(
|
|
3340
3408
|
args: UntagResourceCommandInput,
|
|
3341
3409
|
options?: __HttpHandlerOptions
|