@aws-sdk/client-connect 3.1076.0 → 3.1077.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.
Files changed (64) hide show
  1. package/README.md +14 -0
  2. package/dist-cjs/index.js +199 -53
  3. package/dist-es/Connect.js +4 -0
  4. package/dist-es/commands/CreateAttachedFileCommand.js +16 -0
  5. package/dist-es/commands/StartContactConversationalAnalyticsJobCommand.js +16 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +25 -0
  8. package/dist-es/runtimeConfig.browser.js +0 -2
  9. package/dist-es/runtimeConfig.js +1 -2
  10. package/dist-es/runtimeConfig.native.js +0 -2
  11. package/dist-es/runtimeConfig.shared.js +2 -0
  12. package/dist-es/schemas/schemas_0.js +128 -50
  13. package/dist-types/Connect.d.ts +14 -0
  14. package/dist-types/ConnectClient.d.ts +4 -2
  15. package/dist-types/commands/BatchGetAttachedFileMetadataCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateAttachedFileCommand.d.ts +115 -0
  17. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  18. package/dist-types/commands/GetAttachedFileCommand.d.ts +1 -1
  19. package/dist-types/commands/GetMetricDataCommand.d.ts +2 -1
  20. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -2
  21. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
  22. package/dist-types/commands/StartChatContactCommand.d.ts +2 -1
  23. package/dist-types/commands/StartContactConversationalAnalyticsJobCommand.d.ts +135 -0
  24. package/dist-types/commands/StartEmailContactCommand.d.ts +2 -1
  25. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -1
  26. package/dist-types/commands/StartTaskContactCommand.d.ts +2 -1
  27. package/dist-types/commands/UpdateContactCommand.d.ts +2 -1
  28. package/dist-types/commands/index.d.ts +2 -0
  29. package/dist-types/models/enums.d.ts +65 -0
  30. package/dist-types/models/models_0.d.ts +75 -94
  31. package/dist-types/models/models_1.d.ts +95 -33
  32. package/dist-types/models/models_2.d.ts +34 -60
  33. package/dist-types/models/models_3.d.ts +218 -728
  34. package/dist-types/models/models_4.d.ts +728 -3
  35. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  36. package/dist-types/runtimeConfig.d.ts +1 -1
  37. package/dist-types/runtimeConfig.native.d.ts +1 -1
  38. package/dist-types/runtimeConfig.shared.d.ts +1 -0
  39. package/dist-types/schemas/schemas_0.d.ts +12 -0
  40. package/dist-types/ts3.4/Connect.d.ts +40 -0
  41. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  42. package/dist-types/ts3.4/commands/CreateAttachedFileCommand.d.ts +53 -0
  43. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +2 -4
  45. package/dist-types/ts3.4/commands/SearchEmailAddressesCommand.d.ts +4 -2
  46. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  47. package/dist-types/ts3.4/commands/StartContactConversationalAnalyticsJobCommand.d.ts +53 -0
  48. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  50. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  51. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  52. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  53. package/dist-types/ts3.4/models/enums.d.ts +30 -0
  54. package/dist-types/ts3.4/models/models_0.d.ts +14 -21
  55. package/dist-types/ts3.4/models/models_1.d.ts +22 -9
  56. package/dist-types/ts3.4/models/models_2.d.ts +9 -15
  57. package/dist-types/ts3.4/models/models_3.d.ts +56 -145
  58. package/dist-types/ts3.4/models/models_4.d.ts +155 -3
  59. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  60. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  61. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  62. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
  63. package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
  64. package/package.json +6 -8
@@ -1,8 +1,733 @@
1
- import type { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, EvaluationFormValidationStatus, EvaluationFormVersionStatus } from "./enums";
2
- import type { AdditionalEmailRecipients, AgentInfo, Campaign, EvaluationFormAutoEvaluationConfiguration, EvaluationFormLanguageConfiguration, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy } from "./models_0";
1
+ import type { AnsweringMachineDetectionStatus, Channel, ContactInitiationMethod, DisconnectOnCustomerExitParticipantType, EvaluationFormValidationStatus, EvaluationFormVersionStatus } from "./enums";
2
+ import type { AdditionalEmailRecipients, AgentInfo, Campaign, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormLanguageConfiguration, EvaluationFormScoreThreshold, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy, Reference, UserInfo } from "./models_0";
3
3
  import type { ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, GlobalResiliencyMetadata, NextContactEntry, QualityMetrics, QueueInfo, RecordingInfo, TaskTemplateInfoV2, WisdomInfo } from "./models_1";
4
4
  import type { ContactSearchSummaryAgentInfo, ContactSearchSummaryAiAgentInfo, ContactSearchSummaryQueueInfo } from "./models_2";
5
- import type { ContactSearchSummarySegmentAttributeValue, EvaluationFormItem, RoutingCriteria, RoutingCriteriaInput, SegmentAttributeValue } from "./models_3";
5
+ import type { ChatMessage, ContactSearchSummarySegmentAttributeValue, EmailAddressInfo, EmailAttachment, EvaluationFormQuestion, InboundAdditionalRecipients, InboundEmailContent, ParticipantConfiguration, ParticipantDetails, PersistentChat, QueueInfoInput, RoutingCriteriaInputStep, SegmentAttributeValue, Step, TaskAttachment, TemplatedMessageConfig } from "./models_3";
6
+ /**
7
+ * @public
8
+ */
9
+ export interface StartChatContactRequest {
10
+ /**
11
+ * <p>The identifier of the Connect Customer 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>
12
+ * @public
13
+ */
14
+ InstanceId: string | undefined;
15
+ /**
16
+ * <p>The identifier of the flow for initiating the chat.
17
+ * To
18
+ * see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here
19
+ * in bold: </p>
20
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
21
+ * </p>
22
+ * @public
23
+ */
24
+ ContactFlowId: string | undefined;
25
+ /**
26
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes. They
27
+ * can be accessed in flows just like any other contact attributes. </p>
28
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
29
+ * alphanumeric, dash, and underscore characters.</p>
30
+ * @public
31
+ */
32
+ Attributes?: Record<string, string> | undefined;
33
+ /**
34
+ * <p>Information identifying the participant.</p>
35
+ * @public
36
+ */
37
+ ParticipantDetails: ParticipantDetails | undefined;
38
+ /**
39
+ * <p> The configuration of the participant. </p>
40
+ * @public
41
+ */
42
+ ParticipantConfiguration?: ParticipantConfiguration | undefined;
43
+ /**
44
+ * <p>The initial message to be sent to the newly created chat.</p>
45
+ * @public
46
+ */
47
+ InitialMessage?: ChatMessage | undefined;
48
+ /**
49
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
50
+ * request. If not provided, the Amazon Web Services
51
+ * SDK populates this field. For more information about idempotency, see
52
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
53
+ * @public
54
+ */
55
+ ClientToken?: string | undefined;
56
+ /**
57
+ * <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
58
+ * hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
59
+ * @public
60
+ */
61
+ ChatDurationInMinutes?: number | undefined;
62
+ /**
63
+ * <p>The supported chat message content types. Supported types are <code>text/plain</code>,
64
+ * <code>text/markdown</code>, <code>application/json</code>,
65
+ * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
66
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
67
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
68
+ * list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain,
69
+ * text/markdown, application/json]</code>, <code>[text/markdown, text/plain]</code>, <code>[text/plain,
70
+ * application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
71
+ * <note>
72
+ * <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show view</a> flow block.</p>
73
+ * </note>
74
+ * @public
75
+ */
76
+ SupportedMessagingContentTypes?: string[] | undefined;
77
+ /**
78
+ * <p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how
79
+ * to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable
80
+ * persistent chat</a>.</p>
81
+ * @public
82
+ */
83
+ PersistentChat?: PersistentChat | undefined;
84
+ /**
85
+ * <p>The unique identifier for an Connect Customer contact. This identifier is related to the chat starting.</p>
86
+ * <note>
87
+ * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
88
+ * </note>
89
+ * @public
90
+ */
91
+ RelatedContactId?: string | undefined;
92
+ /**
93
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
94
+ * attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
95
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
96
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
97
+ * <note>
98
+ * <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
99
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in the
100
+ * SupportedMessagingContentTypes field of this API in order to set <code>SegmentAttributes</code> as \{<code>
101
+ * "connect:Subtype": \{"valueString" : "connect:Guide" \}\}</code>.</p>
102
+ * </note>
103
+ * @public
104
+ */
105
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
106
+ /**
107
+ * <p>The customer's identification number. For example, the <code>CustomerId</code> may be a customer number from
108
+ * your CRM.</p>
109
+ * @public
110
+ */
111
+ CustomerId?: string | undefined;
112
+ /**
113
+ * <p>A list of participant types to automatically disconnect when the end customer ends the chat session, allowing them to continue through disconnect flows such as surveys or feedback forms.</p>
114
+ * @public
115
+ */
116
+ DisconnectOnCustomerExit?: DisconnectOnCustomerExitParticipantType[] | undefined;
117
+ }
118
+ /**
119
+ * @public
120
+ */
121
+ export interface StartEmailContactRequest {
122
+ /**
123
+ * <p>The identifier of the Connect Customer 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>
124
+ * @public
125
+ */
126
+ InstanceId: string | undefined;
127
+ /**
128
+ * <p>The email address of the customer.</p>
129
+ * @public
130
+ */
131
+ FromEmailAddress: EmailAddressInfo | undefined;
132
+ /**
133
+ * <p>The email address associated with the Connect Customer instance.</p>
134
+ * @public
135
+ */
136
+ DestinationEmailAddress: string | undefined;
137
+ /**
138
+ * <p>A description of the email contact.</p>
139
+ * @public
140
+ */
141
+ Description?: string | undefined;
142
+ /**
143
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following
144
+ * reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
145
+ * <code>DATE</code>. <code>EMAIL</code> | <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported
146
+ * reference type during email creation.</p>
147
+ * @public
148
+ */
149
+ References?: Record<string, Reference> | undefined;
150
+ /**
151
+ * <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
152
+ * @public
153
+ */
154
+ Name?: string | undefined;
155
+ /**
156
+ * <p>The email message body to be sent to the newly created email.</p>
157
+ * @public
158
+ */
159
+ EmailMessage: InboundEmailContent | undefined;
160
+ /**
161
+ * <p>The additional recipients address of the email.</p>
162
+ * @public
163
+ */
164
+ AdditionalRecipients?: InboundAdditionalRecipients | undefined;
165
+ /**
166
+ * <p>List of S3 presigned URLs of email attachments and their file name. </p>
167
+ * @public
168
+ */
169
+ Attachments?: EmailAttachment[] | undefined;
170
+ /**
171
+ * <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Connect Customer admin website, on the navigation
172
+ * menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
173
+ * flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
174
+ * ContactFlowId is the last part of the ARN, shown here in bold: </p>
175
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
176
+ * </p>
177
+ * @public
178
+ */
179
+ ContactFlowId?: string | undefined;
180
+ /**
181
+ * <p>The contactId that is related to this contact. Linking emails together by using <code>RelatedContactID</code>
182
+ * copies over contact attributes from the related email contact to the new email contact. All updates to user-defined
183
+ * attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of
184
+ * contacts that can be linked by using <code>RelatedContactId</code>. </p>
185
+ * @public
186
+ */
187
+ RelatedContactId?: string | undefined;
188
+ /**
189
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
190
+ * can be accessed in flows just like any other contact attributes.</p>
191
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
192
+ * alphanumeric, dash, and underscore characters.</p>
193
+ * @public
194
+ */
195
+ Attributes?: Record<string, string> | undefined;
196
+ /**
197
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
198
+ * attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
199
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
200
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
201
+ * <note>
202
+ * <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer number of minutes the
203
+ * contact will be active for before expiring, with <code>SegmentAttributes</code> like \{ <code>
204
+ * "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
205
+ * </note>
206
+ * @public
207
+ */
208
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
209
+ /**
210
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
211
+ * request. If not provided, the Amazon Web Services
212
+ * SDK populates this field. For more information about idempotency, see
213
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
214
+ * @public
215
+ */
216
+ ClientToken?: string | undefined;
217
+ }
218
+ /**
219
+ * @public
220
+ */
221
+ export interface StartOutboundChatContactRequest {
222
+ /**
223
+ * <p>Information about the endpoint.</p>
224
+ * @public
225
+ */
226
+ SourceEndpoint: Endpoint | undefined;
227
+ /**
228
+ * <p>Information about the endpoint.</p>
229
+ * @public
230
+ */
231
+ DestinationEndpoint: Endpoint | undefined;
232
+ /**
233
+ * <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name
234
+ * (ARN) of the instance.</p>
235
+ * @public
236
+ */
237
+ InstanceId: string | undefined;
238
+ /**
239
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
240
+ * attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
241
+ * <ul>
242
+ * <li>
243
+ * <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
244
+ * </li>
245
+ * <li>
246
+ * <p>This field can be used to show channel subtype, such as <code>connect:SMS</code> and
247
+ * <code>connect:WhatsApp</code>.</p>
248
+ * </li>
249
+ * </ul>
250
+ * @public
251
+ */
252
+ SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
253
+ /**
254
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
255
+ * can be accessed in flows just like any other contact attributes.</p>
256
+ * @public
257
+ */
258
+ Attributes?: Record<string, string> | undefined;
259
+ /**
260
+ * <p>The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer console user
261
+ * interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On
262
+ * the flow page, under the name of the flow, choose <b>Show additional flow information</b>.
263
+ * The ContactFlowId is the last part of the ARN, shown here in bold:</p>
264
+ * <ul>
265
+ * <li>
266
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
267
+ * </p>
268
+ * </li>
269
+ * </ul>
270
+ * @public
271
+ */
272
+ ContactFlowId: string | undefined;
273
+ /**
274
+ * <p>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25
275
+ * hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</p>
276
+ * @public
277
+ */
278
+ ChatDurationInMinutes?: number | undefined;
279
+ /**
280
+ * <p>The customer's details.</p>
281
+ * @public
282
+ */
283
+ ParticipantDetails?: ParticipantDetails | undefined;
284
+ /**
285
+ * <p>A chat message.</p>
286
+ * @public
287
+ */
288
+ InitialSystemMessage?: ChatMessage | undefined;
289
+ /**
290
+ * <p>Information about template message configuration.</p>
291
+ * @public
292
+ */
293
+ InitialTemplatedSystemMessage?: TemplatedMessageConfig | undefined;
294
+ /**
295
+ * <p>The unique identifier for an Connect Customer contact. This identifier is related to the contact
296
+ * starting.</p>
297
+ * @public
298
+ */
299
+ RelatedContactId?: string | undefined;
300
+ /**
301
+ * <p>The supported chat message content types. Supported types are:</p>
302
+ * <ul>
303
+ * <li>
304
+ * <p>
305
+ * <code>text/plain</code>
306
+ * </p>
307
+ * </li>
308
+ * <li>
309
+ * <p>
310
+ * <code>text/markdown</code>
311
+ * </p>
312
+ * </li>
313
+ * <li>
314
+ * <p>
315
+ * <code>application/json, application/vnd.amazonaws.connect.message.interactive</code>
316
+ * </p>
317
+ * </li>
318
+ * <li>
319
+ * <p>
320
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>
321
+ * </p>
322
+ * </li>
323
+ * </ul>
324
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other supported type in the
325
+ * list. For example, all the following lists are valid because they contain <code>text/plain</code>:</p>
326
+ * <ul>
327
+ * <li>
328
+ * <p>
329
+ * <code>[text/plain, text/markdown, application/json]</code>
330
+ * </p>
331
+ * </li>
332
+ * <li>
333
+ * <p>
334
+ * <code>[text/markdown, text/plain]</code>
335
+ * </p>
336
+ * </li>
337
+ * <li>
338
+ * <p>
339
+ * <code>[text/plain, application/json,
340
+ * application/vnd.amazonaws.connect.message.interactive.response]</code>
341
+ * </p>
342
+ * </li>
343
+ * </ul>
344
+ * @public
345
+ */
346
+ SupportedMessagingContentTypes?: string[] | undefined;
347
+ /**
348
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
349
+ * the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with
350
+ * idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact
351
+ * ID is returned.</p>
352
+ * @public
353
+ */
354
+ ClientToken?: string | undefined;
355
+ }
356
+ /**
357
+ * @public
358
+ */
359
+ export interface StartTaskContactRequest {
360
+ /**
361
+ * <p>The identifier of the Connect Customer 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>
362
+ * @public
363
+ */
364
+ InstanceId: string | undefined;
365
+ /**
366
+ * <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task
367
+ * contacts linked using the same <code>PreviousContactID</code> will affect every contact in the chain. There can be a
368
+ * maximum of 12 linked task contacts in a chain.</p>
369
+ * @public
370
+ */
371
+ PreviousContactId?: string | undefined;
372
+ /**
373
+ * <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Connect Customer admin website, on the navigation
374
+ * menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the
375
+ * flow page, under the name of the flow, choose <b>Show additional flow information</b>. The
376
+ * ContactFlowId is the last part of the ARN, shown here in bold: </p>
377
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
378
+ * </p>
379
+ * @public
380
+ */
381
+ ContactFlowId?: string | undefined;
382
+ /**
383
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and
384
+ * can be accessed in flows just like any other contact attributes.</p>
385
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
386
+ * alphanumeric, dash, and underscore characters.</p>
387
+ * @public
388
+ */
389
+ Attributes?: Record<string, string> | undefined;
390
+ /**
391
+ * <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
392
+ * @public
393
+ */
394
+ Name: string | undefined;
395
+ /**
396
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
397
+ * reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> | <code>STRING</code> |
398
+ * <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a supported reference type during task
399
+ * creation.</p>
400
+ * @public
401
+ */
402
+ References?: Record<string, Reference> | undefined;
403
+ /**
404
+ * <p>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</p>
405
+ * @public
406
+ */
407
+ Description?: string | undefined;
408
+ /**
409
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
410
+ * request. If not provided, the Amazon Web Services
411
+ * SDK populates this field. For more information about idempotency, see
412
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
413
+ * @public
414
+ */
415
+ ClientToken?: string | undefined;
416
+ /**
417
+ * <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
418
+ * @public
419
+ */
420
+ ScheduledTime?: Date | undefined;
421
+ /**
422
+ * <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the <i>Connect Customer Administrator Guide</i>. </p>
423
+ * @public
424
+ */
425
+ TaskTemplateId?: string | undefined;
426
+ /**
427
+ * <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the flow that is defined
428
+ * on agent or queue quick connect. For more information about quick connects, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick connects</a>.</p>
429
+ * @public
430
+ */
431
+ QuickConnectId?: string | undefined;
432
+ /**
433
+ * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking tasks together by using <code>RelatedContactID</code> copies over contact
434
+ * attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new
435
+ * task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
436
+ * <code>PreviousContactID</code>. There are no limits to the number of contacts that can be linked by using
437
+ * <code>RelatedContactId</code>. </p>
438
+ * @public
439
+ */
440
+ RelatedContactId?: string | undefined;
441
+ /**
442
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
443
+ * attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
444
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
445
+ * <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created
446
+ * a task.</p>
447
+ * <note>
448
+ * <p>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
449
+ * be active for before expiring, with <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry":
450
+ * \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}</code>. </p>
451
+ * <p>To set the created by user, a valid AgentResourceId must be supplied, with <code>SegmentAttributes</code> like
452
+ * \{ <code>"connect:CreatedByUser" \{ "ValueString":
453
+ * "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
454
+ * </p>
455
+ * </note>
456
+ * @public
457
+ */
458
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
459
+ /**
460
+ * <p>List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.</p>
461
+ * @public
462
+ */
463
+ Attachments?: TaskAttachment[] | undefined;
464
+ }
465
+ /**
466
+ * @public
467
+ */
468
+ export interface UpdateContactRequest {
469
+ /**
470
+ * <p>The identifier of the Connect Customer 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>
471
+ * @public
472
+ */
473
+ InstanceId: string | undefined;
474
+ /**
475
+ * <p>The identifier of the contact. This is the identifier of the contact associated with the first interaction with
476
+ * your contact center.</p>
477
+ * @public
478
+ */
479
+ ContactId: string | undefined;
480
+ /**
481
+ * <p>The name of the contact.</p>
482
+ * @public
483
+ */
484
+ Name?: string | undefined;
485
+ /**
486
+ * <p>The description of the contact.</p>
487
+ * @public
488
+ */
489
+ Description?: string | undefined;
490
+ /**
491
+ * <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
492
+ * @public
493
+ */
494
+ References?: Record<string, Reference> | undefined;
495
+ /**
496
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an
497
+ * attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.</p>
498
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
499
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
500
+ * <p>Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be
501
+ * updated by using the UpdateContact API.</p>
502
+ * @public
503
+ */
504
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
505
+ /**
506
+ * <p> Information about the queue associated with a contact. This parameter can only be updated for external audio
507
+ * contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in
508
+ * the <i>
509
+ * Connect Customer Administrator Guide</i>.</p>
510
+ * @public
511
+ */
512
+ QueueInfo?: QueueInfoInput | undefined;
513
+ /**
514
+ * <p>Information about the agent associated with a contact. This parameter can only be updated for external audio
515
+ * contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in
516
+ * the <i>
517
+ * Connect Customer Administrator Guide</i>.</p>
518
+ * @public
519
+ */
520
+ UserInfo?: UserInfo | undefined;
521
+ /**
522
+ * <p>The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually
523
+ * the end customer's phone number. This value can only be updated for external audio contacts. For more information,
524
+ * see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer
525
+ * Contact Lens integration</a> in the <i>Connect Customer Administrator Guide</i>.</p>
526
+ * @public
527
+ */
528
+ CustomerEndpoint?: Endpoint | undefined;
529
+ /**
530
+ * <p>External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of
531
+ * the external system such as the contact center. This value can only be updated for external audio contacts. For more
532
+ * information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Connect Customer Contact Lens integration</a> in the <i>Connect Customer Administrator
533
+ * Guide</i>.</p>
534
+ * @public
535
+ */
536
+ SystemEndpoint?: Endpoint | undefined;
537
+ }
538
+ /**
539
+ * <p>Information about an item from an evaluation form. The item must be either a section or a question.</p>
540
+ * @public
541
+ */
542
+ export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember;
543
+ /**
544
+ * @public
545
+ */
546
+ export declare namespace EvaluationFormItem {
547
+ /**
548
+ * <p>The information of the section.</p>
549
+ * @public
550
+ */
551
+ interface SectionMember {
552
+ Section: EvaluationFormSection;
553
+ Question?: never;
554
+ $unknown?: never;
555
+ }
556
+ /**
557
+ * <p>The information of the question.</p>
558
+ * @public
559
+ */
560
+ interface QuestionMember {
561
+ Section?: never;
562
+ Question: EvaluationFormQuestion;
563
+ $unknown?: never;
564
+ }
565
+ /**
566
+ * @public
567
+ */
568
+ interface $UnknownMember {
569
+ Section?: never;
570
+ Question?: never;
571
+ $unknown: [string, any];
572
+ }
573
+ /**
574
+ * @deprecated unused in schema-serde mode.
575
+ *
576
+ */
577
+ interface Visitor<T> {
578
+ Section: (value: EvaluationFormSection) => T;
579
+ Question: (value: EvaluationFormQuestion) => T;
580
+ _: (name: string, value: any) => T;
581
+ }
582
+ }
583
+ /**
584
+ * <p>Latest routing criteria on the contact.</p>
585
+ * @public
586
+ */
587
+ export interface RoutingCriteria {
588
+ /**
589
+ * <p>List of routing steps. When Connect Customer does not find an available agent meeting the requirements in a
590
+ * step for a given step duration, the routing criteria will move on to the next step sequentially until a join is
591
+ * completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
592
+ * @public
593
+ */
594
+ Steps?: Step[] | undefined;
595
+ /**
596
+ * <p>The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when
597
+ * contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue
598
+ * even though Routing criteria is never activated for contacts in agent queue.</p>
599
+ * @public
600
+ */
601
+ ActivationTimestamp?: Date | undefined;
602
+ /**
603
+ * <p>Information about the index of the routing criteria.</p>
604
+ * @public
605
+ */
606
+ Index?: number | undefined;
607
+ }
608
+ /**
609
+ * <p>An object to define the RoutingCriteria.</p>
610
+ * @public
611
+ */
612
+ export interface RoutingCriteriaInput {
613
+ /**
614
+ * <p>When Connect Customer does not find an available agent meeting the requirements in a step for a given step
615
+ * duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent.
616
+ * When all steps are exhausted, the contact will be offered to any agent in the queue.</p>
617
+ * @public
618
+ */
619
+ Steps?: RoutingCriteriaInputStep[] | undefined;
620
+ }
621
+ /**
622
+ * <p>Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation
623
+ * forms can only contain sections and subsections (two level nesting).</p>
624
+ * @public
625
+ */
626
+ export interface EvaluationFormSection {
627
+ /**
628
+ * <p>The title of the section.</p>
629
+ * @public
630
+ */
631
+ Title: string | undefined;
632
+ /**
633
+ * <p>The identifier of the section. An identifier must be unique within the evaluation form.</p>
634
+ * @public
635
+ */
636
+ RefId: string | undefined;
637
+ /**
638
+ * <p>The instructions of the section.</p>
639
+ * @public
640
+ */
641
+ Instructions?: string | undefined;
642
+ /**
643
+ * <p>The items of the section.</p>
644
+ * @public
645
+ */
646
+ Items: EvaluationFormItem[] | undefined;
647
+ /**
648
+ * <p>The scoring weight of the section.</p>
649
+ * @public
650
+ */
651
+ Weight?: number | undefined;
652
+ /**
653
+ * <p>The flag to exclude the section from scoring.</p>
654
+ * @public
655
+ */
656
+ IsExcludedFromScoring?: boolean | undefined;
657
+ /**
658
+ * <p>The score thresholds for performance categories.</p>
659
+ * @public
660
+ */
661
+ ScoreThresholds?: EvaluationFormScoreThreshold[] | undefined;
662
+ }
663
+ /**
664
+ * @public
665
+ */
666
+ export interface CreateEvaluationFormRequest {
667
+ /**
668
+ * <p>The identifier of the Connect Customer 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>
669
+ * @public
670
+ */
671
+ InstanceId: string | undefined;
672
+ /**
673
+ * <p>A title of the evaluation form.</p>
674
+ * @public
675
+ */
676
+ Title: string | undefined;
677
+ /**
678
+ * <p>The description of the evaluation form.</p>
679
+ * @public
680
+ */
681
+ Description?: string | undefined;
682
+ /**
683
+ * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
684
+ * @public
685
+ */
686
+ Items: EvaluationFormItem[] | undefined;
687
+ /**
688
+ * <p>A scoring strategy of the evaluation form.</p>
689
+ * @public
690
+ */
691
+ ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
692
+ /**
693
+ * <p>Configuration information about automated evaluations.</p>
694
+ * @public
695
+ */
696
+ AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined;
697
+ /**
698
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
699
+ * request. If not provided, the Amazon Web Services
700
+ * SDK populates this field. For more information about idempotency, see
701
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
702
+ * @public
703
+ */
704
+ ClientToken?: string | undefined;
705
+ /**
706
+ * <p>A boolean flag indicating whether to create evaluation form in draft state.</p>
707
+ * @public
708
+ */
709
+ AsDraft?: boolean | undefined;
710
+ /**
711
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
712
+ * @public
713
+ */
714
+ Tags?: Record<string, string> | undefined;
715
+ /**
716
+ * <p>Configuration information about evaluation reviews.</p>
717
+ * @public
718
+ */
719
+ ReviewConfiguration?: EvaluationReviewConfiguration | undefined;
720
+ /**
721
+ * <p>Configuration that specifies the target for the evaluation form.</p>
722
+ * @public
723
+ */
724
+ TargetConfiguration?: EvaluationFormTargetConfiguration | undefined;
725
+ /**
726
+ * <p>Configuration for language settings of the evaluation form.</p>
727
+ * @public
728
+ */
729
+ LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined;
730
+ }
6
731
  /**
7
732
  * <p>Information about the evaluation form.</p>
8
733
  * @public